summaryrefslogtreecommitdiff
path: root/date-fns/src/subMinutes/index.ts
diff options
context:
space:
mode:
Diffstat (limited to 'date-fns/src/subMinutes/index.ts')
-rw-r--r--date-fns/src/subMinutes/index.ts32
1 files changed, 32 insertions, 0 deletions
diff --git a/date-fns/src/subMinutes/index.ts b/date-fns/src/subMinutes/index.ts
new file mode 100644
index 0000000..365928b
--- /dev/null
+++ b/date-fns/src/subMinutes/index.ts
@@ -0,0 +1,32 @@
+import toInteger from '../_lib/toInteger/index'
+import addMinutes from '../addMinutes/index'
+import requiredArgs from '../_lib/requiredArgs/index'
+
+/**
+ * @name subMinutes
+ * @category Minute Helpers
+ * @summary Subtract the specified number of minutes from the given date.
+ *
+ * @description
+ * Subtract the specified number of minutes from 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} amount - the amount of minutes to be subtracted. Positive decimals will be rounded using `Math.floor`, decimals less than zero will be rounded using `Math.ceil`.
+ * @returns {Date} the new date with the minutes subtracted
+ * @throws {TypeError} 2 arguments required
+ *
+ * @example
+ * // Subtract 30 minutes from 10 July 2014 12:00:00:
+ * const result = subMinutes(new Date(2014, 6, 10, 12, 0), 30)
+ * //=> Thu Jul 10 2014 11:30:00
+ */
+export default function subMinutes(dirtyDate: Date | number, dirtyAmount: number) {
+ requiredArgs(2, arguments)
+
+ const amount = toInteger(dirtyAmount)
+ return addMinutes(dirtyDate, -amount)
+}