Skip to content

Commit 025c8f9

Browse files
ptomatoptomato
committed
Release 0.5.0 changelog
1 parent d5a2d4a commit 025c8f9

File tree

2 files changed

+54
-2
lines changed

2 files changed

+54
-2
lines changed

‎CHANGELOG.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,55 @@
1+
# 0.5.0
2+
3+
Breaking changes:
4+
5+
This major update reflects all changes to the Temporal proposal adopted by TC39 between May 2023 and March 2025.
6+
7+
The majority of these changes were made in the June 2024 TC39 meeting (slides [here](https://docs.google.com/presentation/d/1PPMAxVnVjFwRPuJwOvVsw9nZLQ6jDM8Hd5PNO0Grp4I/edit?slide=id.g2e01b5af2da_0_444#slide=id.g2e01b5af2da_0_444)) where the scope of Temporal was reduced at the request of JS engine implementers who were concerned about the size impact of adding Temporal to distributions on limited-capacity devices like low-end Android phones and Apple Watch.
8+
9+
- User-defined calendars have been removed.
10+
Calendars are now represented by strings representing built-in calendars.
11+
Without custom calendars, the huge surface area of `Temporal.Calendar` was not necessary, and that type was removed from the proposal.
12+
- User-defined time zones have been removed.
13+
Time zones are now only represented by string identifiers representing built-in time zones: either a Zone or Link name from the IANA Time Zone Database, or a time zone offset with minutes precision.
14+
`Temporal.TimeZone` has also been removed, and its methods replaced by the following:
15+
- `getPreviousTransition`/`getNextTransition` - use the new `getTimeZoneTransition` method of `Temporal.ZoneDateTime`.
16+
- `equals` - use `ZonedDateTime.prototype.equals` using the same instant and calendar.
17+
- Other `Temporal.TimeZone` methods can use the corresponding methods on `Temporal.ZonedDateTime`.
18+
- Many convenience methods have been removed. In all cases, the same functionality is available using other Temporal methods:
19+
- Removed `getISOFields()` methods. Instead use `withCalendar('iso8601')` and the individual property getters.
20+
- Removed `withPlainDate()` methods. Instead use `with({ year, monthCode, day })`.
21+
- Removed `toPlainDateTime()` and `toZonedDateTime()` methods of `Temporal.PlainTime`. Instead use the same-named methods on `Temporal.PlainDate` to combine a date and a time.
22+
- Removed `epochSeconds` and `epochMicroseconds` properties. Instead calculate epoch seconds with `Math.floor(epochMilliseconds / 1000)` and epoch microseconds with `epochNanoseconds / 1000n + ((epochNanoseconds % 1000n) < 0n ? -1n : 0n)`.
23+
- Removed `toPlainYearMonth()` and `toPlainMonthDay()` methods of `Temporal.PlainDateTime` and `Temporal.ZonedDateTime`. Instead use `toPlainDate()` and then the methods on `Temporal.PlainDate`.
24+
- Removed `Temporal.Instant.prototype.toZonedDateTime` and `Temporal.Now.zonedDateTime`. Instead use `toZonedDateTimeISO()`/`zonedDateTimeISO()` to create a `Temporal.ZonedDateTime` object using the ISO8601 calendar, and then use `withCalendar()` if a non-ISO calendar is desired.
25+
- The `relativeTo` parameter is no longer accepted in `Temporal.Duration.prototype.add` and `subtract`. Instead take the `relativeTo` object, add the two durations to it, and difference it with the original using `until()`.
26+
- Throw if there are multiple calendar annotations in a string and one has the critical flag ([Proposal PR](https://github.com/tc39/proposal-temporal/pull/2572))
27+
- Changed the way calculations are done with `Temporal.Duration`, and placed limits on each of the units. Years, months, and weeks are each limited to 2³²−1. The other units (days through nanoseconds) are collectively limited: taken together, they must be less than `Number.MAX_SAFE_INTEGER` seconds plus 999,999,999 nanoseconds. This has few user-visible changes, but it does mean that some durations are no longer allowed (for example, `Temporal.Duration.from({ seconds: Number.MAX_VALUE })`.) ([Proposal PR 1](https://github.com/tc39/proposal-temporal/pull/2722), [PR 2](https://github.com/tc39/proposal-temporal/pull/2727), [PR 3](https://github.com/tc39/proposal-temporal/pull/2612))
28+
- Offset time zones are now limited to minutes precision. That is, you can have `[+01:01]` but not `[+01:00:01]` or `[+01:00:00.000000001]` ([Proposal PR](https://github.com/tc39/proposal-temporal/pull/2607))
29+
- For APIs that take a string, other primitives are no longer coerced to strings. Technically, you could previously do `Temporal.PlainDate.from(20230711)` and it would be treated as `Temporal.PlainDate.from("20230711")`. This is no longer the case. ([Proposal PR](https://github.com/tc39/proposal-temporal/pull/2574))
30+
- `Temporal.PlainYearMonth.prototype.toPlainDate` and `Temporal.PlainMonthDay.prototype.toPlainDate` now have clamping behaviour instead of throwing if the resulting PlainDate would be invalid. For example, `birthday.toPlainDate({ year: 2025 })` will now return February 28, 2025 if the birthday in question if February 29. ([Proposal PR](https://github.com/tc39/proposal-temporal/pull/2718))
31+
- If you still want the throwing behaviour, you can get it more verbosely:
32+
```js
33+
const { monthCode, day } = birthday;
34+
Temporal.PlainDate.from({ year: 2025, monthCode, day }, { overflow: 'reject' });
35+
```
36+
- Not all calendars have a week numbering scheme, so `weekOfYear` and `yearOfWeek` methods may now return `undefined` ([Proposal PR](https://github.com/tc39/proposal-temporal/pull/2756))
37+
- In `Temporal.Duration.prototype.round()`, rounding to a >1 increment of a calendar `smallestUnit` while simultaneously balancing to a calendar `largestUnit` is now disallowed and will throw ([Proposal PR](https://github.com/tc39/proposal-temporal/pull/2916))
38+
- Creating a `Temporal.MonthDay` in a non-ISO8601 calendar will now throw if the year is too far (>¼ million years) in the future or past ([Proposal PR](https://github.com/tc39/proposal-temporal/pull/3054))
39+
40+
Bug fixes:
41+
42+
- Fixed several bugs in duration calculations, particularly rounding ([Proposal PR 1](https://github.com/tc39/proposal-temporal/pull/2571), [PR 2](https://github.com/tc39/proposal-temporal/pull/2758), [PR 3](https://github.com/tc39/proposal-temporal/pull/2759), [PR 4](https://github.com/tc39/proposal-temporal/pull/2797), [PR 5](https://github.com/tc39/proposal-temporal/pull/2810))
43+
- Fixed a bug in start-of-day calculations ([Proposal PR](https://github.com/tc39/proposal-temporal/pull/2918))
44+
- Many small bug fixes to bring the polyfill into better compliance with the Temporal proposal
45+
46+
Non-breaking changes
47+
48+
- Many improvements in performance and bundle size
49+
- Remove runtime dependency on tslib. Now this package has only one runtime dependency: JSBI (a polyfill for `BigInt`)
50+
- Update dev dependencies
51+
- Support Node 20.x and test it in CI
52+
153
# 0.4.4
254

355
Breaking changes:

‎package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@js-temporal/polyfill",
3-
"version": "0.4.4",
4-
"description": "Polyfill for Tc39 Stage 3 proposal Temporal (https://github.com/tc39/proposal-temporal)",
3+
"version": "0.5.0",
4+
"description": "Polyfill for ECMA TC39 Stage 3 proposal Temporal (https://github.com/tc39/proposal-temporal)",
55
"type": "module",
66
"main": "./dist/index.cjs",
77
"module": "./dist/index.esm.js",

0 commit comments

Comments
 (0)