@checkdigit/time 4.0.0 → 5.0.0-PR.21-7813

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

@@ -1,3 +1,9 @@
+import type { ContextOptions, DateArg } from '../types.ts';
+/**
+ * The {@link setYear} function options.
+ */
+export interface SetYearOptions<DateType extends Date = Date> extends ContextOptions<DateType> {
+}
 /**
  * @name setYear
  * @category Year Helpers
@@ -7,9 +13,11 @@
  * Set the year to 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 year - The year of the new date
+ * @param options - An object with options.
  *
  * @returns The new date with the year set
  *
@@ -18,4 +26,4 @@
  * const result = setYear(new Date(2014, 8, 1), 2013)
  * //=> Sun Sep 01 2013 00:00:00
  */
-export declare function setYear<DateType extends Date>(date: DateType | number | string, year: number): DateType;
+export declare function setYear<DateType extends Date, ResultDate extends Date = DateType>(date: DateArg<DateType>, year: number, options?: SetYearOptions<ResultDate> | undefined): ResultDate;

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

@@ -1,3 +1,9 @@
+import type { ContextOptions, DateArg } from '../types.ts';
+/**
+ * The {@link startOfDay} function options.
+ */
+export interface StartOfDayOptions<DateType extends Date = Date> extends ContextOptions<DateType> {
+}
 /**
  * @name startOfDay
  * @category Day Helpers
@@ -8,8 +14,10 @@
  * The result will be in the local timezone.
  *
  * @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 original date
+ * @param options - The options
  *
  * @returns The start of a day
  *
@@ -18,4 +26,4 @@
  * const result = startOfDay(new Date(2014, 8, 2, 11, 55, 0))
  * //=> Tue Sep 02 2014 00:00:00
  */
-export declare function startOfDay<DateType extends Date>(date: DateType | number | string): DateType;
+export declare function startOfDay<DateType extends Date, ResultDate extends Date = DateType>(date: DateArg<DateType>, options?: StartOfDayOptions<ResultDate> | undefined): ResultDate;

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

@@ -1,3 +1,9 @@
+import type { ContextOptions, DateArg } from '../types.ts';
+/**
+ * The {@link startOfDecade} options.
+ */
+export interface StartOfDecadeOptions<DateType extends Date = Date> extends ContextOptions<DateType> {
+}
 /**
  * @name startOfDecade
  * @category Decade Helpers
@@ -7,8 +13,10 @@
  * Return the start of a decade for 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 original date
+ * @param options - An object with options
  *
  * @returns The start of a decade
  *
@@ -17,4 +25,4 @@
  * const result = startOfDecade(new Date(2015, 9, 21, 00, 00, 00))
  * //=> Jan 01 2010 00:00:00
  */
-export declare function startOfDecade<DateType extends Date>(date: DateType | number | string): DateType;
+export declare function startOfDecade<DateType extends Date, ResultDate extends Date = DateType>(date: DateArg<DateType>, options?: StartOfDecadeOptions<ResultDate> | undefined): ResultDate;

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

@@ -1,3 +1,9 @@
+import type { ContextOptions, DateArg } from '../types.ts';
+/**
+ * The {@link startOfHour} function options.
+ */
+export interface StartOfHourOptions<DateType extends Date = Date> extends ContextOptions<DateType> {
+}
 /**
  * @name startOfHour
  * @category Hour Helpers
@@ -8,8 +14,10 @@
  * The result will be in the local timezone.
  *
  * @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 original date
+ * @param options - An object with options
  *
  * @returns The start of an hour
  *
@@ -18,4 +26,4 @@
  * const result = startOfHour(new Date(2014, 8, 2, 11, 55))
  * //=> Tue Sep 02 2014 11:00:00
  */
-export declare function startOfHour<DateType extends Date>(date: DateType | number | string): DateType;
+export declare function startOfHour<DateType extends Date, ResultDate extends Date = DateType>(date: DateArg<DateType>, options?: StartOfHourOptions<ResultDate> | undefined): ResultDate;

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

