UNPKG

615 BTypeScriptView Raw
1/**
2 * @name isFriday
3 * @category Weekday Helpers
4 * @summary Is the given date Friday?
5 *
6 * @description
7 * Is the given date Friday?
8 *
9 * @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).
10 *
11 * @param date - The date to check
12 *
13 * @returns The date is Friday
14 *
15 * @example
16 * // Is 26 September 2014 Friday?
17 * const result = isFriday(new Date(2014, 8, 26))
18 * //=> true
19 */
20export declare function isFriday<DateType extends Date>(
21 date: DateType | number | string,
22): boolean;