123456789101112131415161718192021222324252627282930313233343536 |
- import { addISOWeekYears } from "./addISOWeekYears.js";
- /**
- * The {@link subISOWeekYears} function options.
- */
- /**
- * @name subISOWeekYears
- * @category ISO Week-Numbering Year Helpers
- * @summary Subtract the specified number of ISO week-numbering years from the given date.
- *
- * @description
- * Subtract the specified number of ISO week-numbering years from the given date.
- *
- * 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
- *
- * @example
- * // Subtract 5 ISO week-numbering years from 1 September 2014:
- * const result = subISOWeekYears(new Date(2014, 8, 1), 5)
- * //=> Mon Aug 31 2009 00:00:00
- */
- export function subISOWeekYears(date, amount, options) {
- return addISOWeekYears(date, -amount, options);
- }
- // Fallback for modularized imports:
- export default subISOWeekYears;
|