@checkdigit/time 4.0.0 → 5.0.0-PR.21-177c

package/dist-types/date-fns/subISOWeekYears/index.d.ts

@@ -1,3 +1,9 @@
+import type { ContextOptions, DateArg } from '../types.ts';
+/**
+ * The {@link subISOWeekYears} function options.
+ */
+export interface SubISOWeekYearsOptions<DateType extends Date = Date> extends ContextOptions<DateType> {
+}
 /**
  * @name subISOWeekYears
  * @category ISO Week-Numbering Year Helpers
@@ -9,9 +15,11 @@
  * ISO week-numbering year: http://en.wikipedia.org/wiki/ISO_week_date
  *
  * @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
+ * @typeParam ResultDate - The result `Date` type, it is the type returned from the context function if it is passed, or inferred from the arguments.
  *
  * @param date - The date to be changed
  * @param amount - The amount of ISO week-numbering years to be subtracted.
+ * @param options - The options
  *
  * @returns The new date with the ISO week-numbering years subtracted
  *
@@ -20,4 +28,4 @@
  * const result = subISOWeekYears(new Date(2014, 8, 1), 5)
  * //=> Mon Aug 31 2009 00:00:00
  */
-export declare function subISOWeekYears<DateType extends Date>(date: DateType | number | string, amount: number): DateType;
+export declare function subISOWeekYears<DateType extends Date, ResultDate extends Date = DateType>(date: DateArg<DateType>, amount: number, options?: SubISOWeekYearsOptions<ResultDate> | undefined): ResultDate;

package/dist-types/date-fns/subMilliseconds/index.d.ts

@@ -1,21 +1,19 @@
+import type { ContextOptions, DateArg } from '../types.ts';
+/**
+ * The {@link subMilliseconds} function options.
+ */
+export interface SubMillisecondsOptions<DateType extends Date = Date> extends ContextOptions<DateType> {
+}
 /**
- * @name subMilliseconds
- * @category Millisecond Helpers
- * @summary Subtract the specified number of milliseconds from the given date.
- *
- * @description
  * Subtract the specified number of milliseconds from the given date.
  *
  * @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
+ * @typeParam ResultDate - The result `Date` type, it is the type returned from the context function if it is passed, or inferred from the arguments.
  *
  * @param date - The date to be changed
  * @param amount - The amount of milliseconds to be subtracted.
+ * @param options - An object with options
  *
  * @returns The new date with the milliseconds subtracted
- *
- * @example
- * // Subtract 750 milliseconds from 10 July 2014 12:45:30.000:
- * const result = subMilliseconds(new Date(2014, 6, 10, 12, 45, 30, 0), 750)
- * //=> Thu Jul 10 2014 12:45:29.250
  */
-export declare function subMilliseconds<DateType extends Date>(date: DateType | number | string, amount: number): DateType;
+export declare function subMilliseconds<DateType extends Date, ResultDate extends Date = DateType>(date: DateArg<DateType>, amount: number, options?: SubMillisecondsOptions<ResultDate> | undefined): ResultDate;

package/dist-types/date-fns/subMinutes/index.d.ts

@@ -1,3 +1,9 @@
+import type { ContextOptions, DateArg } from '../types.ts';
+/**
+ * The {@link subMinutes} function options.
+ */
+export interface SubMinutesOptions<DateType extends Date = Date> extends ContextOptions<DateType> {
+}
 /**
  * @name subMinutes
  * @category Minute Helpers
@@ -7,9 +13,11 @@
  * Subtract the specified number of minutes from the given date.
  *
  * @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
+ * @typeParam ResultDate - The result `Date` type, it is the type returned from the context function if it is passed, or inferred from the arguments.
  *
  * @param date - The date to be changed
  * @param amount - The amount of minutes to be subtracted.
+ * @param options - An object with options
  *
  * @returns The new date with the minutes subtracted
  *
@@ -18,4 +26,4 @@
  * const result = subMinutes(new Date(2014, 6, 10, 12, 0), 30)
  * //=> Thu Jul 10 2014 11:30:00
  */
