winzones/dist/index.d.ts

A TypeScript library for mapping between IANA and Windows time zones

type NonEmptyArray<T> = readonly [T, ...T[]];

/**
 * Finds the Windows timezone equivalent for an IANA timezone identifier.
 *
 * @example
 * ```typescript
 * findWindowsFromIana('America/New_York') // 'Eastern Standard Time'
 * findWindowsFromIana('Invalid/Timezone') // undefined
 * ```
 */
declare function findWindowsFromIana(ianaTimezone: string): string | undefined;
/**
 * Finds the IANA timezone equivalents for a Windows timezone.
 *
 * @example
 * ```typescript
 * findIanaFromWindows('Eastern Standard Time') // ['America/New_York', 'America/Toronto', ...]
 * findIanaFromWindows('Invalid Timezone') // undefined
 * ```
 */
declare function findIanaFromWindows(windowsTimezone: string): NonEmptyArray<string> | undefined;

export { findIanaFromWindows, findWindowsFromIana };