timepiece/node_modules/date-fns/isWeekend.d.mts

23 lines
662 B
TypeScript
Raw Normal View History

2024-05-14 14:54:12 +00:00
/**
* @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).
*
* @param date - The date to check
*
* @returns The date falls on a weekend
*
* @example
* // Does 5 October 2014 fall on a weekend?
* const result = isWeekend(new Date(2014, 9, 5))
* //=> true
*/
export declare function isWeekend<DateType extends Date>(
date: DateType | number | string,
): boolean;