previousSaturday.js 778 B

1234567891011121314151617181920212223242526
  1. "use strict";
  2. exports.previousSaturday = previousSaturday;
  3. var _index = require("./previousDay.js");
  4. /**
  5. * @name previousSaturday
  6. * @category Weekday Helpers
  7. * @summary When is the previous Saturday?
  8. *
  9. * @description
  10. * When is the previous Saturday?
  11. *
  12. * @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).
  13. *
  14. * @param date - The date to start counting from
  15. *
  16. * @returns The previous Saturday
  17. *
  18. * @example
  19. * // When is the previous Saturday before Jun, 20, 2021?
  20. * const result = previousSaturday(new Date(2021, 5, 20))
  21. * //=> Sat June 19 2021 00:00:00
  22. */
  23. function previousSaturday(date) {
  24. return (0, _index.previousDay)(date, 6);
  25. }