UpgradeableLockHandle<TMutex, TUpgradedMutex> Interface

Package: @esfx/async-lockable

An object used to release a held lock or upgrade to a stronger lock.

Declaration

export interface UpgradeableLockHandle<TMutex extends AsyncLockable = AsyncLockable, TUpgradedMutex extends AsyncLockable = AsyncLockable> extends LockHandle<TMutex> 

Inheritance

LockHandle<TMutex>

UpgradeableLockHandle<TMutex, TUpgradedMutex>

Inherited Members

lock(cancelable)

mutex

ownsLock

unlock()

Methods

upgrade(cancelable)

Upgrades the lock to a stronger lock.

Declaration

upgrade(cancelable?: Cancelable): Promise<LockHandle<TUpgradedMutex>>;

Parameters

cancelable

Cancelable

A Cancelable used to cancel the request.

Returns

Promise<LockHandle<TUpgradedMutex>>