diff options
Diffstat (limited to 'node_modules/date-fns/esm/getWeeksInMonth/index.js')
| -rw-r--r-- | node_modules/date-fns/esm/getWeeksInMonth/index.js | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/node_modules/date-fns/esm/getWeeksInMonth/index.js b/node_modules/date-fns/esm/getWeeksInMonth/index.js new file mode 100644 index 0000000..fcc18ec --- /dev/null +++ b/node_modules/date-fns/esm/getWeeksInMonth/index.js @@ -0,0 +1,35 @@ +import differenceInCalendarWeeks from "../differenceInCalendarWeeks/index.js"; +import lastDayOfMonth from "../lastDayOfMonth/index.js"; +import startOfMonth from "../startOfMonth/index.js"; +import requiredArgs from "../_lib/requiredArgs/index.js"; +/** + * @name getWeeksInMonth + * @category Week Helpers + * @summary Get the number of calendar weeks a month spans. + * + * @description + * Get the number of calendar weeks the month in the given date spans. + * + * @param {Date|Number} date - the given date + * @param {Object} [options] - an object with options. + * @param {Locale} [options.locale=defaultLocale] - the locale object. See [Locale]{@link https://date-fns.org/docs/Locale} + * @param {0|1|2|3|4|5|6} [options.weekStartsOn=0] - the index of the first day of the week (0 - Sunday) + * @returns {Number} the number of calendar weeks + * @throws {TypeError} 2 arguments required + * @throws {RangeError} `options.weekStartsOn` must be between 0 and 6 + * + * @example + * // How many calendar weeks does February 2015 span? + * const result = getWeeksInMonth(new Date(2015, 1, 8)) + * //=> 4 + * + * @example + * // If the week starts on Monday, + * // how many calendar weeks does July 2017 span? + * const result = getWeeksInMonth(new Date(2017, 6, 5), { weekStartsOn: 1 }) + * //=> 6 + */ +export default function getWeeksInMonth(date, options) { + requiredArgs(1, arguments); + return differenceInCalendarWeeks(lastDayOfMonth(date), startOfMonth(date), options) + 1; +}
\ No newline at end of file |
