aboutsummaryrefslogtreecommitdiffstats
path: root/node_modules/date-fns/esm/isFuture/index.js
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/date-fns/esm/isFuture/index.js')
-rw-r--r--node_modules/date-fns/esm/isFuture/index.js27
1 files changed, 27 insertions, 0 deletions
diff --git a/node_modules/date-fns/esm/isFuture/index.js b/node_modules/date-fns/esm/isFuture/index.js
new file mode 100644
index 0000000..9bc27db
--- /dev/null
+++ b/node_modules/date-fns/esm/isFuture/index.js
@@ -0,0 +1,27 @@
+import toDate from "../toDate/index.js";
+import requiredArgs from "../_lib/requiredArgs/index.js";
+/**
+ * @name isFuture
+ * @category Common Helpers
+ * @summary Is the given date in the future?
+ * @pure false
+ *
+ * @description
+ * Is the given date in the future?
+ *
+ * > ⚠️ Please note that this function is not present in the FP submodule as
+ * > it uses `Date.now()` internally hence impure and can't be safely curried.
+ *
+ * @param {Date|Number} date - the date to check
+ * @returns {Boolean} the date is in the future
+ * @throws {TypeError} 1 argument required
+ *
+ * @example
+ * // If today is 6 October 2014, is 31 December 2014 in the future?
+ * const result = isFuture(new Date(2014, 11, 31))
+ * //=> true
+ */
+export default function isFuture(dirtyDate) {
+ requiredArgs(1, arguments);
+ return toDate(dirtyDate).getTime() > Date.now();
+} \ No newline at end of file
send patches to the email below
yukais@pinapelz.com
include the subject [PATCH repo_name]
pinapelz.com
homepage