25 lines
858 B
TypeScript
25 lines
858 B
TypeScript
|
/**
|
||
|
|
* @name getISOWeeksInYear
|
||
|
|
* @category ISO Week-Numbering Year Helpers
|
||
|
|
* @summary Get the number of weeks in an ISO week-numbering year of the given date.
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* Get the number of weeks in an ISO week-numbering year of the given date.
|
||
|
|
*
|
||
|
|
* 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 number of ISO weeks in a year
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // How many weeks are in ISO week-numbering year 2015?
|
||
|
|
* const result = getISOWeeksInYear(new Date(2015, 1, 11))
|
||
|
|
* //=> 53
|
||
|
|
*/
|
||
|
|
export declare function getISOWeeksInYear<DateType extends Date>(
|
||
|
|
date: DateType | number | string,
|
||
|
|
): number;
|