Executes the specified function in the worker constructor with the task data input parameter.
@@ -143,19 +146,24 @@
Optionaldata: Data
-
The task input data for the specified worker function. This can only be serializable data.
+
The optional task input data for the specified task function. This can only be structured-cloneable data.
Optionalname: string
-
The name of the worker function to execute. If not specified, the default worker function will be executed.
+
The optional name of the task function to execute. If not specified, the default task function will be executed.
+
+
+
+
OptionaltransferList: TransferListItem[]
+
An optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the pool's worker_threads worker and they should not be used in the main thread afterwards.
Returns Promise<Response>
Promise that will be fulfilled when the task is completed.
Type of data sent to the worker. This can only be serializable data.
+Type of data sent to the worker. This can only be structured-cloneable data.
Response = unknown
-Type of execution response. This can only be serializable data.
+Type of execution response. This can only be structured-cloneable data.
@@ -59,6 +59,7 @@ enable
-
destroy: (() => Promise<void>)
- (): Promise<void>
-
-
- Defined in src/pools/pool.ts:211
emitter?: PoolEmitter
+Defined in src/pools/pool.ts:194
-
enable
+Defined in src/pools/pool.ts:242
-execute: ((data?, name?) => Promise<Response>)
+execute: ((data?, name?, transferList?) => Promise<Response>)
-
+Defined in src/pools/pool.ts:177
+
+list
+
+
-
set
-
+Defined in src/pools/pool.ts:251
-
set
-
+Defined in src/pools/pool.ts:224
-
set
-
+Defined in src/pools/pool.ts:233
worker
+worker
+Defined in src/pools/pool.ts:181
Properties
destroy
+ReadonlydestroyType declaration
@@ -76,29 +77,31 @@Shutdowns every current worker in this pool.
+Terminates all workers in this pool.
Returns Promise<void>
OptionalReadonlyemitterEmitter on which events can be listened to.
Events that can currently be listened to:
-- '
'full': Emitted when the pool is dynamic and full.'busy': Emitted when the pool is busy.'ready': Emitted when the number of workers created in the pool has reached the minimum size expected and are ready.'busy': Emitted when the number of workers created in the pool has reached the maximum size expected and are executing at least one task.'full': Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.destroy': Emitted when the pool is destroyed.'error': Emitted when an uncaught error occurs.'taskError': Emitted when an error occurs while executing a task.enable
+ReadonlyenableType declaration
@@ -125,16 +128,16 @@Returns void
execute
-
+ReadonlyexecuteType declaration
-- (data?, name?): Promise<Response>
+- (data?, name?, transferList?): Promise<Response>
-
-
-
-
+
- Defined in src/pools/pool.ts:203
info: PoolInfo
@@ -163,16 +171,33 @@
Executes the specified function in the worker constructor with the task data input parameter.
-Optionaldata: DataThe task input data for the specified worker function. This can only be serializable data.
+The optional task input data for the specified task function. This can only be structured-cloneable data.
-Optionalname: stringThe name of the worker function to execute. If not specified, the default worker function will be executed.
+The optional name of the task function to execute. If not specified, the default task function will be executed.
+
+OptionaltransferList: TransferListItem[]An optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the pool's worker_threads worker and they should not be used in the main thread afterwards.
Returns Promise<Response>
Promise that will be fulfilled when the task is completed.
Readonlyinfo
+ReadonlylistType declaration
++-
+
+- (): string[]
+-
+
Lists the names of task function available in this pool.
+Returns string[]
The names of task function available in this pool.
+ +set
+ReadonlysetType declaration
-- (tasksQueueOptions): void
+- (tasksQueueOptions): void
-
Sets the worker tasks queue options in this pool.
Returns void
set
+ReadonlysetType declaration
-- (workerChoiceStrategy, workerChoiceStrategyOptions?): void
+- (workerChoiceStrategy, workerChoiceStrategyOptions?): void
-
-
-
@@ -216,16 +241,16 @@
Sets the worker choice strategy in this pool.
Parameters
workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
+workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
The worker choice strategy.
Returns void
set
+ReadonlysetType declaration
-- (workerChoiceStrategyOptions): void
+- (workerChoiceStrategyOptions): void
-
Sets the worker choice strategy options in this pool.
Returns void
-ReadonlyworkerPool worker nodes.