UNPKG

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