lastDayOfISOWeek.cjs 1.2 KB

1234567891011121314151617181920212223242526272829303132333435
  1. "use strict";
  2. exports.lastDayOfISOWeek = lastDayOfISOWeek;
  3. var _index = require("./lastDayOfWeek.cjs");
  4. /**
  5. * The {@link lastDayOfISOWeek} function options.
  6. */
  7. /**
  8. * @name lastDayOfISOWeek
  9. * @category ISO Week Helpers
  10. * @summary Return the last day of an ISO week for the given date.
  11. *
  12. * @description
  13. * Return the last day of an ISO week for the given date.
  14. * The result will be in the local timezone.
  15. *
  16. * ISO week-numbering year: http://en.wikipedia.org/wiki/ISO_week_date
  17. *
  18. * @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).
  19. * @typeParam ResultDate - The result `Date` type, it is the type returned from the context function if it is passed, or inferred from the arguments.
  20. *
  21. * @param date - The original date
  22. * @param options - An object with options
  23. *
  24. * @returns The last day of an ISO week
  25. *
  26. * @example
  27. * // The last day of an ISO week for 2 September 2014 11:55:00:
  28. * const result = lastDayOfISOWeek(new Date(2014, 8, 2, 11, 55, 0))
  29. * //=> Sun Sep 07 2014 00:00:00
  30. */
  31. function lastDayOfISOWeek(date, options) {
  32. return (0, _index.lastDayOfWeek)(date, { ...options, weekStartsOn: 1 });
  33. }