summaryrefslogtreecommitdiff
path: root/date-fns/src/addWeeks/index.ts
diff options
context:
space:
mode:
Diffstat (limited to 'date-fns/src/addWeeks/index.ts')
-rw-r--r--date-fns/src/addWeeks/index.ts36
1 files changed, 36 insertions, 0 deletions
diff --git a/date-fns/src/addWeeks/index.ts b/date-fns/src/addWeeks/index.ts
new file mode 100644
index 0000000..0b52616
--- /dev/null
+++ b/date-fns/src/addWeeks/index.ts
@@ -0,0 +1,36 @@
+import toInteger from '../_lib/toInteger/index'
+import addDays from '../addDays/index'
+import requiredArgs from '../_lib/requiredArgs/index'
+
+/**
+ * @name addWeeks
+ * @category Week Helpers
+ * @summary Add the specified number of weeks to the given date.
+ *
+ * @description
+ * Add the specified number of week to the given date.
+ *
+ * ### 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).
+ *
+ * @param {Date|Number} date - the date to be changed
+ * @param {Number} amount - the amount of weeks to be added. Positive decimals will be rounded using `Math.floor`, decimals less than zero will be rounded using `Math.ceil`.
+ * @returns {Date} the new date with the weeks added
+ * @throws {TypeError} 2 arguments required
+ *
+ * @example
+ * // Add 4 weeks to 1 September 2014:
+ * const result = addWeeks(new Date(2014, 8, 1), 4)
+ * //=> Mon Sep 29 2014 00:00:00
+ */
+export default function addWeeks(
+ dirtyDate: Date | number,
+ dirtyAmount: number
+): Date {
+ requiredArgs(2, arguments)
+
+ const amount = toInteger(dirtyAmount)
+ const days = amount * 7
+ return addDays(dirtyDate, days)
+}