23 lines
730 B
TypeScript
23 lines
730 B
TypeScript
|
/**
|
||
|
|
* @name startOfDecade
|
||
|
|
* @category Decade Helpers
|
||
|
|
* @summary Return the start of a decade for the given date.
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* Return the start 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 start of a decade
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // The start of a decade for 21 October 2015 00:00:00:
|
||
|
|
* const result = startOfDecade(new Date(2015, 9, 21, 00, 00, 00))
|
||
|
|
* //=> Jan 01 2010 00:00:00
|
||
|
|
*/
|
||
|
|
export declare function startOfDecade<DateType extends Date>(
|
||
|
|
date: DateType | number | string,
|
||
|
|
): DateType;
|