Class LockBox<L>

Type Parameters

L extends Lockable = Lockable

Hierarchy

LockBox

Implements

Lockable

Index

Constructors

constructor

new LockBox<L>(): LockBox<L>
Type Parameters
- L extends Lockable = Lockable
Returns LockBox<L>

Properties

`Protected` _locks

_locks: Map<string, L> = ...

Accessors

count

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

locks

get locks(): ReadonlyMap<string, L>
Returns ReadonlyMap<string, L>
- Defined in src/LockBox.ts:19

Methods

isLocked

isLocked(key?, ...params): boolean
Parameters
- Optional key: string
- Rest ...params: Parameters<L["isLocked"]>
Returns boolean
Implementation of Lockable.isLocked
- Defined in src/LockBox.ts:31

lock

lock(...params): ResourceAcquireCancellable<LockBox<L>>
Parameters
- Rest ...params: [key: string, lockConstructor: (new () => L), ...lockingParams: Parameters<L["lock"]>[]][] | [...requests: [key: string, lockConstructor: (new () => L), ...lockingParams: Parameters<L["lock"]>[]][], ctx: Partial<ContextTimedInput>] | [ctx?: Partial<ContextTimedInput>]
Returns ResourceAcquireCancellable<LockBox<L>>
Implementation of Lockable.lock
- Defined in src/LockBox.ts:44

lockMulti

lockMulti(...requests): [key: string, lockAcquire: ResourceAcquireCancellable<L>, ...lockingParams: Parameters<L["lock"]>[]][]
Parameters
- Rest ...requests: [key: string, lockConstructor: (new () => L), ...lockingParams: Parameters<L["lock"]>[]][]
Returns [key: string, lockAcquire: ResourceAcquireCancellable<L>, ...lockingParams: Parameters<L["lock"]>[]][]
- Defined in src/LockBox.ts:132

waitForUnlock

waitForUnlock(...params): PromiseCancellable<void>
Parameters
- Rest ...params: [] | [key?: string, ctx?: Partial<ContextTimedInput>] | [key?: string] | [ctx?: Partial<ContextTimedInput>]
Returns PromiseCancellable<void>
Implementation of Lockable.waitForUnlock
- Defined in src/LockBox.ts:209

withF

withF<T>(...params): Promise<T>
Type Parameters
- T
Parameters
- Rest ...params: [...[key: string, lockConstructor: (new () => L), ...lockingParams: Parameters<L["lock"]>[]][], ((lockBox) => Promise<T>)] | [...[key: string, lockConstructor: (new () => L), ...lockingParams: Parameters<L["lock"]>[]][], Partial<ContextTimedInput>, ((lockBox) => Promise<T>)] | [undefined | Partial<ContextTimedInput>, ((lockBox) => Promise<T>)]
Returns Promise<T>
Implementation of Lockable.withF
- Defined in src/LockBox.ts:253

withG

withG<T, TReturn, TNext>(...params): AsyncGenerator<T, TReturn, TNext>
Type Parameters
- T
- TReturn
- TNext
Parameters
- Rest ...params: [...[key: string, lockConstructor: (new () => L), ...lockingParams: Parameters<L["lock"]>[]][], ((lockBox) => AsyncGenerator<T, TReturn, TNext>)] | [...[key: string, lockConstructor: (new () => L), ...lockingParams: Parameters<L["lock"]>[]][], Partial<ContextTimedInput>, ((lockBox) => AsyncGenerator<T, TReturn, TNext>)] | [undefined | Partial<ContextTimedInput>, ((lockBox) => AsyncGenerator<T, TReturn, TNext>)]
Returns AsyncGenerator<T, TReturn, TNext>
Implementation of Lockable.withG
- Defined in src/LockBox.ts:292

withMultiF

withMultiF<T>(...params): Promise<T>
Type Parameters
- T
Parameters
- Rest ...params: [...requests: [key: string, lockConstructor: (new () => L), ...lockingParams: Parameters<L["lock"]>[]][], f: ((multiLocks) => Promise<T>)]
Returns Promise<T>
- Defined in src/LockBox.ts:267

