Repository navigation
types: require timeZone property in ZonedDateTimeLike (#352) - #376
Closed
cyber-atharv wants to merge 1 commit into
Closed
cyber-atharv wants to merge 1 commit into
cyber-atharv wants to merge 1 commit into
Conversation
Contributor
|
Thanks for the PR! |
This file contains hidden or 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
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.
Description
Closes #352.
In
index.d.ts,ZonedDateTimeLikepreviously definedtimeZone?: TimeZoneLikeas optional.However, when calling
Temporal.ZonedDateTime.from()with a property bag, the TC39 specification (ToTemporalZonedDateTime) requires thetimeZoneproperty. At runtime, omittingtimeZonethrows:Changes
ZonedDateTimeLike: MadetimeZone: TimeZoneLikerequired, reflecting runtime requirements forfrom(),compare(),equals(),until(),since(), andrelativeTo.ZonedDateTime.prototype.with: Typed parameter asOmit<ZonedDateTimeLike, 'timeZone'>so that partial date/time modifications (e.g.zdt.with({ year: 2027 })) remain valid without requiringtimeZone, while correctly preventing callers from passingtimeZone(which throwsTypeError: with() does not support a timeZone propertyat runtime).Verification
prettier index.d.ts --check(Passed)tsc index.d.ts --noEmit --types --strict --lib ESNext(Passed)tsc --noEmit(Passed)Temporal.ZonedDateTime.from({ year: 2026, month: 1, day: 1 })now fails TypeScript type-checking with:Property 'timeZone' is missing in type '{ year: number; month: number; day: number; }' but required in type 'ZonedDateTimeLike'Temporal.ZonedDateTime.from({ year: 2026, month: 1, day: 1, timeZone: 'UTC' })andzdt.with({ year: 2027 })compile cleanly.