LockHandle<TMutex> Interface

An object used to release a held lock.

export interface LockHandle<TMutex extends AsyncLockable = AsyncLockable> extends Disposable, AsyncLockable

LockHandle<TMutex>

Gets the associated AsyncLockable object.

readonly mutex: TMutex;

TMutex

Indicates whether this handle owns its associated mutex.

readonly ownsLock: boolean;

Reacquires the lock. If this handle already owns the lock, an Error is thrown.

lock(cancelable?: Cancelable): Promise<this>;

A Cancelable used to cancel the request.

Releases the lock. If this handle does not own the lock, an Error is thrown.

unlock(): void;

void