withMultiG

withMultiG<T, TReturn, TNext>(...params): AsyncGenerator<T, TReturn, TNext>
Type Parameters
- T
- TReturn
- TNext
Parameters
- Rest ...params: [...requests: [key: string, lockConstructor: (new () => L), ...lockingParams: Parameters<L["lock"]>[]][], g: ((multiLocks) => AsyncGenerator<T, TReturn, TNext>)]
Returns AsyncGenerator<T, TReturn, TNext>
- Defined in src/LockBox.ts:308

Class LockBox<L>

Type Parameters

L extends Lockable = Lockable

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

L extends Lockable = Lockable

Returns LockBox<L>

Properties

Protected _locks

Accessors

count

Returns number

locks

Returns ReadonlyMap<string, L>

Methods

isLocked

Parameters

Optional key: string

Rest ...params: Parameters<L["isLocked"]>

Returns boolean

lock

Parameters

Rest ...params: [key: string, lockConstructor: (new () => L), ...lockingParams: Parameters<L["lock"]>[]][] | [...requests: [key: string, lockConstructor: (new () => L), ...lockingParams: Parameters<L["lock"]>[]][], ctx: Partial<ContextTimedInput>] | [ctx?: Partial<ContextTimedInput>]

Returns ResourceAcquireCancellable<LockBox<L>>

lockMulti

Parameters

Rest ...requests: [key: string, lockConstructor: (new () => L), ...lockingParams: Parameters<L["lock"]>[]][]

Returns [key: string, lockAcquire: ResourceAcquireCancellable<L>, ...lockingParams: Parameters<L["lock"]>[]][]

waitForUnlock

Parameters

Rest ...params: [] | [key?: string, ctx?: Partial<ContextTimedInput>] | [key?: string] | [ctx?: Partial<ContextTimedInput>]

Returns PromiseCancellable<void>

withF

Type Parameters

T

Parameters

Returns Promise<T>

withG

Type Parameters

T

TReturn

TNext

Parameters

Returns AsyncGenerator<T, TReturn, TNext>

withMultiF

Type Parameters

T

Parameters

Rest ...params: [...requests: [key: string, lockConstructor: (new () => L), ...lockingParams: Parameters<L["lock"]>[]][], f: ((multiLocks) => Promise<T>)]

Returns Promise<T>

withMultiG

Type Parameters

T

TReturn

TNext

Parameters

Rest ...params: [...requests: [key: string, lockConstructor: (new () => L), ...lockingParams: Parameters<L["lock"]>[]][], g: ((multiLocks) => AsyncGenerator<T, TReturn, TNext>)]

Returns AsyncGenerator<T, TReturn, TNext>

Settings

Member Visibility

Theme

On This Page

`Protected` _locks

`Optional` key: string

`Rest` ...params: Parameters<L["isLocked"]>

`Rest` ...params: [key: string, lockConstructor: (new () => L), ...lockingParams: Parameters<L["lock"]>[]][] | [...requests: [key: string, lockConstructor: (new () => L), ...lockingParams: Parameters<L["lock"]>[]][], ctx: Partial<ContextTimedInput>] | [ctx?: Partial<ContextTimedInput>]

`Rest` ...requests: [key: string, lockConstructor: (new () => L), ...lockingParams: Parameters<L["lock"]>[]][]

`Rest` ...params: [] | [key?: string, ctx?: Partial<ContextTimedInput>] | [key?: string] | [ctx?: Partial<ContextTimedInput>]

`Rest` ...params: [...requests: [key: string, lockConstructor: (new () => L), ...lockingParams: Parameters<L["lock"]>[]][], f: ((multiLocks) => Promise<T>)]

`Rest` ...params: [...requests: [key: string, lockConstructor: (new () => L), ...lockingParams: Parameters<L["lock"]>[]][], g: ((multiLocks) => AsyncGenerator<T, TReturn, TNext>)]