33 lines
1.2 KiB
JavaScript
33 lines
1.2 KiB
JavaScript
|
import toDate from "../toDate/index.js";
|
||
|
|
import requiredArgs from "../_lib/requiredArgs/index.js";
|
||
|
|
/**
|
||
|
|
* @name lastDayOfQuarter
|
||
|
|
* @category Quarter Helpers
|
||
|
|
* @summary Return the last day of a year quarter for the given date.
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* Return the last day of a year quarter for the given date.
|
||
|
|
* The result will be in the local timezone.
|
||
|
|
*
|
||
|
|
* @param {Date|Number} date - the original date
|
||
|
|
* @param {Object} [options] - an object with options.
|
||
|
|
* @param {0|1|2} [options.additionalDigits=2] - passed to `toDate`. See [toDate]{@link https://date-fns.org/docs/toDate}
|
||
|
|
* @returns {Date} the last day of a quarter
|
||
|
|
* @throws {TypeError} 1 argument required
|
||
|
|
* @throws {RangeError} `options.additionalDigits` must be 0, 1 or 2
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // The last day of a quarter for 2 September 2014 11:55:00:
|
||
|
|
* const result = lastDayOfQuarter(new Date(2014, 8, 2, 11, 55, 0))
|
||
|
|
* //=> Tue Sep 30 2014 00:00:00
|
||
|
|
*/
|
||
|
|
|
||
|
|
export default function lastDayOfQuarter(dirtyDate) {
|
||
|
|
requiredArgs(1, arguments);
|
||
|
|
var date = toDate(dirtyDate);
|
||
|
|
var currentMonth = date.getMonth();
|
||
|
|
var month = currentMonth - currentMonth % 3 + 3;
|
||
|
|
date.setMonth(month, 0);
|
||
|
|
date.setHours(0, 0, 0, 0);
|
||
|
|
return date;
|
||
|
|
}
|