Skip to content

Latest commit

 

History

History
97 lines (59 loc) · 3.15 KB

zoned.md

File metadata and controls

97 lines (59 loc) · 3.15 KB

«|»

ZonedDateTime

A ZonedDateTime is an object that specifies a specific point in time in a specific time-zone. It bases this on an Instant and a timezone string.

new ZonedDateTime(instant : Instant, timeZone: string)

The constructor may only be called as such. It takes two arguments. The first is an instance of Instant and the second is a string representing a valid IANA timezone or an offset.

zoned.instant: Instant

The instance of Instant that was used to create this ZonedDateTime.

zoned.offsetSeconds : number

The number of seconds the ZonedDateTime's time is offset from UTC.

zoned.offsetString: string

The time-zone offset represented as a string.

This must always have the format: sign``hours:minutes where

  • sign is eitner + or -
  • hours is the hours offset 0-padded to 2 digits.
  • minutes is the minutes offset 0-padded to 2 digits.

Examples: +00:00, -04:00, +03:00, ...

zoned.ianaZone: string | undefined

If the ZonedDateTime was created using an IANA-Timezone (rather than an offset) this property will return that timezone string. Otherwise this property will be undefined.

zoned.timeZone: string

This will be zoned.ianaZone if available or zone.offsetString if it is not.

zoned.toString(): string

This creates an ISO-8601 string in the following format year-month-dayThours:minutes:seconds.nanoseconds``offset if an IANA-Zone is not available or year-month-dayThours:minutes:seconds.nanoseconds``offset[iana] if an IANA-Timezone is available.

The year is 0-padded to a minimum of 4 digits. month, day, hours, minutes, seconds are 0-padded to a minimum of 2 digits. nanoseconds is 0-padded to a minimum of 9 digits. the offset is the timezone offset as created by zoned.offsetString. iana is the IANA Timezone string.

Examples:

  • 1976-11-18T15:23:30.123456789+01:00[Europe/Vienna] - created with Europe/Vienna timezone
  • 1976-11-18T15:23:30.123456789+01:00 - created with +01:00 timezone

zoned.toJSON(): string

Equivalent to zoned.toString().

ZonedDateTime.fromString(isostring: string) : ZonedDateTime

Parses a string in the specific ISO-8601 format emitted by zoned.toString().

ZonedDateTime.fromSeconds(seconds : number, zone : string) : ZonedDateTime

Equivalent to new ZonedDateTime(Instant.fromSeconds(seconds), zone).

ZonedDateTime.fromMilliseconds(milliseconds : number, zone : string) : ZonedDateTime

Equivalent to new ZonedDateTime(Instant.fromMilliseconds(milliseconds), zone).

ZonedDateTime.fromMicroseconds(micros : BigInt, zone : string) : ZonedDateTime

Equivalent to new ZonedDateTime(Instant.fromMicroseconds(micros), zone).

ZonedDateTime.fromNanoseconds(nanos : BigInt, zone : string) : ZonedDateTime

Equivalent to new ZonedDateTime(Instant.fromNanoseconds(nanos), zone).