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