summaryrefslogtreecommitdiff
path: root/date-fns/src/nextSaturday
diff options
context:
space:
mode:
Diffstat (limited to 'date-fns/src/nextSaturday')
-rw-r--r--date-fns/src/nextSaturday/index.d.ts4
-rw-r--r--date-fns/src/nextSaturday/index.js.flow52
-rw-r--r--date-fns/src/nextSaturday/index.ts25
-rw-r--r--date-fns/src/nextSaturday/test.ts48
4 files changed, 129 insertions, 0 deletions
diff --git a/date-fns/src/nextSaturday/index.d.ts b/date-fns/src/nextSaturday/index.d.ts
new file mode 100644
index 0000000..20532f7
--- /dev/null
+++ b/date-fns/src/nextSaturday/index.d.ts
@@ -0,0 +1,4 @@
+// This file is generated automatically by `scripts/build/typings.js`. Please, don't change it.
+
+import { nextSaturday } from 'date-fns'
+export default nextSaturday
diff --git a/date-fns/src/nextSaturday/index.js.flow b/date-fns/src/nextSaturday/index.js.flow
new file mode 100644
index 0000000..4b7c616
--- /dev/null
+++ b/date-fns/src/nextSaturday/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: Date | number) => Date
diff --git a/date-fns/src/nextSaturday/index.ts b/date-fns/src/nextSaturday/index.ts
new file mode 100644
index 0000000..ac3d5a6
--- /dev/null
+++ b/date-fns/src/nextSaturday/index.ts
@@ -0,0 +1,25 @@
+import requiredArgs from '../_lib/requiredArgs/index'
+import nextDay from '../nextDay/index'
+import toDate from '../toDate/index'
+
+/**
+ * @name nextSaturday
+ * @category Weekday Helpers
+ * @summary When is the next Saturday?
+ *
+ * @description
+ * When is the next Saturday?
+ *
+ * @param {Date | number} date - the date to start counting from
+ * @returns {Date} the next Saturday
+ * @throws {TypeError} 1 argument required
+ *
+ * @example
+ * // When is the next Saturday after Mar, 22, 2020?
+ * const result = nextSaturday(new Date(2020, 2, 22))
+ * //=> Sat Mar 28 2020 00:00:00
+ */
+export default function nextSaturday(date: Date | number): Date {
+ requiredArgs(1, arguments)
+ return nextDay(toDate(date), 6)
+}
diff --git a/date-fns/src/nextSaturday/test.ts b/date-fns/src/nextSaturday/test.ts
new file mode 100644
index 0000000..6799b46
--- /dev/null
+++ b/date-fns/src/nextSaturday/test.ts
@@ -0,0 +1,48 @@
+// @flow
+/* eslint-env mocha */
+
+import assert from 'power-assert'
+import nextSaturday from '.'
+
+describe('nextSaturday', () => {
+ it('returns the following Saturday given various dates before the same', () => {
+ assert.deepStrictEqual(
+ nextSaturday(new Date(2020, 2 /* Mar */, 23)),
+ new Date(2020, 2 /* Mar */, 28)
+ )
+
+ assert.deepStrictEqual(
+ nextSaturday(new Date(2020, 2 /* Mar */, 22)),
+ new Date(2020, 2 /* Mar */, 28)
+ )
+
+ assert.deepStrictEqual(
+ nextSaturday(new Date(2020, 2 /* Mar */, 21)),
+ new Date(2020, 2 /* Mar */, 28)
+ )
+
+ assert.deepStrictEqual(
+ nextSaturday(new Date(2020, 2 /* Mar */, 20)),
+ new Date(2020, 2 /* Mar */, 21)
+ )
+
+ assert.deepStrictEqual(
+ nextSaturday(new Date(2020, 2 /* Mar */, 19)),
+ new Date(2020, 2 /* Mar */, 21)
+ )
+
+ assert.deepStrictEqual(
+ nextSaturday(new Date(2020, 2 /* Mar */, 18)),
+ new Date(2020, 2 /* Mar */, 21)
+ )
+
+ assert.deepStrictEqual(
+ nextSaturday(new Date(2020, 2 /* Mar */, 17)),
+ new Date(2020, 2 /* Mar */, 21)
+ )
+ })
+
+ it('returns `Invalid Date` if the given date is invalid', () => {
+ assert(nextSaturday(new Date(NaN)) instanceof Date)
+ })
+})