call_bill
This library is used to bill telephone calls. Can also be used to sort by LCR (Least Cost Routing).
Installing
Add this library to your package.json configuration:
"dependencies":
Using it
var call_bill = ; var result = call_bill;
See below to know how the rates
variable should be formed. The result
variable is an object that contains the total cost, seconds, and effective
seconds billed, along with a full description of any rates used.
Validating Input and Output
In the schema directory you will find the JSON Schema definitions.
Inputs
Outputs
Rates Examples
The rate
JSON Object is documented in the source code for
index.js.
Below you will find a few examples for the most common usage. More examples can be found in the tests.
Flat rate
- The total time will be billed at $0.015 with a billing increment of 6s.
var flatRate = increment: 6 costPerMinute: 0015 description: 'Standard flat rate for US calls';
First seconds with one rate, next seconds with another
- The first 15 seconds will be billed at $0.015 with a billing increment of 15s.
- The remaining time will be billed at $0.017 with a billing increment of 6s.
var rates = increment: 15 costPerMinute: 0015 duration: 15 increment: 6 costPerMinute: 0017;
Complex: First seconds free, then incrementally expensive
- The first 5 minutes for these calls will be free.
- The next 10 minutes will be billed at $0.017/min with a billing increment of 6s.
- The remaining time will be billed at $0.02/min with a billing increment of 6s.
var rates = increment: 15 costPerMinute: 0 duration: 300 increment: 6 costPerMinute: 0017 duration: 600 increment: 6 costPerMinute: 002;
LCR (Least Cost Routing)
var result = call_bill;
Where rates
is an array of an array of rates, for example:
increment: 6 costPerMinute: 0020 increment: 6 costPerMinute: 0017 increment: 6 costPerMinute: 0015
Essentially passing an array of the same rates
argument passed to call_bill.bill
Developers
This project uses standard npm scripts. Current tasks include:
- test: Runs Mocha tests.
- jsdoc: Runs JSDoc3.
- eslint: Runs ESLint.
- coverage: Runs the tests and then Instanbul to get a coverage report.
- build: This is the default task, and will run all the other tasks.
Running an npm task
To run a task, just do:
npm run build
Contributing
To contribute:
- Make sure you open a concise and short pull request.
- Throw in any needed unit tests to accomodate the new code or the changes involved.
- Run
npm run build
and make sure everything is ok before submitting the pull request (make eslint happy). - Your code must comply with the Javascript Standard Style, ESLint should take care of that.
License
The source code is released under Apache 2 License.
Check LICENSE file for more information.