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

23 lines
704 B
TypeScript
Raw Normal View History

2024-05-14 14:54:12 +00:00
/**
* @name previousTuesday
* @category Weekday Helpers
* @summary When is the previous Tuesday?
*
* @description
* When is the previous Tuesday?
*
* @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 Tuesday
*
* @example
* // When is the previous Tuesday before Jun, 18, 2021?
* const result = previousTuesday(new Date(2021, 5, 18))
* //=> Tue June 15 2021 00:00:00
*/
export declare function previousTuesday<DateType extends Date>(
date: DateType | number | string,
): DateType;