-export declare function subMinutes<DateType extends Date>(date: DateType | number | string, amount: number): DateType;
+export declare function subMinutes<DateType extends Date, ResultDate extends Date = DateType>(date: DateArg<DateType>, amount: number, options?: SubMinutesOptions<ResultDate> | undefined): ResultDate;

package/dist-types/date-fns/subMonths/index.d.ts

@@ -1,3 +1,9 @@
+import type { ContextOptions, DateArg } from '../types.ts';
+/**
+ * The subMonths function options.
+ */
+export interface SubMonthsOptions<DateType extends Date = Date> extends ContextOptions<DateType> {
+}
 /**
  * @name subMonths
  * @category Month Helpers
@@ -7,9 +13,11 @@
  * Subtract the specified number of months from the given date.
  *
  * @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
+ * @typeParam ResultDate - The result `Date` type, it is the type returned from the context function if it is passed, or inferred from the arguments.
  *
  * @param date - The date to be changed
  * @param amount - The amount of months to be subtracted.
+ * @param options - An object with options
  *
  * @returns The new date with the months subtracted
  *
@@ -18,4 +26,4 @@
  * const result = subMonths(new Date(2015, 1, 1), 5)
  * //=> Mon Sep 01 2014 00:00:00
  */
-export declare function subMonths<DateType extends Date>(date: DateType | number | string, amount: number): DateType;
+export declare function subMonths<DateType extends Date, ResultDate extends Date = DateType>(date: DateArg<DateType>, amount: number, options?: SubMonthsOptions<ResultDate> | undefined): ResultDate;

package/dist-types/date-fns/subQuarters/index.d.ts

@@ -1,3 +1,9 @@
+import type { ContextOptions, DateArg } from '../types.ts';
+/**
+ * The {@link subQuarters} function options.
+ */
+export interface SubQuartersOptions<DateType extends Date = Date> extends ContextOptions<DateType> {
+}
 /**
  * @name subQuarters
  * @category Quarter Helpers
@@ -7,9 +13,11 @@
  * Subtract the specified number of year quarters from the given date.
  *
  * @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
+ * @typeParam ResultDate - The result `Date` type, it is the type returned from the context function if it is passed, or inferred from the arguments.
  *
  * @param date - The date to be changed
  * @param amount - The amount of quarters to be subtracted.
+ * @param options - An object with options
  *
  * @returns The new date with the quarters subtracted
  *
@@ -18,4 +26,4 @@
  * const result = subQuarters(new Date(2014, 8, 1), 3)
  * //=> Sun Dec 01 2013 00:00:00
  */
-export declare function subQuarters<DateType extends Date>(date: DateType | number | string, amount: number): DateType;
+export declare function subQuarters<DateType extends Date, ResultDate extends Date = DateType>(date: DateArg<DateType>, amount: number, options?: SubQuartersOptions<ResultDate>): ResultDate;

package/dist-types/date-fns/subSeconds/index.d.ts

@@ -1,15 +1,18 @@
+import type { ContextOptions, DateArg } from '../types.ts';
+/**
+ * The {@link subSeconds} function options.
+ */
+export interface SubSecondsOptions<DateType extends Date = Date> extends ContextOptions<DateType> {
+}
 /**
- * @name subSeconds
- * @category Second Helpers
- * @summary Subtract the specified number of seconds from the given date.
- *
- * @description
  * Subtract the specified number of seconds from the given date.
  *
  * @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
+ * @typeParam ResultDate - The result `Date` type, it is the type returned from the context function if it is passed, or inferred from the arguments.
  *
  * @param date - The date to be changed
  * @param amount - The amount of seconds to be subtracted.
+ * @param options - The options
  *
  * @returns The new date with the seconds subtracted
  *
@@ -18,4 +21,4 @@
  * const result = subSeconds(new Date(2014, 6, 10, 12, 45, 0), 30)
  * //=> Thu Jul 10 2014 12:44:30
  */
