123456789101112131415161718192021222324252627282930313233 |
- "use strict";
- exports.subYears = subYears;
- var _index = require("./addYears.cjs");
- /**
- * The {@link subYears} function options.
- */
- /**
- * @name subYears
- * @category Year Helpers
- * @summary Subtract the specified number of years from the given date.
- *
- * @description
- * Subtract the specified number of years 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 years to be subtracted.
- * @param options - An object with options
- *
- * @returns The new date with the years subtracted
- *
- * @example
- * // Subtract 5 years from 1 September 2014:
- * const result = subYears(new Date(2014, 8, 1), 5)
- * //=> Tue Sep 01 2009 00:00:00
- */
- function subYears(date, amount, options) {
- return (0, _index.addYears)(date, -amount, options);
- }
|