33 lines
1.1 KiB
JavaScript
33 lines
1.1 KiB
JavaScript
|
import toInteger from '../_lib/toInteger/index.js';
|
||
|
|
import addMonths from '../addMonths/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.
|
||
|
|
*
|
||
|
|
* ### v2.0.0 breaking changes:
|
||
|
|
*
|
||
|
|
* - [Changes that are common for the whole library](https://github.com/date-fns/date-fns/blob/master/docs/upgradeGuide.md#Common-Changes).
|
||
|
|
*
|
||
|
|
* @param {Date|Number} date - the date to be changed
|
||
|
|
* @param {Number} amount - the amount of months to be subtracted
|
||
|
|
* @returns {Date} the new date with the months subtracted
|
||
|
|
* @throws {TypeError} 2 arguments required
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // Subtract 5 months from 1 February 2015:
|
||
|
|
* var result = subMonths(new Date(2015, 1, 1), 5)
|
||
|
|
* //=> Mon Sep 01 2014 00:00:00
|
||
|
|
*/
|
||
|
|
|
||
|
|
export default function subMonths(dirtyDate, dirtyAmount) {
|
||
|
|
if (arguments.length < 2) {
|
||
|
|
throw new TypeError('2 arguments required, but only ' + arguments.length + ' present');
|
||
|
|
}
|
||
|
|
|
||
|
|
var amount = toInteger(dirtyAmount);
|
||
|
|
return addMonths(dirtyDate, -amount);
|
||
|
|
}
|