UNPKG

798 BTypeScriptView Raw
1import type { ContextOptions } from "./types.js";
2/**
3 * The {@link startOfTomorrow} function options.
4 */
5export interface StartOfTomorrowOptions<DateType extends Date = Date>
6 extends ContextOptions<DateType> {}
7/**
8 * @name startOfTomorrow
9 * @category Day Helpers
10 * @summary Return the start of tomorrow.
11 * @pure false
12 *
13 * @typeParam ContextDate - The `Date` type of the context function.
14 *
15 * @param options - An object with options
16 *
17 * @returns The start of tomorrow
18 *
19 * @description
20 * Return the start of tomorrow.
21 *
22 * @example
23 * // If today is 6 October 2014:
24 * const result = startOfTomorrow()
25 * //=> Tue Oct 7 2014 00:00:00
26 */
27export declare function startOfTomorrow<ContextDate extends Date>(
28 options?: StartOfTomorrowOptions<ContextDate> | undefined,
29): ContextDate;