@vritant/async-action-pump

About

A package containing utilities to dynamically queue async operations.

Usage

AsyncActionPump

Can be used to dynamically queue and run asynchronous operations

1import { AsyncActionPump, LogMessage } from '@vritant/async-action-pump'
2
3// Create options for async action pump. This is optional.
4const options = {
5    logger: (logMessage: LogMessage) => {
6        if (logMessage.type === 'log') {
7            // verbose logs from the async action pump.
8            console.log(logMessage.message);
9        } else if (logMessage.type === 'error') {
10            // errors encountered in the async action pump.
11            // These contain errors not caught by posted actions.
12            console.error(logMessage.error);
13        }
14    }
15}
16
17// Create an AsyncActionPump
18const asyncActionPump = AsyncActionPump.create<number>(options);
19
20// Post an async action into the queue.
21// Since the queue is empty, the operation will immediately run.
22asyncActionPump.post(async () => await someAsyncOperation());
23
24// Post another async action into the queue.
25// Since an operation was already posted previously, this will
26// only run once the previous operation is complete.
27asyncActionPump.post(async () => await someAsyncOperation());
28
29// Wait for all operations so far to be complete.
30await asyncActionPump.waitForAllActions();
31
32// Post an action and wait for it's completion.
33// This can be used to run async actions in order and get their result.
34const res = asyncActionPump.postAsync(() => Promise.resolve(1));
35console.log(res); // res = 1

ActionPump

Can be used to dynamically queue and synchronous operations asynchronously

1import { ActionPump } from '@vritant/async-action-pump'
2
3// Create an ActionPump
4const actionPump = ActionPump.create<void>();
5
6// Post an action into the queue.
7// Since the queue is empty, the operation will immediately run asynchronously.
8actionPump.post(() => someOperation());
9
10// Post another action into the queue.
11// Since an operation was already posted previously, this will
12// only run once the previous operation is complete.
13actionPump.post(() => someOperation());

CancellableAsyncActionPump

Can be used to dynamically queue and run asynchronous cancellable operations. It is similar to the AsyncActionQueue, but adds the ability to cancel queued actions as well.

1import { CancellableAsyncActionPump } from '@vritant/async-action-pump'
2
3// Create an CancellableAsyncActionPump
4const cancellableAsyncActionPump = CancellableAsyncActionPump<void>.create();
5
6// Post a cancellable async action into the queue.
7// Since the queue is empty, the operation will immediately run.
8cancellableAsyncActionPump.post(
9    async (cancellationToken: ICancellationToken) => 
10        await someCancellableOperation(cancellationToken)
11    );
12
13// Cancel all running and queued actions so far in the queue.
14// NOTE: this does not terminate the running action. The cancellation
15// token used by the running action is signalled a cancellation.
16// It is the action's responsibility to terminate. No future actions will be
17// run until the running action terminates.
18cancellableAsyncActionPump.cancelQueuedAndRunningOperations();