23 lines
604 B
TypeScript
23 lines
604 B
TypeScript
|
/**
|
||
|
|
* @name getYear
|
||
|
|
* @category Year Helpers
|
||
|
|
* @summary Get the year of the given date.
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* Get the year of 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 given date
|
||
|
|
*
|
||
|
|
* @returns The year
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // Which year is 2 July 2014?
|
||
|
|
* const result = getYear(new Date(2014, 6, 2))
|
||
|
|
* //=> 2014
|
||
|
|
*/
|
||
|
|
export declare function getYear<DateType extends Date>(
|
||
|
|
date: DateType | number | string,
|
||
|
|
): number;
|