@@ -1,3 +1,9 @@
+import type { ContextOptions, DateArg } from '../types.ts';
+/**
+ * The {@link startOfISOWeek} function options.
+ */
+export interface StartOfISOWeekOptions<DateType extends Date = Date> extends ContextOptions<DateType> {
+}
 /**
  * @name startOfISOWeek
  * @category ISO Week Helpers
@@ -10,8 +16,10 @@
  * 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 original date
+ * @param options - An object with options
  *
  * @returns The start of an ISO week
  *
@@ -20,4 +28,4 @@
  * const result = startOfISOWeek(new Date(2014, 8, 2, 11, 55, 0))
  * //=> Mon Sep 01 2014 00:00:00
  */
-export declare function startOfISOWeek<DateType extends Date>(date: DateType | number | string): DateType;
+export declare function startOfISOWeek<DateType extends Date, ResultDate extends Date = DateType>(date: DateArg<DateType>, options?: StartOfISOWeekOptions<ResultDate> | undefined): ResultDate;

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

@@ -1,3 +1,9 @@
+import type { ContextOptions, DateArg } from '../types.ts';
+/**
+ * The {@link startOfISOWeekYear} function options.
+ */
+export interface StartOfISOWeekYearOptions<DateType extends Date = Date> extends ContextOptions<DateType> {
+}
 /**
  * @name startOfISOWeekYear
  * @category ISO Week-Numbering Year Helpers
@@ -11,8 +17,10 @@
  * 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 original date
+ * @param options - An object with options
  *
  * @returns The start of an ISO week-numbering year
  *
@@ -21,4 +29,4 @@
  * const result = startOfISOWeekYear(new Date(2005, 6, 2))
  * //=> Mon Jan 03 2005 00:00:00
  */
-export declare function startOfISOWeekYear<DateType extends Date>(date: DateType | number | string): DateType;
+export declare function startOfISOWeekYear<DateType extends Date, ResultDate extends Date = DateType>(date: DateArg<DateType>, options?: StartOfISOWeekYearOptions<ResultDate> | undefined): ResultDate;

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

@@ -1,3 +1,9 @@
+import type { ContextOptions, DateArg } from '../types.ts';
+/**
+ * The {@link startOfMinute} function options.
+ */
+export interface StartOfMinuteOptions<DateType extends Date = Date> extends ContextOptions<DateType> {
+}
 /**
  * @name startOfMinute
  * @category Minute Helpers
@@ -8,8 +14,10 @@
  * The result will be in the local timezone.
  *
  * @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 original date
+ * @param options - An object with options
  *
  * @returns The start of a minute
  *
@@ -18,4 +26,4 @@
  * const result = startOfMinute(new Date(2014, 11, 1, 22, 15, 45, 400))
  * //=> Mon Dec 01 2014 22:15:00
  */
-export declare function startOfMinute<DateType extends Date>(date: DateType | number | string): DateType;
+export declare function startOfMinute<DateType extends Date, ResultDate extends Date = DateType>(date: DateArg<DateType>, options?: StartOfMinuteOptions<ResultDate> | undefined): ResultDate;

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

@@ -1,15 +1,24 @@
+import type { ContextOptions, DateArg } from '../types.ts';
+/**
+ * The {@link startOfMonth} function options.
+ */
+export interface StartOfMonthOptions<ResultDate extends Date> extends ContextOptions<ResultDate> {
+}
 /**
  * @name startOfMonth
  * @category Month Helpers
  * @summary Return the start of a month for the given date.
  *
  * @description
- * Return the start of a month for the given date.
- * The result will be in the local timezone.
+ * Return the start of a month for the given date. The result will be in the local timezone.
  *
- * @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 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 original date
+ * @param options - An object with options
  *
  * @returns The start of a month
  *
@@ -18,4 +27,4 @@
  * const result = startOfMonth(new Date(2014, 8, 2, 11, 55, 0))
  * //=> Mon Sep 01 2014 00:00:00
  */
-export declare function startOfMonth<DateType extends Date>(date: DateType | number | string): DateType;
+export declare function startOfMonth<DateType extends Date, ResultDate extends Date = DateType>(date: DateArg<DateType>, options?: StartOfMonthOptions<ResultDate> | undefined): ResultDate;

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

@@ -1,3 +1,9 @@
+import type { ContextOptions, DateArg } from '../types.ts';
+/**
+ * The {@link startOfQuarter} function options.
+ */
+export interface StartOfQuarterOptions<DateType extends Date = Date> extends ContextOptions<DateType> {
+}
 /**
  * @name startOfQuarter
  * @category Quarter Helpers
@@ -8,8 +14,10 @@
  * The result will be in the local timezone.
  *
  * @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 original date
+ * @param options - The options
  *
  * @returns The start of a quarter
  *
@@ -18,4 +26,4 @@
  * const result = startOfQuarter(new Date(2014, 8, 2, 11, 55, 0))
  * //=> Tue Jul 01 2014 00:00:00
  */
