feat(date): add builtin function time to the date package to convert any timeable into datetime (#4749) #4833
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Rahul-Vasan
requested review from
nathanielc and
lwandzura
and removed request for
a team
sanderson
requested changes
Jun 4, 2022
| @@ -39,6 +39,35 @@ package date | |||
| // ``` | |||
| builtin second : (t: T) => int where T: Timeable | |||
|
|
|||
| // time returns the datetime of a specified timeable. | |||
There was a problem hiding this comment.
Suggested change
| // time returns the datetime of a specified timeable. | |
| // time returns the time value of a specified relative duration or time. | |
| // | |
| // `date.time` assumes duration values are relative to `now()`. |
| // time returns the datetime of a specified timeable. | ||
| // | ||
| // ## Parameters | ||
| // - t: Timeable. It can be either time or duration |
There was a problem hiding this comment.
Suggested change
| // - t: Timeable. It can be either time or duration | |
| // - t: Duration or time value. |
Comment on lines
+59
to
+60
| // ``` | ||
| // ### Return the time for a given relative duration |
There was a problem hiding this comment.
Suggested change
| // ``` | |
| // ### Return the time for a given relative duration | |
| // ``` | |
| // | |
| // ### Return the time for a given relative duration |
Comment on lines
+62
to
+68
| // ```no_run | ||
| // import "date" | ||
| // | ||
| // date.time(t: -1d1h1m1s1us1ns) | ||
| // | ||
| // // Returns 2022-06-02T20:02:19.506570999Z | ||
| // ``` |
There was a problem hiding this comment.
- To keep this example and return value constant, define the
nowoption in the example. - Add the
introduced: NEXTmetadata to tag this function with the next tagged Flux version.
Suggested change
| // ```no_run | |
| // import "date" | |
| // | |
| // date.time(t: -1d1h1m1s1us1ns) | |
| // | |
| // // Returns 2022-06-02T20:02:19.506570999Z | |
| // ``` | |
| // ```no_run | |
| // import "date" | |
| // | |
| // option now = () => 2022-01-01T00:00:00Z | |
| // | |
| // date.time(t: -1h) | |
| // | |
| // // Returns 2021-12-31T23:00:00.000000000Z | |
| // ``` | |
| // | |
| // ## Metadata | |
| // introduced: NEXT | |
| // |
This pull request was closed.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This feature addition now addresses the need for a function as part of the date package to be able to convert any Timeable into a datetime.
fixes: #4749
testing done:
import "date"
date.time(t: -1h)
2022-06-03T15:49:42.544101000Z
start = date.time(t: -1h)
start
2022-06-03T15:50:19.282299000Z
start = date.time(t: 2020-01-01)
start
2020-01-01T00:00:00.000000000Z
date.time(t: 2022-06-03T15:49:42.544101000Z)
2022-06-03T15:49:42.544101000Z
date.time(t: 2022-06-04T15:49:42Z)
2022-06-04T15:49:42.000000000Z
date.time(t: 2022-06-04T15:49:04.541Z)
2022-06-04T15:49:04.541000000Z
date.time(t: -3d12h4m25s1ms1us1ns)
2022-05-31T04:55:07.872817999Z
date.time(t: -1y1mo1w)
2021-04-26T17:00:24.855445000Z
Done checklist