diff options
Diffstat (limited to 'node_modules/date-fns/esm/eachWeekendOfYear/index.js')
| -rw-r--r-- | node_modules/date-fns/esm/eachWeekendOfYear/index.js | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/node_modules/date-fns/esm/eachWeekendOfYear/index.js b/node_modules/date-fns/esm/eachWeekendOfYear/index.js new file mode 100644 index 0000000..1f1f393 --- /dev/null +++ b/node_modules/date-fns/esm/eachWeekendOfYear/index.js @@ -0,0 +1,37 @@ +import eachWeekendOfInterval from "../eachWeekendOfInterval/index.js"; +import endOfYear from "../endOfYear/index.js"; +import startOfYear from "../startOfYear/index.js"; +import requiredArgs from "../_lib/requiredArgs/index.js"; +/** + * @name eachWeekendOfYear + * @category Year Helpers + * @summary List all the Saturdays and Sundays in the year. + * + * @description + * Get all the Saturdays and Sundays in the year. + * + * @param {Date|Number} date - the given year + * @returns {Date[]} an array containing all the Saturdays and Sundays + * @throws {TypeError} 1 argument required + * @throws {RangeError} The passed date is invalid + * + * @example + * // Lists all Saturdays and Sundays in the year + * const result = eachWeekendOfYear(new Date(2020, 1, 1)) + * //=> [ + * // Sat Jan 03 2020 00:00:00, + * // Sun Jan 04 2020 00:00:00, + * // ... + * // Sun Dec 27 2020 00:00:00 + * // ] + * ] + */ +export default function eachWeekendOfYear(dirtyDate) { + requiredArgs(1, arguments); + var startDate = startOfYear(dirtyDate); + var endDate = endOfYear(dirtyDate); + return eachWeekendOfInterval({ + start: startDate, + end: endDate + }); +}
\ No newline at end of file |
