summaryrefslogtreecommitdiff
path: root/date-fns/src/endOfYesterday
diff options
context:
space:
mode:
Diffstat (limited to 'date-fns/src/endOfYesterday')
-rw-r--r--date-fns/src/endOfYesterday/benchmark.js9
-rw-r--r--date-fns/src/endOfYesterday/index.d.ts4
-rw-r--r--date-fns/src/endOfYesterday/index.js.flow52
-rw-r--r--date-fns/src/endOfYesterday/index.ts34
-rw-r--r--date-fns/src/endOfYesterday/test.ts34
5 files changed, 133 insertions, 0 deletions
diff --git a/date-fns/src/endOfYesterday/benchmark.js b/date-fns/src/endOfYesterday/benchmark.js
new file mode 100644
index 0000000..e3681e5
--- /dev/null
+++ b/date-fns/src/endOfYesterday/benchmark.js
@@ -0,0 +1,9 @@
+// @flow
+/* eslint-env mocha */
+/* global suite, benchmark */
+
+import endOfYesterday from '.'
+
+suite('endOfYesterday', () => {
+ benchmark('date-fns', () => endOfYesterday())
+})
diff --git a/date-fns/src/endOfYesterday/index.d.ts b/date-fns/src/endOfYesterday/index.d.ts
new file mode 100644
index 0000000..b06935b
--- /dev/null
+++ b/date-fns/src/endOfYesterday/index.d.ts
@@ -0,0 +1,4 @@
+// This file is generated automatically by `scripts/build/typings.js`. Please, don't change it.
+
+import { endOfYesterday } from 'date-fns'
+export default endOfYesterday
diff --git a/date-fns/src/endOfYesterday/index.js.flow b/date-fns/src/endOfYesterday/index.js.flow
new file mode 100644
index 0000000..26bde32
--- /dev/null
+++ b/date-fns/src/endOfYesterday/index.js.flow
@@ -0,0 +1,52 @@
+// @flow
+// This file is generated automatically by `scripts/build/typings.js`. Please, don't change it.
+
+export type Interval = {
+ start: Date | number,
+ end: Date | number,
+}
+
+export type Locale = {
+ code?: string,
+ formatDistance?: (...args: Array<any>) => any,
+ formatRelative?: (...args: Array<any>) => any,
+ localize?: {
+ ordinalNumber: (...args: Array<any>) => any,
+ era: (...args: Array<any>) => any,
+ quarter: (...args: Array<any>) => any,
+ month: (...args: Array<any>) => any,
+ day: (...args: Array<any>) => any,
+ dayPeriod: (...args: Array<any>) => any,
+ },
+ formatLong?: {
+ date: (...args: Array<any>) => any,
+ time: (...args: Array<any>) => any,
+ dateTime: (...args: Array<any>) => any,
+ },
+ match?: {
+ ordinalNumber: (...args: Array<any>) => any,
+ era: (...args: Array<any>) => any,
+ quarter: (...args: Array<any>) => any,
+ month: (...args: Array<any>) => any,
+ day: (...args: Array<any>) => any,
+ dayPeriod: (...args: Array<any>) => any,
+ },
+ options?: {
+ weekStartsOn?: 0 | 1 | 2 | 3 | 4 | 5 | 6,
+ firstWeekContainsDate?: 1 | 2 | 3 | 4 | 5 | 6 | 7,
+ },
+}
+
+export type Duration = {
+ years?: number,
+ months?: number,
+ weeks?: number,
+ days?: number,
+ hours?: number,
+ minutes?: number,
+ seconds?: number,
+}
+
+export type Day = 0 | 1 | 2 | 3 | 4 | 5 | 6
+
+declare module.exports: () => Date
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
+}
diff --git a/date-fns/src/endOfYesterday/test.ts b/date-fns/src/endOfYesterday/test.ts
new file mode 100644
index 0000000..4046e64
--- /dev/null
+++ b/date-fns/src/endOfYesterday/test.ts
@@ -0,0 +1,34 @@
+// @flow
+/* eslint-env mocha */
+
+import assert from 'assert'
+import sinon from 'sinon'
+import endOfYesterday from '.'
+
+describe('endOfYesterday', () => {
+ it('returns yesterday with the time settled to 23:59:59.999', () => {
+ const clock = sinon.useFakeTimers(
+ new Date(2014, 8 /* Sep */, 25, 14, 30, 45, 500).getTime()
+ )
+
+ const result = endOfYesterday()
+ assert.deepEqual(result, new Date(2014, 8 /* Sep */, 24, 23, 59, 59, 999))
+
+ clock.restore()
+ })
+
+ it('handles dates before 100 AD', () => {
+ const now = new Date(0)
+ now.setFullYear(14, 8 /* Sep */, 25)
+ now.setHours(14, 30, 45, 500)
+ const clock = sinon.useFakeTimers(now.getTime())
+
+ const expectedResult = new Date(0)
+ expectedResult.setFullYear(14, 8 /* Sep */, 24)
+ expectedResult.setHours(23, 59, 59, 999)
+ const result = endOfYesterday()
+ assert.deepEqual(result, expectedResult)
+
+ clock.restore()
+ })
+})