aboutsummaryrefslogtreecommitdiffstats
path: root/node_modules/date-fns/esm/eachWeekendOfMonth/index.js
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/date-fns/esm/eachWeekendOfMonth/index.js')
-rw-r--r--node_modules/date-fns/esm/eachWeekendOfMonth/index.js41
1 files changed, 41 insertions, 0 deletions
diff --git a/node_modules/date-fns/esm/eachWeekendOfMonth/index.js b/node_modules/date-fns/esm/eachWeekendOfMonth/index.js
new file mode 100644
index 0000000..00dffec
--- /dev/null
+++ b/node_modules/date-fns/esm/eachWeekendOfMonth/index.js
@@ -0,0 +1,41 @@
+import eachWeekendOfInterval from "../eachWeekendOfInterval/index.js";
+import startOfMonth from "../startOfMonth/index.js";
+import endOfMonth from "../endOfMonth/index.js";
+import requiredArgs from "../_lib/requiredArgs/index.js";
+/**
+ * @name eachWeekendOfMonth
+ * @category Month Helpers
+ * @summary List all the Saturdays and Sundays in the given month.
+ *
+ * @description
+ * Get all the Saturdays and Sundays in the given month.
+ *
+ * @param {Date|Number} date - the given month
+ * @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 given month
+ * const result = eachWeekendOfMonth(new Date(2022, 1, 1))
+ * //=> [
+ * // Sat Feb 05 2022 00:00:00,
+ * // Sun Feb 06 2022 00:00:00,
+ * // Sat Feb 12 2022 00:00:00,
+ * // Sun Feb 13 2022 00:00:00,
+ * // Sat Feb 19 2022 00:00:00,
+ * // Sun Feb 20 2022 00:00:00,
+ * // Sat Feb 26 2022 00:00:00,
+ * // Sun Feb 27 2022 00:00:00
+ * // ]
+ */
+export default function eachWeekendOfMonth(dirtyDate) {
+ requiredArgs(1, arguments);
+ var startDate = startOfMonth(dirtyDate);
+ if (isNaN(startDate.getTime())) throw new RangeError('The passed date is invalid');
+ var endDate = endOfMonth(dirtyDate);
+ return eachWeekendOfInterval({
+ start: startDate,
+ end: endDate
+ });
+} \ No newline at end of file
send patches to the email below
yukais@pinapelz.com
include the subject [PATCH repo_name]
pinapelz.com
homepage