Class Lock

Hierarchy

Lock

Implements

Lockable

Index

Constructors

Properties

Accessors

Methods

isLocked lock waitForUnlock withF withG

Constructors

constructor

new Lock(): Lock
Returns Lock

Properties

`Protected` semaphore

semaphore: Semaphore = ...

Accessors

count

get count(): number
Returns number
Implementation of Lockable.count
- Defined in src/Lock.ts:13

Methods

isLocked

isLocked(): boolean
Returns boolean
Implementation of Lockable.isLocked
- Defined in src/Lock.ts:17

lock

lock(ctx?): ResourceAcquireCancellable<Lock>
Parameters
- Optional ctx: Partial<ContextTimedInput>
Returns ResourceAcquireCancellable<Lock>
Implementation of Lockable.lock
- Defined in src/Lock.ts:21

waitForUnlock

waitForUnlock(ctx?): PromiseCancellable<void>
Parameters
- Optional ctx: Partial<ContextTimedInput>
Returns PromiseCancellable<void>
Implementation of Lockable.waitForUnlock
- Defined in src/Lock.ts:44

withF

withF<T>(...params): Promise<T>
Type Parameters
- T
Parameters
- Rest ...params: [((lock) => Promise<T>)] | [undefined | Partial<ContextTimedInput>, ((lock) => Promise<T>)]
Returns Promise<T>
Implementation of Lockable.withF
- Defined in src/Lock.ts:50

withG

withG<T, TReturn, TNext>(...params): AsyncGenerator<T, TReturn, TNext>
Type Parameters
- T
- TReturn
- TNext
Parameters
- Rest ...params: [((lock) => AsyncGenerator<T, TReturn, TNext>)] | [undefined | Partial<ContextTimedInput>, ((lock) => AsyncGenerator<T, TReturn, TNext>)]
Returns AsyncGenerator<T, TReturn, TNext>
Implementation of Lockable.withG
- Defined in src/Lock.ts:60

Generated using TypeDoc