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