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

package/src/date-fns/startOfISOWeek/index.ts

@@ -1,4 +1,14 @@
-import { startOfWeek } from '../startOfWeek/index';
+/* eslint-disable eslint-comments/no-unlimited-disable */
+/* eslint-disable */
+// @ts-nocheck
+
+import { startOfWeek } from '../startOfWeek/index.ts';
+import type { ContextOptions, DateArg } from '../types.ts';
+
+/**
+ * The {@link startOfISOWeek} function options.
+ */
+export interface StartOfISOWeekOptions<DateType extends Date = Date> extends ContextOptions<DateType> {}
 
 /**
  * @name startOfISOWeek
@@ -12,8 +22,10 @@ import { startOfWeek } from '../startOfWeek/index';
  * 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
  *
@@ -22,6 +34,11 @@ import { startOfWeek } from '../startOfWeek/index';
  * const result = startOfISOWeek(new Date(2014, 8, 2, 11, 55, 0))
  * //=> Mon Sep 01 2014 00:00:00
  */
-export function startOfISOWeek<DateType extends Date>(date: DateType | number | string): DateType {
-  return startOfWeek(date, { weekStartsOn: 1 });
+export function startOfISOWeek<DateType extends Date, ResultDate extends Date = DateType>(
+  date: DateArg<DateType>,
+  options?: StartOfISOWeekOptions<ResultDate> | undefined,
+): ResultDate {
+  return startOfWeek(date, { ...options, weekStartsOn: 1 });
 }
+
+/* eslint-enable */

package/src/date-fns/startOfISOWeekYear/index.ts

@@ -1,6 +1,16 @@
-import { getISOWeekYear } from '../getISOWeekYear/index';
-import { startOfISOWeek } from '../startOfISOWeek/index';
-import { constructFrom } from '../constructFrom/index';
+/* eslint-disable eslint-comments/no-unlimited-disable */
+/* eslint-disable */
+// @ts-nocheck
+
+import { constructFrom } from '../constructFrom/index.ts';
+import { getISOWeekYear } from '../getISOWeekYear/index.ts';
+import { startOfISOWeek } from '../startOfISOWeek/index.ts';
+import type { ContextOptions, DateArg } from '../types.ts';
+
+/**
+ * The {@link startOfISOWeekYear} function options.
+ */
+export interface StartOfISOWeekYearOptions<DateType extends Date = Date> extends ContextOptions<DateType> {}
 
 /**
  * @name startOfISOWeekYear
@@ -15,8 +25,10 @@ import { constructFrom } from '../constructFrom/index';
  * 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
  *
@@ -25,10 +37,15 @@ import { constructFrom } from '../constructFrom/index';
  * const result = startOfISOWeekYear(new Date(2005, 6, 2))
  * //=> Mon Jan 03 2005 00:00:00
  */
-export function startOfISOWeekYear<DateType extends Date>(date: DateType | number | string): DateType {
-  const year = getISOWeekYear(date);
-  const fourthOfJanuary = constructFrom(date, 0);
+export function startOfISOWeekYear<DateType extends Date, ResultDate extends Date = DateType>(
+  date: DateArg<DateType>,
+  options?: StartOfISOWeekYearOptions<ResultDate> | undefined,
+): ResultDate {
+  const year = getISOWeekYear(date, options);
+  const fourthOfJanuary = constructFrom(options?.in || date, 0);
   fourthOfJanuary.setFullYear(year, 0, 4);
   fourthOfJanuary.setHours(0, 0, 0, 0);
   return startOfISOWeek(fourthOfJanuary);
 }
+
+/* eslint-enable */

package/src/date-fns/startOfMinute/index.ts

@@ -1,4 +1,14 @@
-import { toDate } from '../toDate/index';
+/* eslint-disable eslint-comments/no-unlimited-disable */
+/* eslint-disable */
+// @ts-nocheck
+
+import { toDate } from '../toDate/index.ts';
+import type { ContextOptions, DateArg } from '../types.ts';
+
+/**
+ * The {@link startOfMinute} function options.
+ */
+export interface StartOfMinuteOptions<DateType extends Date = Date> extends ContextOptions<DateType> {}
 
 /**
  * @name startOfMinute
@@ -10,8 +20,10 @@ import { toDate } from '../toDate/index';
  * 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
  *
@@ -20,8 +32,13 @@ import { toDate } from '../toDate/index';
  * const result = startOfMinute(new Date(2014, 11, 1, 22, 15, 45, 400))
  * //=> Mon Dec 01 2014 22:15:00
  */
-export function startOfMinute<DateType extends Date>(date: DateType | number | string): DateType {
-  const _date = toDate(date);
-  _date.setSeconds(0, 0);
-  return _date;
+export function startOfMinute<DateType extends Date, ResultDate extends Date = DateType>(
+  date: DateArg<DateType>,
+  options?: StartOfMinuteOptions<ResultDate> | undefined,
+): ResultDate {
+  const date_ = toDate(date, options?.in);
+  date_.setSeconds(0, 0);
+  return date_;
 }
+
+/* eslint-enable */

package/src/date-fns/startOfMonth/index.ts

@@ -1,4 +1,14 @@
-import { toDate } from '../toDate/index';
+/* eslint-disable eslint-comments/no-unlimited-disable */
+/* eslint-disable */
+// @ts-nocheck
+
+import { toDate } from '../toDate/index.ts';
+import type { ContextOptions, DateArg } from '../types.ts';
+
+/**
+ * The {@link startOfMonth} function options.
+ */
+export interface StartOfMonthOptions<ResultDate extends Date> extends ContextOptions<ResultDate> {}
 
 /**
  * @name startOfMonth
@@ -6,12 +16,15 @@ import { toDate } from '../toDate/index';
  * @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
  *
@@ -20,9 +33,14 @@ import { toDate } from '../toDate/index';
  * const result = startOfMonth(new Date(2014, 8, 2, 11, 55, 0))
  * //=> Mon Sep 01 2014 00:00:00
  */
-export function startOfMonth<DateType extends Date>(date: DateType | number | string): DateType {
-  const _date = toDate(date);
+export function startOfMonth<DateType extends Date, ResultDate extends Date = DateType>(
+  date: DateArg<DateType>,
+  options?: StartOfMonthOptions<ResultDate> | undefined,
+): ResultDate {
+  const _date = toDate(date, options?.in);
   _date.setDate(1);
   _date.setHours(0, 0, 0, 0);
   return _date;
 }
+
+/* eslint-enable */

package/src/date-fns/startOfQuarter/index.ts

@@ -1,4 +1,14 @@
-import { toDate } from '../toDate/index';
+/* eslint-disable eslint-comments/no-unlimited-disable */
+/* eslint-disable */
+// @ts-nocheck
+
+import { toDate } from '../toDate/index.ts';
+import type { ContextOptions, DateArg } from '../types.ts';
+
+/**
+ * The {@link startOfQuarter} function options.
+ */
+export interface StartOfQuarterOptions<DateType extends Date = Date> extends ContextOptions<DateType> {}
 
 /**
  * @name startOfQuarter
@@ -10,8 +20,10 @@ import { toDate } from '../toDate/index';
  * 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
  *
@@ -20,11 +32,16 @@ import { toDate } from '../toDate/index';
  * const result = startOfQuarter(new Date(2014, 8, 2, 11, 55, 0))
  * //=> Tue Jul 01 2014 00:00:00
  */
-export function startOfQuarter<DateType extends Date>(date: DateType | number | string): DateType {
-  const _date = toDate(date);
+export function startOfQuarter<DateType extends Date, ResultDate extends Date = DateType>(
+  date: DateArg<DateType>,
+  options?: StartOfQuarterOptions<ResultDate> | undefined,
+): ResultDate {
+  const _date = toDate(date, options?.in);
   const currentMonth = _date.getMonth();
   const month = currentMonth - (currentMonth % 3);
   _date.setMonth(month, 1);
   _date.setHours(0, 0, 0, 0);
   return _date;
 }
+
+/* eslint-enable */

package/src/date-fns/startOfSecond/index.ts

@@ -1,4 +1,14 @@
-import { toDate } from '../toDate/index';
+/* eslint-disable eslint-comments/no-unlimited-disable */
+/* eslint-disable */
+// @ts-nocheck
+
+import { toDate } from '../toDate/index.ts';
+import type { DateArg, ContextOptions } from '../types.ts';
+
+/**
+ * The {@link startOfSecond} function options.
+ */
+export interface StartOfSecondOptions<DateType extends Date = Date> extends ContextOptions<DateType> {}
 
 /**
  * @name startOfSecond
@@ -10,8 +20,10 @@ import { toDate } from '../toDate/index';
  * 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
  *
@@ -20,8 +32,13 @@ import { toDate } from '../toDate/index';
  * const result = startOfSecond(new Date(2014, 11, 1, 22, 15, 45, 400))
  * //=> Mon Dec 01 2014 22:15:45.000
  */
-export function startOfSecond<DateType extends Date>(date: DateType | number | string): DateType {
-  const _date = toDate(date);
-  _date.setMilliseconds(0);
-  return _date;
+export function startOfSecond<DateType extends Date, ResultDate extends Date = DateType>(
+  date: DateArg<DateType>,
+  options?: StartOfSecondOptions<ResultDate> | undefined,
+): ResultDate {
+  const date_ = toDate(date, options?.in);
+  date_.setMilliseconds(0);
+  return date_;
 }
+
+/* eslint-enable */

package/src/date-fns/startOfToday/index.ts

@@ -1,4 +1,14 @@
-import { startOfDay } from '../startOfDay/index';
+/* eslint-disable eslint-comments/no-unlimited-disable */
+/* eslint-disable */
+// @ts-nocheck
+
+import { startOfDay } from '../startOfDay/index.ts';
+import type { ContextOptions } from '../types.ts';
+
+/**
+ * The {@link startOfToday} function options.
+ */
+export interface StartOfTodayOptions<DateType extends Date = Date> extends ContextOptions<DateType> {}
 
 /**
  * @name startOfToday
@@ -9,6 +19,10 @@ import { startOfDay } from '../startOfDay/index';
  * @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
@@ -16,6 +30,10 @@ import { startOfDay } from '../startOfDay/index';
  * const result = startOfToday()
  * //=> Mon Oct 6 2014 00:00:00
  */
-export function startOfToday(): Date {
-  return startOfDay(Date.now());
+export function startOfToday<ContextDate extends Date>(
+  options?: StartOfTodayOptions<ContextDate> | undefined,
+): ContextDate {
+  return startOfDay(Date.now(), options);
 }
+
+/* eslint-enable */

package/src/date-fns/startOfTomorrow/index.ts

@@ -1,27 +1,48 @@
+/* eslint-disable eslint-comments/no-unlimited-disable */
+/* eslint-disable */
+// @ts-nocheck
+
+import { constructFrom } from '../constructFrom/index.ts';
+import { constructNow } from '../constructNow/index.ts';
+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 function startOfTomorrow(): Date {
-  const now = new Date();
+export function startOfTomorrow<ContextDate extends Date>(
+  options?: StartOfTomorrowOptions<ContextDate> | undefined,
+): ContextDate {
+  const now = constructNow(options?.in);
   const year = now.getFullYear();
   const month = now.getMonth();
   const day = now.getDate();
 
-  const date = new Date(0);
+  const date = constructFrom(options?.in, 0);
   date.setFullYear(year, month, day + 1);
   date.setHours(0, 0, 0, 0);
   return date;
 }
+
+/* eslint-enable */

package/src/date-fns/startOfWeek/index.ts

@@ -1,11 +1,18 @@
-import { toDate } from '../toDate/index';
-import type { LocalizedOptions, WeekOptions } from '../types';
-import { getDefaultOptions } from '../_lib/defaultOptions/index';
+/* eslint-disable eslint-comments/no-unlimited-disable */
+/* eslint-disable */
+// @ts-nocheck
+
+import { getDefaultOptions } from '../_lib/defaultOptions/index.ts';
+import { toDate } from '../toDate/index.ts';
+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
@@ -17,6 +24,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
@@ -33,10 +41,10 @@ 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 function startOfWeek<DateType extends Date>(
-  date: DateType | number | string,
-  options?: StartOfWeekOptions,
-): DateType {
+export function startOfWeek<DateType extends Date, ResultDate extends Date = DateType>(
+  date: DateArg<DateType>,
+  options?: StartOfWeekOptions<ResultDate>,
+): ResultDate {
   const defaultOptions = getDefaultOptions();
   const weekStartsOn =
     options?.weekStartsOn ??
@@ -45,7 +53,7 @@ export function startOfWeek<DateType extends Date>(
     defaultOptions.locale?.options?.weekStartsOn ??
     0;
 
-  const _date = toDate(date);
+  const _date = toDate(date, options?.in);
   const day = _date.getDay();
   const diff = (day < weekStartsOn ? 7 : 0) + day - weekStartsOn;
 
@@ -53,3 +61,5 @@ export function startOfWeek<DateType extends Date>(
   _date.setHours(0, 0, 0, 0);
   return _date;
 }
+
+/* eslint-enable */

package/src/date-fns/startOfWeekYear/index.ts

@@ -1,16 +1,21 @@
-import { constructFrom } from '../constructFrom/index';
-import { getWeekYear } from '../getWeekYear/index';
-import { startOfWeek } from '../startOfWeek/index';
-import type { FirstWeekContainsDateOptions, LocalizedOptions, WeekOptions } from '../types';
-import { getDefaultOptions } from '../_lib/defaultOptions/index';
+/* eslint-disable eslint-comments/no-unlimited-disable */
+/* eslint-disable */
+// @ts-nocheck
+
+import { getDefaultOptions } from '../_lib/defaultOptions/index.ts';
+import { constructFrom } from '../constructFrom/index.ts';
+import { getWeekYear } from '../getWeekYear/index.ts';
+import { startOfWeek } from '../startOfWeek/index.ts';
+import type { ContextOptions, DateArg, FirstWeekContainsDateOptions, LocalizedOptions, WeekOptions } from '../types.ts';
 
 /**
  * The {@link startOfWeekYear} function options.
  */
-export interface StartOfWeekYearOptions
+export interface StartOfWeekYearOptions<DateType extends Date = Date>
   extends LocalizedOptions<'options'>,
     FirstWeekContainsDateOptions,
-    WeekOptions {}
+    WeekOptions,
+    ContextOptions<DateType> {}
 
 /**
  * @name startOfWeekYear
@@ -27,6 +32,7 @@ export interface StartOfWeekYearOptions
  * 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
@@ -48,10 +54,10 @@ export interface StartOfWeekYearOptions
  * })
  * //=> Mon Jan 03 2005 00:00:00
  */
-export function startOfWeekYear<DateType extends Date>(
-  date: DateType | number | string,
-  options?: StartOfWeekYearOptions,
-): DateType {
+export function startOfWeekYear<DateType extends Date, ResultDate extends Date = DateType>(
+  date: DateArg<DateType>,
+  options?: StartOfWeekYearOptions<ResultDate>,
+): ResultDate {
   const defaultOptions = getDefaultOptions();
   const firstWeekContainsDate =
     options?.firstWeekContainsDate ??
@@ -61,9 +67,11 @@ export function startOfWeekYear<DateType extends Date>(
     1;
 
   const year = getWeekYear(date, options);
-  const firstWeek = constructFrom(date, 0);
+  const firstWeek = constructFrom(options?.in || date, 0);
   firstWeek.setFullYear(year, 0, firstWeekContainsDate);
   firstWeek.setHours(0, 0, 0, 0);
   const _date = startOfWeek(firstWeek, options);
   return _date;
 }
+
+/* eslint-enable */

package/src/date-fns/startOfYear/index.ts

@@ -1,5 +1,14 @@
-import { toDate } from '../toDate/index';
-import { constructFrom } from '../constructFrom/index';
+/* eslint-disable eslint-comments/no-unlimited-disable */
+/* eslint-disable */
+// @ts-nocheck
+
+import { toDate } from '../toDate/index.ts';
+import type { ContextOptions, DateArg } from '../types.ts';
+
+/**
+ * The {@link startOfYear} function options.
+ */
+export interface StartOfYearOptions<DateType extends Date = Date> extends ContextOptions<DateType> {}
 
 /**
  * @name startOfYear
@@ -11,8 +20,10 @@ import { constructFrom } from '../constructFrom/index';
  * 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
  *
@@ -21,10 +32,14 @@ import { constructFrom } from '../constructFrom/index';
  * const result = startOfYear(new Date(2014, 8, 2, 11, 55, 00))
  * //=> Wed Jan 01 2014 00:00:00
  */
-export function startOfYear<DateType extends Date>(date: DateType | number | string): DateType {
-  const cleanDate = toDate(date);
-  const _date = constructFrom(date, 0);
-  _date.setFullYear(cleanDate.getFullYear(), 0, 1);
-  _date.setHours(0, 0, 0, 0);
-  return _date;
+export function startOfYear<DateType extends Date, ResultDate extends Date = DateType>(
+  date: DateArg<DateType>,
+  options?: StartOfYearOptions<ResultDate> | undefined,
+): ResultDate {
+  const date_ = toDate(date, options?.in);
+  date_.setFullYear(date_.getFullYear(), 0, 1);
+  date_.setHours(0, 0, 0, 0);
+  return date_;
 }
+
+/* eslint-enable */

package/src/date-fns/startOfYesterday/index.ts

@@ -1,9 +1,25 @@
+/* eslint-disable eslint-comments/no-unlimited-disable */
+/* eslint-disable */
+// @ts-nocheck
+
+import { constructNow } from '../constructNow/index.ts';
+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,14 +30,18 @@
  * const result = startOfYesterday()
  * //=> Sun Oct 5 2014 00:00:00
  */
-export function startOfYesterday(): Date {
-  const now = new Date();
+export function startOfYesterday<ContextDate extends Date>(
+  options?: StartOfYesterdayOptions<ContextDate> | undefined,
+): ContextDate {
+  const now = constructNow(options?.in);
   const year = now.getFullYear();
   const month = now.getMonth();
   const day = now.getDate();
 
-  const date = new Date(0);
+  const date = constructNow(options?.in);
   date.setFullYear(year, month, day - 1);
   date.setHours(0, 0, 0, 0);
   return date;
 }
+
+/* eslint-enable */

package/src/date-fns/sub/index.ts

@@ -1,7 +1,16 @@
-import { subDays } from '../subDays/index';
-import { subMonths } from '../subMonths/index';
-import type { Duration } from '../types';
-import { constructFrom } from '../constructFrom/index';
+/* eslint-disable eslint-comments/no-unlimited-disable */
+/* eslint-disable */
+// @ts-nocheck
+
+import { constructFrom } from '../constructFrom/index.ts';
+import { subDays } from '../subDays/index.ts';
+import { subMonths } from '../subMonths/index.ts';
+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
@@ -12,9 +21,11 @@ import { constructFrom } from '../constructFrom/index';
  * 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                        |
  * |---------|------------------------------------|
@@ -43,20 +54,21 @@ import { constructFrom } from '../constructFrom/index';
  * })
  * //=> Mon Sep 1 2014 10:19:50
  */
-export function sub<DateType extends Date>(date: DateType | number | string, duration: Duration): DateType {
+export function sub<DateType extends Date, ResultDate extends Date = DateType>(
+  date: DateArg<DateType>,
+  duration: Duration,
+  options?: SubOptions<ResultDate>,
+): ResultDate {
   const { years = 0, months = 0, weeks = 0, days = 0, hours = 0, minutes = 0, seconds = 0 } = duration;
 
-  // Subtract years and months
-  const dateWithoutMonths = subMonths(date, months + years * 12);
-
-  // Subtract weeks and days
-  const dateWithoutDays = subDays(dateWithoutMonths, days + weeks * 7);
+  const withoutMonths = subMonths(date, months + years * 12, options);
+  const withoutDays = subDays(withoutMonths, days + weeks * 7, options);
 
-  // Subtract hours, minutes and seconds
-  const minutestoSub = minutes + hours * 60;
-  const secondstoSub = seconds + minutestoSub * 60;
-  const mstoSub = secondstoSub * 1000;
-  const finalDate = constructFrom(date, dateWithoutDays.getTime() - mstoSub);
+  const minutesToSub = minutes + hours * 60;
+  const secondsToSub = seconds + minutesToSub * 60;
+  const msToSub = secondsToSub * 1000;
 
-  return finalDate;
+  return constructFrom(options?.in || date, +withoutDays - msToSub);
 }
+
+/* eslint-enable */