| 1234567891011121314151617181920212223242526272829303132 |
- import { toDate } from "./toDate.mjs";
- /**
- * @name endOfYear
- * @category Year Helpers
- * @summary Return the end of a year for the given date.
- *
- * @description
- * Return the end of a year 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).
- *
- * @param date - The original date
- *
- * @returns The end of a year
- *
- * @example
- * // The end of a year for 2 September 2014 11:55:00:
- * const result = endOfYear(new Date(2014, 8, 2, 11, 55, 00))
- * //=> Wed Dec 31 2014 23:59:59.999
- */
- export function endOfYear(date) {
- const _date = toDate(date);
- const year = _date.getFullYear();
- _date.setFullYear(year + 1, 0, 0);
- _date.setHours(23, 59, 59, 999);
- return _date;
- }
- // Fallback for modularized imports:
- export default endOfYear;
|