Class PendingWorkPool<T>

Type Parameters

T

Hierarchy

PendingWorkPool

Index

Constructors

Properties

coordinatorJob debouncedJob options skipSleep

Methods

addWork checkComplete get getCount getFirstValue getPendingWork handleWork hasFinished loadPendingWork removeWork runJob skipNextSleep start stop

Constructors

constructor

new PendingWorkPool<T>(options: Utils.PendingWorkOptions<T>): Utils.PendingWorkPool<T>
Type Parameters
- T
Parameters
- options: Utils.PendingWorkOptions<T>
Returns Utils.PendingWorkPool<T>
- Defined in packages/core/src/utils/concurrence/pendingWork.ts:33

Properties

`Protected` coordinatorJob

coordinatorJob: undefined | JobRunner

`Protected` debouncedJob

debouncedJob: undefined | DebouncedJobRunner

`Protected` options

options: Utils.PendingWorkOptions<T>

`Protected` skipSleep

skipSleep: boolean = false

Methods

addWork

addWork(work: Utils.PendingWork<T> | Utils.PendingWork<T>[]): Promise<void>
Parameters
- work: Utils.PendingWork<T> | Utils.PendingWork<T>[]
Returns Promise<void>
- Defined in packages/core/src/utils/concurrence/pendingWork.ts:70

`Protected` checkComplete

checkComplete(works: Utils.PendingWork<T>[]): Promise<Utils.PendingWork<T>[]>
Parameters
- works: Utils.PendingWork<T>[]
Returns Promise<Utils.PendingWork<T>[]>
- Defined in packages/core/src/utils/concurrence/pendingWork.ts:210

get

get(signature: string): Promise<undefined | Utils.PendingWork<T>>
Parameters
- signature: string
Returns Promise<undefined | Utils.PendingWork<T>>
- Defined in packages/core/src/utils/concurrence/pendingWork.ts:100

getCount

getCount(): Promise<number>
Returns Promise<number>
- Defined in packages/core/src/utils/concurrence/pendingWork.ts:92

getFirstValue

getFirstValue(): Promise<undefined | Utils.PendingWork<T>>
Returns Promise<undefined | Utils.PendingWork<T>>
- Defined in packages/core/src/utils/concurrence/pendingWork.ts:96

`Protected` getPendingWork

getPendingWork(chunkSize?: number): Promise<Generator<Promise<void>, any, unknown>>
Parameters
- chunkSize: number = 1
Returns Promise<Generator<Promise<void>, any, unknown>>
- Defined in packages/core/src/utils/concurrence/pendingWork.ts:126

`Protected` handleWork

handleWork(works: Utils.PendingWork<T>[]): Promise<number | void>
Parameters
- works: Utils.PendingWork<T>[]
Returns Promise<number | void>
- Defined in packages/core/src/utils/concurrence/pendingWork.ts:206

hasFinished

hasFinished(): Promise<void>
Returns Promise<void>
- Defined in packages/core/src/utils/concurrence/pendingWork.ts:56

`Protected` loadPendingWork

loadPendingWork(pendingWorkGen: AsyncIterator<StorageEntry<string, Utils.PendingWork<T>>, any, undefined>, size: number): Promise<Utils.PendingWork<T>[]>
Parameters
- pendingWorkGen: AsyncIterator<StorageEntry<string, Utils.PendingWork<T>>, any, undefined>
- size: number
Returns Promise<Utils.PendingWork<T>[]>
- Defined in packages/core/src/utils/concurrence/pendingWork.ts:184

removeWork

removeWork(work: Utils.PendingWork<T> | Utils.PendingWork<T>[]): Promise<void>
Parameters
- work: Utils.PendingWork<T> | Utils.PendingWork<T>[]
Returns Promise<void>
- Defined in packages/core/src/utils/concurrence/pendingWork.ts:81

`Protected` runJob

runJob(): Promise<number>
Returns Promise<number>
- Defined in packages/core/src/utils/concurrence/pendingWork.ts:109

skipNextSleep

skipNextSleep(): void
Returns void
- Defined in packages/core/src/utils/concurrence/pendingWork.ts:104

start

start(): Promise<void>
Returns Promise<void>
- Defined in packages/core/src/utils/concurrence/pendingWork.ts:51

stop

stop(): Promise<void>
Returns Promise<void>
- Defined in packages/core/src/utils/concurrence/pendingWork.ts:66

Generated using TypeDoc