README
moment-business-days-ph
This is a momentJS plugin that allows you to use only business days (Monday to Friday) with italian holidays.
NOTES:
- This plugin uses moment-business-days.
- This plugin sets the italian locale (it), format (DD/MM) and official italian holidays.
- It is possible to add custom holidays (for local or district holidays) with italian format (DD/MM).
- For the documentation see moment-business-days and moment.
Install
// For NodeJS
$ npm install moment-business-days-ph
// or install and save on package.json
$ npm install --save moment-business-days-ph
// For bower
$ bower install moment-business-days-ph
How to use
// NodeJS
var moment = require('moment-business-days-ph');
// You'll be able use moment and moment-business-days.js as you normally do
// Browser
// Add after moment.js and moment-business-days.js library
<script src="moment.js"></script>
<script src="moment-business-days.js"></script>
<script src="moment-business-days-ph.js"></script>
Add a custom holiday
** Note that only fixed holidays are supported on this version ** ** You may overwrite the holiday function or submit a PR for determining the other holidays **
var moment = require('moment-business-days-ph');
moment.addHoliday('08/09'); // 'custom local holiday' on 8th September (DD/MM)
/*
moment-business-days-ph will now stop considering fixed regular holidays as business day
All other Philippine holidays is already set:
holidays: [
'01/01', // New Year
'09/04', // Araw ng Kagitingan
'01/05', // Labor Day
'12/06', // Independence Day
'30/11', // Bonifacio Day
'25/12', // Christmas Day
'30/12', // Rizal Day
]
*/
Run Tests
npm test
Methods from moment-business-days
businessAdd(days)
Will add just business days excluding Saturday and Sunday, return a moment date object:
// 30-01-2015 is Friday, DD-MM-YYYY is the format
moment('30-01-2015', 'DD-MM-YYYY').businessAdd(3)._d // Wed Feb 04 2015 00:00:00 GMT-0600 (CST)
businessSubtract(days)
Will subtract just business days excluding Saturday and Sunday, return a moment date object:
// 27-01-2015 is Tuesday, DD-MM-YYYY is the format
moment('27-01-2015', 'DD-MM-YYYY').businessSubtract(3)._d // Thu Jan 22 2015 00:00:00 GMT-0600 (CST)
isBusinessDay()
Check if the date is a business day and return true/false:
// 31-01-2015 is Saturday
moment('31-01-2015', 'DD-MM-YYYY').isBusinessDay() // false
// 30-01-2015 is Fridat
moment('30-01-2015', 'DD-MM-YYYY').isBusinessDay() // true
nextBusinessDay()
Will retrieve the next business date as moment date object:
//Next busines day of Friday 30-01-2015
moment('30-01-2015', 'DD-MM-YYYY').nextBusinessDay()._d // Mon Feb 02 2015 00:00:00 GMT-0600 (CST)
//Next busines day of Monday 02-02-2015
moment('02-02-2015', 'DD-MM-YYYY').nextBusinessDay()._d //Tue Feb 03 2015 00:00:00 GMT-0600 (CST)
prevBusinessDay()
Will retrieve the previous business date as moment date object:
//Previous busines day of Monday 02-02-2015
moment('02-02-2015', 'DD-MM-YYYY').prevBusinessDay()._d // Fri Jan 30 2015 00:00:00 GMT-0600 (CST)
//Previous busines day of Tuesday 03-02-2015
moment('03-02-2015', 'DD-MM-YYYY').prevBusinessDay()._d //Mon Feb 02 2015 00:00:00 GMT-0600 (CST)
monthBusinessDays()
Retrieve an array of the business days in the month, each one is a moment object.
//Busines days in month January 2015
moment('01-01-2015', 'DD-MM-YYYY').monthBusinessDays()
/*
[ { _isAMomentObject: true,
_i: '01-01-2015',
_f: 'DD-MM-YYYY',
_isUTC: false,
_pf:{ ... },
_locale: { ... },
_d: Thu Jan 01 2015 00:00:00 GMT-0600 (CST)
} {
...
},
( ... )
]
*/
monthNaturalDays()
Is like monthBusinessDays(), but this method will include the weekends on it's response.
monthBusinessWeeks()
Retrieve an array of arrays, these arrays are the representation of a business weeks and each week (array) have it own business days (Monday to Friday). There could be the case that one week (array) have less than 5 days, this is because the month started on the middle of the week, for example: the first week of January 2015 just have two days, Thursday 1st and Friday 2nd. Each day in the week arrays are moment objects.
//Busines weeks in month January 2015
moment('01-01-2015', 'DD-MM-YYYY').monthBusinessWeeks()
/*
[ [ { _isAMomentObject: true,
_i: '01-01-2015',
_f: 'DD-MM-YYYY',
_isUTC: false,
_pf: [...],
_locale: [...],
_d: Thu Jan 01 2015 00:00:00 GMT-0600 (CST)
}, { _isAMomentObject: true,
_i: '01-01-2015',
_f: 'DD-MM-YYYY',
_isUTC: false,
_pf: [...],
_locale: [...],
_d: Fri Jan 02 2015 00:00:00 GMT-0600 (CST) }
],
[...]
]
*/
monthNaturalWeeks()
It's like monthBusinessWeeks(), but this method will include weekends on it's response.
The objects returned by functions are momentjs objects (except isBusinessDay) so you can handle it with moment native functions.
businessDiff()
Calculate number of busines days between dates.
var diff = moment('05-15-2017', 'MM-DD-YYYY').businessDiff(moment('05-08-2017','MM-DD-YYYY'));
// diff = 5