31 lines
897 B
TypeScript
31 lines
897 B
TypeScript
|
import type { ContextOptions, DateArg } from "./types.js";
|
||
|
|
/**
|
||
|
|
* The {@link isThisISOWeek} function options.
|
||
|
|
*/
|
||
|
|
export interface IsThisISOWeekOptions extends ContextOptions<Date> {}
|
||
|
|
/**
|
||
|
|
* @name isThisISOWeek
|
||
|
|
* @category ISO Week Helpers
|
||
|
|
* @summary Is the given date in the same ISO week as the current date?
|
||
|
|
* @pure false
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* Is the given date in the same ISO week as the current date?
|
||
|
|
*
|
||
|
|
* ISO week-numbering year: http://en.wikipedia.org/wiki/ISO_week_date
|
||
|
|
*
|
||
|
|
* @param date - The date to check
|
||
|
|
* @param options - An object with options
|
||
|
|
*
|
||
|
|
* @returns The date is in this ISO week
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // If today is 25 September 2014, is 22 September 2014 in this ISO week?
|
||
|
|
* const result = isThisISOWeek(new Date(2014, 8, 22))
|
||
|
|
* //=> true
|
||
|
|
*/
|
||
|
|
export declare function isThisISOWeek(
|
||
|
|
date: DateArg<Date> & {},
|
||
|
|
options?: IsThisISOWeekOptions | undefined,
|
||
|
|
): boolean;
|