circuitbreaker-js
v0.1.1
Published
An implementation of the circuit breaker pattern for use in JavaScript.
Downloads
8
Maintainers
Readme
CircuitBreaker
An implementation of the circuit breaker programming pattern for use in client side javascript.
Contributing
All contributions are greatly appreciated! Please fork and make a pull request to this repository. Try your best to keep the coverage at 100%!
Setup
You'll first need to install the dependencies with npm.
npm install
Then you'll need to build the files.
node ./node_modules/gulp/bin/gulp.js build
This will take the files in ./src/*.coffee
and build them to be ./dist/circuitbreaker.js
Documentation
Currently, all documentation lives in the code. Since this is a pre-V1 version, there is no API documentation yet.
To build the annotated source, run the command:
npm run-script docs
Testing
To run the tests, just use the command:
node ./node_modules/gulp/bin/gulp.js test