UNPKG

1.01 kBJavaScriptView Raw
1import { nextDay } from "./nextDay.js";
2
3/**
4 * The {@link nextThursday} function options.
5 */
6
7/**
8 * @name nextThursday
9 * @category Weekday Helpers
10 * @summary When is the next Thursday?
11 *
12 * @description
13 * When is the next Thursday?
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 Thursday
22 *
23 * @example
24 * // When is the next Thursday after Mar, 22, 2020?
25 * const result = nextThursday(new Date(2020, 2, 22))
26 * //=> Thur Mar 26 2020 00:00:00
27 */
28export function nextThursday(date, options) {
29 return nextDay(date, 4, options);
30}
31
32// Fallback for modularized imports:
33export default nextThursday;