23 lines
754 B
TypeScript
23 lines
754 B
TypeScript
/**
|
|
* @name lastDayOfDecade
|
|
* @category Decade Helpers
|
|
* @summary Return the last day of a decade for the given date.
|
|
*
|
|
* @description
|
|
* Return the last day 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 last day of a decade
|
|
*
|
|
* @example
|
|
* // The last day of a decade for 21 December 2012 21:12:00:
|
|
* const result = lastDayOfDecade(new Date(2012, 11, 21, 21, 12, 00))
|
|
* //=> Wed Dec 31 2019 00:00:00
|
|
*/
|
|
export declare function lastDayOfDecade<DateType extends Date>(
|
|
date: DateType | number | string,
|
|
): DateType;
|