Class ZoneAbstract

An abstract Zone class

Interface

Hierarchy

Constructors

constructor

Accessors

ianaName isUniversal isValid name type

Methods

equals formatOffset offset offsetName

Constructors

constructor

Accessors

ianaName

  • get ianaName(): string

  • Returns string

isUniversal

  • get isUniversal(): boolean

  • Returns whether the offset is known to be fixed for the whole year.

    Abstract

    Returns boolean

isValid

  • get isValid(): boolean

  • Return whether this Zone is valid.

    Abstract

    Returns boolean

name

  • get name(): string

  • The name of this zone.

    Abstract

    Returns string

type

  • get type(): string

  • The type of zone

    Abstract

    Returns string

Methods

equals

  • Return whether this Zone is equal to another zone

    Abstract

    Returns

    Parameters

    • other: Zone

      the zone to compare

    Returns boolean

formatOffset

  • Returns the offset's value as a string

    Abstract

    Returns

    Parameters

    • ts: number

      Epoch milliseconds for which to get the offset

    • format: ZoneOffsetFormat

      What style of offset to return. Accepts 'narrow', 'short', or 'techie'. Returning '+6', '+06:00', or '+0600' respectively

    Returns string

offset

  • Return the offset in minutes for this zone at the specified timestamp.

    Abstract

    Returns

    Parameters

    • ts: number

      Epoch milliseconds for which to compute the offset

    Returns number

offsetName

  • Returns the offset's common name (such as EST) at the specified timestamp

    Abstract

    Returns

    Parameters

    • Optional ts: number

      Epoch milliseconds for which to get the name

    • Optional options: ZoneOffsetOptions

      Options to affect the format

    Returns null | string

Settings

Member Visibility

Theme

Generated using TypeDoc