Interface Lock

A lock for controlling concurrent access to shared resource.

interface Lock {
    acquire(options?): MaybePromise<void>;
    release(options?): MaybePromise<void>;
    tryAcquire(options?): MaybePromise<boolean>;
}

Implemented by

Index

Methods

acquire release tryAcquire

Methods

acquire

acquire(options?): MaybePromise<void>
Waits for a lock to be acquired.
Parameters
- Optional options: AbortOptions
Returns MaybePromise<void>
- Defined in packages/commons/src/async/lock.ts:7

release

release(options?): MaybePromise<void>
Releases a lock.
Parameters
- Optional options: AbortOptions
Returns MaybePromise<void>
- Defined in packages/commons/src/async/lock.ts:13

tryAcquire

tryAcquire(options?): MaybePromise<boolean>
Tried to acquire a lock. Returns true if success, false otherwise.
Parameters
- Optional options: AbortOptions
Returns MaybePromise<boolean>
- Defined in packages/commons/src/async/lock.ts:10

Generated using TypeDoc