Vlad Durnea
cffdf8af86
Some checks failed
CI/CD Pipeline / unit-tests (push) Failing after 1m16s
CI/CD Pipeline / integration-tests (push) Failing after 2m32s
CI/CD Pipeline / lint (push) Successful in 5m22s
CI/CD Pipeline / e2e-tests (push) Has been skipped
CI/CD Pipeline / build (push) Has been skipped
38 lines
1.1 KiB
JavaScript
38 lines
1.1 KiB
JavaScript
import { addDays } from "./addDays.mjs";
|
|
import { getDay } from "./getDay.mjs";
|
|
|
|
/**
|
|
* @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 function nextDay(date, day) {
|
|
let delta = day - getDay(date);
|
|
if (delta <= 0) delta += 7;
|
|
|
|
return addDays(date, delta);
|
|
}
|
|
|
|
// Fallback for modularized imports:
|
|
export default nextDay;
|