ThreadWorker | poolifier

@@ -47,50 +47,59 @@ but the minimum number of workers will be guaranteed.

ThreadWorker

Defined in src/worker/thread-worker.ts:26

Index

Constructors

constructor

new ThreadWorker<Data, Response>(taskFunctions, opts?): ThreadWorker<Data, Response>
@@ -107,7 +116,7 @@ but the minimum number of workers will be guaranteed.

Parameters
- -
  taskFunctions: WorkerFunction<Data, Response> | TaskFunctions<Data, Response>
  +
  taskFunctions: TaskFunction<Data, Response> | TaskFunctions<Data, Response>
  
  Task function(s) processed by the worker when the pool's execution function is invoked.

Defined in src/worker/thread-worker.ts:40

Properties

`Protected` `Optional` `Readonly` aliveInterval

aliveInterval?: Timeout

Handler id of the aliveInterval worker alive check.

`Protected` `Optional` activeInterval

activeInterval?: Timeout

Handler id of the activeInterval worker activity check.

Defined in src/worker/abstract-worker.ts:79

`Protected` `Readonly` isMain

isMain: boolean

@@ -140,7 +149,7 @@ but the minimum number of workers will be guaranteed.

Defined in src/worker/abstract-worker.ts:91

`Protected` lastTaskTimestamp

lastTaskTimestamp: number

@@ -149,25 +158,24 @@ but the minimum number of workers will be guaranteed.

`Protected` `Readonly` mainWorker

mainWorker: MessagePort

Reference to main worker.

Defined in src/worker/abstract-worker.ts:71

`Protected` `Readonly` opts

opts: WorkerOptions = ...

`Protected` opts

opts: WorkerOptions = DEFAULT_WORKER_OPTIONS

Options for the worker.

Defined in src/worker/abstract-worker.ts:94

`Private` port

port: MessagePort

Message port used to communicate with the main worker.

`Protected` statistics

statistics: WorkerStatistics

@@ -176,16 +184,16 @@ but the minimum number of workers will be guaranteed.

Defined in src/worker/abstract-worker.ts:75

`Protected` taskFunctions

taskFunctions: Map<string, WorkerFunction<Data, Response>>

taskFunctions: Map<string, TaskFunction<Data, Response>>

Task function(s) processed by the worker when the pool's execution function is invoked.

Defined in src/worker/abstract-worker.ts:67

Accessors

@@ -199,9 +207,36 @@ but the minimum number of workers will be guaranteed.

Defined in src/worker/thread-worker.ts:84

Methods

addTaskFunction

addTaskFunction(name, fn): TaskFunctionOperationResult
+
Adds a task function to the worker. +If a task function with the same name already exists, it is replaced.
+
+
+
Parameters
+
- +
  name: string
  +
  The name of the task function to add.
  +
  +
- +
  fn: TaskFunction<Data, Response>
  +
  The task function to add.
  +
  +
+
Returns TaskFunctionOperationResult
Whether the task function was added or not.
+ +
+
Inherited from AbstractWorker.addTaskFunction
+
- Defined in src/worker/abstract-worker.ts:179

asyncId

Defined in node_modules/.pnpm/@types+node@20.8.7/node_modules/@types/node/async_hooks.d.ts:315

bind

`Protected` checkAlive

checkAlive(): void
-
Checks if the worker should be terminated, because its living too long.
-
-
Returns void
-
-
Inherited from AbstractWorker.checkAlive
-
- Defined in src/worker/abstract-worker.ts:196

Defined in node_modules/.pnpm/@types+node@20.8.7/node_modules/@types/node/async_hooks.d.ts:288

emitDestroy

Defined in node_modules/.pnpm/@types+node@20.8.7/node_modules/@types/node/async_hooks.d.ts:311

Index

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

constructor

Parameters

taskFunctions: WorkerFunction<Data, Response> | TaskFunctions<Data, Response>

taskFunctions: TaskFunction<Data, Response> | TaskFunctions<Data, Response>

Properties

Protected Optional Readonly aliveInterval

Protected Optional activeInterval

Protected Readonly isMain

Protected lastTaskTimestamp

Protected Readonly mainWorker

Protected Readonly opts

Protected opts

Private port

Protected statistics

Protected taskFunctions

Accessors

Methods

addTaskFunction

Parameters

name: string

fn: TaskFunction<Data, Response>

Returns TaskFunctionOperationResult

asyncId

bind

Protected checkAlive

Returns void

emitDestroy

Protected getMainWorker

Returns MessagePort

Protected handleError

Parameters

e: string | Error

error: string | Error

Protected handleKillMessage

Parameters

message: MessageValue<Data, unknown>

Returns void

Protected handleReadyMessage

Parameters

message: MessageValue<Data, unknown>

Returns void

Protected handleTaskFunctionOperationMessage

Parameters

message: MessageValue<Data, unknown>

Returns void

hasTaskFunction

Parameters

name: string

Returns TaskFunctionOperationResult

listTaskFunctionNames

Returns string[]

Protected messageListener

Parameters

message: MessageValue<Data, Data>

message: MessageValue<Data, unknown>

Returns void

removeTaskFunction

Parameters

name: string

Returns TaskFunctionOperationResult

Protected run

Parameters

task: Task<Data>

Returns void

Protected runAsync

Parameters

fn: WorkerAsyncFunction<Data, Response>

fn: TaskAsyncFunction<Data, Response>

message: MessageValue<Data, unknown>

task: Task<Data>

Returns void

runInAsyncScope

`Protected` `Optional` `Readonly` aliveInterval

`Protected` `Optional` activeInterval

`Protected` `Readonly` isMain

`Protected` lastTaskTimestamp

`Protected` `Readonly` mainWorker

`Protected` `Readonly` opts

`Protected` opts

`Private` port

`Protected` statistics

`Protected` taskFunctions

`Protected` checkAlive

`Protected` getMainWorker

`Protected` handleError

`Protected` handleKillMessage

`Protected` handleReadyMessage

`Protected` handleTaskFunctionOperationMessage

`Protected` messageListener

`Protected` run

`Protected` runAsync

`Protected` runSync

`Protected` sendTaskFunctionNamesToMainWorker

`Protected` sendToMainWorker

`Static` bind