@checkdigit/time 3.0.0-PR.17-5aaf → 4.0.0-PR.18-81a3

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

@@ -1,10 +1,107 @@
-type Locale = Intl.ResolvedDateTimeFormatOptions['locale'];
-type FormatOptions = Intl.DateTimeFormatOptions;
-type LocaleOptions = {
-    locale: Locale | Locale[];
-};
-export default function intlFormat<DateType extends Date>(date: DateType): string;
-export default function intlFormat<DateType extends Date>(date: DateType, localeOptions: LocaleOptions): string;
-export default function intlFormat<DateType extends Date>(date: DateType, formatOptions: FormatOptions): string;
-export default function intlFormat<DateType extends Date>(date: DateType, formatOptions: FormatOptions, localeOptions: LocaleOptions): string;
-export {};
+/**
+ * The locale string (see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl#locales_argument).
+ */
+export type IntlFormatLocale = Intl.ResolvedDateTimeFormatOptions['locale'];
+/**
+ * The format options (see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/DateTimeFormat#options)
+ */
+export type IntlFormatFormatOptions = Intl.DateTimeFormatOptions;
+/**
+ * The locale options.
+ */
+export interface IntlFormatLocaleOptions {
+    /** The locale(s) to use (see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl#locales_argument) */
+    locale: IntlFormatLocale | IntlFormatLocale[];
+}
+/**
+ * @name intlFormat
+ * @category Common Helpers
+ * @summary Format the date with Intl.DateTimeFormat (https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat).
+ *
+ * @description
+ * Return the formatted date string in the given format.
+ * The method uses [`Intl.DateTimeFormat`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat) inside.
+ * formatOptions are the same as [`Intl.DateTimeFormat` options](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat#using_options)
+ *
+ * > ⚠️ Please note that before Node version 13.0.0, only the locale data for en-US is available by default.
+ *
+ * @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).
+ *
+ * @param date - The date to format
+ *
+ * @returns The formatted date string
+ *
+ * @throws `date` must not be Invalid Date
+ *
+ * @example
+ * // Represent 4 October 2019 in middle-endian format:
+ * const result = intlFormat(new Date(2019, 9, 4, 12, 30, 13, 456))
+ * //=> 10/4/2019
+ */
+export declare function intlFormat<DateType extends Date>(date: DateType | number | string): string;
+/**
+ * @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).
+ *
+ * @param date - The date to format
+ * @param localeOptions - An object with locale
+ *
+ * @returns The formatted date string
+ *
+ * @throws `date` must not be Invalid Date
+ *
+ * @example
+ * // Represent 4 October 2019 in Korean.
+ * // Convert the date with locale's options.
+ * const result = intlFormat(new Date(2019, 9, 4, 12, 30, 13, 456), {
+ *   locale: 'ko-KR',
+ * })
+ * //=> 2019. 10. 4.
+ */
+export declare function intlFormat<DateType extends Date>(date: DateType | number | string, localeOptions: IntlFormatLocaleOptions): string;
+/**
+ * @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).
+ *
+ * @param date - The date to format
+ * @param formatOptions - The format options
+ *
+ * @returns The formatted date string
+ *
+ * @throws `date` must not be Invalid Date
+ *
+ * @example
+ * // Represent 4 October 2019.
+ * // Convert the date with format's options.
+ * const result = intlFormat.default(new Date(2019, 9, 4, 12, 30, 13, 456), {
+ *   year: 'numeric',
+ *   month: 'numeric',
+ *   day: 'numeric',
+ *   hour: 'numeric',
+ * })
+ * //=> 10/4/2019, 12 PM
+ */
+export declare function intlFormat<DateType extends Date>(date: DateType | number | string, formatOptions: IntlFormatFormatOptions): string;
+/**
+ * @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).
+ *
+ * @param date - The date to format
+ * @param formatOptions - The format options
+ * @param localeOptions - An object with locale
+ *
+ * @returns The formatted date string
+ *
+ * @throws `date` must not be Invalid Date
+ *
+ * @example
+ * // Represent 4 October 2019 in German.
+ * // Convert the date with format's options and locale's options.
+ * const result = intlFormat(new Date(2019, 9, 4, 12, 30, 13, 456), {
+ *   weekday: 'long',
+ *   year: 'numeric',
+ *   month: 'long',
+ *   day: 'numeric',
+ * }, {
+ *   locale: 'de-DE',
+ * })
+ * //=> Freitag, 4. Oktober 2019
+ */
+export declare function intlFormat<DateType extends Date>(date: DateType | number | string, formatOptions: IntlFormatFormatOptions, localeOptions: IntlFormatLocaleOptions): string;

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

