forked from date-fns/date-fns
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.js
28 lines (26 loc) · 1.05 KB
/
index.js
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
import toInteger from '../_lib/toInteger/index'
import addBusinessDays from '../addBusinessDays/index'
import requiredArgs from '../_lib/requiredArgs/index'
/**
* @name subBusinessDays
* @category Day Helpers
* @summary Substract the specified number of business days (mon - fri) to the given date.
*
* @description
* Substract the specified number of business days (mon - fri) to the given date, ignoring weekends.
*
* @param {Date|Number} date - the date to be changed
* @param {Number} amount - the amount of business days to be subtracted. Fractional values are truncated towards zero.
* @returns {Date} the new date with the business days subtracted
* @throws {TypeError} 2 arguments required
*
* @example
* // Substract 10 business days from 1 September 2014:
* var result = subBusinessDays(new Date(2014, 8, 1), 10)
* //=> Mon Aug 18 2014 00:00:00 (skipped weekend days)
*/
export default function subBusinessDays(dirtyDate, dirtyAmount) {
requiredArgs(2, arguments)
var amount = toInteger(dirtyAmount)
return addBusinessDays(dirtyDate, -amount)
}