summaryrefslogtreecommitdiff
path: root/date-fns/src/endOfToday/index.ts
diff options
context:
space:
mode:
Diffstat (limited to 'date-fns/src/endOfToday/index.ts')
-rw-r--r--date-fns/src/endOfToday/index.ts28
1 files changed, 28 insertions, 0 deletions
diff --git a/date-fns/src/endOfToday/index.ts b/date-fns/src/endOfToday/index.ts
new file mode 100644
index 0000000..9d0c180
--- /dev/null
+++ b/date-fns/src/endOfToday/index.ts
@@ -0,0 +1,28 @@
+import endOfDay from '../endOfDay/index'
+
+/**
+ * @name endOfToday
+ * @category Day Helpers
+ * @summary Return the end of today.
+ * @pure false
+ *
+ * @description
+ * Return the end of today.
+ *
+ * > ⚠️ 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.
+ *
+ * ### 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).
+ *
+ * @returns {Date} the end of today
+ *
+ * @example
+ * // If today is 6 October 2014:
+ * var result = endOfToday()
+ * //=> Mon Oct 6 2014 23:59:59.999
+ */
+export default function endOfToday(): Date {
+ return endOfDay(Date.now())
+}