Skip to content

Commit

Permalink
Minor docs clarification about DateTime.toLocaleString(..., {timeZone})
Browse files Browse the repository at this point in the history
Closes: #577
  • Loading branch information
ptomato authored and ryzokuken committed Oct 4, 2020
1 parent a26cbc9 commit 5f1b383
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/datetime.md
Original file line number Diff line number Diff line change
Expand Up @@ -671,7 +671,9 @@ This method overrides `Object.prototype.toLocaleString()` to provide a human-rea

The `locales` and `options` arguments are the same as in the constructor to [`Intl.DateTimeFormat`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DateTimeFormat).

> **NOTE**: Unlike in [`Temporal.Instant.prototype.toLocaleString()`](./instant.html#toLocaleString), `options.timeZone` will have no effect, because `Temporal.DateTime` carries no time zone information and is just a wall-clock time.
> **NOTE**: Unlike in [`Temporal.Instant.prototype.toLocaleString()`](./instant.html#toLocaleString), `options.timeZone` will have no effect, because `Temporal.DateTime` carries no time zone information.
> It's not always possible to uniquely determine the localized time zone name using the `Temporal.DateTime` instance and the `options.timeZone`.
> Therefore, to display a localized date and time including its time zone, convert the `Temporal.DateTime` to a `Temporal.LocalDateTime` or `Temporal.Instant` and then call the `toLocaleString()` method.
Example usage:

Expand Down

0 comments on commit 5f1b383

Please sign in to comment.