-export declare function startOfQuarter<DateType extends Date>(date: DateType | number | string): DateType;
+export declare function startOfQuarter<DateType extends Date, ResultDate extends Date = DateType>(date: DateArg<DateType>, options?: StartOfQuarterOptions<ResultDate> | undefined): ResultDate;

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

@@ -1,3 +1,9 @@
+import type { DateArg, ContextOptions } from '../types.ts';
+/**
+ * The {@link startOfSecond} function options.
+ */
+export interface StartOfSecondOptions<DateType extends Date = Date> extends ContextOptions<DateType> {
+}
 /**
  * @name startOfSecond
  * @category Second Helpers
@@ -8,8 +14,10 @@
  * The result will be in the local timezone.
  *
  * @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 original date
+ * @param options - The options
  *
  * @returns The start of a second
  *
@@ -18,4 +26,4 @@
  * const result = startOfSecond(new Date(2014, 11, 1, 22, 15, 45, 400))
  * //=> Mon Dec 01 2014 22:15:45.000
  */
-export declare function startOfSecond<DateType extends Date>(date: DateType | number | string): DateType;
+export declare function startOfSecond<DateType extends Date, ResultDate extends Date = DateType>(date: DateArg<DateType>, options?: StartOfSecondOptions<ResultDate> | undefined): ResultDate;

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

@@ -1,3 +1,9 @@
+import type { ContextOptions } from '../types.ts';
+/**
+ * The {@link startOfToday} function options.
+ */
+export interface StartOfTodayOptions<DateType extends Date = Date> extends ContextOptions<DateType> {
+}
 /**
  * @name startOfToday
  * @category Day Helpers
@@ -7,6 +13,10 @@
  * @description
  * Return the start of today.
  *
+ * @typeParam ContextDate - The `Date` type of the context function.
+ *
+ * @param options - An object with options
+ *
  * @returns The start of today
  *
  * @example
@@ -14,4 +24,4 @@
  * const result = startOfToday()
  * //=> Mon Oct 6 2014 00:00:00
  */
-export declare function startOfToday(): Date;
+export declare function startOfToday<ContextDate extends Date>(options?: StartOfTodayOptions<ContextDate> | undefined): ContextDate;

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

@@ -1,17 +1,27 @@
+import type { ContextOptions } from '../types.ts';
+/**
+ * The {@link startOfTomorrow} function options.
+ */
+export interface StartOfTomorrowOptions<DateType extends Date = Date> extends ContextOptions<DateType> {
+}
 /**
  * @name startOfTomorrow
  * @category Day Helpers
  * @summary Return the start of tomorrow.
  * @pure false
  *
- * @description
- * Return the start of tomorrow.
+ * @typeParam ContextDate - The `Date` type of the context function.
+ *
+ * @param options - An object with options
  *
  * @returns The start of tomorrow
  *
+ * @description
+ * Return the start of tomorrow.
+ *
  * @example
  * // If today is 6 October 2014:
  * const result = startOfTomorrow()
  * //=> Tue Oct 7 2014 00:00:00
  */
-export declare function startOfTomorrow(): Date;
+export declare function startOfTomorrow<ContextDate extends Date>(options?: StartOfTomorrowOptions<ContextDate> | undefined): ContextDate;

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

@@ -1,8 +1,8 @@
-import type { LocalizedOptions, WeekOptions } from '../types';
+import type { ContextOptions, DateArg, LocalizedOptions, WeekOptions } from '../types.ts';
 /**
  * The {@link startOfWeek} function options.
  */