-export declare function subSeconds<DateType extends Date>(date: DateType | number | string, amount: number): DateType;
+export declare function subSeconds<DateType extends Date, ResultDate extends Date = DateType>(date: DateArg<DateType>, amount: number, options?: SubSecondsOptions<ResultDate> | undefined): ResultDate;

package/dist-types/date-fns/subWeeks/index.d.ts

@@ -1,3 +1,9 @@
+import type { ContextOptions, DateArg } from '../types.ts';
+/**
+ * The {@link subWeeks} function options.
+ */
+export interface SubWeeksOptions<DateType extends Date = Date> extends ContextOptions<DateType> {
+}
 /**
  * @name subWeeks
  * @category Week Helpers
@@ -7,9 +13,11 @@
  * Subtract the specified number of weeks from the given date.
  *
  * @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
+ * @typeParam ResultDate - The result `Date` type, it is the type returned from the context function if it is passed, or inferred from the arguments.
  *
  * @param date - The date to be changed
  * @param amount - The amount of weeks to be subtracted.
+ * @param options - An object with options
  *
  * @returns The new date with the weeks subtracted
  *
@@ -18,4 +26,4 @@
  * const result = subWeeks(new Date(2014, 8, 1), 4)
  * //=> Mon Aug 04 2014 00:00:00
  */
-export declare function subWeeks<DateType extends Date>(date: DateType | number | string, amount: number): DateType;
+export declare function subWeeks<DateType extends Date, ResultDate extends Date = DateType>(date: DateArg<DateType>, amount: number, options?: SubWeeksOptions<ResultDate> | undefined): ResultDate;

package/dist-types/date-fns/subYears/index.d.ts

@@ -1,3 +1,9 @@
+import type { ContextOptions, DateArg } from '../types.ts';
+/**
+ * The {@link subYears} function options.
+ */
+export interface SubYearsOptions<DateType extends Date = Date> extends ContextOptions<DateType> {
+}
 /**
  * @name subYears
  * @category Year Helpers
@@ -7,9 +13,11 @@
  * Subtract the specified number of years from the given date.
  *
  * @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
+ * @typeParam ResultDate - The result `Date` type, it is the type returned from the context function if it is passed, or inferred from the arguments.
  *
  * @param date - The date to be changed
  * @param amount - The amount of years to be subtracted.
+ * @param options - An object with options
  *
  * @returns The new date with the years subtracted
  *
@@ -18,4 +26,4 @@
  * const result = subYears(new Date(2014, 8, 1), 5)
  * //=> Tue Sep 01 2009 00:00:00
  */
-export declare function subYears<DateType extends Date>(date: DateType | number | string, amount: number): DateType;
+export declare function subYears<DateType extends Date, ResultDate extends Date = DateType>(date: DateArg<DateType>, amount: number, options?: SubYearsOptions<ResultDate>): ResultDate;

package/dist-types/date-fns/toDate/index.d.ts

@@ -1,3 +1,4 @@
+import type { ConstructableDate, ContextFn, DateArg } from '../types.ts';
 /**
  * @name toDate
  * @category Common Helpers
@@ -12,9 +13,15 @@
  *
  * If the argument is none of the above, the function returns Invalid Date.
  *
+ * Starting from v3.7.0, it clones a date using `[Symbol.for("constructDateFrom")]`
+ * enabling to transfer extra properties from the reference date to the new date.
+ * It's useful for extensions like [`TZDate`](https://github.com/date-fns/tz)
+ * that accept a time zone as a constructor argument.
+ *
  * **Note**: *all* Date arguments passed to any *date-fns* function is processed by `toDate`.
  *
  * @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
+ * @typeParam ResultDate - The result `Date` type, it is the type returned from the context function if it is passed, or inferred from the arguments.
  *
  * @param argument - The value to convert
  *
@@ -30,4 +37,4 @@
  * const result = toDate(1392098430000)
  * //=> Tue Feb 11 2014 11:30:30
  */
