1234567891011121314151617181920212223242526 |
- import toInteger from "../_lib/toInteger/index.js";
- import addMonths from "../addMonths/index.js";
- import requiredArgs from "../_lib/requiredArgs/index.js";
- /**
- * @name subMonths
- * @category Month Helpers
- * @summary Subtract the specified number of months from the given date.
- *
- * @description
- * Subtract the specified number of months from the given date.
- *
- * @param {Date|Number} date - the date to be changed
- * @param {Number} amount - the amount of months 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 months subtracted
- * @throws {TypeError} 2 arguments required
- *
- * @example
- * // Subtract 5 months from 1 February 2015:
- * const result = subMonths(new Date(2015, 1, 1), 5)
- * //=> Mon Sep 01 2014 00:00:00
- */
- export default function subMonths(dirtyDate, dirtyAmount) {
- requiredArgs(2, arguments);
- var amount = toInteger(dirtyAmount);
- return addMonths(dirtyDate, -amount);
- }
|