previousSaturday.d.ts 711 B

12345678910111213141516171819202122
  1. /**
  2. * @name previousSaturday
  3. * @category Weekday Helpers
  4. * @summary When is the previous Saturday?
  5. *
  6. * @description
  7. * When is the previous Saturday?
  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 Saturday
  14. *
  15. * @example
  16. * // When is the previous Saturday before Jun, 20, 2021?
  17. * const result = previousSaturday(new Date(2021, 5, 20))
  18. * //=> Sat June 19 2021 00:00:00
  19. */
  20. export declare function previousSaturday<DateType extends Date>(
  21. date: DateType | number | string,
  22. ): DateType;