-export declare function toDate<DateType extends Date>(argument: DateType | number | string): DateType;
+export declare function toDate<DateType extends Date | ConstructableDate, ResultDate extends Date = DateType>(argument: DateArg<DateType>, context?: ContextFn<ResultDate> | undefined): ResultDate;

package/dist-types/date-fns/transpose/index.d.ts

@@ -1,4 +1,4 @@
-import type { GenericDateConstructor } from '../types';
+import type { ContextFn, GenericDateConstructor } from '../types.ts';
 /**
  * @name transpose
  * @category Generic Helpers
@@ -9,10 +9,10 @@ import type { GenericDateConstructor } from '../types';
  * to transpose the date in the system time zone to say `UTCDate` or any other
  * date extension.
  *
- * @typeParam DateInputType - The input `Date` type derived from the passed argument.
- * @typeParam DateOutputType - The output `Date` type derived from the passed constructor.
+ * @typeParam InputDate - The input `Date` type derived from the passed argument.
+ * @typeParam ResultDate - The result `Date` type derived from the passed constructor.
  *
- * @param fromDate - The date to use values from
+ * @param date - The date to use values from
  * @param constructor - The date constructor to use
  *
  * @returns Date transposed to the given constructor
@@ -27,4 +27,4 @@ import type { GenericDateConstructor } from '../types';
  * transpose(date, UTCDate)
  * //=> 'Sun Jul 10 2022 00:00:00 GMT+0000 (Coordinated Universal Time)'
  */
-export declare function transpose<DateInputType extends Date, DateOutputType extends Date>(fromDate: DateInputType, constructor: DateOutputType | GenericDateConstructor<DateOutputType>): DateOutputType;
+export declare function transpose<InputDate extends Date, ResultDate extends Date>(date: InputDate, constructor: ResultDate | GenericDateConstructor<ResultDate> | ContextFn<ResultDate>): ResultDate;

package/dist-types/date-fns/types.d.ts

@@ -1,6 +1,18 @@
-import type { Locale } from './locale/types';
-export type * from './locale/types';
-export type * from './fp/types';
+import { type constructFromSymbol } from './constants/index.ts';
+import type { Locale } from './locale/types.ts';
+export type * from './locale/types.ts';
+/**
+ * The argument type.
+ */
+export type DateArg<DateType extends Date> = DateType | number | string;
+/**
+ * Date extension interface that allows to transfer extra properties from
+ * the reference date to the new date. It's useful for extensions like [`TZDate`](https://github.com/date-fns/tz)
+ * that accept a time zone as a constructor argument.
+ */
+export interface ConstructableDate extends Date {
+    [constructFromSymbol]: <DateType extends Date = Date>(value: DateArg<Date> & {}) => DateType;
+}
 /**
  * The generic date constructor. Replicates the Date constructor. Used to build
  * generic functions.
@@ -22,7 +34,7 @@ export interface GenericDateConstructor<DateType extends Date = Date> {
      *
      * @returns The date instance
      */
-    new (value: Date | number | string): DateType;
+    new (value: DateArg<Date> & {}): DateType;
     /**
      * The date constructor. Creates date with the passed date values (year,
      * month, etc.) Note that the month is 0-indexed.
@@ -66,23 +78,19 @@ export type DurationUnit = keyof Duration;
 /**
  * An object that combines two dates to represent the time interval.
  *
- * @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
+ * @typeParam StartDate - The start `Date` type.
+ * @typeParam EndDate - The end `Date` type.
  */
