24 lines
763 B
TypeScript
24 lines
763 B
TypeScript
|
/**
|
||
|
|
* @name startOfYear
|
||
|
|
* @category Year Helpers
|
||
|
|
* @summary Return the start of a year for the given date.
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* Return the start 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 start of a year
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // The start of a year for 2 September 2014 11:55:00:
|
||
|
|
* const result = startOfYear(new Date(2014, 8, 2, 11, 55, 00))
|
||
|
|
* //=> Wed Jan 01 2014 00:00:00
|
||
|
|
*/
|
||
|
|
export declare function startOfYear<DateType extends Date>(
|
||
|
|
date: DateType | number | string,
|
||
|
|
): DateType;
|