mirror of https://github.com/lukechilds/docs.git
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
25 lines
726 B
25 lines
726 B
6 years ago
|
var addMonths = require('../add_months/index.js')
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @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|String|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
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // Subtract 5 months from 1 February 2015:
|
||
|
|
* var result = subMonths(new Date(2015, 1, 1), 5)
|
||
|
|
* //=> Mon Sep 01 2014 00:00:00
|
||
|
|
*/
|
||
|
|
function subMonths (dirtyDate, dirtyAmount) {
|
||
|
|
var amount = Number(dirtyAmount)
|
||
|
|
return addMonths(dirtyDate, -amount)
|
||
|
|
}
|
||
|
|
|
||
|
|
module.exports = subMonths
|