Class Mutex

A mutex is a task queue where at most one task is active at a time.

Implements

PromiseLike<unknown>

Index

Constructors

Methods

initiateTask run terminate then

Constructors

constructor

new Mutex(owner, initial?): Mutex
Parameters
- owner: {}
- Optionalinitial: PromiseLike<unknown>
Returns Mutex
- Defined in packages/general/src/util/Mutex.ts:20

Methods

`Protected`initiateTask

initiateTask(task): Promise<unknown>
Execute a task immediately if it is a function.
Parameters
- task: PromiseLike<unknown> | (() => PromiseLike<unknown>)
Returns Promise<unknown>
- Defined in packages/general/src/util/Mutex.ts:94

run

run(task, cancel?): void
Enqueue additional work.

If task is a function it runs when current activity completes. If it is a promise then the mutex will not clear until task resolves.
Parameters
- task: PromiseLike<unknown> | (() => PromiseLike<unknown>)
- Optionalcancel: (() => void)
  - - (): void
    - Returns void
Returns void
- Defined in packages/general/src/util/Mutex.ts:45

terminate

terminate(cleanup?): void
Cancel remaining work and perform one last task with the Mutex held.
Parameters
- Optionalcleanup: (() => PromiseLike<void>)
  - - (): PromiseLike<void>
    - Returns PromiseLike<void>
Returns void
- Defined in packages/general/src/util/Mutex.ts:71

then

then<TResult1, TResult2>(onfulfilled?, onrejected?): PromiseLike<TResult1 | TResult2>
As a PromiseLike, you can await the Mutex. This promise resolves when current activity completes but the mutex may engage in another activity immediately thereafter. So the mutex is not guaranteed to be available after an await.
Type Parameters
- TResult1 = void
- TResult2 = never
Parameters
- Optionalonfulfilled: null | ((value: unknown) => TResult1 | PromiseLike<TResult1>)
- Optionalonrejected: null | ((reason: any) => TResult2 | PromiseLike<TResult2>)
Returns PromiseLike<TResult1 | TResult2>
Implementation of PromiseLike.then
- Defined in packages/general/src/util/Mutex.ts:32