Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(discussion) proposal pr: optional arguments for functions #58

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

WilcoSp
Copy link
Contributor

@WilcoSp WilcoSp commented May 12, 2024

based on issue #56

is*, diff* and most other functions that use the date function could 1 or more arguments be made optional to allow using the current time (now) without needing to create new Date().

currently this draft has only isAfter, isBefore and diffMilliseconds to give an example how it could look. I would like to first discuss which other functions could allow for optional arguments to use the current time ('now') and how

Copy link

vercel bot commented May 12, 2024

@WilcoSp is attempting to deploy a commit to the Formkit Team on Vercel.

A member of the Team first needs to authorize it.

*
* @param inputDate - The date that should be before the other one to return true
* @param dateToCompare - The date to compare with
* @param dateToCompare - The date to compare with or `now` if nothing given
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

in JSDocs, an optional param should be wrapped in square bracket (see JSDocs). Also to be really aligned with JSDocs, the type should also be included and come before the param name, so it should be something like

* @param {DateInput} inputDate - The date that should be before the other one to return true
* @param {MaybeDateInput} [dateToCompare] - The date to compare with or `now` if nothing given

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah we could at use square brackets to indicate a param is optional. although we don't need to add types because we use typescript to provide the types

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants