12345678910111213141516171819202122232425262728293031323334353637 |
- "use strict";
- exports.endOfMonth = endOfMonth;
- var _index = require("./toDate.cjs");
- /**
- * The {@link endOfMonth} function options.
- */
- /**
- * @name endOfMonth
- * @category Month Helpers
- * @summary Return the end of a month for the given date.
- *
- * @description
- * Return the end of a month for the given date.
- * The result will be in the local timezone.
- *
- * @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).
- * @typeParam ResultDate - The result `Date` type, it is the type returned from the context function if it is passed, or inferred from the arguments.
- *
- * @param date - The original date
- * @param options - An object with options
- *
- * @returns The end of a month
- *
- * @example
- * // The end of a month for 2 September 2014 11:55:00:
- * const result = endOfMonth(new Date(2014, 8, 2, 11, 55, 0))
- * //=> Tue Sep 30 2014 23:59:59.999
- */
- function endOfMonth(date, options) {
- const _date = (0, _index.toDate)(date, options?.in);
- const month = _date.getMonth();
- _date.setFullYear(_date.getFullYear(), month + 1, 0);
- _date.setHours(23, 59, 59, 999);
- return _date;
- }
|