Class default

Creates a mutex that when acquired will return a lock that needs to be released before any waiting code can be run.

Hierarchy

default

Index

Constructors

Properties

Methods

acquireAsync waitAsync

Constructors

constructor

new default(): default
Returns default

Properties

`Private` `Optional` #onRelease

#onRelease?: default<unknown>

Methods

acquireAsync

acquireAsync(cancellationToken?): Promise<Lock>
Acquires a lock on this mutex. Only one lock can be kept at a time; calling multiple times will create dependent locks
Parameters
- cancellationToken: default = CancellationToken.default
Returns Promise<Lock>
- Defined in src/Mutex.ts:37

waitAsync

waitAsync(cancellationToken?): Promise<void>
Returns a promise that can be awaited until the lock is released. If there is no lock the promise is resolved immediately.
Parameters
- cancellationToken: default = CancellationToken.default
Returns Promise<void>
- Defined in src/Mutex.ts:68

Generated using TypeDoc