previousTuesday.d.ts 704 B

12345678910111213141516171819202122
  1. /**
  2. * @name previousTuesday
  3. * @category Weekday Helpers
  4. * @summary When is the previous Tuesday?
  5. *
  6. * @description
  7. * When is the previous Tuesday?
  8. *
  9. * @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).
  10. *
  11. * @param date - The date to start counting from
  12. *
  13. * @returns The previous Tuesday
  14. *
  15. * @example
  16. * // When is the previous Tuesday before Jun, 18, 2021?
  17. * const result = previousTuesday(new Date(2021, 5, 18))
  18. * //=> Tue June 15 2021 00:00:00
  19. */
  20. export declare function previousTuesday<DateType extends Date>(
  21. date: DateType | number | string,
  22. ): DateType;