Variable TimeZoneUtilsConst

Type declaration

• getTimeZoneDetails:function

  • getTimeZoneDetails(timeZone): TimeZone

  • Gets details for a specific time zone

    Parameters

    • timeZone: string

      The IANA time zone name

    Returns TimeZone

    Object containing time zone name and short name

    Throws

    Error if the time zone is invalid

    Example

    const details = TimeZoneUtils.getTimeZoneDetails('America/New_York');
    console.log(details);
    // Output: { name: 'America/New_York', shortName: 'EDT' }
    Copy

• getTimeZones:function

  • getTimeZones(filters?, showUsersFirst?): TimeZone[]

  • Gets a list of time zones, optionally filtered and with user's time zone first

    Parameters

    • Optional filters: string[]

      Optional array of time zone names to filter by
    • showUsersFirst: boolean = true

      Whether to show user's time zone first in the list

    Returns TimeZone[]

    Array of time zone objects

    Example

    // Get all time zones with user's time zone first
    const allTimeZones = TimeZoneUtils.getTimeZones();
    
    // Get filtered time zones without user's time zone first
    const filteredTimeZones = TimeZoneUtils.getTimeZones(
      ['America/New_York', 'Europe/London'],
      false
    );
    Copy

• getTimeZonesOptions:function

  • getTimeZonesOptions(...filters): string[]

  • Gets HTML option elements for time zones

    Parameters

    • Rest ...filters: string[]

      Optional array of time zone names to filter by

    Returns string[]

    Array of HTML option strings

    Example

    // Get options for specific time zones
    const options = TimeZoneUtils.getTimeZonesOptions(
      'America/New_York',
      'Europe/London'
    );
    
    // Use in select element
    const select = document.createElement('select');
    select.innerHTML = options.join('');
    Copy

• getUsersTimeZone:function

  • getUsersTimeZone(): TimeZone

  • Gets the user's time zone

    Returns TimeZone

    Time zone object for user's time zone

    Example

    const userTimeZone = TimeZoneUtils.getUsersTimeZone();
    console.log(`User's time zone: ${userTimeZone.name} (${userTimeZone.shortName})`);
    Copy

• getUsersTimeZoneName:function

  • getUsersTimeZoneName(): string

  • Gets the user's time zone name

    Returns string

    User's IANA time zone name

    Example

    const timeZoneName = TimeZoneUtils.getUsersTimeZoneName();
    console.log(`User's time zone name: ${timeZoneName}`);
    Copy

• isValidTimeZone:function

  • isValidTimeZone(timeZone): boolean

  • Checks if a time zone name is valid

    Parameters

    • timeZone: string

      The IANA time zone name to check

    Returns boolean

    True if the time zone is valid

    Example

    const isValid = TimeZoneUtils.isValidTimeZone('America/New_York');
    console.log(`Is valid time zone: ${isValid}`);
    Copy