timepiece/node_modules/date-fns/isFriday.d.ts

23 lines
615 B
TypeScript
Raw Normal View History

2024-05-14 14:54:12 +00:00
/**
* @name isFriday
* @category Weekday Helpers
* @summary Is the given date Friday?
*
* @description
* Is the given date Friday?
*
* @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 is Friday
*
* @example
* // Is 26 September 2014 Friday?
* const result = isFriday(new Date(2014, 8, 26))
* //=> true
*/
export declare function isFriday<DateType extends Date>(
date: DateType | number | string,
): boolean;