@@ -1,14 +1,22 @@
-import type { IntlOptionsUnit } from '../types';
 /**
  * The {@link intlFormatDistance} function options.
  */
 export interface IntlFormatDistanceOptions {
-    unit?: IntlOptionsUnit;
-    locale?: string;
+    /** Force the distance unit */
+    unit?: IntlFormatDistanceUnit;
+    /** The locale(s) to use (see: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl#locales_argument) */
+    locale?: Intl.UnicodeBCP47LocaleIdentifier | Intl.UnicodeBCP47LocaleIdentifier[];
+    /** The locale matching algorithm to use. Other value: 'lookup'. See MDN for details [Locale identification and negotiation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl#locale_identification_and_negotiation) */
     localeMatcher?: Intl.RelativeTimeFormatLocaleMatcher;
+    /** The output message format. The values are 'auto' (e.g. `yesterday`), 'always'(e.g. `1 day ago`) */
     numeric?: Intl.RelativeTimeFormatNumeric;
+    /** The length of the result. The values are: 'long' (e.g. `1 month`), 'short' (e.g. 'in 1 mo.'), 'narrow' (e.g. 'in 1 mo.'). The narrow one could be similar to the short one for some locales. */
     style?: Intl.RelativeTimeFormatStyle;
 }
+/**
+ * The unit used to format the distance in {@link intlFormatDistance}.
+ */
+export type IntlFormatDistanceUnit = 'year' | 'quarter' | 'month' | 'week' | 'day' | 'hour' | 'minute' | 'second';
 /**
  * @name intlFormatDistance
  * @category Common Helpers
@@ -39,19 +47,23 @@ export interface IntlFormatDistanceOptions {
  * | 1 year                 | last year      | next year       |
  * | 2+ years               | X years ago    | in X years      |
  *
- * @param date - the date
- * @param baseDate - the date to compare with.
- * @param options - an object with options.
+ * @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).
+ *
+ * @param date - The date
+ * @param baseDate - The date to compare with.
+ * @param options - An object with options.
  * See MDN for details [Locale identification and negotiation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl#locale_identification_and_negotiation)
  * The narrow one could be similar to the short one for some locales.
- * @returns the distance in words according to language-sensitive relative time formatting.
- * @throws {RangeError} `date` must not be Invalid Date
- * @throws {RangeError} `baseDate` must not be Invalid Date
- * @throws {RangeError} `options.unit` must not be invalid Unit
- * @throws {RangeError} `options.locale` must not be invalid locale
- * @throws {RangeError} `options.localeMatcher` must not be invalid localeMatcher
- * @throws {RangeError} `options.numeric` must not be invalid numeric
- * @throws {RangeError} `options.style` must not be invalid style
+ *
+ * @returns The distance in words according to language-sensitive relative time formatting.
+ *
+ * @throws `date` must not be Invalid Date
+ * @throws `baseDate` must not be Invalid Date
+ * @throws `options.unit` must not be invalid Unit
+ * @throws `options.locale` must not be invalid locale
+ * @throws `options.localeMatcher` must not be invalid localeMatcher
+ * @throws `options.numeric` must not be invalid numeric
+ * @throws `options.style` must not be invalid style
  *
  * @example
  * // What is the distance between the dates when the fist date is after the second?
@@ -104,4 +116,4 @@ export interface IntlFormatDistanceOptions {
  * )
  * //=> 'in 2 yr'
  */
-export default function intlFormatDistance(date: Date | number, baseDate: Date | number, options?: IntlFormatDistanceOptions): string;
+export declare function intlFormatDistance<DateType extends Date>(date: DateType | number | string, baseDate: DateType | number | string, options?: IntlFormatDistanceOptions): string;

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

@@ -6,13 +6,16 @@
  * @description
  * Is the first date after the second one?
  *
