Class LockGuard

A disposable Lock wrapper for RAII-style lock.

Hierarchy

AsyncDisposableCloseable
- LockGuard

Implements

Closeable
AsyncDisposable

Index

Constructors

Properties

count lock acquire

Methods

[asyncDispose] close

Constructors

`Private` constructor

new LockGuard(lock): LockGuard
Parameters
- lock: Lock
Returns LockGuard
Overrides AsyncDisposableCloseable.constructor
- Defined in packages/commons/src/async/lockguard.ts:9

Properties

`Private` count

count: number = 1

`Private` `Readonly` lock

lock: Lock

`Static` acquire

acquire: Function = ...

Acquires a lock and returns a LockGuard for the Lock.

Methods

[asyncDispose]

[asyncDispose](): Promise<void>
Returns Promise<void>
Implementation of AsyncDisposable.[asyncDispose]
Inherited from AsyncDisposableCloseable.[asyncDispose]
- Defined in packages/commons/src/lifecycle/closeable.ts:20

close

close(): MaybePromise<void>
Closes this object and releases any system resource associated with it.

Returns MaybePromise<void>
Implementation of Closeable.close
Overrides AsyncDisposableCloseable.close
- Defined in packages/commons/src/async/lockguard.ts:21

Generated using TypeDoc