summaryrefslogtreecommitdiff
path: root/date-fns/src/startOfMinute/index.ts
diff options
context:
space:
mode:
Diffstat (limited to 'date-fns/src/startOfMinute/index.ts')
-rw-r--r--date-fns/src/startOfMinute/index.ts32
1 files changed, 32 insertions, 0 deletions
diff --git a/date-fns/src/startOfMinute/index.ts b/date-fns/src/startOfMinute/index.ts
new file mode 100644
index 0000000..87d6a12
--- /dev/null
+++ b/date-fns/src/startOfMinute/index.ts
@@ -0,0 +1,32 @@
+import toDate from '../toDate/index'
+import requiredArgs from '../_lib/requiredArgs/index'
+
+/**
+ * @name startOfMinute
+ * @category Minute Helpers
+ * @summary Return the start of a minute for the given date.
+ *
+ * @description
+ * Return the start of a minute for the given date.
+ * The result will be in the local timezone.
+ *
+ * ### 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 original date
+ * @returns {Date} the start of a minute
+ * @throws {TypeError} 1 argument required
+ *
+ * @example
+ * // The start of a minute for 1 December 2014 22:15:45.400:
+ * const result = startOfMinute(new Date(2014, 11, 1, 22, 15, 45, 400))
+ * //=> Mon Dec 01 2014 22:15:00
+ */
+export default function startOfMinute(dirtyDate: Date | number): Date {
+ requiredArgs(1, arguments)
+
+ const date = toDate(dirtyDate)
+ date.setSeconds(0, 0)
+ return date
+}