date-vir
Version:
Easy and explicit dates and times.
43 lines (42 loc) • 893 B
TypeScript
import { type ArrayElement } from '@augment-vir/common';
import { allTimezoneNames } from './timezone-names.js';
/**
* All possible timezone names.
*
* @category Timezone
* @see {@link allTimezoneNames}
*/
export type Timezone = ArrayElement<typeof allTimezoneNames>;
/**
* An enum of all possible timezone names.
*
* @category Timezone
* @example
*
* ```ts
* import {Timezone} from 'date-vir';
*
* Timezone['Africa/Bamako'];
* ```
*/
export declare const Timezone: Readonly<{
[SpecificTimezoneName in Timezone]: SpecificTimezoneName;
}>;
/**
* The timezone of the current user's environment.
*
* @category Timezone
*/
export declare const userTimezone: Timezone;
/**
* The UTC timezone.
*
* @category Timezone
*/
export declare const utcTimezone: "UTC";
/**
* The UTC timezone as a type.
*
* @category Timezone
*/
export type UtcTimezone = typeof utcTimezone;