45 lines
1.4 KiB
JavaScript
45 lines
1.4 KiB
JavaScript
|
"use strict";
|
||
|
|
|
||
|
|
Object.defineProperty(exports, "__esModule", {
|
||
|
|
value: true
|
||
|
|
});
|
||
|
|
exports.default = subYears;
|
||
|
|
|
||
|
|
var _index = _interopRequireDefault(require("../_lib/toInteger/index.js"));
|
||
|
|
|
||
|
|
var _index2 = _interopRequireDefault(require("../addYears/index.js"));
|
||
|
|
|
||
|
|
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @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.
|
||
|
|
*
|
||
|
|
* ### 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 years to be subtracted
|
||
|
|
* @returns {Date} the new date with the years subtracted
|
||
|
|
* @throws {TypeError} 2 arguments required
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // Subtract 5 years from 1 September 2014:
|
||
|
|
* var result = subYears(new Date(2014, 8, 1), 5)
|
||
|
|
* //=> Tue Sep 01 2009 00:00:00
|
||
|
|
*/
|
||
|
|
function subYears(dirtyDate, dirtyAmount) {
|
||
|
|
if (arguments.length < 2) {
|
||
|
|
throw new TypeError('2 arguments required, but only ' + arguments.length + ' present');
|
||
|
|
}
|
||
|
|
|
||
|
|
var amount = (0, _index.default)(dirtyAmount);
|
||
|
|
return (0, _index2.default)(dirtyDate, -amount);
|
||
|
|
}
|
||
|
|
|
||
|
|
module.exports = exports.default;
|