Update addWeekdays name to addBusinessDays

CHANGELOG.md

@@ -15,7 +15,7 @@ for the list of changes made since `v2.0.0-alpha.1`.
 
 ### Added
 
-- New function [addWeekDays](https://github.com/date-fns/date-fns/pull/1154),
+- New function [addBusinessDays](https://github.com/date-fns/date-fns/pull/1154),
   similar to addDays but ignoring weekends.
 
   End date can thus only ever be mon/tue/wed/thu/fri.

src/addWeekDays/index.d.ts → src/addBusinessDays/index.d.ts

@@ -1,4 +1,4 @@
 // This file is generated automatically by `scripts/build/typings.js`. Please, don't change it.
 
-import { addWeekDays } from 'date-fns'
-export = addWeekDays
+import { addBusinessDays } from 'date-fns'
+export = addBusinessDays

src/addWeekDays/index.js → src/addBusinessDays/index.js

@@ -3,7 +3,7 @@ import isWeekend from '../isWeekend/index.js'
 import toDate from '../toDate/index.js'
 
 /**
- * @name addWeekDays
+ * @name addBusinessDays
  * @category Day Helpers
  * @summary Add the specified number of weekdays (mo - fri) to the given date, ignoring weekends.
  *
@@ -17,10 +17,10 @@ import toDate from '../toDate/index.js'
  *
  * @example
  * // Add 10 weekdays to 1 September 2014:
- * var result = addWeekDays(new Date(2014, 8, 1), 10)
+ * var result = addBusinessDays(new Date(2014, 8, 1), 10)
  * //=> Mon Sep 15 2014 00:00:00 (skipped weekend days)
  */
-export default function addWeekDays(dirtyDate, dirtyAmount) {
+export default function addBusinessDays(dirtyDate, dirtyAmount) {
   if (arguments.length < 2) {
     throw new TypeError(
       '2 arguments required, but only ' + arguments.length + ' present'

src/addWeekDays/test.js → src/addBusinessDays/test.js

@@ -2,48 +2,48 @@
 /* eslint-env mocha */
 
 import assert from 'power-assert'
-import addWeekDays from '.'
+import addBusinessDays from '.'
 
-describe('addWeekDays', function() {
+describe('addBusinessDays', function() {
   it('adds the given number of weekdays', function() {
-    var result = addWeekDays(new Date(2014, 8 /* Sep */, 1), 10)
+    var result = addBusinessDays(new Date(2014, 8 /* Sep */, 1), 10)
     assert.deepEqual(result, new Date(2014, 8 /* Sep */, 15))
   })
 
   it('accepts a timestamp', function() {
-    var result = addWeekDays(new Date(2014, 8 /* Sep */, 1).getTime(), 10)
+    var result = addBusinessDays(new Date(2014, 8 /* Sep */, 1).getTime(), 10)
     assert.deepEqual(result, new Date(2014, 8 /* Sep */, 15))
   })
 
   it('converts a fractional number to an integer', function() {
-    var result = addWeekDays(new Date(2014, 8 /* Sep */, 1), 10.5)
+    var result = addBusinessDays(new Date(2014, 8 /* Sep */, 1), 10.5)
     assert.deepEqual(result, new Date(2014, 8 /* Sep */, 15))
   })
 
   it('implicitly converts number arguments', function() {
     // $ExpectedMistake
-    var result = addWeekDays(new Date(2014, 8 /* Sep */, 1), '10')
+    var result = addBusinessDays(new Date(2014, 8 /* Sep */, 1), '10')
     assert.deepEqual(result, new Date(2014, 8 /* Sep */, 15))
   })
 
   it('does not mutate the original date', function() {
     var date = new Date(2014, 8 /* Sep */, 1)
-    addWeekDays(date, 11)
+    addBusinessDays(date, 11)
     assert.deepEqual(date, new Date(2014, 8 /* Sep */, 1))
   })
 
   it('returns `Invalid Date` if the given date is invalid', function() {
-    var result = addWeekDays(new Date(NaN), 10)
+    var result = addBusinessDays(new Date(NaN), 10)
     assert(result instanceof Date && isNaN(result))
   })
 
   it('returns `Invalid Date` if the given amount is NaN', function() {
-    var result = addWeekDays(new Date(2014, 8 /* Sep */, 1), NaN)
+    var result = addBusinessDays(new Date(2014, 8 /* Sep */, 1), NaN)
     assert(result instanceof Date && isNaN(result))
   })
 
   it('throws TypeError exception if passed less than 2 arguments', function() {
-    assert.throws(addWeekDays.bind(null), TypeError)
-    assert.throws(addWeekDays.bind(null, 1), TypeError)
+    assert.throws(addBusinessDays.bind(null), TypeError)
+    assert.throws(addBusinessDays.bind(null, 1), TypeError)
   })
 })

src/esm/fp/index.js

@@ -8,7 +8,7 @@ export { default as addMinutes } from './addMinutes/index.js'
 export { default as addMonths } from './addMonths/index.js'
 export { default as addQuarters } from './addQuarters/index.js'
 export { default as addSeconds } from './addSeconds/index.js'
-export { default as addWeekDays } from './addWeekDays/index.js'
+export { default as addBusinessDays } from './addBusinessDays/index.js'
 export { default as addWeeks } from './addWeeks/index.js'
 export { default as addYears } from './addYears/index.js'
 export {

src/esm/index.js

@@ -8,7 +8,7 @@ export { default as addMinutes } from './addMinutes/index.js'
 export { default as addMonths } from './addMonths/index.js'
 export { default as addQuarters } from './addQuarters/index.js'
 export { default as addSeconds } from './addSeconds/index.js'
-export { default as addWeekDays } from './addWeekDays/index.js'
+export { default as addBusinessDays } from './addBusinessDays/index.js'
 export { default as addWeeks } from './addWeeks/index.js'
 export { default as addYears } from './addYears/index.js'
 export {

src/fp/addWeekDays/index.d.ts → src/fp/addBusinessDays/index.d.ts

@@ -1,4 +1,4 @@
 // This file is generated automatically by `scripts/build/typings.js`. Please, don't change it.
 
-import { addWeekDays } from 'date-fns/fp'
-export = addWeekDays
+import { addBusinessDays } from 'date-fns/fp'
+export = addBusinessDays

src/fp/addWeekDays/index.js → src/fp/addBusinessDays/index.js

@@ -1,8 +1,8 @@
 // This file is generated automatically by `scripts/build/fp.js`. Please, don't change it.
 
-import fn from '../../addWeekDays/index.js'
+import fn from '../../addBusinessDays/index.js'
 import convertToFP from '../_lib/convertToFP/index.js'
 
-var addWeekDays = convertToFP(fn, 2)
+var addBusinessDays = convertToFP(fn, 2)
 
-export default addWeekDays
+export default addBusinessDays

src/fp/index.js

@@ -9,7 +9,7 @@ module.exports = {
   addMonths: require('./addMonths/index.js'),
   addQuarters: require('./addQuarters/index.js'),
   addSeconds: require('./addSeconds/index.js'),
-  addWeekDays: require('./addWeekDays/index.js'),
+  addBusinessDays: require('./addBusinessDays/index.js'),
   addWeeks: require('./addWeeks/index.js'),
   addYears: require('./addYears/index.js'),
   areIntervalsOverlapping: require('./areIntervalsOverlapping/index.js'),

src/fp/index.js.flow

@@ -74,7 +74,7 @@ declare module.exports: {
   addMonths: CurriedFn2<number, Date | number, Date>,
   addQuarters: CurriedFn2<number, Date | number, Date>,
   addSeconds: CurriedFn2<number, Date | number, Date>,
-  addWeekDays: CurriedFn2<number, Date | number, Date>,
+  addBusinessDays: CurriedFn2<number, Date | number, Date>,
   addWeeks: CurriedFn2<number, Date | number, Date>,
   addYears: CurriedFn2<number, Date | number, Date>,
   areIntervalsOverlapping: CurriedFn2<Interval, Interval, boolean>,

src/index.js

@@ -9,7 +9,7 @@ module.exports = {
   addMonths: require('./addMonths/index.js'),
   addQuarters: require('./addQuarters/index.js'),
   addSeconds: require('./addSeconds/index.js'),
-  addWeekDays: require('./addWeekDays/index.js'),
+  addBusinessDays: require('./addBusinessDays/index.js'),
   addWeeks: require('./addWeeks/index.js'),
   addYears: require('./addYears/index.js'),
   areIntervalsOverlapping: require('./areIntervalsOverlapping/index.js'),

src/index.js.flow

@@ -52,7 +52,7 @@ declare module.exports: {
 
   addSeconds: (date: Date | number, amount: number) => Date,
 
-  addWeekDays: (date: Date | number, amount: number) => Date,
+  addBusinessDays: (date: Date | number, amount: number) => Date,
 
   addWeeks: (date: Date | number, amount: number) => Date,
 

typings.d.ts

@@ -113,8 +113,8 @@ declare module 'date-fns' {
 
   }
 
-  function addWeekDays(date: Date | number, amount: number): Date
-  namespace addWeekDays {
+  function addBusinessDays(date: Date | number, amount: number): Date
+  namespace addBusinessDays {
 
   }
 
@@ -1138,9 +1138,9 @@ declare module 'date-fns/addSeconds' {
   export = addSeconds
 }
 
-declare module 'date-fns/addWeekDays' {
-  import { addWeekDays } from 'date-fns'
-  export = addWeekDays
+declare module 'date-fns/addBusinessDays' {
+  import { addBusinessDays } from 'date-fns'
+  export = addBusinessDays
 }
 
 declare module 'date-fns/addWeeks' {
@@ -1918,9 +1918,9 @@ declare module 'date-fns/addSeconds/index' {
   export = addSeconds
 }
 
-declare module 'date-fns/addWeekDays/index' {
-  import { addWeekDays } from 'date-fns'
-  export = addWeekDays
+declare module 'date-fns/addBusinessDays/index' {
+  import { addBusinessDays } from 'date-fns'
+  export = addBusinessDays
 }
 
 declare module 'date-fns/addWeeks/index' {
@@ -2698,9 +2698,9 @@ declare module 'date-fns/addSeconds/index.js' {
   export = addSeconds
 }
 
-declare module 'date-fns/addWeekDays/index.js' {
-  import { addWeekDays } from 'date-fns'
-  export = addWeekDays
+declare module 'date-fns/addBusinessDays/index.js' {
+  import { addBusinessDays } from 'date-fns'
+  export = addBusinessDays
 }
 
 declare module 'date-fns/addWeeks/index.js' {
@@ -3481,8 +3481,8 @@ declare module 'date-fns/fp' {
 
   }
 
-  const addWeekDays: CurriedFn2<number, Date | number, Date>
-  namespace addWeekDays {
+  const addBusinessDays: CurriedFn2<number, Date | number, Date>
+  namespace addBusinessDays {
 
   }
 
@@ -4453,9 +4453,9 @@ declare module 'date-fns/fp/addSeconds' {
   export = addSeconds
 }
 
-declare module 'date-fns/fp/addWeekDays' {
-  import { addWeekDays } from 'date-fns/fp'
-  export = addWeekDays
+declare module 'date-fns/fp/addBusinessDays' {
+  import { addBusinessDays } from 'date-fns/fp'
+  export = addBusinessDays
 }
 
 declare module 'date-fns/fp/addWeeks' {
@@ -5353,9 +5353,9 @@ declare module 'date-fns/fp/addSeconds/index' {
   export = addSeconds
 }
 
-declare module 'date-fns/fp/addWeekDays/index' {
-  import { addWeekDays } from 'date-fns/fp'
-  export = addWeekDays
+declare module 'date-fns/fp/addBusinessDays/index' {
+  import { addBusinessDays } from 'date-fns/fp'
+  export = addBusinessDays
 }
 
 declare module 'date-fns/fp/addWeeks/index' {
@@ -6253,9 +6253,9 @@ declare module 'date-fns/fp/addSeconds/index.js' {
   export = addSeconds
 }
 
-declare module 'date-fns/fp/addWeekDays/index.js' {
-  import { addWeekDays } from 'date-fns/fp'
-  export = addWeekDays
+declare module 'date-fns/fp/addBusinessDays/index.js' {
+  import { addBusinessDays } from 'date-fns/fp'
+  export = addBusinessDays
 }
 
 declare module 'date-fns/fp/addWeeks/index.js' {
@@ -7156,8 +7156,8 @@ declare module 'date-fns/esm' {
 
   }
 
-  function addWeekDays(date: Date | number, amount: number): Date
-  namespace addWeekDays {
+  function addBusinessDays(date: Date | number, amount: number): Date
+  namespace addBusinessDays {
 
   }
 
@@ -8181,9 +8181,9 @@ declare module 'date-fns/esm/addSeconds' {
   export default addSeconds
 }
 
-declare module 'date-fns/esm/addWeekDays' {
-  import { addWeekDays } from 'date-fns/esm'
-  export default addWeekDays
+declare module 'date-fns/esm/addBusinessDays' {
+  import { addBusinessDays } from 'date-fns/esm'
+  export default addBusinessDays
 }
 
 declare module 'date-fns/esm/addWeeks' {
@@ -8961,9 +8961,9 @@ declare module 'date-fns/esm/addSeconds/index' {
   export default addSeconds
 }
 
-declare module 'date-fns/esm/addWeekDays/index' {
-  import { addWeekDays } from 'date-fns/esm'
-  export default addWeekDays
+declare module 'date-fns/esm/addBusinessDays/index' {
+  import { addBusinessDays } from 'date-fns/esm'
+  export default addBusinessDays
 }
 
 declare module 'date-fns/esm/addWeeks/index' {
@@ -9741,9 +9741,9 @@ declare module 'date-fns/esm/addSeconds/index.js' {
   export default addSeconds
 }
 
-declare module 'date-fns/esm/addWeekDays/index.js' {
-  import { addWeekDays } from 'date-fns/esm'
-  export default addWeekDays
+declare module 'date-fns/esm/addBusinessDays/index.js' {
+  import { addBusinessDays } from 'date-fns/esm'
+  export default addBusinessDays
 }
 
 declare module 'date-fns/esm/addWeeks/index.js' {
@@ -10524,8 +10524,8 @@ declare module 'date-fns/esm/fp' {
 
   }
 
-  const addWeekDays: CurriedFn2<number, Date | number, Date>
-  namespace addWeekDays {
+  const addBusinessDays: CurriedFn2<number, Date | number, Date>
+  namespace addBusinessDays {
 
   }
 
@@ -11496,9 +11496,9 @@ declare module 'date-fns/esm/fp/addSeconds' {
   export default addSeconds
 }
 
-declare module 'date-fns/esm/fp/addWeekDays' {
-  import { addWeekDays } from 'date-fns/esm/fp'
-  export default addWeekDays
+declare module 'date-fns/esm/fp/addBusinessDays' {
+  import { addBusinessDays } from 'date-fns/esm/fp'
+  export default addBusinessDays
 }
 
 declare module 'date-fns/esm/fp/addWeeks' {
@@ -12396,9 +12396,9 @@ declare module 'date-fns/esm/fp/addSeconds/index' {
   export default addSeconds
 }
 
-declare module 'date-fns/esm/fp/addWeekDays/index' {
-  import { addWeekDays } from 'date-fns/esm/fp'
-  export default addWeekDays
+declare module 'date-fns/esm/fp/addBusinessDays/index' {
+  import { addBusinessDays } from 'date-fns/esm/fp'
+  export default addBusinessDays
 }
 
 declare module 'date-fns/esm/fp/addWeeks/index' {
@@ -13296,9 +13296,9 @@ declare module 'date-fns/esm/fp/addSeconds/index.js' {
   export default addSeconds
 }
 
-declare module 'date-fns/esm/fp/addWeekDays/index.js' {
-  import { addWeekDays } from 'date-fns/esm/fp'
-  export default addWeekDays
+declare module 'date-fns/esm/fp/addBusinessDays/index.js' {
+  import { addBusinessDays } from 'date-fns/esm/fp'
+  export default addBusinessDays
 }
 
 declare module 'date-fns/esm/fp/addWeeks/index.js' {
@@ -16303,7 +16303,7 @@ interface dateFns {
 
   addSeconds(date: Date | number, amount: number): Date
 
-  addWeekDays(date: Date | number, amount: number): Date
+  addBusinessDays(date: Date | number, amount: number): Date
 
   addWeeks(date: Date | number, amount: number): Date