@zxteam/cancellation

ZXTeam's Cancellation Sources

Interfaces

CancellationTokenSource

Classes

AggregatedCancellationToken

Allows to watch several CancellationToken as single token.

graph LR
  CancellationToken1(CancellationToken 1)
  CancellationToken2(CancellationToken 2)
  CancellationTokenN(CancellationToken N)
  CancellationToken1 --> AggregatedCancellationToken
  CancellationToken2 --> AggregatedCancellationToken
  CancellationTokenN --> AggregatedCancellationToken
  AggregatedCancellationToken --> Action

The Action will be cancelled if any of CancellationToken fire to active state.

SimpleCancellationTokenSource

TimeoutCancellationTokenSource

Functions

sleep

await sleep(DUMMY_CANCELLATION_TOKEN, 25); // Suspend execution for 25 milliseconds

const cancellationTokenSource = new ManualCancellationTokenSource();
...
await sleep(cancellationTokenSource.token, 25); // Suspend execution for 25 milliseconds or cancel if cancellationTokenSource activates

const cancellationTokenSource = new ManualCancellationTokenSource();
...
await sleep(cancellationTokenSource.token); // Suspend infinitely while cancellationTokenSource activates