@vvo/tzdb 6.198.0 → 6.199.0

package/dist/index.d.cts

@@ -0,0 +1,54 @@
+export type TimeZoneName = string;
+export interface RawTimeZone {
+    /** IANA name of the most populated zone of the group, like "America/Los_Angeles" */
+    name: TimeZoneName;
+    /** English generic name, like "Pacific Time" */
+    alternativeName: string;
+    /** Every IANA name, current or deprecated, that shows this exact time */
+    group: TimeZoneName[];
+    continentCode: string;
+    continentName: string;
+    countryName: string;
+    countryCode: string;
+    /** Up to four cities, most populated first */
+    mainCities: string[];
+    /** UTC offset outside of daylight saving time */
+    rawOffsetInMinutes: number;
+    /** Abbreviation outside of daylight saving time, like "PST" */
+    abbreviation: string;
+    /** Abbreviation during daylight saving time, like "PDT". Only for zones that observe it */
+    dstAbbreviation?: string;
+    rawFormat: string;
+}
+export interface TimeZone extends RawTimeZone {
+    /** UTC offset right now, according to the tz database of the browser or Node.js */
+    currentTimeOffsetInMinutes: number;
+    currentTimeFormat: string;
+    /** "PDT" or "PST" depending on the current date */
+    currentAbbreviation: string;
+}
+export interface TimeZoneOptions {
+    /** Adds an "Etc/UTC" time zone, whose group includes "UTC" and "GMT" */
+    includeUtc?: boolean;
+    /**
+     * Adds the fixed offset time zones from "Etc/GMT-14" to "Etc/GMT+12".
+     * Their sign is inverted: "Etc/GMT+5" is 5 hours behind UTC.
+     */
+    includeGmtOffsets?: boolean;
+    /**
+     * Translates alternativeName, countryName and continentName with the Intl
+     * API, like "fr" or "es-MX". City names are not translated.
+     */
+    locale?: string;
+}
+export declare const rawTimeZones: RawTimeZone[];
+export declare const timeZonesNames: TimeZoneName[];
+export declare const abbreviations: Record<string, string>;
+/** Release of the IANA tz database used to build the data, like "2026e" */
+export declare const tzdbVersion: string;
+/**
+ * Time zones grouped by country and clock, sorted by current offset. The
+ * current offset comes from the runtime's own tz database, which browsers
+ * and operating systems keep up to date.
+ */
+export declare function getTimeZones(options?: TimeZoneOptions): TimeZone[];

package/dist/index.d.ts

@@ -1,28 +1,54 @@
-type TimeZoneName = string;
-
-interface RawTimeZone {
-  name: TimeZoneName;
-  alternativeName: string;
-  group: string[];
-  continentCode: string;
-  continentName: string;
-  countryName: string;
-  countryCode: string;
-  mainCities: string[];
-  rawOffsetInMinutes: number;
-  abbreviation: string;
-  rawFormat: string;
+export type TimeZoneName = string;
+export interface RawTimeZone {
+    /** IANA name of the most populated zone of the group, like "America/Los_Angeles" */
+    name: TimeZoneName;
+    /** English generic name, like "Pacific Time" */
+    alternativeName: string;
+    /** Every IANA name, current or deprecated, that shows this exact time */
+    group: TimeZoneName[];
+    continentCode: string;
+    continentName: string;
+    countryName: string;
+    countryCode: string;
+    /** Up to four cities, most populated first */
+    mainCities: string[];
+    /** UTC offset outside of daylight saving time */
+    rawOffsetInMinutes: number;
+    /** Abbreviation outside of daylight saving time, like "PST" */
+    abbreviation: string;
+    /** Abbreviation during daylight saving time, like "PDT". Only for zones that observe it */
+    dstAbbreviation?: string;
+    rawFormat: string;
 }
-
-interface TimeZone extends RawTimeZone {
-  currentTimeOffsetInMinutes: number;
-  currentTimeFormat: string;
+export interface TimeZone extends RawTimeZone {
+    /** UTC offset right now, according to the tz database of the browser or Node.js */
+    currentTimeOffsetInMinutes: number;
+    currentTimeFormat: string;
+    /** "PDT" or "PST" depending on the current date */
+    currentAbbreviation: string;
 }
-
-interface TimeZoneOptions {
-  includeUtc?: boolean;
+export interface TimeZoneOptions {
+    /** Adds an "Etc/UTC" time zone, whose group includes "UTC" and "GMT" */
+    includeUtc?: boolean;
+    /**
+     * Adds the fixed offset time zones from "Etc/GMT-14" to "Etc/GMT+12".
+     * Their sign is inverted: "Etc/GMT+5" is 5 hours behind UTC.
+     */
+    includeGmtOffsets?: boolean;
+    /**
+     * Translates alternativeName, countryName and continentName with the Intl
+     * API, like "fr" or "es-MX". City names are not translated.
+     */
+    locale?: string;
 }
-
-export const rawTimeZones: RawTimeZone[];
-export const timeZonesNames: TimeZoneName[];
-export function getTimeZones(opts?: TimeZoneOptions): TimeZone[];
+export declare const rawTimeZones: RawTimeZone[];
+export declare const timeZonesNames: TimeZoneName[];
+export declare const abbreviations: Record<string, string>;
+/** Release of the IANA tz database used to build the data, like "2026e" */
+export declare const tzdbVersion: string;
+/**
+ * Time zones grouped by country and clock, sorted by current offset. The
+ * current offset comes from the runtime's own tz database, which browsers
+ * and operating systems keep up to date.
+ */
+export declare function getTimeZones(options?: TimeZoneOptions): TimeZone[];