index.js 1.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243
  1. "use strict";
  2. var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
  3. Object.defineProperty(exports, "__esModule", {
  4. value: true
  5. });
  6. exports.default = getWeeksInMonth;
  7. var _index = _interopRequireDefault(require("../differenceInCalendarWeeks/index.js"));
  8. var _index2 = _interopRequireDefault(require("../lastDayOfMonth/index.js"));
  9. var _index3 = _interopRequireDefault(require("../startOfMonth/index.js"));
  10. var _index4 = _interopRequireDefault(require("../_lib/requiredArgs/index.js"));
  11. /**
  12. * @name getWeeksInMonth
  13. * @category Week Helpers
  14. * @summary Get the number of calendar weeks a month spans.
  15. *
  16. * @description
  17. * Get the number of calendar weeks the month in the given date spans.
  18. *
  19. * @param {Date|Number} date - the given date
  20. * @param {Object} [options] - an object with options.
  21. * @param {Locale} [options.locale=defaultLocale] - the locale object. See [Locale]{@link https://date-fns.org/docs/Locale}
  22. * @param {0|1|2|3|4|5|6} [options.weekStartsOn=0] - the index of the first day of the week (0 - Sunday)
  23. * @returns {Number} the number of calendar weeks
  24. * @throws {TypeError} 2 arguments required
  25. * @throws {RangeError} `options.weekStartsOn` must be between 0 and 6
  26. *
  27. * @example
  28. * // How many calendar weeks does February 2015 span?
  29. * const result = getWeeksInMonth(new Date(2015, 1, 8))
  30. * //=> 4
  31. *
  32. * @example
  33. * // If the week starts on Monday,
  34. * // how many calendar weeks does July 2017 span?
  35. * const result = getWeeksInMonth(new Date(2017, 6, 5), { weekStartsOn: 1 })
  36. * //=> 6
  37. */
  38. function getWeeksInMonth(date, options) {
  39. (0, _index4.default)(1, arguments);
  40. return (0, _index.default)((0, _index2.default)(date), (0, _index3.default)(date), options) + 1;
  41. }
  42. module.exports = exports.default;