Methods

(static) get(tzid) → (nullable) {ICAL.Timezone}

Returns a timezone by its tzid if present.

Parameters:
NameTypeDescription
tzidString

Timezone identifier (e.g. America/Los_Angeles)

Returns:

The timezone, or null if not found

Type: 
ICAL.Timezone

(static) has(tzid) → {Boolean}

Checks if timezone id has been registered.

Parameters:
NameTypeDescription
tzidString

Timezone identifier (e.g. America/Los_Angeles)

Returns:

False, when not present

Type: 
Boolean

(static) register(nameopt, zone)

Registers a timezone object or component.

Parameters:
NameTypeAttributesDescription
nameString<optional>

The name of the timezone. Defaults to the component's TZID if not passed.

zoneICAL.Component | ICAL.Timezone

The initialized zone or vtimezone.

(static) remove(tzid) → (nullable) {ICAL.Timezone}

Removes a timezone by its tzid from the list.

Parameters:
NameTypeDescription
tzidString

Timezone identifier (e.g. America/Los_Angeles)

Returns:

The removed timezone, or null if not registered

Type: 
ICAL.Timezone