- * @param date - the date that should be after the other one to return true
- * @param dateToCompare - the date to compare with
- * @returns the first date is after the second 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).
+ *
+ * @param date - The date that should be after the other one to return true
+ * @param dateToCompare - The date to compare with
+ *
+ * @returns The first date is after the second date
  *
  * @example
  * // Is 10 July 1989 after 11 February 1987?
  * const result = isAfter(new Date(1989, 6, 10), new Date(1987, 1, 11))
  * //=> true
  */
-export default function isAfter<DateType extends Date>(dirtyDate: DateType | number, dirtyDateToCompare: DateType | number): boolean;
+export declare function isAfter<DateType extends Date>(date: DateType | number | string, dateToCompare: DateType | number | string): boolean;

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

@@ -6,13 +6,16 @@
  * @description
  * Is the first date before the second one?
  *
- * @param date - the date that should be before the other one to return true
- * @param dateToCompare - the date to compare with
- * @returns the first date is before the second 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).
+ *
+ * @param date - The date that should be before the other one to return true
+ * @param dateToCompare - The date to compare with
+ *
+ * @returns The first date is before the second date
  *
  * @example
  * // Is 10 July 1989 before 11 February 1987?
  * const result = isBefore(new Date(1989, 6, 10), new Date(1987, 1, 11))
  * //=> false
  */
-export default function isBefore<DateType extends Date>(dirtyDate: DateType | number, dirtyDateToCompare: DateType | number): boolean;
+export declare function isBefore<DateType extends Date>(date: DateType | number | string, dateToCompare: DateType | number | string): boolean;

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

@@ -6,8 +6,9 @@
  * @description
  * Returns true if the given value is an instance of Date. The function works for dates transferred across iframes.
  *
- * @param value - the value to check
- * @returns true if the given value is a date
+ * @param value - The value to check
+ *
+ * @returns True if the given value is a date
  *
  * @example
  * // For a valid date:
@@ -29,4 +30,4 @@
  * const result = isDate({})
  * //=> false
  */
-export default function isDate(value: unknown): value is Date;
+export declare function isDate(value: unknown): value is Date;

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

@@ -6,9 +6,12 @@
  * @description
  * Are the given dates equal?
  *
- * @param dateLeft - the first date to compare
- * @param dateRight - the second date to compare
- * @returns the dates are equal
+ * @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).
+ *
+ * @param dateLeft - The first date to compare
+ * @param dateRight - The second date to compare
+ *
+ * @returns The dates are equal
  *
  * @example
  * // Are 2 July 2014 06:30:45.000 and 2 July 2014 06:30:45.500 equal?
@@ -18,4 +21,4 @@
  * )
  * //=> false
  */
-export default function isEqual<DateType extends Date>(dirtyLeftDate: DateType | number, dirtyRightDate: DateType | number): boolean;
+export declare function isEqual<DateType extends Date>(leftDate: DateType | number | string, rightDate: DateType | number | string): boolean;

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

@@ -6,10 +6,11 @@
  * @description
  * Checks if the given arguments convert to an existing date.
  *
- * @param year of the date to check
- * @param month of the date to check
- * @param day of the date to check
- * @returns the date exists
+ * @param year - The year of the date to check
+ * @param month - The month of the date to check
+ * @param day - The day of the date to check
+ *
+ * @returns `true` if the date exists
  *
  * @example
  * // For the valid date:
@@ -21,4 +22,4 @@
  * const result = isExists(2018, 1, 31)
  * //=> false
  */
-export default function isExists(year: number, month: number, day: number): boolean;
+export declare function isExists(year: number, month: number, day: number): boolean;

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

@@ -6,12 +6,15 @@
  * @description
  * Is the given date the first day of a month?
  *
- * @param date - the date to check
- * @returns the date is the first day of a month
+ * @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).
+ *
+ * @param date - The date to check
+
+ * @returns The date is the first day of a month
  *
  * @example
  * // Is 1 September 2014 the first day of a month?
  * const result = isFirstDayOfMonth(new Date(2014, 8, 1))
  * //=> true
  */
-export default function isFirstDayOfMonth<DateType extends Date>(dirtyDate: DateType | number): boolean;
+export declare function isFirstDayOfMonth<DateType extends Date>(date: DateType | number | string): boolean;

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

@@ -6,12 +6,15 @@
  * @description
  * Is the given date Friday?
  *
