@types/async

What is @types/async?

@types/async provides TypeScript type definitions for the async library, which is a utility module that provides straight-forward, powerful functions for working with asynchronous JavaScript. It allows you to manage asynchronous control flow using various patterns such as series, parallel, waterfall, and more.

What are @types/async's main functionalities?

Series

Executes a list of functions in series, each one running once the previous function has completed. If any functions in the series pass an error to its callback, no more functions are run and the callback for the series is immediately called with the value of the error.

const async = require('async');
async.series([
  function(callback) {
    setTimeout(function() {
      console.log('Task 1');
      callback(null, 'one');
    }, 200);
  },
  function(callback) {
    setTimeout(function() {
      console.log('Task 2');
      callback(null, 'two');
    }, 100);
  }
],
function(err, results) {
  console.log(results);
});

Parallel

Executes a list of functions in parallel, without waiting until the previous function has completed. If any functions in the series pass an error to its callback, the main callback is immediately called with the value of the error.

const async = require('async');
async.parallel([
  function(callback) {
    setTimeout(function() {
      console.log('Task 1');
      callback(null, 'one');
    }, 200);
  },
  function(callback) {
    setTimeout(function() {
      console.log('Task 2');
      callback(null, 'two');
    }, 100);
  }
],
function(err, results) {
  console.log(results);
});

Waterfall

Runs an array of functions in series, each passing their results to the next in the array. However, if any of the functions pass an error to the callback, the next function is not executed and the main callback is immediately called with the error.

const async = require('async');
async.waterfall([
  function(callback) {
    callback(null, 'one', 'two');
  },
  function(arg1, arg2, callback) {
    console.log(arg1, arg2);
    callback(null, 'three');
  },
  function(arg1, callback) {
    console.log(arg1);
    callback(null, 'done');
  }
],
function (err, result) {
  console.log(result);
});

Other packages similar to @types/async

bluebird

Bluebird is a fully featured promise library with focus on innovative features and performance. It provides a wide range of utilities for working with promises, including methods for managing asynchronous control flow. Unlike async, Bluebird is promise-based rather than callback-based.

q

Q is a library for creating and composing asynchronous promises in JavaScript. It allows you to write asynchronous code that is more readable and maintainable. Q is similar to async in that it provides utilities for managing asynchronous operations, but it uses promises instead of callbacks.

rxjs

RxJS is a library for reactive programming using Observables, to make it easier to compose asynchronous or callback-based code. It provides powerful operators for working with asynchronous data streams. RxJS is more complex and feature-rich compared to async, offering a different paradigm for handling async operations.

README

Installation

npm install --save @types/async

Summary

This package contains type definitions for Async (https://github.com/caolan/async).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/async.

Additional Details

• Last updated: Mon, 15 Nov 2021 17:01:34 GMT
• Dependencies: none
• Global values: async

Credits

These definitions were written by Boris Yankov, Arseniy Maximov, Joe Herman, Angus Fenying, Pascal Martin, Dmitri Trofimov, Etienne Rossignon, Lifeng Zhu, Tümay Çeber, and Andrew Pensinger.