Minimal async jobs utility library, with streams support.
AsyncKit provides harness for parallel and serial iterators over list of items represented by arrays or objects. Optionally it accepts abort function (should be synchronously return by iterator for each item), and terminates left over jobs upon an error event. For specific iteration order built-in (ascending and descending) and custom sort helpers also supported, via asynckit.serialOrdered method.
It ensures async operations to keep behavior more stable and prevent Maximum call stack size exceeded errors, from sync iterators.
compression
size
asynckit.js
12.34 kB
asynckit.min.js
4.11 kB
asynckit.min.js.gz
1.47 kB
Install
$ npm install --save asynckit
Examples
Parallel Jobs
Runs iterator over provided array in parallel. Stores output in the result array, on the matching positions. In unlikely event of an error from one of the jobs, will terminate rest of the active jobs (if abort function is provided) and return error along with salvaged data to the main callback function.
Input Array
var parallel =require('asynckit').parallel, assert =require('assert') ;var source = [ 1,1,4,16,64,32,8,2 ], expectedResult = [ 2,2,8,32,128,64,16,4 ], expectedTarget = [ 1,1,2,4,8,16,32,64 ], target = [] ;parallel(source, asyncJob,function(err, result){assert.deepEqual(result, expectedResult);assert.deepEqual(target, expectedTarget);});// async job accepts one element from the array// and a callback functionfunctionasyncJob(item, cb){// different delays (in ms) per itemvar delay = item *25;// pretend different jobs take different time to finish// and not in consequential ordervar timeoutId =setTimeout(function() {target.push(item);cb(null, item *2); }, delay);// allow to cancel "leftover" jobs upon error// return function, invoking of which will abort this jobreturnclearTimeout.bind(null, timeoutId);}
Runs iterator over provided array sequentially. Stores output in the result array, on the matching positions. In unlikely event of an error from one of the jobs, will not proceed to the rest of the items in the list and return error along with salvaged data to the main callback function.
Input Array
var serial =require('asynckit/serial'), assert =require('assert') ;var source = [ 1,1,4,16,64,32,8,2 ], expectedResult = [ 2,2,8,32,128,64,16,4 ], expectedTarget = [ 0,1,2,3,4,5,6,7 ], target = [] ;serial(source, asyncJob,function(err, result){assert.deepEqual(result, expectedResult);assert.deepEqual(target, expectedTarget);});// extended interface (item, key, callback)// also supported for arraysfunctionasyncJob(item, key, cb){target.push(key);// it will be automatically made async// even it iterator "returns" in the same event loopcb(null, item *2);}
Note: Since object is an unordered collection of properties, it may produce unexpected results with sequential iterations. Whenever order of the jobs' execution is important please use serialOrdered method.