@checkdigit/time 3.0.0-PR.17-58cd → 4.0.0-PR.18-9134

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

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

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

@@ -6,9 +6,12 @@
  * @description
  * Are the given dates in the same quarter (and year)?
  *
- * @param dateLeft - the first date to check
- * @param dateRight - the second date to check
- * @returns the dates are in the same quarter (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 quarter (and year)
  *
  * @example
  * // Are 1 January 2014 and 8 March 2014 in the same quarter?
@@ -20,4 +23,4 @@
  * const result = isSameQuarter(new Date(2014, 0, 1), new Date(2015, 0, 1))
  * //=> false
  */
-export default function isSameQuarter<DateType extends Date>(dirtyDateLeft: DateType | number, dirtyDateRight: DateType | number): boolean;
+export declare function isSameQuarter<DateType extends Date>(dateLeft: DateType | number | string, dateRight: DateType | number | string): boolean;

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

@@ -6,9 +6,12 @@
  * @description
  * Are the given dates in the same second (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 second (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 second (and hour and day)
  *
  * @example
  * // Are 4 September 2014 06:30:15.000 and 4 September 2014 06:30.15.500 in the same second?
@@ -34,4 +37,4 @@
  * )
  * //=> false
  */
-export default function isSameSecond<DateType extends Date>(dirtyDateLeft: DateType | number, dirtyDateRight: DateType | number): boolean;
+export declare function isSameSecond<DateType extends Date>(dateLeft: DateType | number | string, dateRight: DateType | number | string): boolean;

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

@@ -1,8 +1,8 @@
-import type { LocaleOptions, WeekStartOptions } from '../types';
+import type { LocalizedOptions, WeekOptions } from "../types";
 /**
  * The {@link isSameWeek} function options.
  */
-export interface IsSameWeekOptions extends WeekStartOptions, LocaleOptions {
+export interface IsSameWeekOptions extends WeekOptions, LocalizedOptions<"options"> {
 }
 /**
  * @name isSameWeek
@@ -12,10 +12,13 @@ export interface IsSameWeekOptions extends WeekStartOptions, LocaleOptions {
  * @description
  * Are the given dates in the same week (and month and year)?
  *
- * @param dateLeft - the first date to check
- * @param dateRight - the second date to check
- * @param options - an object with options.
- * @returns the dates are in the same week (and month 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
+ * @param options - An object with options
+ *
+ * @returns The dates are in the same week (and month and year)
  *
  * @example
  * // Are 31 August 2014 and 4 September 2014 in the same week?
@@ -35,4 +38,4 @@ export interface IsSameWeekOptions extends WeekStartOptions, LocaleOptions {
  * const result = isSameWeek(new Date(2014, 0, 1), new Date(2015, 0, 1))
  * //=> false
  */
-export default function isSameWeek<DateType extends Date>(dirtyDateLeft: DateType | number, dirtyDateRight: DateType | number, options?: IsSameWeekOptions): boolean;
+export declare function isSameWeek<DateType extends Date>(dateLeft: DateType | number | string, dateRight: DateType | number | string, options?: IsSameWeekOptions): boolean;

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

@@ -6,13 +6,16 @@
  * @description
  * Are the given dates in the same year?
  *
- * @param dateLeft - the first date to check
- * @param dateRight - the second date to check
- * @returns the dates are in the same 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 year
  *
  * @example
  * // Are 2 September 2014 and 25 September 2014 in the same year?
  * const result = isSameYear(new Date(2014, 8, 2), new Date(2014, 8, 25))
  * //=> true
  */
-export default function isSameYear<DateType extends Date>(dirtyDateLeft: DateType | number, dirtyDateRight: DateType | number): boolean;
+export declare function isSameYear<DateType extends Date>(dateLeft: DateType | number | string, dateRight: DateType | number | string): boolean;

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

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

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

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

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

@@ -7,11 +7,11 @@
  * @description
  * Is the given date in the same hour as the current date?
  *
- * > ⚠️ 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 this hour
+ * @param date - The date to check
+ *
+ * @returns The date is in this hour
  *
  * @example
  * // If now is 25 September 2014 18:30:15.500,
@@ -19,4 +19,4 @@
  * const result = isThisHour(new Date(2014, 8, 25, 18))
  * //=> true
  */
-export default function isThisHour<DateType extends Date>(dirtyDate: DateType | number): boolean;
+export declare function isThisHour<DateType extends Date>(date: DateType | number | string): boolean;

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

@@ -9,15 +9,15 @@
  *
  * ISO week-numbering year: http://en.wikipedia.org/wiki/ISO_week_date
  *
- * > ⚠️ 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 this ISO week
+ * @param date - The date to check
+ *
+ * @returns The date is in this ISO week
  *
  * @example
  * // If today is 25 September 2014, is 22 September 2014 in this ISO week?
  * const result = isThisISOWeek(new Date(2014, 8, 22))
  * //=> true
  */
-export default function isThisISOWeek<DateType extends Date>(dirtyDate: DateType | number): boolean;
+export declare function isThisISOWeek<DateType extends Date>(date: DateType | number | string): boolean;

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

@@ -7,11 +7,11 @@
  * @description
  * Is the given date in the same minute as the current date?
  *
- * > ⚠️ 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 this minute
+ * @param date - The date to check
+ *
+ * @returns The date is in this minute
  *
  * @example
  * // If now is 25 September 2014 18:30:15.500,
@@ -19,4 +19,4 @@
  * const result = isThisMinute(new Date(2014, 8, 25, 18, 30))
  * //=> true
  */
-export default function isThisMinute<DateType extends Date>(dirtyDate: DateType | number): boolean;
+export declare function isThisMinute<DateType extends Date>(date: DateType | number | string): boolean;

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

@@ -7,15 +7,15 @@
  * @description
  * Is the given date in the same month as the current date?
  *
- * > ⚠️ 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 this month
+ * @param date - The date to check
+ *
+ * @returns The date is in this month
  *
  * @example
  * // If today is 25 September 2014, is 15 September 2014 in this month?
  * const result = isThisMonth(new Date(2014, 8, 15))
  * //=> true
  */
-export default function isThisMonth<DateType extends Date>(dirtyDate: DateType | number): boolean;
+export declare function isThisMonth<DateType extends Date>(date: DateType | number | string): boolean;

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

@@ -7,15 +7,15 @@
  * @description
  * Is the given date in the same quarter as the current date?
  *
- * > ⚠️ 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 this quarter
+ * @param date - The date to check
+ *
+ * @returns The date is in this quarter
  *
  * @example
  * // If today is 25 September 2014, is 2 July 2014 in this quarter?
  * const result = isThisQuarter(new Date(2014, 6, 2))
  * //=> true
  */
-export default function isThisQuarter<DateType extends Date>(dirtyDate: DateType | number): boolean;
+export declare function isThisQuarter<DateType extends Date>(date: DateType | number | string): boolean;

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

@@ -7,11 +7,11 @@
  * @description
  * Is the given date in the same second as the current date?
  *
- * > ⚠️ 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 this second
+ * @param date - The date to check
+ *
+ * @returns The date is in this second
  *
  * @example
  * // If now is 25 September 2014 18:30:15.500,
@@ -19,4 +19,4 @@
  * const result = isThisSecond(new Date(2014, 8, 25, 18, 30, 15))
  * //=> true
  */
-export default function isThisSecond<DateType extends Date>(dirtyDate: DateType | number): boolean;
+export declare function isThisSecond<DateType extends Date>(date: DateType | number | string): boolean;

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

@@ -1,8 +1,8 @@
-import type { LocaleOptions, WeekStartOptions } from '../types';
+import type { LocalizedOptions, WeekOptions } from "../types";
 /**
  * The {@link isThisWeek} function options.
  */
-export interface IsThisWeekOptions extends WeekStartOptions, LocaleOptions {
+export interface IsThisWeekOptions extends WeekOptions, LocalizedOptions<"options"> {
 }
 /**
  * @name isThisWeek
@@ -13,12 +13,12 @@ export interface IsThisWeekOptions extends WeekStartOptions, LocaleOptions {
  * @description
  * Is the given date in the same week as the current date?
  *
- * > ⚠️ 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
- * @param options - the object with options
- * @returns the date is in this week
+ * @param date - The date to check
+ * @param options - The object with options
+ *
+ * @returns The date is in this week
  *
  * @example
  * // If today is 25 September 2014, is 21 September 2014 in this week?
@@ -31,4 +31,4 @@ export interface IsThisWeekOptions extends WeekStartOptions, LocaleOptions {
  * const result = isThisWeek(new Date(2014, 8, 21), { weekStartsOn: 1 })
  * //=> false
  */
-export default function is<DateType extends Date>(dirtyDate: DateType | number, options?: IsThisWeekOptions): boolean;
+export declare function isThisWeek<DateType extends Date>(date: DateType | number | string, options?: IsThisWeekOptions): boolean;

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

@@ -7,15 +7,15 @@
  * @description
  * Is the given date in the same year as the current date?
  *
- * > ⚠️ 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 this year
+ * @param date - The date to check
+ *
+ * @returns The date is in this year
  *
  * @example
  * // If today is 25 September 2014, is 2 July 2014 in this year?
  * const result = isThisYear(new Date(2014, 6, 2))
  * //=> true
  */
-export default function isThisYear<DateType extends Date>(dirtyDate: DateType | number): boolean;
+export declare function isThisYear<DateType extends Date>(date: DateType | number | string): boolean;

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

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

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

@@ -7,15 +7,15 @@
  * @description
  * Is the given date today?
  *
- * > ⚠️ 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 today
+ * @param date - The date to check
+ *
+ * @returns The date is today
  *
  * @example
  * // If today is 6 October 2014, is 6 October 14:00:00 today?
  * const result = isToday(new Date(2014, 9, 6, 14, 0))
  * //=> true
  */
-export default function isToday<DateType extends Date>(dirtyDate: DateType | number): boolean;
+export declare function isToday<DateType extends Date>(date: DateType | number | string): boolean;

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

@@ -7,15 +7,15 @@
  * @description
  * Is the given date tomorrow?
  *
- * > ⚠️ 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 tomorrow
+ * @param date - The date to check
+ *
+ * @returns The date is tomorrow
  *
  * @example
  * // If today is 6 October 2014, is 7 October 14:00:00 tomorrow?
  * const result = isTomorrow(new Date(2014, 9, 7, 14, 0))
  * //=> true
  */
-export default function isTomorrow<DateType extends Date>(dirtyDate: DateType | number): boolean;
+export declare function isTomorrow<DateType extends Date>(date: DateType | number | string): boolean;

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

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

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

@@ -5,13 +5,16 @@
  *
  * @description
  * Returns false if argument is Invalid Date and true otherwise.
- * Argument is converted to Date using `toDate`. See [toDate]{@link https://date-fns.org/docs/toDate}
+ * Argument is converted to Date using `toDate`. See [toDate](https://date-fns.org/docs/toDate)
  * Invalid Date is a Date, whose time value is NaN.
  *
  * Time value of Date: http://es5.github.io/#x15.9.1.1
  *
- * @param date - the date to check
- * @returns the date is valid
+ * @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 valid
  *
  * @example
  * // For the valid date:
@@ -28,4 +31,4 @@
  * const result = isValid(new Date(''))
  * //=> false
  */
-export default function isValid(dirtyDate: unknown): boolean;
+export declare function isValid(date: unknown): boolean;

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

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

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

@@ -6,12 +6,15 @@
  * @description
  * Does the given date fall on a weekend?
  *
- * @param date - the date to check
- * @returns the date falls on a weekend
+ * @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 falls on a weekend
  *
  * @example
  * // Does 5 October 2014 fall on a weekend?
  * const result = isWeekend(new Date(2014, 9, 5))
  * //=> true
  */
-export default function isWeekend<DateType extends Date>(dirtyDate: DateType | number): boolean;
+export declare function isWeekend<DateType extends Date>(date: DateType | number | string): boolean;

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

@@ -1,4 +1,4 @@
-import type { Interval } from '../types';
+import type { Interval } from "../types";
 /**
  * @name isWithinInterval
  * @category Interval Helpers
@@ -7,11 +7,12 @@ import type { Interval } from '../types';
  * @description
  * Is the given date within the interval? (Including start and end.)
  *
- * @param date - the date to check
- * @param interval - the interval to check
- * @returns the date is within the interval
- * @throws {RangeError} The start of an interval cannot be after its end
- * @throws {RangeError} Date in interval cannot be `Invalid 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 to check
+ * @param interval - The interval to check
+ *
+ * @returns The date is within the interval
  *
  * @example
  * // For the date within the interval:
@@ -31,10 +32,12 @@ import type { Interval } from '../types';
  *
  * @example
  * // For date equal to interval start:
- * isWithinInterval(date, { start, end: date }) // => true
+ * isWithinInterval(date, { start, end: date })
+ * // => true
  *
  * @example
  * // For date equal to interval end:
- * isWithinInterval(date, { start: date, end }) // => true
+ * isWithinInterval(date, { start: date, end })
+ * // => true
  */
-export default function isWithinInterval<DateType extends Date>(dirtyDate: DateType | number, interval: Interval<DateType>): boolean;
+export declare function isWithinInterval<DateType extends Date>(date: DateType | number | string, interval: Interval<DateType>): boolean;

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

@@ -7,15 +7,15 @@
  * @description
  * Is the given date yesterday?
  *
- * > ⚠️ 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 yesterday
+ * @param date - The date to check
+ *
+ * @returns The date is yesterday
  *
  * @example
  * // If today is 6 October 2014, is 5 October 14:00:00 yesterday?
  * const result = isYesterday(new Date(2014, 9, 5, 14, 0))
  * //=> true
  */
-export default function isYesterday<DateType extends Date>(dirtyDate: DateType | number): boolean;
+export declare function isYesterday<DateType extends Date>(date: DateType | number | string): boolean;

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

@@ -6,12 +6,15 @@
  * @description
  * Return the last day of a decade for the given date.
  *
- * @param date - the original date
- * @returns the last day of a decade
+ * @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 original date
+ *
+ * @returns The last day of a decade
  *
  * @example
  * // The last day of a decade for 21 December 2012 21:12:00:
  * const result = lastDayOfDecade(new Date(2012, 11, 21, 21, 12, 00))
  * //=> Wed Dec 31 2019 00:00:00
  */
-export default function lastDayOfDecade<DateType extends Date>(dirtyDate: DateType | number): DateType;
+export declare function lastDayOfDecade<DateType extends Date>(date: DateType | number | string): DateType;

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

@@ -9,12 +9,15 @@
  *
  * ISO week-numbering year: http://en.wikipedia.org/wiki/ISO_week_date
  *
- * @param date - the original date
- * @returns the last day of an ISO week
+ * @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 original date
+ *
+ * @returns The last day of an ISO week
  *
  * @example
  * // The last day of an ISO week for 2 September 2014 11:55:00:
  * const result = lastDayOfISOWeek(new Date(2014, 8, 2, 11, 55, 0))
  * //=> Sun Sep 07 2014 00:00:00
  */
-export default function lastDayOfISOWeek<DateType extends Date>(dirtyDate: DateType | number): DateType;
+export declare function lastDayOfISOWeek<DateType extends Date>(date: DateType | number | string): DateType;