Interface TimezoneManager

interface TimezoneManager {
    clearAllTimezones(): void;
    getTimezoneForId(timezoneId: string): Timezone;
    hasTimezoneForId(timezoneId: string): boolean;
    isAlias(timezoneId: string): boolean;
    listAllTimezones(includeAliases?: boolean): string[];
    registerAlias(aliasName: string, timezoneId: string): void;
    registerDefaultTimezones(): void;
    registerTimezone(timezone: Timezone): void;
    registerTimezoneFromICS(timezoneId: string, ics: string): void;
    unregisterAlias(aliasName: string): void;
    unregisterTimezones(timezoneId: string): void;
}

Index

Methods

clearAllTimezones getTimezoneForId hasTimezoneForId isAlias listAllTimezones registerAlias registerDefaultTimezones registerTimezone registerTimezoneFromICS unregisterAlias unregisterTimezones

Methods

clearAllTimezones

clearAllTimezones(): void
Clear all timezones

Returns void
- Defined in timezoneManager.ts:177

getTimezoneForId

getTimezoneForId(timezoneId: string): Timezone
Gets a timezone for the given id.
Parameters
- timezoneId: string
  The id of the timezone
Returns Timezone
- Defined in timezoneManager.ts:35

hasTimezoneForId

hasTimezoneForId(timezoneId: string): boolean
Checks if there is a timezone for the given id stored in this manager.
Parameters
- timezoneId: string
  The id of the timezone
Returns boolean
- Defined in timezoneManager.ts:58

isAlias

isAlias(timezoneId: string): boolean
Checks if the given timezone id is an alias.
Parameters
- timezoneId: string
  The id of the timezone
Returns boolean
- Defined in timezoneManager.ts:67

listAllTimezones

listAllTimezones(includeAliases?: boolean): string[]
Lists all timezones.
Parameters
- includeAliases: boolean = false
  Whether or not to include aliases
Returns string[]
- Defined in timezoneManager.ts:76

registerAlias

registerAlias(aliasName: string, timezoneId: string): void
Registers a new timezone-alias
Parameters
- aliasName: string
  The timezone-id of the alias
- timezoneId: string
  The timezone-id to resolve the alias to
Returns void
- Defined in timezoneManager.ts:141

registerDefaultTimezones

registerDefaultTimezones(): void
Returns void
- Defined in timezoneManager.ts:106

registerTimezone

registerTimezone(timezone: Timezone): void
Registers a timezone
Parameters
- timezone: Timezone
  The timezone-object to register
Returns void
- Defined in timezoneManager.ts:91

registerTimezoneFromICS

registerTimezoneFromICS(timezoneId: string, ics: string): void
Registers a timezone based on ics data.
Parameters
- timezoneId: string
  The id of the timezone
- ics: string
  The iCalendar timezone definition
Returns void
- Defined in timezoneManager.ts:130

unregisterAlias

unregisterAlias(aliasName: string): void
Unregisters a timezone-alias.
Parameters
- aliasName: string
  The alias to unregister
Returns void
- Defined in timezoneManager.ts:167

unregisterTimezones

unregisterTimezones(timezoneId: string): void
Unregisters a timezone.
Parameters
- timezoneId: string
  Unregisters a timezone by Id
Returns void
- Defined in timezoneManager.ts:157