-export interface Interval<DateType extends Date = Date> {
+export interface Interval<StartType extends DateArg<Date> = DateArg<Date>, EndType extends DateArg<Date> = DateArg<Date>> {
     /** The start of the interval. */
-    start: DateType | number | string;
+    start: StartType;
     /** The end of the interval. */
-    end: DateType | number | string;
+    end: EndType;
 }
 /**
  * A version of {@link Interval} that has both start and end resolved to Date.
  */
-export interface NormalizedInterval<DateType extends Date = Date> {
-    /** The start of the interval. */
-    start: DateType;
-    /** The end of the interval. */
-    end: DateType;
-}
+export type NormalizedInterval<DateType extends Date = Date> = Interval<DateType, DateType>;
 /**
  * The era. Can be either 0 (AD - Anno Domini) or 1 (BC - Before Christ).
  */
@@ -231,3 +239,23 @@ export interface NearestToUnitOptions<Unit extends number> {
      * hours. */
     nearestTo?: Unit;
 }
+/**
+ * The context options. Used to build function options.
+ */
+export interface ContextOptions<DateType extends Date> {
+    /**
+     * The context to use in the function. It allows to normalize the arguments
+     * to a specific date instance, which is useful for extensions like [`TZDate`](https://github.com/date-fns/tz).
+     */
+    in?: ContextFn<DateType> | undefined;
+}
+/**
+  /**
+   * The context function type. It's used to normalize the input arguments to
+   * a specific date instance, which is useful for extensions like [`TZDate`](https://github.com/date-fns/tz).
+   */
+export type ContextFn<DateType extends Date> = (value: DateArg<Date> & {}) => DateType;
+/**
+ * Resolves passed type or array of types.
+ */
+export type MaybeArray<Type> = Type | Type[];

package/dist-types/date-fns-tz/_lib/getTimezoneOffsetInMilliseconds/index.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Google Chrome as of 67.0.3396.87 introduced timezones with offset that includes seconds.
+ * They usually appear for dates that denote time before the timezones were introduced
+ * (e.g. for 'Europe/Prague' timezone the offset is GMT+00:57:44 before 1 October 1891
+ * and GMT+01:00:00 after that date)
+ *
+ * Date#getTimezoneOffset returns the offset in minutes and would return 57 for the example above,
+ * which would lead to incorrect calculations.
+ *
+ * This function returns the timezone offset in milliseconds that takes seconds in account.
+ */
+export declare function getTimezoneOffsetInMilliseconds(date: Date): number;

package/dist-types/date-fns-tz/_lib/newDateUTC/index.d.ts

@@ -5,4 +5,4 @@
  *
  * For `Date.UTC(...)`, use `newDateUTC(...).getTime()`.
  */
-export default function newDateUTC(fullYear: number, month: number, day: number, hour: number, minute: number, second: number, millisecond: number): Date;
+export declare function newDateUTC(fullYear: number, month: number, day: number, hour: number, minute: number, second: number, millisecond: number): Date;

package/dist-types/date-fns-tz/_lib/tzIntlTimeZoneName/index.d.ts

@@ -1,10 +1,7 @@
+import type { FormatOptionsWithTZ } from '../../index.ts';
 /**
  * Returns the formatted time zone name of the provided `timeZone` or the current
  * system time zone if omitted, accounting for DST according to the UTC value of
  * the date.
  */
-import type { Locale } from '../../../date-fns/locale/types';
-export default function tzIntlTimeZoneName(length: 'short' | 'long' | 'shortOffset' | 'longOffset' | 'shortGeneric' | 'longGeneric', date: Date, options: {
-    timeZone: string;
-    locale?: Locale;
-}): string | undefined;
+export declare function tzIntlTimeZoneName(length: Intl.DateTimeFormatOptions['timeZoneName'], date: Date, options: FormatOptionsWithTZ): string | undefined;

package/dist-types/date-fns-tz/_lib/tzParseTimezone/index.d.ts

@@ -1 +1 @@
-export default function tzParseTimezone(timezoneString: string, date?: Date, isUtcDate?: boolean): number;
+export declare function tzParseTimezone(timezoneString: string | undefined, date: Date | number | undefined, isUtcDate?: boolean): number;

package/dist-types/date-fns-tz/_lib/tzPattern/index.d.ts

@@ -1,3 +1,2 @@
 /** Regex to identify the presence of a time zone specifier in a date string */
-declare const tzPattern: RegExp;
-export default tzPattern;
+export declare const tzPattern: RegExp;

package/dist-types/date-fns-tz/_lib/tzTokenizeDate/index.d.ts

@@ -2,4 +2,4 @@
  * Returns the [year, month, day, hour, minute, seconds] tokens of the provided
  * `date` as it will be rendered in the `timeZone`.
  */
-export default function tzTokenizeDate(date: Date, timeZone: string): number[];
+export declare function tzTokenizeDate(date: Date, timeZone: string): number[];

package/dist-types/date-fns-tz/format/formatters/index.d.ts

@@ -1,19 +1,2 @@
-declare const formatters: {
-    X: (date: Date, token: string, _localize: boolean | null, options: {
-        timeZone: string;
-        _originalDate?: Date;
-    }) => string;
-    x: (date: Date, token: string, _localize: boolean | null, options: {
-        timeZone: string;
-        _originalDate?: Date;
-    }) => string;
-    O: (date: Date, token: string, _localize: boolean | null, options: {
-        timeZone: string;
-        _originalDate?: Date;
-    }) => string;
-    z: (date: Date, token: string, _localize: boolean | null, options: {
-        timeZone: string;
-        _originalDate?: Date;
-    }) => string | undefined;
-};
-export default formatters;
+import type { FormatOptionsWithTZ } from '../../index.ts';
+export declare const formatters: Record<string, (date: Date, token: string, options: FormatOptionsWithTZ) => string | undefined>;

package/dist-types/date-fns-tz/format/index.d.ts

@@ -1,4 +1,4 @@
-import type { OptionsWithTZ } from '../types';
+import type { FormatOptionsWithTZ } from '../index.ts';
 /**
  * @name format
  * @category Common Helpers
@@ -267,9 +267,9 @@ import type { OptionsWithTZ } from '../types';
  *
  * - Characters are now escaped using single quote symbols (`'`) instead of square brackets.
  *
- * @param {Date|String|Number} date - the original date
- * @param {String} format - the string of tokens
- * @param {OptionsWithTZ} [options] - the object with options. See [Options]{@link https://date-fns.org/docs/Options}
+ * @param date the original date
+ * @param formatStr the string of tokens
+ * @param options the object with options. See [Options]{@link https://date-fns.org/docs/Options}
  * @param {0|1|2} [options.additionalDigits=2] - passed to `toDate`. See [toDate]{@link
  *   https://date-fns.org/docs/toDate}
  * @param {0|1|2|3|4|5|6} [options.weekStartsOn=0] - the index of the first day of the week (0 - Sunday)
@@ -281,7 +281,8 @@ import type { OptionsWithTZ } from '../types';
  *   - Some of the local week-numbering year tokens (`YY`, `YYYY`) that are confused with the calendar year tokens
  *   (`yy`, `yyyy`). See: https://git.io/fxCyr
  * @param {String} [options.timeZone=''] - used to specify the IANA time zone offset of a date String.
- * @returns {String} the formatted date string
+ * @param {Date|Number} [options.originalDate] - can be used to pass the original unmodified date to `format` to
+ *   improve correctness of the replaced timezone token close to the DST threshold.
  * @throws {TypeError} 2 arguments required
  * @throws {RangeError} `options.additionalDigits` must be 0, 1 or 2
  * @throws {RangeError} `options.locale` must contain `localize` property
@@ -293,20 +294,20 @@ import type { OptionsWithTZ } from '../types';
  *
  * @example
  * // Represent 11 February 2014 in middle-endian format:
- * var result = format(new Date(2014, 1, 11), 'MM/dd/yyyy')
+ * const result = format(new Date(2014, 1, 11), 'MM/dd/yyyy')
  * //=> '02/11/2014'
  *
  * @example
  * // Represent 2 July 2014 in Esperanto:
  * import { eoLocale } from 'date-fns/locale/eo'
- * var result = format(new Date(2014, 6, 2), "do 'de' MMMM yyyy", {
+ * const result = format(new Date(2014, 6, 2), "do 'de' MMMM yyyy", {
  *   locale: eoLocale
  * })
  * //=> '2-a de julio 2014'
  *
  * @example
  * // Escape string by single quote characters:
- * var result = format(new Date(2014, 6, 2, 15), "h 'o''clock'")
+ * const result = format(new Date(2014, 6, 2, 15), "h 'o''clock'")
  * //=> "3 o'clock"
  */
-export default function format(dirtyDate: Date | string | number, dirtyFormatStr: string, dirtyOptions?: OptionsWithTZ): string;
+export declare function format(date: Date | string | number, formatStr: string, options?: FormatOptionsWithTZ): string;

package/dist-types/date-fns-tz/formatInTimeZone/index.d.ts

@@ -1,13 +1,13 @@
-import type { OptionsWithTZ } from '../types';
+import type { FormatOptionsWithTZ } from '../index.ts';
 /**
  * @name formatInTimeZone
  * @category Time Zone Helpers
  * @summary Gets the offset in milliseconds between the time zone and Universal Coordinated Time (UTC)
  *
- * @param {Date|String|Number} date - the date representing the local time / real UTC time
- * @param {String} timeZone - the time zone this date should be formatted for; can be an offset or IANA time zone
- * @param {String} formatStr - the string of tokens
- * @param {OptionsWithTZ} [options] - the object with options. See [Options]{@link https://date-fns.org/docs/Options}
+ * @param date the date representing the local time / real UTC time
+ * @param timeZone the time zone this date should be formatted for; can be an offset or IANA time zone
+ * @param formatStr the string of tokens
+ * @param options the object with options. See [Options]{@link https://date-fns.org/docs/Options}
  * @param {0|1|2} [options.additionalDigits=2] - passed to `toDate`. See [toDate]{@link
  *   https://date-fns.org/docs/toDate}
  * @param {0|1|2|3|4|5|6} [options.weekStartsOn=0] - the index of the first day of the week (0 - Sunday)
@@ -19,6 +19,5 @@ import type { OptionsWithTZ } from '../types';
  *   - Some of the local week-numbering year tokens (`YY`, `YYYY`) that are confused with the calendar year tokens
  *   (`yy`, `yyyy`). See: https://git.io/fxCyr
  * @param {String} [options.timeZone=''] - used to specify the IANA time zone offset of a date String.
- * @returns {String} the formatted date string
  */
-export default function formatInTimeZone(date: Date | string | number, timeZone: string, formatStr: string, options?: OptionsWithTZ): string;
+export declare function formatInTimeZone(date: Date | string | number, timeZone: string, formatStr: string, options?: FormatOptionsWithTZ): string;

package/dist-types/date-fns-tz/{zonedTimeToUtc → fromZonedTime}/index.d.ts

@@ -1,6 +1,6 @@
-import type { OptionsWithTZ } from '../types';
+import type { ToDateOptionsWithTZ } from '../index.ts';
 /**
- * @name zonedTimeToUtc
+ * @name fromZonedTime
  * @category Time Zone Helpers
  * @summary Get the UTC date/time from a date representing local time in a given time zone
  *
@@ -10,17 +10,16 @@ import type { OptionsWithTZ } from '../types';
  * date represented local time in time zone, the timestamp of the output date will
  * give the equivalent UTC of that local time regardless of the current system time zone.
  *
- * @param {Date|String|Number} date - the date with values representing the local time
- * @param {String} timeZone - the time zone of this local time, can be an offset or IANA time zone
- * @param {OptionsWithTZ} [options] - the object with options. See [Options]{@link https://date-fns.org/docs/Options}
+ * @param date the date with values representing the local time
+ * @param timeZone the time zone of this local time, can be an offset or IANA time zone
+ * @param options the object with options. See [Options]{@link https://date-fns.org/docs/Options}
  * @param {0|1|2} [options.additionalDigits=2] - passed to `toDate`. See [toDate]{@link https://date-fns.org/docs/toDate}
- * @returns {Date} the new date with the equivalent time in the time zone
  * @throws {TypeError} 2 arguments required
  * @throws {RangeError} `options.additionalDigits` must be 0, 1 or 2
  *
  * @example
  * // In June 10am in Los Angeles is 5pm UTC
- * const result = zonedTimeToUtc(new Date(2014, 5, 25, 10, 0, 0), 'America/Los_Angeles')
+ * const result = fromZonedTime(new Date(2014, 5, 25, 10, 0, 0), 'America/Los_Angeles')
  * //=> 2014-06-25T17:00:00.000Z
  */
-export default function zonedTimeToUtc(date: Date | string | number, timeZone: string, options: OptionsWithTZ): Date;
+export declare function fromZonedTime(date: Date | string | number, timeZone: string, options?: ToDateOptionsWithTZ): Date;

package/dist-types/date-fns-tz/getTimezoneOffset/index.d.ts

@@ -11,9 +11,8 @@
  * the second parameter to ensure the offset correctly accounts for DST at that time of
  * year. When omitted, the current date is used.
  *
- * @param {String} timeZone - the time zone of this local time, can be an offset or IANA time zone
- * @param {Date|Number} [date] - the date with values representing the local time
- * @returns {Number} the time zone offset in milliseconds
+ * @param timeZone the time zone of this local time, can be an offset or IANA time zone
+ * @param date the date with values representing the local time
  *
  * @example
  * const result = getTimezoneOffset('-07:00')
@@ -25,4 +24,4 @@
  * const result = getTimezoneOffset('America/New_York', new Date(2016, 6, 1))
  *   //=> -14400000 (-4 * 60 * 60 * 1000)
  */
-export default function getTimezoneOffset(timeZone: string, date: Date | number): number;
+export declare function getTimezoneOffset(timeZone: string, date?: Date | number): number;

package/dist-types/date-fns-tz/index.d.ts

@@ -1,6 +1,15 @@
-export { default as tzFormat } from './format';
-export { default as tzFormatInTimeZone } from './formatInTimeZone';
-export { default as tzGetTimezoneOffset } from './getTimezoneOffset';
-export { default as tzToDate } from './toDate';
-export { default as tzUtcToZonedTime } from './utcToZonedTime';
-export { default as tzZonedTimeToUtc } from './zonedTimeToUtc';
+import type { FormatOptions, ParseISOOptions, Locale } from '../date-fns/index.ts';
+export interface FormatOptionsWithTZ extends Omit<FormatOptions, 'locale'> {
+    locale?: FormatOptions['locale'] & Pick<Locale, 'code'>;
+    timeZone?: string;
+    originalDate?: Date | string | number;
+}
+export interface ToDateOptionsWithTZ extends ParseISOOptions {
+    timeZone?: string;
+}
+export { format as tzFormat } from './format/index.ts';
+export { formatInTimeZone as tzFormatInTimeZone } from './formatInTimeZone/index.ts';
+export { fromZonedTime as tzZonedTimeToUtc } from './fromZonedTime/index.ts';
+export { toZonedTime as tzUtcToZonedTime } from './toZonedTime/index.ts';
+export { getTimezoneOffset as getTimezoneOffset } from './getTimezoneOffset/index.ts';
+export { toDate as tzToDate } from './toDate/index.ts';