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