30 lines
928 B
TypeScript
30 lines
928 B
TypeScript
|
import type { ContextOptions, DateArg } from "./types.js";
|
||
|
|
/**
|
||
|
|
* The {@link getISOWeeksInYear} function options.
|
||
|
|
*/
|
||
|
|
export interface GetISOWeeksInYearOptions extends ContextOptions<Date> {}
|
||
|
|
/**
|
||
|
|
* @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
|
||
|
|
*
|
||
|
|
* @param date - The given date
|
||
|
|
* @param options - An object with options
|
||
|
|
*
|
||
|
|
* @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(
|
||
|
|
date: DateArg<Date> & {},
|
||
|
|
options?: GetISOWeeksInYearOptions | undefined,
|
||
|
|
): number;
|