summaryrefslogtreecommitdiff
path: root/date-fns/src/nextTuesday/index.ts
diff options
context:
space:
mode:
authorSebastian <sebasjm@gmail.com>2021-08-23 16:46:06 -0300
committerSebastian <sebasjm@gmail.com>2021-08-23 16:48:30 -0300
commit38acabfa6089ab8ac469c12b5f55022fb96935e5 (patch)
tree453dbf70000cc5e338b06201af1eaca8343f8f73 /date-fns/src/nextTuesday/index.ts
parentf26125e039143b92dc0d84e7775f508ab0cdcaa8 (diff)
downloadnode-vendor-master.tar.gz
node-vendor-master.tar.bz2
node-vendor-master.zip
added web vendorsHEADmaster
Diffstat (limited to 'date-fns/src/nextTuesday/index.ts')
-rw-r--r--date-fns/src/nextTuesday/index.ts25
1 files changed, 25 insertions, 0 deletions
diff --git a/date-fns/src/nextTuesday/index.ts b/date-fns/src/nextTuesday/index.ts
new file mode 100644
index 0000000..eb1304d
--- /dev/null
+++ b/date-fns/src/nextTuesday/index.ts
@@ -0,0 +1,25 @@
+import requiredArgs from '../_lib/requiredArgs/index'
+import nextDay from '../nextDay/index'
+import toDate from '../toDate/index'
+
+/**
+ * @name nextTuesday
+ * @category Weekday Helpers
+ * @summary When is the next Tuesday?
+ *
+ * @description
+ * When is the next Tuesday?
+ *
+ * @param {Date | number} date - the date to start counting from
+ * @returns {Date} the next Tuesday
+ * @throws {TypeError} 1 argument required
+ *
+ * @example
+ * // When is the next Tuesday after Mar, 22, 2020?
+ * const result = nextTuesday(new Date(2020, 2, 22))
+ * //=> Tue Mar 24 2020 00:00:00
+ */
+export default function nextTuesday(date: Date | number): Date {
+ requiredArgs(1, arguments)
+ return nextDay(toDate(date), 2)
+}