-export interface StartOfWeekOptions extends LocalizedOptions<'options'>, WeekOptions {
+export interface StartOfWeekOptions<DateType extends Date = Date> extends LocalizedOptions<'options'>, WeekOptions, ContextOptions<DateType> {
 }
 /**
  * @name startOfWeek
@@ -14,6 +14,7 @@ export interface StartOfWeekOptions extends LocalizedOptions<'options'>, WeekOpt
  * The result will be in the local timezone.
  *
  * @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 original date
  * @param options - An object with options
@@ -30,4 +31,4 @@ export interface StartOfWeekOptions extends LocalizedOptions<'options'>, WeekOpt
  * const result = startOfWeek(new Date(2014, 8, 2, 11, 55, 0), { weekStartsOn: 1 })
  * //=> Mon Sep 01 2014 00:00:00
  */
-export declare function startOfWeek<DateType extends Date>(date: DateType | number | string, options?: StartOfWeekOptions): DateType;
+export declare function startOfWeek<DateType extends Date, ResultDate extends Date = DateType>(date: DateArg<DateType>, options?: StartOfWeekOptions<ResultDate>): ResultDate;

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

@@ -1,8 +1,8 @@
-import type { FirstWeekContainsDateOptions, LocalizedOptions, WeekOptions } from '../types';
+import type { ContextOptions, DateArg, FirstWeekContainsDateOptions, LocalizedOptions, WeekOptions } from '../types.ts';
 /**
  * The {@link startOfWeekYear} function options.
  */
-export interface StartOfWeekYearOptions extends LocalizedOptions<'options'>, FirstWeekContainsDateOptions, WeekOptions {
+export interface StartOfWeekYearOptions<DateType extends Date = Date> extends LocalizedOptions<'options'>, FirstWeekContainsDateOptions, WeekOptions, ContextOptions<DateType> {
 }
 /**
  * @name startOfWeekYear
@@ -19,6 +19,7 @@ export interface StartOfWeekYearOptions extends LocalizedOptions<'options'>, Fir
  * Week numbering: https://en.wikipedia.org/wiki/Week#The_ISO_week_date_system
  *
  * @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.
  *
  * @param date - The original date
  * @param options - An object with options
@@ -40,4 +41,4 @@ export interface StartOfWeekYearOptions extends LocalizedOptions<'options'>, Fir
  * })
  * //=> Mon Jan 03 2005 00:00:00
  */
-export declare function startOfWeekYear<DateType extends Date>(date: DateType | number | string, options?: StartOfWeekYearOptions): DateType;
+export declare function startOfWeekYear<DateType extends Date, ResultDate extends Date = DateType>(date: DateArg<DateType>, options?: StartOfWeekYearOptions<ResultDate>): ResultDate;

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

@@ -1,3 +1,9 @@
+import type { ContextOptions, DateArg } from '../types.ts';
+/**
+ * The {@link startOfYear} function options.
+ */
+export interface StartOfYearOptions<DateType extends Date = Date> extends ContextOptions<DateType> {
+}
 /**
  * @name startOfYear
  * @category Year Helpers
@@ -8,8 +14,10 @@
  * The result will be in the local timezone.
  *
  * @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 original date
+ * @param options - The options
  *
  * @returns The start of a year
  *
@@ -18,4 +26,4 @@
  * const result = startOfYear(new Date(2014, 8, 2, 11, 55, 00))
  * //=> Wed Jan 01 2014 00:00:00
  */
-export declare function startOfYear<DateType extends Date>(date: DateType | number | string): DateType;
+export declare function startOfYear<DateType extends Date, ResultDate extends Date = DateType>(date: DateArg<DateType>, options?: StartOfYearOptions<ResultDate> | undefined): ResultDate;

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

@@ -1,9 +1,19 @@
+import type { ContextOptions } from '../types.ts';
+/**
+ * The {@link startOfYesterday} function options.
+ */
+export interface StartOfYesterdayOptions<DateType extends Date = Date> extends ContextOptions<DateType> {
+}
 /**
  * @name startOfYesterday
  * @category Day Helpers
  * @summary Return the start of yesterday.
  * @pure false
  *
+ * @typeParam ContextDate - The `Date` type of the context function.
+ *
+ * @param options - An object with options
+ *
  * @description
  * Return the start of yesterday.
  *
@@ -14,4 +24,4 @@
  * const result = startOfYesterday()
  * //=> Sun Oct 5 2014 00:00:00
  */
-export declare function startOfYesterday(): Date;
+export declare function startOfYesterday<ContextDate extends Date>(options?: StartOfYesterdayOptions<ContextDate> | undefined): ContextDate;

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

@@ -1,4 +1,9 @@
-import type { Duration } from '../types';
+import type { ContextOptions, DateArg, Duration } from '../types.ts';
+/**
+ * The {@link sub} function options.
+ */
+export interface SubOptions<DateType extends Date = Date> extends ContextOptions<DateType> {
+}
 /**
  * @name sub
  * @category Common Helpers
@@ -8,9 +13,11 @@ import type { Duration } from '../types';
  * Subtract the specified years, months, weeks, days, hours, minutes and 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 duration - The object with years, months, weeks, days, hours, minutes and seconds to be subtracted
+ * @param options - An object with options
  *
  * | Key     | Description                        |
  * |---------|------------------------------------|
@@ -39,4 +46,4 @@ import type { Duration } from '../types';
  * })
  * //=> Mon Sep 1 2014 10:19:50
  */
-export declare function sub<DateType extends Date>(date: DateType | number | string, duration: Duration): DateType;
+export declare function sub<DateType extends Date, ResultDate extends Date = DateType>(date: DateArg<DateType>, duration: Duration, options?: SubOptions<ResultDate>): ResultDate;

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

@@ -1,21 +1,29 @@
+import type { ContextOptions, DateArg } from '../types.ts';
+/**
+ * The {@link subBusinessDays} function options.
+ */
+export interface SubBusinessDaysOptions<DateType extends Date = Date> extends ContextOptions<DateType> {
+}
 /**
  * @name subBusinessDays
  * @category Day Helpers
- * @summary Substract the specified number of business days (mon - fri) to the given date.
+ * @summary Subtract the specified number of business days (mon - fri) from the given date.
  *
  * @description
- * Substract the specified number of business days (mon - fri) to the given date, ignoring weekends.
+ * Subtract the specified number of business days (mon - fri) from the given date, ignoring weekends.
  *
  * @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 business days to be subtracted.
+ * @param options - An object with options
  *
  * @returns The new date with the business days subtracted
  *
  * @example
- * // Substract 10 business days from 1 September 2014:
+ * // Subtract 10 business days from 1 September 2014:
  * const result = subBusinessDays(new Date(2014, 8, 1), 10)
  * //=> Mon Aug 18 2014 00:00:00 (skipped weekend days)
  */
-export declare function subBusinessDays<DateType extends Date>(date: DateType | number | string, amount: number): DateType;
+export declare function subBusinessDays<DateType extends Date, ResultDate extends Date = DateType>(date: DateArg<DateType>, amount: number, options?: SubBusinessDaysOptions<ResultDate> | undefined): ResultDate;

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

@@ -1,15 +1,20 @@
+import type { ContextOptions, DateArg } from '../types.ts';
+/**
+ * The {@link subDays} function options.
+ */
+export interface SubDaysOptions<DateType extends Date = Date> extends ContextOptions<DateType> {
+}
 /**
  * @name subDays
  * @category Day Helpers
  * @summary Subtract the specified number of days from the given date.
  *
- * @description
- * Subtract the specified number of days 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 days to be subtracted.
+ * @param options - An object with options
  *
  * @returns The new date with the days subtracted
  *
@@ -18,4 +23,4 @@
  * const result = subDays(new Date(2014, 8, 1), 10)
  * //=> Fri Aug 22 2014 00:00:00
  */
-export declare function subDays<DateType extends Date>(date: DateType | number | string, amount: number): DateType;
+export declare function subDays<DateType extends Date, ResultDate extends Date = DateType>(date: DateArg<DateType>, amount: number, options?: SubDaysOptions<ResultDate> | undefined): ResultDate;

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

@@ -1,3 +1,9 @@
+import type { ContextOptions, DateArg } from '../types.ts';
+/**
+ * The {@link subHours} function options.
+ */
+export interface SubHoursOptions<DateType extends Date = Date> extends ContextOptions<DateType> {
+}
 /**
  * @name subHours
  * @category Hour Helpers
@@ -7,9 +13,11 @@
  * Subtract the specified number of hours 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 hours to be subtracted.
+ * @param options - The options
  *
  * @returns The new date with the hours subtracted
  *
@@ -18,4 +26,4 @@
  * const result = subHours(new Date(2014, 6, 11, 1, 0), 2)
  * //=> Thu Jul 10 2014 23:00:00
  */
-export declare function subHours<DateType extends Date>(date: DateType | number | string, amount: number): DateType;
+export declare function subHours<DateType extends Date, ResultDate extends Date = DateType>(date: DateArg<DateType>, amount: number, options?: SubHoursOptions<ResultDate> | undefined): ResultDate;

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;