diff options
Diffstat (limited to 'node_modules/date-fns/esm/subYears/index.js')
| -rw-r--r-- | node_modules/date-fns/esm/subYears/index.js | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/node_modules/date-fns/esm/subYears/index.js b/node_modules/date-fns/esm/subYears/index.js new file mode 100644 index 0000000..80ee3e2 --- /dev/null +++ b/node_modules/date-fns/esm/subYears/index.js @@ -0,0 +1,26 @@ +import toInteger from "../_lib/toInteger/index.js"; +import addYears from "../addYears/index.js"; +import requiredArgs from "../_lib/requiredArgs/index.js"; +/** + * @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. + * + * @param {Date|Number} date - the date to be changed + * @param {Number} amount - the amount of years to be subtracted. Positive decimals will be rounded using `Math.floor`, decimals less than zero will be rounded using `Math.ceil`. + * @returns {Date} the new date with the years subtracted + * @throws {TypeError} 2 arguments required + * + * @example + * // Subtract 5 years from 1 September 2014: + * const result = subYears(new Date(2014, 8, 1), 5) + * //=> Tue Sep 01 2009 00:00:00 + */ +export default function subYears(dirtyDate, dirtyAmount) { + requiredArgs(2, arguments); + var amount = toInteger(dirtyAmount); + return addYears(dirtyDate, -amount); +}
\ No newline at end of file |