- * @param date - the date to check
- * @returns the date is Friday
+ * @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).
+ *
+ * @param date - The date to check
+ *
+ * @returns The date is Friday
  *
  * @example
  * // Is 26 September 2014 Friday?
  * const result = isFriday(new Date(2014, 8, 26))
  * //=> true
  */
-export default function isFriday<DateType extends Date>(dirtyDate: DateType | number): boolean;
+export declare function isFriday<DateType extends Date>(date: DateType | number | string): boolean;

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

@@ -7,15 +7,15 @@
  * @description
  * Is the given date in the future?
  *
- * > ⚠️ Please note that this function is not present in the FP submodule as
- * > it uses `Date.now()` internally hence impure and can't be safely curried.
+ * @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).
  *
- * @param date - the date to check
- * @returns the date is in the future
+ * @param date - The date to check
+ *
+ * @returns The date is in the future
  *
  * @example
  * // If today is 6 October 2014, is 31 December 2014 in the future?
  * const result = isFuture(new Date(2014, 11, 31))
  * //=> true
  */
-export default function isFuture<DateType extends Date>(dirtyDate: DateType | number): boolean;
+export declare function isFuture<DateType extends Date>(date: DateType | number | string): boolean;

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

@@ -6,12 +6,15 @@
  * @description
  * Is the given date the last day of a month?
  *
- * @param date - the date to check
- * @returns the date is the last day of a month
+ * @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).
+ *
+ * @param date - The date to check
+
+ * @returns The date is the last day of a month
  *
  * @example
  * // Is 28 February 2014 the last day of a month?
  * const result = isLastDayOfMonth(new Date(2014, 1, 28))
  * //=> true
  */
-export default function isLastDayOfMonth<DateType extends Date>(dirtyDate: DateType | number): boolean;
+export declare function isLastDayOfMonth<DateType extends Date>(date: DateType | number | string): boolean;

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

@@ -6,12 +6,15 @@
  * @description
  * Is the given date in the leap year?
  *
- * @param date - the date to check
- * @returns the date is in the leap year
+ * @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).
+ *
+ * @param date - The date to check
+ *
+ * @returns The date is in the leap year
  *
  * @example
  * // Is 1 September 2012 in the leap year?
  * const result = isLeapYear(new Date(2012, 8, 1))
  * //=> true
  */
-export default function isLeapYear<DateType extends Date>(dirtyDate: DateType | number): boolean;
+export declare function isLeapYear<DateType extends Date>(date: DateType | number | string): boolean;

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

@@ -1,8 +1,8 @@
-import type { AdditionalTokensOptions, FirstWeekContainsDateOptions, LocaleOptions, WeekStartOptions } from '../types';
+import type { AdditionalTokensOptions, FirstWeekContainsDateOptions, LocalizedOptions, WeekOptions } from '../types';
 /**
  * The {@link isMatch} function options.
  */
