UNPKG

1.16 kBTypeScriptView Raw
1import type { ContextOptions, DateArg } from "./types.js";
2/**
3 * The {@link nextTuesday} function options.
4 */
5export interface NextTuesdayOptions<DateType extends Date = Date>
6 extends ContextOptions<DateType> {}
7/**
8 * @name nextTuesday
9 * @category Weekday Helpers
10 * @summary When is the next Tuesday?
11 *
12 * @description
13 * When is the next Tuesday?
14 *
15 * @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).
16 * @typeParam ResultDate - The result `Date` type, it is the type returned from the context function if it is passed, or inferred from the arguments.
17 *
18 * @param date - The date to start counting from
19 * @param options - An object with options
20 *
21 * @returns The next Tuesday
22 *
23 * @example
24 * // When is the next Tuesday after Mar, 22, 2020?
25 * const result = nextTuesday(new Date(2020, 2, 22))
26 * //=> Tue Mar 24 2020 00:00:00
27 */
28export declare function nextTuesday<
29 DateType extends Date,
30 ResultDate extends Date = DateType,
31>(
32 date: DateArg<DateType>,
33 options?: NextTuesdayOptions<ResultDate>,
34): ResultDate;