26 lines
861 B
TypeScript
26 lines
861 B
TypeScript
/**
|
|
* @name getISOWeekYear
|
|
* @category ISO Week-Numbering Year Helpers
|
|
* @summary Get the ISO week-numbering year of the given date.
|
|
*
|
|
* @description
|
|
* Get the ISO week-numbering year of the given date,
|
|
* which always starts 3 days before the year's first Thursday.
|
|
*
|
|
* ISO week-numbering year: http://en.wikipedia.org/wiki/ISO_week_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 ISO week-numbering year
|
|
*
|
|
* @example
|
|
* // Which ISO-week numbering year is 2 January 2005?
|
|
* const result = getISOWeekYear(new Date(2005, 0, 2))
|
|
* //=> 2004
|
|
*/
|
|
export declare function getISOWeekYear<DateType extends Date>(
|
|
date: DateType | number | string,
|
|
): number;
|