25 lines
649 B
TypeScript
25 lines
649 B
TypeScript
|
import type { ContextOptions, DateArg } from "./types.js";
|
||
|
|
export interface IsLeapYearOptions extends ContextOptions<Date> {}
|
||
|
|
/**
|
||
|
|
* @name isLeapYear
|
||
|
|
* @category Year Helpers
|
||
|
|
* @summary Is the given date in the leap year?
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* Is the given date in the leap year?
|
||
|
|
*
|
||
|
|
* @param date - The date to check
|
||
|
|
* @param options - The options object
|
||
|
|
*
|
||
|
|
* @returns The date is in the leap year
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // Is 1 September 2012 in the leap year?
|
||
|
|
* const result = isLeapYear(new Date(2012, 8, 1))
|
||
|
|
* //=> true
|
||
|
|
*/
|
||
|
|
export declare function isLeapYear(
|
||
|
|
date: DateArg<Date> & {},
|
||
|
|
options?: IsLeapYearOptions | undefined,
|
||
|
|
): boolean;
|