Class AutoReleaseWorkerPool

Similar to the WorkerPool class except it creates and destroys workers automatically with a maximum of maxWorkers workers. Workers are terminated when it is idle for at least idleTimeElapsedBeforeRelease milliseconds.

Hierarchy

WorkerPool
- AutoReleaseWorkerPool

Implements

IDisposable

Index

Constructors

constructor

new AutoReleaseWorkerPool(maxWorkers: number, createWorkerAsync: () => Promise<Worker>, options?: AutoReleaseWorkerPoolOptions): AutoReleaseWorkerPool

Overrides WorkerPool.constructor
- Defined in .temp/docdirectory/doc.d.ts:71560
Parameters
- maxWorkers: number
- createWorkerAsync: () => Promise<Worker>
  - - (): Promise<Worker>
    - Returns Promise<Worker>
- Optional options: AutoReleaseWorkerPoolOptions
Returns AutoReleaseWorkerPool

Properties

Static DefaultOptionsSearch playground for DefaultOptions

DefaultOptions: AutoReleaseWorkerPoolOptions

Default options for the constructor. Override to change the defaults.

Methods

disposeSearch playground for dispose

dispose(): void

Implementation of IDisposable.dispose

Inherited from WorkerPool.dispose
- Defined in .temp/docdirectory/doc.d.ts:71529
Terminates all workers and clears any pending actions.

Returns void

pushSearch playground for push

push(action: (worker: Worker, onComplete: () => void) => void): void

Overrides WorkerPool.push
- Defined in .temp/docdirectory/doc.d.ts:71562
Parameters
- action: (worker: Worker, onComplete: () => void) => void
  - - (worker: Worker, onComplete: () => void): void
    - Parameters
      - worker: Worker
      - onComplete: () => void
        
        (): void
        
        Returns void
      Returns void
Returns void

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

maxWorkers: number

createWorkerAsync: () => Promise<Worker>

Returns Promise<Worker>

Optional options: AutoReleaseWorkerPoolOptions

Returns AutoReleaseWorkerPool

Properties

Static DefaultOptionsSearch playground for DefaultOptions

Methods

disposeSearch playground for dispose

Returns void

pushSearch playground for push

Parameters

action: (worker: Worker, onComplete: () => void) => void

Parameters

worker: Worker

onComplete: () => void

Returns void

Returns void

Returns void