next-biz-date
v2.1.3
Published
Returns the next business date for a given reference date (initialDate), an offset count value, a direction (FORWARD or BACKWARDS) and a given array of holidays. This package is optimized by memoization techniques.
Downloads
49
Maintainers
Readme
next-biz-date
Provides a comprehensive way to find next business day by skipping an array of target (previously sorted) holidays and weekends.
example test:
mkdir nbd-test
cd nbd-test
npm i next-biz date
cd node_modules
cd next-biz-date
npm test
If you have nyc and mocha installed (npm i nyc -g
and npm i mocha -g
) you can also run npm test
to execute the unit tests.
You can look at the test folder for a examples on usage, which consists in creating an array of dates (strings with yyyy-mm-dd format) that then is passed to the FindNextBizDate()
function along with a cadidateDate specification.
The basic outline is:
- Define Initial Date (String with YYYY-MM-DD format. I.e.
"2020-12-24"
) - Define array of holidays (strings with YYYY-MM-DD format). I.e.:
["2020-12-25","2020-12-28","2021-01-01"]
- Define an offset (integer >=0) and a direction (
"FORWARD"
or"BACKWARDS"
). I.e.:1
- Call the
FindNextBizDate()
function passing thecandidateDate
, theholidaysArray
,offset
anddirection
you defined. - The function will determine the date that results from counting business days, skipping holidays and weekend days begining from the proposed date as "day 0" (i.e.: 2020-12-24) with offset (1) on the corresponding direction (FORWARD) is a business day (not a weekend day,not a holiday). If it is not, then it will scan for the next business day.
- Result: For
InitialDate=2020-12-24, offset=1, direction=FORWARD and holidays = ["2020-12-25","2020-12-28","2021-01-01"]
the result will be*2020-12-29*
Example Code:
See the file example-use.js within the package as an example of how to use it. Notice require('../next-biz-date');
would be changed to require('next-biz-date');
under normal conditions.
For our example nbd-test folder you can create the following example.js
file in the root of the nbd-test package.
const nbd = require("next-biz-date");
const holidays = [
"2020-12-17",
"2020-12-25",
"2020-12-28",
"2021-01-01",
"2021-01-04"
];
const testCases = [
{initialDate: "2020-12-24", offset: 1, direction: "FORWARD", expected_result: "2020-12-29"},
{initialDate: "2020-12-29", offset: 1, direction: "BACKWARDS", expected_result: "2020-12-24"}
];
testCases.forEach((item, idx)=>{
console.log(`CASE #${idx}: `,item);
console.log(" RESULT: ", nbd.FindNextBizDate(item.initialDate, holidays, item.offset, item.direction));
});