array-series

What is array-series?

The array-series npm package allows you to run an array of asynchronous functions in series, meaning one after the other, where each function waits for the previous one to complete before starting.

What are array-series's main functionalities?

Run asynchronous functions in series

This feature allows you to run an array of asynchronous functions in series. Each function in the array takes a callback function as its argument, which it calls when it has completed its task. The next function in the array will not start until the previous one has called its callback.

const series = require('array-series');

const tasks = [
  function (done) {
    setTimeout(function () {
      console.log('Task 1');
      done();
    }, 1000);
  },
  function (done) {
    setTimeout(function () {
      console.log('Task 2');
      done();
    }, 500);
  },
  function (done) {
    setTimeout(function () {
      console.log('Task 3');
      done();
    }, 100);
  }
];

series(tasks, function (err) {
  if (err) throw err;
  console.log('All tasks completed');
});

Other packages similar to array-series

async

The async package provides a wide range of utilities for working with asynchronous JavaScript. It includes methods for running functions in series, parallel, and other control flow patterns. Compared to array-series, async offers more flexibility and additional features such as error handling, queue management, and more.

run-series

The run-series package is similar to array-series in that it allows you to run an array of asynchronous functions in series. However, run-series is part of a suite of small modules for asynchronous control flow, which can be used together for more complex workflows.

promise-series

The promise-series package allows you to run an array of functions that return promises in series. This package is useful if you prefer working with promises instead of callbacks. It provides a similar functionality to array-series but leverages the power of promises for better readability and error handling.

README

Array Series

Call an array of asynchronous functions in series

API

series(fns[, context[, callback]])

var series = require('array-series')

series([
  function (done) {
    done()
  }
], this, function (err) {

})

fns

fns is an array of functions to call in series. The argument signature should be:

function (done) {
  done(new Error())
  // or
  done()
}

That is, each function should only take a done as an argument. Each callback should only take an optional Error as an argument.

context

Optional context to pass to each fn. Basically fn.call(context, done).

callback(err)

function (err) {

}

Only argument is an Error argument. It will return the first error in the series of functions that returns an error, and no function after will be called.

License

The MIT License (MIT)

Copyright (c) 2013 Jonathan Ong [e-mail]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.