| 123456789101112131415161718192021222324252627282930 |
- import type { Day } from "./types.js";
- /**
- * @name nextDay
- * @category Weekday Helpers
- * @summary When is the next day of the week?
- *
- * @description
- * When is the next day of the week? 0-6 the day of the week, 0 represents Sunday.
- *
- * @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).
- *
- * @param date - The date to check
- * @param day - day of the week
- *
- * @returns The date is the next day of week
- *
- * @example
- * // When is the next Monday after Mar, 20, 2020?
- * const result = nextDay(new Date(2020, 2, 20), 1)
- * //=> Mon Mar 23 2020 00:00:00
- *
- * @example
- * // When is the next Tuesday after Mar, 21, 2020?
- * const result = nextDay(new Date(2020, 2, 21), 2)
- * //=> Tue Mar 24 2020 00:00:00
- */
- export declare function nextDay<DateType extends Date>(
- date: DateType | number | string,
- day: Day,
- ): DateType;
|