BusinessDaysCalculator
This is a library for calculating the number of business days between two dates, considering the number of holidays in the range.
You can use it as a Node.js module or in browser.
Instalation
If you use NPM, then you can install it with npm install business-days-calculator
. Otherwise, you can download the latest release and use it in your browser or in other Javascript-based projects.
Usage
Node.js
var calculator = ;var calendar = ;calculator; var today = ;console;console;console;
Browser
API Reference
ContinuousDaysBetween(date1, date2)
Counts the number of continuous/consecutive days between date1 and date2
date1: date, required. Starting date.
date2: date, required. Ending date.
return: integer. Number of continous days between dates.
Example
var calculator = require; var data = calculator.ContinuousDaysBetween;\\data equals to 30
HolidaysBetween(date1, date2)
Counts the number of holidays between date1 and date2
date1: date, required. Starting date.
date2: date, required. Ending date.
return: integer. Number of holidays according to the calendar in use.
Example
var calendar = require;var calculator = require;calculator.SetCalendar; var data = calculator.HolidaysBetween;\\data equals to 12
IsBusinessDay(date)
Verifies if date doesn't correspond to a Sunday or Saturday, neither is a holiday.
date: date, required. Date reference.
return: Boolean. Whether date is a business day or not.
Example
var calendar = require;var calculator = require;calculator.SetCalendar; var data = calculator.IsBusinessDay;\\data equals to false
IsHoliday(date)
Verifies if date happens to be a holiday.
date: date, required. Date reference.
return: Boolean. Whether date is a holiday or not.
Example
var calendar = require;var calculator = require;calculator.SetCalendar; var data = calculator.IsHoliday;\\data equals to true
Locale()
Verifies which locale/calendar the library is set to use.
return: String. Locale identificator.
Example
var calendar = require;var calculator = require;calculator.SetCalendar; var data = \\data equals to 'brazil'
NextHoliday(date)
Retrieves the next holiday after date.
date: date, required. Date reference (date won't be considered as a candidate).
return: Mixed. date if there's a holiday in the calendar anywhere after date; false, otherwise.
Example
var calendar = require;var calculator = require;calculator.SetCalendar; var data = calculator.NextHoliday;\\data equals to 'Mon Feb 24 2020'
NextWorkingDay(date, considerHolidays)
Retrieves the next business/working day after date.
date: date, required. Date reference (date won't be considered as a candidate).
considerHolidays: boolean, optional (default: true). Whether the holiday calendar should be used in the filter. If negative, this method will output the first week day after date;
return: date. Next business/working day.
Example
var calendar = require;var calculator = require;calculator.SetCalendar; var data = calculator.NextHoliday;\\data equals to 'Mon Feb 24 2020'
SetCalendar(calendar)
Configures the library to use calendar as a reference for holidays.
calendar: Mixed, required. object, as an extension of 'holidays-calendar' library (useful in Node.js environment only); String representing the locale to be used.
Example
var brazilianCalendar = require;var calendar = require;var calculator = require; calculator.SetCalendar; var data = \\data equals to 'brazil' calendar.AddCalendar; // adds a new calendar, although empty calculator.SetCalendar;data = \\data equals to 'generic' calendar.AddCalendar; // adds a new calendar, although emptycalculator.SetCalendar;data = \\data equals to 'generic2'
WorkingDaysBetween(date1, date2, discountHolidays)
Counts the number of business days between date1 and date2
date1: date, required. Starting date.
date2: date, required. Ending date.
discountHolidays: boolean, optional (default: true). Whether the library should consider holidays in the counting.
return: integer. Number of business days according to the calendar in use.
Example
var calendar = require;var calculator = require;calculator.SetCalendar; var data = calculator.WorkingDaysBetween;\\data equals to 250data = calculator.WorkingDaysBetween;\\data equals to 262