-export interface IsMatchOptions extends LocaleOptions, WeekStartOptions, FirstWeekContainsDateOptions, AdditionalTokensOptions {
+export interface IsMatchOptions extends LocalizedOptions<'options' | 'match' | 'formatLong'>, WeekOptions, FirstWeekContainsDateOptions, AdditionalTokensOptions {
 }
 /**
  * @name isMatch
@@ -225,8 +225,8 @@ export interface IsMatchOptions extends LocaleOptions, WeekStartOptions, FirstWe
  *
  *    The same difference is true for local and ISO week-numbering years (`Y` and `R`),
  *    except local week-numbering years are dependent on `options.weekStartsOn`
- *    and `options.firstWeekContainsDate` (compare [setISOWeekYear]{@link https://date-fns.org/docs/setISOWeekYear}
- *    and [setWeekYear]{@link https://date-fns.org/docs/setWeekYear}).
+ *    and `options.firstWeekContainsDate` (compare [setISOWeekYear](https://date-fns.org/docs/setISOWeekYear)
+ *    and [setWeekYear](https://date-fns.org/docs/setWeekYear)).
  *
  * 5. These patterns are not in the Unicode Technical Standard #35:
  *    - `i`: ISO day of week
@@ -260,20 +260,22 @@ export interface IsMatchOptions extends LocaleOptions, WeekStartOptions, FirstWe
  *
  * If `formatString` matches with `dateString` but does not provides tokens, `referenceDate` will be returned.
  *
+ * @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).
  *
- *
- * @param dateString - the date string to verify
- * @param formatString - the string of tokens
- * @param options - an object with options.
+ * @param dateStr - The date string to verify
+ * @param format - The string of tokens
+ * @param options - An object with options.
  *   see: https://github.com/date-fns/date-fns/blob/master/docs/unicodeTokens.md
  *   see: https://github.com/date-fns/date-fns/blob/master/docs/unicodeTokens.md
- * @returns is format string a match for date string?
- * @throws {RangeError} `options.locale` must contain `match` property
- * @throws {RangeError} use `yyyy` instead of `YYYY` for formatting years; see: https://github.com/date-fns/date-fns/blob/master/docs/unicodeTokens.md
- * @throws {RangeError} use `yy` instead of `YY` for formatting years; see: https://github.com/date-fns/date-fns/blob/master/docs/unicodeTokens.md
- * @throws {RangeError} use `d` instead of `D` for formatting days of the month; see: https://github.com/date-fns/date-fns/blob/master/docs/unicodeTokens.md
- * @throws {RangeError} use `dd` instead of `DD` for formatting days of the month; see: https://github.com/date-fns/date-fns/blob/master/docs/unicodeTokens.md
- * @throws {RangeError} format string contains an unescaped latin alphabet character
+ *
+ * @returns Is format string a match for date string?
+ *
+ * @throws `options.locale` must contain `match` property
+ * @throws use `yyyy` instead of `YYYY` for formatting years; see: https://github.com/date-fns/date-fns/blob/master/docs/unicodeTokens.md
+ * @throws use `yy` instead of `YY` for formatting years; see: https://github.com/date-fns/date-fns/blob/master/docs/unicodeTokens.md
+ * @throws use `d` instead of `D` for formatting days of the month; see: https://github.com/date-fns/date-fns/blob/master/docs/unicodeTokens.md
+ * @throws use `dd` instead of `DD` for formatting days of the month; see: https://github.com/date-fns/date-fns/blob/master/docs/unicodeTokens.md
+ * @throws format string contains an unescaped latin alphabet character
  *
  * @example
  * // Match 11 February 2014 from middle-endian format:
@@ -288,4 +290,4 @@ export interface IsMatchOptions extends LocaleOptions, WeekStartOptions, FirstWe
  * })
  * //=> true
  */
-export default function isMatch(dateString: string, formatString: string, options?: IsMatchOptions): boolean;
+export declare function isMatch(dateStr: string, formatStr: string, options?: IsMatchOptions): boolean;

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

@@ -6,12 +6,15 @@
  * @description
  * Is the given date Monday?
  *
- * @param date - the date to check
- * @returns the date is Monday
+ * @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).
+ *
+ * @param date - The date to check
+ *
+ * @returns The date is Monday
  *
  * @example
  * // Is 22 September 2014 Monday?
  * const result = isMonday(new Date(2014, 8, 22))
  * //=> true
  */
-export default function isMonday<DateType extends Date>(date: DateType | number): boolean;
+export declare function isMonday<DateType extends Date>(date: DateType | number | string): boolean;

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

@@ -7,15 +7,15 @@
  * @description
  * Is the given date in the past?
  *
- * > ⚠️ Please note that this function is not present in the FP submodule as
- * > it uses `Date.now()` internally hence impure and can't be safely curried.
+ * @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).
  *
- * @param date - the date to check
- * @returns the date is in the past
+ * @param date - The date to check
+ *
+ * @returns The date is in the past
  *
  * @example
  * // If today is 6 October 2014, is 2 July 2014 in the past?
  * const result = isPast(new Date(2014, 6, 2))
  * //=> true
  */
-export default function isPast<DateType extends Date>(dirtyDate: DateType | number): boolean;
+export declare function isPast<DateType extends Date>(date: DateType | number | string): boolean;

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

@@ -6,9 +6,12 @@
  * @description
  * Are the given dates in the same day (and year and month)?
  *
- * @param dateLeft - the first date to check
- * @param dateRight - the second date to check
- * @returns the dates are in the same day (and year and month)
+ * @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).
+ *
+ * @param dateLeft - The first date to check
+ * @param dateRight - The second date to check
+
+ * @returns The dates are in the same day (and year and month)
  *
  * @example
  * // Are 4 September 06:00:00 and 4 September 18:00:00 in the same day?
