timepiece/node_modules/date-fns/endOfDecade.d.ts

23 lines
716 B
TypeScript
Raw Normal View History

2024-05-14 14:54:12 +00:00
/**
* @name endOfDecade
* @category Decade Helpers
* @summary Return the end of a decade for the given date.
*
* @description
* Return the end of a decade for 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 original date
*
* @returns The end of a decade
*
* @example
* // The end of a decade for 12 May 1984 00:00:00:
* const result = endOfDecade(new Date(1984, 4, 12, 00, 00, 00))
* //=> Dec 31 1989 23:59:59.999
*/
export declare function endOfDecade<DateType extends Date>(
date: DateType | number | string,
): DateType;