23 lines
697 B
TypeScript
23 lines
697 B
TypeScript
|
/**
|
||
|
|
* @name previousSunday
|
||
|
|
* @category Weekday Helpers
|
||
|
|
* @summary When is the previous Sunday?
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* When is the previous 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 previous Sunday
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // When is the previous Sunday before Jun, 21, 2021?
|
||
|
|
* const result = previousSunday(new Date(2021, 5, 21))
|
||
|
|
* //=> Sun June 20 2021 00:00:00
|
||
|
|
*/
|
||
|
|
export declare function previousSunday<DateType extends Date>(
|
||
|
|
date: DateType | number | string,
|
||
|
|
): DateType;
|