summaryrefslogtreecommitdiff
path: root/date-fns/src/setMinutes/index.js
diff options
context:
space:
mode:
Diffstat (limited to 'date-fns/src/setMinutes/index.js')
-rw-r--r--date-fns/src/setMinutes/index.js34
1 files changed, 34 insertions, 0 deletions
diff --git a/date-fns/src/setMinutes/index.js b/date-fns/src/setMinutes/index.js
new file mode 100644
index 0000000..2ee7f4b
--- /dev/null
+++ b/date-fns/src/setMinutes/index.js
@@ -0,0 +1,34 @@
+import toInteger from '../_lib/toInteger/index'
+import toDate from '../toDate/index'
+import requiredArgs from '../_lib/requiredArgs/index'
+
+/**
+ * @name setMinutes
+ * @category Minute Helpers
+ * @summary Set the minutes to the given date.
+ *
+ * @description
+ * Set the minutes 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} minutes - the minutes of the new date
+ * @returns {Date} the new date with the minutes set
+ * @throws {TypeError} 2 arguments required
+ *
+ * @example
+ * // Set 45 minutes to 1 September 2014 11:30:40:
+ * var result = setMinutes(new Date(2014, 8, 1, 11, 30, 40), 45)
+ * //=> Mon Sep 01 2014 11:45:40
+ */
+export default function setMinutes(dirtyDate, dirtyMinutes) {
+ requiredArgs(2, arguments)
+
+ var date = toDate(dirtyDate)
+ var minutes = toInteger(dirtyMinutes)
+ date.setMinutes(minutes)
+ return date
+}