registration

This commit is contained in:
User
2025-02-02 16:08:03 +03:00
parent 7f6495eb4d
commit 78afbaed71
6334 changed files with 196774 additions and 165754 deletions

View File

@@ -1,14 +1,18 @@
import type { ContextOptions, DateArg } from "./types.js";
/**
* The {@link isWeekend} function options.
*/
export interface IsWeekendOptions extends ContextOptions<Date> {}
/**
* @name isWeekend
* @category Weekday Helpers
* @summary Does the given date fall on a weekend?
*
* @description
* Does the given date fall on a weekend?
*
* @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).
* Does the given date fall on a weekend? A weekend is either Saturday (`6`) or Sunday (`0`).
*
* @param date - The date to check
* @param options - An object with options
*
* @returns The date falls on a weekend
*
@@ -17,6 +21,7 @@
* const result = isWeekend(new Date(2014, 9, 5))
* //=> true
*/
export declare function isWeekend<DateType extends Date>(
date: DateType | number | string,
export declare function isWeekend(
date: DateArg<Date> & {},
options?: IsWeekendOptions | undefined,
): boolean;