23 lines
681 B
TypeScript
23 lines
681 B
TypeScript
|
/**
|
||
|
|
* @name nextSaturday
|
||
|
|
* @category Weekday Helpers
|
||
|
|
* @summary When is the next Saturday?
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* When is the next 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 next Saturday
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // When is the next Saturday after Mar, 22, 2020?
|
||
|
|
* const result = nextSaturday(new Date(2020, 2, 22))
|
||
|
|
* //=> Sat Mar 28 2020 00:00:00
|
||
|
|
*/
|
||
|
|
export declare function nextSaturday<DateType extends Date>(
|
||
|
|
date: DateType | number | string,
|
||
|
|
): DateType;
|