nextSaturday.cjs 999 B

1234567891011121314151617181920212223242526272829303132
  1. "use strict";
  2. exports.nextSaturday = nextSaturday;
  3. var _index = require("./nextDay.cjs");
  4. /**
  5. * The {@link nextSaturday} function options.
  6. */
  7. /**
  8. * @name nextSaturday
  9. * @category Weekday Helpers
  10. * @summary When is the next Saturday?
  11. *
  12. * @description
  13. * When is the next Saturday?
  14. *
  15. * @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).
  16. * @typeParam ResultDate - The result `Date` type, it is the type returned from the context function if it is passed, or inferred from the arguments.
  17. *
  18. * @param date - The date to start counting from
  19. * @param options - An object with options
  20. *
  21. * @returns The next Saturday
  22. *
  23. * @example
  24. * // When is the next Saturday after Mar, 22, 2020?
  25. * const result = nextSaturday(new Date(2020, 2, 22))
  26. * //=> Sat Mar 28 2020 00:00:00
  27. */
  28. function nextSaturday(date, options) {
  29. return (0, _index.nextDay)(date, 6, options);
  30. }