NOTE: There are no replacements for AsyncBoundedQueue or Pulsar, they have been deprecated.
This library contains a number of coordination primitives to assist in asynchronous application development in JavaScript and TypeScript.
This includes useful additions for building complex asynchronous logic including:
The CancellationTokenSource and
CancellationToken primitives allow you to
create asynchronous operations that can be canceled externally. The following is an example
of a function used to download a file asynchronously that can be canceled:
import * as http from "http";import * as fs from "fs";import { CancellationTokenSource, CancellationToken } from "prex";function downloadFile(from: string, to: string, token = CancellationToken.none) { return new Promise<void>((resolve, reject) => { const request = http.get(from); // abort the request if canceled. const registration = token.register(() => { request.abort(); reject
A Semaphore can be used to protect access to a critical
section of your code when you must limit access across multiple async operations. The following
is an example of two functions which both need exclusive access to a single resource but could
possibly be preempted when suspended while awaiting an asynchronous operation:
import { Semaphore } from "prex";const criticalResource = new Semaphore(1);async function updateCriticalLocalResource() { // Acquire a lock on the critical resource await criticalResource.wait(); // Make local changes... // await a network resources await postUpdateToNetworkResource(changes); // release the lock criticalResource.release();}async function deleteCriticalLocalResource() { // Acquire a lock on the critical resource await criticalResource.wait(); // Make local changes...
A Barrier can be used to coordinate complex async operations:
import { Barrier } from "prex";const barrier = new Barrier(/*participantCount*/ 3);async function processNpcAI() { while (true) { // process AI activities... await barrier.signalAndWait(); }}async function processGameRules() { while (true) { // process game rules await barrier.signalAndWait(); }}async function processGameInput() { while (