luigi12345's picture
08dfd9a55efbd9271021c5a6a797817f380dec2cad965ad37baa82eb841ae914
05323e3 verified
raw
history blame
896 Bytes
"use strict";
exports.addQuarters = addQuarters;
var _index = require("./addMonths.js");
/**
* @name addQuarters
* @category Quarter Helpers
* @summary Add the specified number of year quarters to the given date.
*
* @description
* Add the specified number of year quarters to the given date.
*
* @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
*
* @param date - The date to be changed
* @param amount - The amount of quarters to be added.
*
* @returns The new date with the quarters added
*
* @example
* // Add 1 quarter to 1 September 2014:
* const result = addQuarters(new Date(2014, 8, 1), 1)
* //=> Mon Dec 01 2014 00:00:00
*/
function addQuarters(date, amount) {
const months = amount * 3;
return (0, _index.addMonths)(date, months);
}