summaryrefslogtreecommitdiff
path: root/date-fns/src/endOfYesterday/index.ts
diff options
context:
space:
mode:
Diffstat (limited to 'date-fns/src/endOfYesterday/index.ts')
-rw-r--r--date-fns/src/endOfYesterday/index.ts34
1 files changed, 34 insertions, 0 deletions
diff --git a/date-fns/src/endOfYesterday/index.ts b/date-fns/src/endOfYesterday/index.ts
new file mode 100644
index 0000000..6207cc5
--- /dev/null
+++ b/date-fns/src/endOfYesterday/index.ts
@@ -0,0 +1,34 @@
+/**
+ * @name endOfYesterday
+ * @category Day Helpers
+ * @summary Return the end of yesterday.
+ * @pure false
+ *
+ * @description
+ * Return the end of yesterday.
+ *
+ * > ⚠️ Please note that this function is not present in the FP submodule as
+ * > it uses `new Date()` 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 yesterday
+ *
+ * @example
+ * // If today is 6 October 2014:
+ * const result = endOfYesterday()
+ * //=> Sun Oct 5 2014 23:59:59.999
+ */
+export default function endOfYesterday(): Date {
+ const now = new Date()
+ const year = now.getFullYear()
+ const month = now.getMonth()
+ const day = now.getDate()
+
+ const date = new Date(0)
+ date.setFullYear(year, month, day - 1)
+ date.setHours(23, 59, 59, 999)
+ return date
+}