summaryrefslogtreecommitdiff
path: root/date-fns/src/isFriday/index.ts
diff options
context:
space:
mode:
Diffstat (limited to 'date-fns/src/isFriday/index.ts')
-rw-r--r--date-fns/src/isFriday/index.ts29
1 files changed, 29 insertions, 0 deletions
diff --git a/date-fns/src/isFriday/index.ts b/date-fns/src/isFriday/index.ts
new file mode 100644
index 0000000..9194a2e
--- /dev/null
+++ b/date-fns/src/isFriday/index.ts
@@ -0,0 +1,29 @@
+import toDate from '../toDate/index'
+import requiredArgs from '../_lib/requiredArgs/index'
+
+/**
+ * @name isFriday
+ * @category Weekday Helpers
+ * @summary Is the given date Friday?
+ *
+ * @description
+ * Is the given date Friday?
+ *
+ * ### 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 is Friday
+ * @throws {TypeError} 1 argument required
+ *
+ * @example
+ * // Is 26 September 2014 Friday?
+ * var result = isFriday(new Date(2014, 8, 26))
+ * //=> true
+ */
+export default function isFriday(dirtyDate: Date | number): boolean {
+ requiredArgs(1, arguments)
+
+ return toDate(dirtyDate).getDay() === 5
+}