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

@ai-zen/async-queue

v1.3.1

Published

AsyncQueue is a TypeScript class that provides a simple asynchronous queue implementation. It implements the `Symbol.asyncIterator` interface, allowing it to be used in `for-await-of` loops. This enables one or multiple consumers to process items in the q

Downloads

38

Readme

AsyncQueue

AsyncQueue is a TypeScript class that provides a simple asynchronous queue implementation. It implements the Symbol.asyncIterator interface, allowing it to be used in for-await-of loops. This enables one or multiple consumers to process items in the queue asynchronously.

Installation

Install AsyncQueue using npm:

npm install @ai-zen/async-queue

Usage

Importing

import AsyncQueue from "@ai-zen/async-queue";

Creating an AsyncQueue Instance

const queue = new AsyncQueue([1, 2, 3]);

Pushing Values to the Queue

queue.push(value);

// Or
queue.push(value1, value2, value3, ...);

// Or
queue.push(...values);

The push method adds one or more values to the queue, and increases its size.

Marking the Queue as Done

queue.done();

The done method marks the queue as finished. This indicates that no more items will be added to the queue.

Iterating Over the Queue

for await (const value of queue) {
  // Consume the value
}

The for await...of loop can be used to iterate over the items in the queue. This loop is asynchronous and will wait for each value to be available before consuming it.

Getting the Size of the Queue

const size = queue.size;

The size property returns the current size of the queue.

Examples

Example 1: Single Consumer

You can add data asynchronously while consuming data asynchronously.

const queue = new AsyncQueue();

(async () => {
  for (const value of [1, 2, 3, 4, 5]) {
    await sleep(1); // Simulate asynchronous operations
    queue.push(value);
  }
  queue.done();
})();

for await (const value of queue) {
  await sleep(1); // Simulate asynchronous operations
  console.log(value);
}

console.log("Done!");

Output:

1
2
3
4
5
Done!

Example 2: Multiple Consumers

This is useful for limiting the number of concurrent operations, such as network requests.

// Assume `Task` and `TaskResult` are types defined elsewhere in your code
const queue = new AsyncQueue<Task>(tasks);

queue.done();

const results: TaskResult[] = [];

// Start 10 concurrent consumers using the competing-consumers pattern
await Promise.all(
  Array.from({ length: 10 }).map(async () => {
    for await (const task of queue) {
      try {
        const result = await download(task); // Perform the task
        results.push(result);
      } catch (error) {
        console.error("Task failed:", error);
      }
    }
  })
);

Example 3: Backpressure

The library provides a very simple backpressure control mechanism that can prevent the queue length from exceeding a threshold. Just call and wait for the backpressure method before push. If the queue reaches the threshold, the backpressure method will wait until the queue length decreases to have space.

const queue = new AsyncQueue<number>();
const result: number[] = [];

(async () => {
  for (const value of Array.from({ length: 100 }).map((_, i) => i)) {
    await queue.backpressure(10); // Wait for the queue to have space, the maximum size is 10
    queue.push(value);
  }
  queue.done();
})();

for await (const value of queue) {
  await sleep(1000); // Simulate asynchronous operations
  result.push(value);
}

License

This package is licensed under the MIT License.