UNPKG

674 BTypeScriptView Raw
1/**
2 * @name nextTuesday
3 * @category Weekday Helpers
4 * @summary When is the next Tuesday?
5 *
6 * @description
7 * When is the next Tuesday?
8 *
9 * @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).
10 *
11 * @param date - The date to start counting from
12 *
13 * @returns The next Tuesday
14 *
15 * @example
16 * // When is the next Tuesday after Mar, 22, 2020?
17 * const result = nextTuesday(new Date(2020, 2, 22))
18 * //=> Tue Mar 24 2020 00:00:00
19 */
20export declare function nextTuesday<DateType extends Date>(
21 date: DateType | number | string,
22): DateType;