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

@thrall/async-chain

v1.0.10

Published

Chain asynchronous methods with await.

Downloads

13

Readme

Table of Contents

Motivation

In many programming languages, the builder pattern is a popular way to write expressive APIs that modify an internal state. For example, instead of writing raw SQL queries or using an ORM, KnexJS allows you to chain together the pieces of the query:

knex('users')
  .select('*')
  .where('id')
  .first();

Typically, patterns like this can be trivially implemented by returning this from the methods:

class Builder {
  method1() {
    console.log("Method 1");
    return this;
  }

  method2() {
    console.log("Method 2");
    return this;
  }

  method3() {
    console.log("Method 3");
    return this;
  }
}

(new Builder())
  .method1()
  .method2()
  .method3();

Chains are also very common in functional constructs:

[ ... Array(20) ]
  .map (x => Math.random())
  .sort()
  .reduce((x, y) => x + y)

The problem arises when any function in the chain is asynchronous and returns a promise. This will not work:

class Builder {
  async method1() {
    console.log("Method 1");
    return this;
  }

  async method2() {
    console.log("Method 2");
    return this;
  }

  async method3() {
    console.log("Method 3");
    return this;
  }
}

// Throws: Uncaught TypeError: (intermediate value).method1(...).method2 is not a function
await (new Builder())
  .method1()
  .method2()
  .method3();

To make this work you must add additional boilerplate:

await (new Builder())
  .method1()
  .then((builder) => builder.method2())
  .then((builder) => builder.method3())

That's where async-chain comes in! You can either use the chain function to wrap an asynchronous object or function or you can extend the Chainable in your builder.

// Works!
await chain(new Builder())
  .method1()
  .method2()
  .method3();

It is worth noting that while there are many existing libraries that provide methods for chaining asynchronous operations. Most of them arguably add even more boilerplate than just chaining a series of .then promises.

Getting Started

To install the library, run npm install --save @thrall/async-chain.

There are two ways to use async-chain. If you are using ES6 classes, you can extend Chainable:

import { Chainable } from "async-chain";

class Builder extends Chainable {
  // ...
}

or you can wrap an object or function with the chain method before your await call:

import { chain } from "async-chain";

await chain(object)
  .method1()
  .method2()
  .property
  .slice(1) [0].length;

You will notice in the example above that properties of an asynchronous result can also be chained, as well as synchronous methods, native prototypes and array accessors. If at any point in the chain there is an undefined property or an error occurs, the entire result will return false. If strict mode is enabled and an error occurs or a requested property does not exist, the entire chain will throw an error.

Like normal promises, you can use .then, .catch, and .finally:

chain(object)
  .method1()
  .method2()
  .property
  .slice(1) [0].length
  .then((length) => length / 2)
  .then((length) => console.log(length))
  .catch((error) => console.error(error))
  .finally(() => console.log("Finished"));

You can also use the "pipe" function (when pipe is not already defined as a property on the chain's context) which allows you to operate on the current value of the chain without having to write a separate chain. For example, instead of:

let value = await chain([ "1", "2", "3" ])
  .slice(1) [0];

value = +value;

console.log(value); // 2

You can write:

let value = await chain([ "1", "2", "3" ])
  .slice(1) [0]
  .pipe((value) => +value);

console.log(value); // 2

Reference

function chain(target = global, strict = false, finalize = false): Chainable

class Chainable<T> extends Function {
  constructor(target?: Object | Function, strict?: boolean, finalize?: boolean): ProxyHandler
}

Examples

Network Request

Node v18 introduces a native implementation of the browser's fetch API:

import { chain } from "async-chain";

const ip = await chain()
  .fetch("https://httpbin.org/anything")
  .json()
  .origin;

Credits

This library improves upon the proxy method established in Awaitium.