timepiece/node_modules/date-fns/nextSunday.mjs

28 lines
730 B
JavaScript

import { nextDay } from "./nextDay.mjs";
/**
* @name nextSunday
* @category Weekday Helpers
* @summary When is the next Sunday?
*
* @description
* When is the next 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 start counting from
*
* @returns The next Sunday
*
* @example
* // When is the next Sunday after Mar, 22, 2020?
* const result = nextSunday(new Date(2020, 2, 22))
* //=> Sun Mar 29 2020 00:00:00
*/
export function nextSunday(date) {
return nextDay(date, 0);
}
// Fallback for modularized imports:
export default nextSunday;