Class Mutex

Hierarchy

Mutex

Implements

MutexInterface

Index

Constructors

Properties

Methods

acquire cancel isLocked release runExclusive

Constructors

constructor

new Mutex(cancelError?: Error): Mutex
Parameters
- Optional cancelError: Error
Returns Mutex
- Defined in node_modules/async-mutex/lib/Mutex.d.ts:3

Properties

`Private` _semaphore

_semaphore: any

Methods

acquire

acquire(): Promise<MutexInterface.Releaser>
Returns Promise<MutexInterface.Releaser>
Implementation of MutexInterface.acquire
- Defined in node_modules/async-mutex/lib/Mutex.d.ts:4

cancel

cancel(): void
Returns void
Implementation of MutexInterface.cancel
- Defined in node_modules/async-mutex/lib/Mutex.d.ts:9

isLocked

isLocked(): boolean
Returns boolean
Implementation of MutexInterface.isLocked
- Defined in node_modules/async-mutex/lib/Mutex.d.ts:6

release

release(): void
Deprecated
Deprecated in 0.3.0, will be removed in 0.4.0. Use runExclusive instead.

Returns void
Implementation of MutexInterface.release
- Defined in node_modules/async-mutex/lib/Mutex.d.ts:8

runExclusive

runExclusive<T>(callback: MutexInterface.Worker<T>): Promise<T>
Type Parameters
- T
Parameters
- callback: MutexInterface.Worker<T>
Returns Promise<T>
Implementation of MutexInterface.runExclusive
- Defined in node_modules/async-mutex/lib/Mutex.d.ts:5

Generated using TypeDoc