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

23 lines
697 B
TypeScript
Raw Normal View History

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