aboutsummaryrefslogtreecommitdiffstats
path: root/node_modules/date-fns/esm/isThisHour/index.js
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/date-fns/esm/isThisHour/index.js')
-rw-r--r--node_modules/date-fns/esm/isThisHour/index.js28
1 files changed, 28 insertions, 0 deletions
diff --git a/node_modules/date-fns/esm/isThisHour/index.js b/node_modules/date-fns/esm/isThisHour/index.js
new file mode 100644
index 0000000..afa0ec0
--- /dev/null
+++ b/node_modules/date-fns/esm/isThisHour/index.js
@@ -0,0 +1,28 @@
+import isSameHour from "../isSameHour/index.js";
+import requiredArgs from "../_lib/requiredArgs/index.js";
+/**
+ * @name isThisHour
+ * @category Hour Helpers
+ * @summary Is the given date in the same hour as the current date?
+ * @pure false
+ *
+ * @description
+ * Is the given date in the same hour as the current date?
+ *
+ * > ⚠️ 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 this hour
+ * @throws {TypeError} 1 argument required
+ *
+ * @example
+ * // If now is 25 September 2014 18:30:15.500,
+ * // is 25 September 2014 18:00:00 in this hour?
+ * const result = isThisHour(new Date(2014, 8, 25, 18))
+ * //=> true
+ */
+export default function isThisHour(dirtyDate) {
+ requiredArgs(1, arguments);
+ return isSameHour(Date.now(), dirtyDate);
+} \ No newline at end of file
send patches to the email below
yukais@pinapelz.com
include the subject [PATCH repo_name]
pinapelz.com
homepage