diff options
Diffstat (limited to 'date-fns/src/lastDayOfQuarter/index.ts')
-rw-r--r-- | date-fns/src/lastDayOfQuarter/index.ts | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/date-fns/src/lastDayOfQuarter/index.ts b/date-fns/src/lastDayOfQuarter/index.ts new file mode 100644 index 0000000..578cf12 --- /dev/null +++ b/date-fns/src/lastDayOfQuarter/index.ts @@ -0,0 +1,38 @@ +import toDate from '../toDate/index' +import requiredArgs from '../_lib/requiredArgs/index' + +/** + * @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. + * + * ### 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 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: + * var result = lastDayOfQuarter(new Date(2014, 8, 2, 11, 55, 0)) + * //=> Tue Sep 30 2014 00:00:00 + */ +export default function lastDayOfQuarter(dirtyDate: Date | number): Date { + requiredArgs(1, arguments) + + const date = toDate(dirtyDate) + const currentMonth = date.getMonth() + const month = currentMonth - (currentMonth % 3) + 3 + date.setMonth(month, 0) + date.setHours(0, 0, 0, 0) + return date +} |