summaryrefslogtreecommitdiff
path: root/date-fns/src/setDate/index.ts
diff options
context:
space:
mode:
Diffstat (limited to 'date-fns/src/setDate/index.ts')
-rw-r--r--date-fns/src/setDate/index.ts34
1 files changed, 34 insertions, 0 deletions
diff --git a/date-fns/src/setDate/index.ts b/date-fns/src/setDate/index.ts
new file mode 100644
index 0000000..ab757f3
--- /dev/null
+++ b/date-fns/src/setDate/index.ts
@@ -0,0 +1,34 @@
+import toInteger from '../_lib/toInteger/index'
+import toDate from '../toDate/index'
+import requiredArgs from '../_lib/requiredArgs/index'
+
+/**
+ * @name setDate
+ * @category Day Helpers
+ * @summary Set the day of the month to the given date.
+ *
+ * @description
+ * Set the day of the month 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} dayOfMonth - the day of the month of the new date
+ * @returns {Date} the new date with the day of the month set
+ * @throws {TypeError} 2 arguments required
+ *
+ * @example
+ * // Set the 30th day of the month to 1 September 2014:
+ * var result = setDate(new Date(2014, 8, 1), 30)
+ * //=> Tue Sep 30 2014 00:00:00
+ */
+export default function setDate(dirtyDate: Date | number, dirtyDayOfMonth: number): Date {
+ requiredArgs(2, arguments)
+
+ const date = toDate(dirtyDate)
+ const dayOfMonth = toInteger(dirtyDayOfMonth)
+ date.setDate(dayOfMonth)
+ return date
+}