timepiece/node_modules/date-fns/nextSunday.d.ts

23 lines
667 B
TypeScript
Raw Normal View History

2024-05-14 14:54:12 +00:00
/**
* @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 declare function nextSunday<DateType extends Date>(
date: DateType | number | string,
): DateType;