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.1 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 addDays from '../addDays/index'
import requiredArgs from '../_lib/requiredArgs/index'
/**
* @name subDays
* @category Day Helpers
* @summary Subtract the specified number of days from the given date.
*
* @description
* Subtract the specified number of days 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 days to be subtracted. Fractional values are truncated towards zero.
* @returns {Date} the new date with the days subtracted
* @throws {TypeError} 2 arguments required
*
* @example
* // Subtract 10 days from 1 September 2014:
* const result = subDays(new Date(2014, 8, 1), 10)
* //=> Fri Aug 22 2014 00:00:00
*/
export default function subDays(dirtyDate: Date | number, dirtyAmount: number) {
requiredArgs(2, arguments)
const amount = toInteger(dirtyAmount)
return addDays(dirtyDate, -amount)
}