Temporal.ZonedDateTime.prototype.offset
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
The offset
accessor property of Temporal.ZonedDateTime
instances returns a string representing the offset used to interpret the internal instant, in the form ±HH:mm
(or ±HH:mm:ss.sssssssss
with as much subminute precision as necessary). This offset is guaranteed to be valid for the given instant and time zone at construction time.
The set accessor of offset
is undefined
. You cannot change this property directly. Use the with()
method to create a new Temporal.ZonedDateTime
object with the desired new value (usually also changing the date/time), or use the withTimeZone()
method to create a new Temporal.ZonedDateTime
object in another time zone.
Examples
Using offset
const dt = Temporal.ZonedDateTime.from(
"2021-07-01T12:00:00-07:00[America/Los_Angeles]",
);
console.log(dt.offset); // "-07:00"
const dt2 = Temporal.ZonedDateTime.from("2021-07-01T12:00:00-07[-07]");
console.log(dt2.offset); // "-07:00"
const dt3 = Temporal.ZonedDateTime.from(
"1900-01-01T00:00:00+00:09:21[Europe/Paris]",
);
console.log(dt3.offset); // "+00:09:21"
const dt4 = Temporal.ZonedDateTime.from("2021-07-01T12:00:00Z[Asia/Shanghai]");
console.log(dt4.offset); // "+08:00"
Changing offset
If the local time happens to have two valid offsets, such as within a DST transition, you can change the offset without changing anything else:
const zdt = Temporal.ZonedDateTime.from(
"2024-11-03T01:05:00-04:00[America/New_York]",
);
const newZDT = zdt.with({ offset: "-05:00" });
console.log(newZDT.toString()); // "2024-11-03T01:05:00-05:00[America/New_York]"
Specifications
Specification |
---|
Temporal proposal # sec-get-temporal.zoneddatetime.prototype.offset |
Browser compatibility
Report problems with this compatibility data on GitHubdesktop | mobile | server | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
offset |
Legend
Tip: you can click/tap on a cell for more information.
- No support
- No support
- Experimental. Expect behavior to change in the future.
- See implementation notes.
- User must explicitly enable this feature.