Class WorkerManager<W>

Type Parameters

W extends ModuleMethods

Hierarchy

WorkerManager

Implements

WorkerManagerInterface<W>

Index

Constructors

constructor

new WorkerManager<W>(__namedParameters): WorkerManager<W>
Type Parameters
- W extends ModuleMethods
Parameters
- __namedParameters: {
      cores?: number;
      logger: Logger;
      workerFactory: (() => Promise<ModuleThread<W>>);
  }
  - Optional cores?: number
  - logger: Logger
  - workerFactory: (() => Promise<ModuleThread<W>>)
    - (): Promise<ModuleThread<W>>
      
      Returns Promise<ModuleThread<W>>
Returns WorkerManager<W>
- Defined in src/WorkerManager.ts:48

Properties

`Protected` logger

logger: Logger

`Protected` pool

pool: Pool<ModuleThread<W>>

Methods

call

call<T>(f): Promise<T>
Type Parameters
- T
Parameters
- f: ((worker) => Promise<T>)
  - - (worker): Promise<T>
    - Parameters
      
      worker: ModuleThread<W>
      
      Returns Promise<T>
Returns Promise<T>
Implementation of WorkerManagerInterface.call
- Defined in src/WorkerManager.ts:69

completed

completed(): Promise<void>
Returns Promise<void>
Implementation of WorkerManagerInterface.completed
- Defined in src/WorkerManager.ts:81

destroy

destroy(__namedParameters?): Promise<void>
Parameters
- __namedParameters: {
  force?: boolean;
  } = {}
  - Optional force?: boolean
Returns Promise<void>
Implementation of WorkerManagerInterface.destroy
- Defined in src/WorkerManager.ts:61

queue

queue<T>(f): QueuedTask<ModuleThread<W>, T>
Type Parameters
- T
Parameters
- f: ((worker) => Promise<T>)
  - - (worker): Promise<T>
    - Parameters
      
      worker: ModuleThread<W>
      
      Returns Promise<T>
Returns QueuedTask<ModuleThread<W>, T>
Implementation of WorkerManagerInterface.queue
- Defined in src/WorkerManager.ts:74

settled

settled(): Promise<Error[]>
Returns Promise<Error[]>
Implementation of WorkerManagerInterface.settled
- Defined in src/WorkerManager.ts:86

`Static` createWorkerManager

createWorkerManager<W>(__namedParameters): Promise<WorkerManager<W>>
Creates the WorkerManager The workerFactory needs to be a callback: () => spawn(new Worker(workerPath)) The spawn and Worker can be imported from threads The workerPath must point to a worker script The workerPath can be either an absolute path or relative path If it is a relative path, it has to be relative to the file location where the function expression is defined If cores is set to 0, this creates a useless worker pool Use undefined to mean using all cores
Type Parameters
- W extends ModuleMethods
Parameters
- __namedParameters: {
      cores?: number;
      logger?: Logger;
      workerFactory: (() => Promise<ModuleThread<W>>);
  }
  - Optional cores?: number
  - Optional logger?: Logger
  - workerFactory: (() => Promise<ModuleThread<W>>)
    - (): Promise<ModuleThread<W>>
      
      Returns Promise<ModuleThread<W>>
Returns Promise<WorkerManager<W>>
- Defined in src/WorkerManager.ts:26

Class WorkerManager<W>

Type Parameters

W extends ModuleMethods

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

W extends ModuleMethods

Parameters

__namedParameters: { cores?: number; logger: Logger; workerFactory: (() => Promise<ModuleThread<W>>); }

Optional cores?: number

logger: Logger

workerFactory: (() => Promise<ModuleThread<W>>)

Returns Promise<ModuleThread<W>>

Returns WorkerManager<W>

Properties

Protected logger

Protected pool

Methods

call

Type Parameters

T

Parameters

f: ((worker) => Promise<T>)

Parameters

worker: ModuleThread<W>

Returns Promise<T>

Returns Promise<T>

completed

Returns Promise<void>

destroy

Parameters

__namedParameters: { force?: boolean; } = {}

Optional force?: boolean

Returns Promise<void>

queue

Type Parameters

T

Parameters

f: ((worker) => Promise<T>)

Parameters

worker: ModuleThread<W>

Returns Promise<T>

Returns QueuedTask<ModuleThread<W>, T>

settled

Returns Promise<Error[]>

Static createWorkerManager

Type Parameters

W extends ModuleMethods

Parameters

__namedParameters: { cores?: number; logger?: Logger; workerFactory: (() => Promise<ModuleThread<W>>); }

Optional cores?: number

Optional logger?: Logger

workerFactory: (() => Promise<ModuleThread<W>>)

Returns Promise<ModuleThread<W>>

Returns Promise<WorkerManager<W>>

Settings

Member Visibility

Theme

On This Page

__namedParameters: {
cores?: number;
logger: Logger;
workerFactory: (() => Promise<ModuleThread<W>>);
}

`Optional` cores?: number

`Protected` logger

`Protected` pool

__namedParameters: {
force?: boolean;
} = {}

`Optional` force?: boolean

`Static` createWorkerManager

__namedParameters: {
cores?: number;
logger?: Logger;
workerFactory: (() => Promise<ModuleThread<W>>);
}

`Optional` cores?: number

`Optional` logger?: Logger