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

23 lines
688 B
TypeScript
Raw Normal View History

2024-05-14 14:54:12 +00:00
/**
* @name nextWednesday
* @category Weekday Helpers
* @summary When is the next Wednesday?
*
* @description
* When is the next Wednesday?
*
* @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 Wednesday
*
* @example
* // When is the next Wednesday after Mar, 22, 2020?
* const result = nextWednesday(new Date(2020, 2, 22))
* //=> Wed Mar 25 2020 00:00:00
*/
export declare function nextWednesday<DateType extends Date>(
date: DateType | number | string,
): DateType;