forked from date-fns/date-fns
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.ts
32 lines (30 loc) · 1.15 KB
/
index.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
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. Fractional values are truncated towards zero.
* @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)
}