icream
v1.9.0
Published
javascript async library
Downloads
5
Maintainers
Readme
icream
Javascript library for asynchronous programming. It implements Javascript promises and also provides other primitives useful in asynchronouse programming: streams and stream manipipulation functions, asynchronous sequences and transactions, etc.
Installation
Make sure you have node.js installed. Source code is available onGitHub. Run
npm install icream
to install this package. Installation includes file lib/icream.js
for node.js and dist/icream.min.js
for use in a browser.
Usage
var icream:ICreamStatic = require('icream')
icream.seq(
()=> asyncFunction(), // call some function returning promise value
(result)=> {
// handle the function call result
// and possibly return other value
},
... // continue the sequence of async functions
)
Library is implemented in TypeScript which compiles to nice readable Javascript, but also provides optional type checks, and some sugar for class declarations and shorthand function declarations.
The best way to learn more about library is to look into definitions file lib/icream.d.ts, or walk through unit tests.
Contribute
For bugs, idears, or feature requests open create issue in the tracker. If you whant to change/contribute your code you need to install dev dependencies and grunt-cli:
cd icream
node install
node install grunt-cli
For automation we use grunt. To rebuild project issue the grunt
build command. To run mocha tests:
grunt mocha
In browser tests are run using karma. To test in chrome browser localy run grunt chrome
. Modify project settings to use Travis CI and SauceLabs.