npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@stdlib/utils-async-parallel

v0.1.0

Published

Execute a set of functions in parallel.

Downloads

42

Readme

parallel

NPM version Build Status Coverage Status

Execute functions in parallel and pass the results of all functions to a provided callback.

Installation

npm install @stdlib/utils-async-parallel

Usage

var parallel = require( '@stdlib/utils-async-parallel' );

parallel( fcns, [options,] done )

Executes a set of functions in parallel and passes the results of all functions to a provided callback.

function a( clbk ) {
    setTimeout( onTimeout, 0 );
    function onTimeout() {
        clbk( null, 2 );
    }
}

function b( clbk ) {
    setTimeout( onTimeout, 0 );
    function onTimeout() {
        clbk( null, 4 );
    }
}

function done( error, out ) {
    if ( error ) {
        throw error;
    }
    console.log( out );
    // => [ 2, 4 ]
}

var fcns = [ a, b ];

parallel( fcns, done );

The function accepts the following options:

  • limit: maximum number of functions to execute concurrently. Default: infinity.
  • thisArg: execution context for each function.

To limit the maximum number of functions executing in parallel, set the limit option.

function a( clbk ) {
    setTimeout( onTimeout, 0 );
    function onTimeout() {
        clbk( null, 2 );
    }
}

function b( clbk ) {
    setTimeout( onTimeout, 0 );
    function onTimeout() {
        clbk( null, 4 );
    }
}

function done( error, out ) {
    if ( error ) {
        throw error;
    }
    console.log( out );
    // => [ 2, 4 ]
}

var fcns = [ a, b ];

var opts = {
    'limit': 1
};

parallel( fcns, opts, done );

To set the this context for all functions in the provided function array, set the thisArg option.

function a( clbk ) {
    this.idx += 1;
    clbk( null, 2 );
}

function b( clbk ) {
    this.idx += 1;
    clbk( null, 4 );
}

var fcns = [ a, b ];
var ctx = {
    'idx': 0
};
var opts = {
    'thisArg': ctx
};

parallel( fcns, opts, done );

function done( error, out ) {
    if ( error ) {
        throw error;
    }
    console.log( ctx.idx );
    // => 2
}

parallel.factory( fcns, [options] )

Returns a reusable function which executes a set of functions in parallel.

function a( clbk ) {
    setTimeout( onTimeout, 0 );
    function onTimeout() {
        clbk( null, 2 );
    }
}

function b( clbk ) {
    setTimeout( onTimeout, 0 );
    function onTimeout() {
        clbk( null, 4 );
    }
}

function done( error, out ) {
    if ( error ) {
        throw error;
    }
    console.log( out );
    // => [ 2, 4 ]
}

var fcns = [ a, b ];

var run = parallel.factory( fcns );

run( done );
run( done );
run( done );

Notes

  • The order of the results provided to the done callback corresponds to the order of the provided functions.
  • When executed, each provided function is invoked with a single callback argument. The callback should be invoked upon function completion. The first argument is reserved as an error argument (which can be null). The second argument is reserved for any results which should be passed to the done callback upon completion of all provided functions.
  • If any function fails to invoke the callback argument, the done callback will never be invoked.
  • This implementation is intended to start asynchronous tasks so that execution of each task runs concurrently. If provided a function which does not perform asynchronous tasks, the function will execute synchronously. Hence, this implementation does not guarantee that execution is asynchronous. To do so, wrap the done callback in a function which either executes at the end of the current stack (e.g., nextTick) or during a subsequent turn of the event loop (e.g., setImmediate, setTimeout).
  • The function executes provided functions in the same thread. Accordingly, the function does not spawn new threads.

Examples

var parallel = require( '@stdlib/utils-async-parallel' );

function foo( clbk ) {
    setTimeout( onTimeout, 300 );
    function onTimeout() {
        clbk( null, 'one' );
    }
}

function bar( clbk ) {
    setTimeout( onTimeout, 100 );
    function onTimeout() {
        clbk( null, 'two' );
    }
}

function done( error, results ) {
    if ( error ) {
        throw error;
    }
    console.log( results );
    // => [ 'one', 'two' ]
}

var fcns = [ foo, bar ];

parallel( fcns, done );

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.