@@ -25,4 +28,4 @@
  * const result = isSameDay(new Date(2014, 8, 4), new Date(2015, 8, 4))
  * //=> false
  */
-export default function isSameDay<DateType extends Date>(dirtyDateLeft: DateType | number, dirtyDateRight: DateType | number): boolean;
+export declare function isSameDay<DateType extends Date>(dateLeft: DateType | number | string, dateRight: DateType | number | string): boolean;

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

@@ -6,9 +6,12 @@
  * @description
  * Are the given dates in the same hour (and same day)?
  *
- * @param dateLeft - the first date to check
- * @param dateRight - the second date to check
- * @returns the dates are in the same hour (and same day)
+ * @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).
+ *
+ * @param dateLeft - The first date to check
+ * @param dateRight - The second date to check
+ *
+ * @returns The dates are in the same hour (and same day)
  *
  * @example
  * // Are 4 September 2014 06:00:00 and 4 September 06:30:00 in the same hour?
@@ -20,4 +23,4 @@
  * const result = isSameHour(new Date(2014, 8, 4, 6, 0), new Date(2014, 8, 5, 6, 0))
  * //=> false
  */
-export default function isSameHour<DateType extends Date>(dirtyDateLeft: DateType | number, dirtyDateRight: DateType | number): boolean;
+export declare function isSameHour<DateType extends Date>(dateLeft: DateType | number | string, dateRight: DateType | number | string): boolean;

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

@@ -8,9 +8,12 @@
  *
  * ISO week-numbering year: http://en.wikipedia.org/wiki/ISO_week_date
  *
- * @param dateLeft - the first date to check
- * @param dateRight - the second date to check
- * @returns the dates are in the same ISO week (and year)
+ * @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).
+ *
+ * @param dateLeft - The first date to check
+ * @param dateRight - The second date to check
+ *
+ * @returns The dates are in the same ISO week (and year)
  *
  * @example
  * // Are 1 September 2014 and 7 September 2014 in the same ISO week?
@@ -22,4 +25,4 @@
  * const result = isSameISOWeek(new Date(2014, 8, 1), new Date(2015, 8, 1))
  * //=> false
  */
-export default function isSameISOWeek<DateType extends Date>(dirtyDateLeft: DateType | number, dirtyDateRight: DateType | number): boolean;
+export declare function isSameISOWeek<DateType extends Date>(dateLeft: DateType | number | string, dateRight: DateType | number | string): boolean;

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

@@ -8,13 +8,16 @@
  *
  * ISO week-numbering year: http://en.wikipedia.org/wiki/ISO_week_date
  *
- * @param dateLeft - the first date to check
- * @param dateRight - the second date to check
- * @returns the dates are in the same ISO week-numbering year
+ * @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).
+ *
+ * @param dateLeft - The first date to check
+ * @param dateRight - The second date to check
+ *
+ * @returns The dates are in the same ISO week-numbering year
  *
  * @example
  * // Are 29 December 2003 and 2 January 2005 in the same ISO week-numbering year?
  * const result = isSameISOWeekYear(new Date(2003, 11, 29), new Date(2005, 0, 2))
  * //=> true
  */
-export default function isSameISOWeekYear<DateType extends Date>(dirtyDateLeft: DateType | number, dirtyDateRight: DateType | number): boolean;
+export declare function isSameISOWeekYear<DateType extends Date>(dateLeft: DateType | number | string, dateRight: DateType | number | string): boolean;

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

@@ -6,9 +6,12 @@
  * @description
  * Are the given dates in the same minute (and hour and day)?
  *
- * @param dateLeft - the first date to check
- * @param dateRight - the second date to check
- * @returns the dates are in the same minute (and hour and day)
+ * @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).
+ *
+ * @param dateLeft - The first date to check
+ * @param dateRight - The second date to check
+ *
+ * @returns The dates are in the same minute (and hour and day)
  *
  * @example
  * // Are 4 September 2014 06:30:00 and 4 September 2014 06:30:15 in the same minute?
@@ -26,4 +29,4 @@
  * )
  * //=> false
  */
-export default function isSameMinute<DateType extends Date>(dirtyDateLeft: DateType | number, dirtyDateRight: DateType | number): boolean;
+export declare function isSameMinute<DateType extends Date>(dateLeft: DateType | number | string, dateRight: DateType | number | string): boolean;