summaryrefslogtreecommitdiff
path: root/date-fns/src/isWeekend/index.ts
diff options
context:
space:
mode:
Diffstat (limited to 'date-fns/src/isWeekend/index.ts')
-rw-r--r--date-fns/src/isWeekend/index.ts31
1 files changed, 31 insertions, 0 deletions
diff --git a/date-fns/src/isWeekend/index.ts b/date-fns/src/isWeekend/index.ts
new file mode 100644
index 0000000..9eebd6b
--- /dev/null
+++ b/date-fns/src/isWeekend/index.ts
@@ -0,0 +1,31 @@
+import toDate from '../toDate/index'
+import requiredArgs from '../_lib/requiredArgs/index'
+
+/**
+ * @name isWeekend
+ * @category Weekday Helpers
+ * @summary Does the given date fall on a weekend?
+ *
+ * @description
+ * Does the given date fall on a weekend?
+ *
+ * ### v2.0.0 breaking changes:
+ *
+ * - [Changes that are common for the whole library](https://github.com/date-fns/date-fns/blob/master/docs/upgradeGuide.md#Common-Changes).
+ *
+ * @param {Date|Number} date - the date to check
+ * @returns {Boolean} the date falls on a weekend
+ * @throws {TypeError} 1 argument required
+ *
+ * @example
+ * // Does 5 October 2014 fall on a weekend?
+ * const result = isWeekend(new Date(2014, 9, 5))
+ * //=> true
+ */
+export default function isWeekend(dirtyDate: Date | number): boolean {
+ requiredArgs(1, arguments)
+
+ const date = toDate(dirtyDate)
+ const day = date.getDay()
+ return day === 0 || day === 6
+}