28 lines
658 B
TypeScript
28 lines
658 B
TypeScript
|
import type { ContextOptions, DateArg } from "./types.js";
|
||
|
|
/**
|
||
|
|
* The {@link isFriday} function options.
|
||
|
|
*/
|
||
|
|
export interface IsFridayOptions extends ContextOptions<Date> {}
|
||
|
|
/**
|
||
|
|
* @name isFriday
|
||
|
|
* @category Weekday Helpers
|
||
|
|
* @summary Is the given date Friday?
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* Is the given date Friday?
|
||
|
|
*
|
||
|
|
* @param date - The date to check
|
||
|
|
* @param options - An object with options
|
||
|
|
*
|
||
|
|
* @returns The date is Friday
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // Is 26 September 2014 Friday?
|
||
|
|
* const result = isFriday(new Date(2014, 8, 26))
|
||
|
|
* //=> true
|
||
|
|
*/
|
||
|
|
export declare function isFriday(
|
||
|
|
date: DateArg<Date> & {},
|
||
|
|
options?: IsFridayOptions | undefined,
|
||
|
|
): boolean;
|