UNPKG

688 BTypeScriptView Raw
1import type { ContextOptions, DateArg } from "./types.js";
2/**
3 * The {@link isWednesday} function options.
4 */
5export interface IsWednesdayOptions extends ContextOptions<Date> {}
6/**
7 * @name isWednesday
8 * @category Weekday Helpers
9 * @summary Is the given date Wednesday?
10 *
11 * @description
12 * Is the given date Wednesday?
13 *
14 * @param date - The date to check
15 * @param options - An object with options
16 *
17 * @returns The date is Wednesday
18 *
19 * @example
20 * // Is 24 September 2014 Wednesday?
21 * const result = isWednesday(new Date(2014, 8, 24))
22 * //=> true
23 */
24export declare function isWednesday(
25 date: DateArg<Date> & {},
26 options?: IsWednesdayOptions | undefined,
27): boolean;