Class ThreadPool

Simple thread pool with a microtask-based queue.

Timer-free: browsers clamp nested setTimeout(0) to several ms, which stalls queued tasks.

Hierarchy

ThreadPool

Index

Constructors

Properties

drainListeners maxConcurrency numRunning queueHead queueTail

Methods

awaitAll processNext submit

Constructors

constructor

new ThreadPool(maxConcurrency?): ThreadPool
Construct the thread pool.
Parameters
- Optional maxConcurrency: any
  
  maximum number of threads in the pool (default 1)
Returns ThreadPool

Properties

`Protected` drainListeners

drainListeners: (() => void)[]

Type declaration

- (): void
- Returns void

`Protected` maxConcurrency

maxConcurrency: number

`Protected` numRunning

numRunning: number

`Protected` queueHead

queueHead: any

`Protected` queueTail

queueTail: any

Methods

awaitAll

awaitAll(): Promise<void>
Await all functions to complete.

Returns Promise<void>
resolves when all functions complete

`Protected` processNext

processNext(): void
Returns void

submit

submit<T>(asyncFn): Promise<T>
Submit an asynchronous function to run using the thread pool.
Type Parameters
- T
Parameters
- asyncFn: (() => Promise<T>)
  
  asynchronous function to run with the thread pool
  - - (): Promise<T>
    - Returns Promise<T>
Returns Promise<T>
resolves when the function completes execution

Generated using TypeDoc