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

@neolution-ch/als-context

v3.2.0

Published

Provides an easy to use class for using AsyncLocalStorage from 'async_hooks' by nodejs

Downloads

2,116

Readme

@neolution-ch/als-context

This package is a wrapper for the AsyncLocalStorage. Documentation: https://nodejs.org/api/async_context.html#async_context_class_asynclocalstorage.

https://dev.to/miketalbot/simplify-your-node-code-with-continuation-local-storage-variables-4b3k:

We have all kinds of ways of managing application state on the front end, but when it comes to the server we can find ourselves lost is a mass of parameters or context variables that need to be forwarded to and through everything in case something needs it later.

This is because we can't have global state on something which is processing many things in parallel for different users. At best we could try to create a context and associate that, but there is an easier way using Continuation Local Storage.

CLS is so named because it's a bit like Thread Local Storage - data specifically owned by a thread. It's a set of data that is scope to the current execution context. So no matter how many continuations are flowing through the server, each is sure to have it's own copy.

So basically we can write and read data to the current request. For example we can write a cookie we receive in the request to the CLS and read it anywhere we want (instead of manually passing it around everywhere).

You can also pass the ALSContext a name to have multiple contexts, but its optional.

Example

The AlsContext is typed so you can pass it an interface to make it strongly typed.

export interface AlsTokenContext {
  token?: string;
}

Setting it (usually you want to do this in your server file)

const alsContext = new AlsContext<AlsTokenContext>();

await alsContext.run(
  // this is the function that will be run in inside the Context
  async () => {
    const store = alsContext.getStore();
    if (store) {
      store.token = token;
    }
  },
  {
    token: "my token",
  },
);

Using it:

// eslint-disable-next-line global-require
const alsModule = require("@neolution-ch/als-context");
const alsContext: AlsContext<AlsTokenContext> = new alsModule.AlsContext();
return alsContext.getStore()?.token;

Caveats

:warning: This package only works on the node.js environment not in the browser! So make sure you only require / import it in on the server side, for example like this:

if (typeof window === "undefined") {
  // eslint-disable-next-line global-require
  const alsModule = require("@neolution-ch/als-context");
  const alsContext: AlsContext<YourInterfaceHere> = new alsModule.AlsContext();
}

But we are allowed to always import the type:

import { AlsContext } from "@neolution-ch/als-context/dist/lib/AlsContext/AlsContext";
if (typeof window === "undefined") {
  // eslint-disable-next-line global-require
  const alsModule = require("@neolution-ch/als-context");
  const alsContext: AlsContext<YourInterfaceHere> = new alsModule.AlsContext();
}

You also have to tell webpack to not try to bundle it like so:

webpack: (config, { isServer }) => {
    if (!isServer) {
        config.plugins.push(new IgnorePlugin(/^(\@neolution-ch\/als-context)$/));
    }

    return config;
},