summaryrefslogtreecommitdiff
path: root/date-fns/src/isBefore/index.ts
diff options
context:
space:
mode:
Diffstat (limited to 'date-fns/src/isBefore/index.ts')
-rw-r--r--date-fns/src/isBefore/index.ts32
1 files changed, 32 insertions, 0 deletions
diff --git a/date-fns/src/isBefore/index.ts b/date-fns/src/isBefore/index.ts
new file mode 100644
index 0000000..344b887
--- /dev/null
+++ b/date-fns/src/isBefore/index.ts
@@ -0,0 +1,32 @@
+import toDate from '../toDate/index'
+import requiredArgs from '../_lib/requiredArgs/index'
+
+/**
+ * @name isBefore
+ * @category Common Helpers
+ * @summary Is the first date before the second one?
+ *
+ * @description
+ * Is the first date before the second one?
+ *
+ * ### 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 that should be before the other one to return true
+ * @param {Date|Number} dateToCompare - the date to compare with
+ * @returns {Boolean} the first date is before the second date
+ * @throws {TypeError} 2 arguments required
+ *
+ * @example
+ * // Is 10 July 1989 before 11 February 1987?
+ * var result = isBefore(new Date(1989, 6, 10), new Date(1987, 1, 11))
+ * //=> false
+ */
+export default function isBefore(dirtyDate: Date | number, dirtyDateToCompare: Date | number): boolean {
+ requiredArgs(2, arguments)
+
+ const date = toDate(dirtyDate)
+ const dateToCompare = toDate(dirtyDateToCompare)
+ return date.getTime() < dateToCompare.getTime()
+}