Variable TimezoneServiceConst

Type declaration

• get count(): number

• get:function

  • get(tzid): undefined | Timezone

  • Returns a timezone by its tzid if present.

    Parameters

    • tzid: string

      Timezone identifier (e.g. America/Los_Angeles)

    Returns undefined | Timezone

    The timezone, or null if not found

• has:function

  • has(tzid): boolean

  • Checks if timezone id has been registered.

    Parameters

    • tzid: string

      Timezone identifier (e.g. America/Los_Angeles)

    Returns boolean

    False, when not present

• register:function

  • register(name, timezone?): void

  • Registers a timezone object or component.

    Parameters

    • name: string | Component

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

    • Optional timezone: Component | Timezone

      The initialized zone or vtimezone.

    Returns void

• registerTimezones:function

  • registerTimezones(__namedParameters): void

  • Register timezone definitions.

    Parameters

    • __namedParameters: {
          tzdata: string[];
      }

      • tzdata: string[]

    Returns void

    Example

    import { TimezoneService } from 'ical';
    import tzdata from 'ical/timezones.json';
    TimezoneService.registerTimezones(tzdata);
    Copy

• remove:function

  • remove(tzid): void

  • Removes a timezone by its tzid from the list.

    Parameters

    • tzid: string

      Timezone identifier (e.g. America/Los_Angeles)

    Returns void

• reset:function

  • reset(): void

  • Returns void