X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=1135bfdc7c48600d194d29e380410af18d594b98;hb=5441aea6894a5031667db6447634fa5d97f69e36;hp=2ad84030c0ad3877aa7c0fff0a4e8cf19f0d82a8;hpb=6be0ab6d5c78c8e91cc4668d3d03db95f15cbfab;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 2ad84030..1135bfdc 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,4 +1,4 @@ -
Generated using TypeDoc
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 Tasks Queue
execute
info
+list Task Functions
set Tasks Queue Options
set Worker Choice Strategy
set Worker Choice Strategy Options
@@ -67,7 +68,7 @@
-
destroy: (() => Promise<void>)
- (): Promise<void>
-
-
+ - Defined in src/pools/pool.ts:211
emitter?: PoolEmitter
+Defined in src/pools/pool.ts:194
- Tasks Queue
enable Tasks Queue: ((enable, tasksQueueOptions?) => void)
+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 Task Functions: (() => string[])
+
+
- Tasks Queue Options
set Tasks Queue Options: ((tasksQueueOptions) => void)
-
+Defined in src/pools/pool.ts:251
- Worker Choice Strategy
set Worker Choice Strategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void)
-
+Defined in src/pools/pool.ts:224
- Worker Choice Strategy Options
set Worker Choice Strategy Options: ((workerChoiceStrategyOptions) => void)
-
+Defined in src/pools/pool.ts:233
worker Nodes: WorkerNode<Worker, Data>[]
+worker Nodes: IWorkerNode<Worker, Data>[]
+Defined in src/pools/pool.ts:181
Properties
destroy
+Readonly
destroyType declaration
@@ -76,29 +77,31 @@Terminate every current worker in this pool.
+Terminates all workers in this pool.
Returns Promise<void>
Optional
Readonly
emitterEmitter 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 Tasks Queue
+Readonly
enableType declaration
@@ -125,16 +128,16 @@Returns void
execute
-
+Readonly
executeType declaration
-- (data?, name?): Promise<Response>
+- (data?, name?, transferList?): Promise<Response>
-
@@ -143,19 +146,24 @@
-
-
+
+-
+
+ - 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.
-Optional
data: 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.
-Optional
name: 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.
+
+Optional
transferList: 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.
Readonly
info Task Functions
+Readonly
listType declaration
++-
+
+- (): string[]
+-
+
+
Lists the names of task function available in this pool.
+Returns string[]
The names of task function available in this pool.
+ +set Tasks Queue Options
+Readonly
setType declaration
-- (tasksQueueOptions): void
+- (tasksQueueOptions): void
-
@@ -187,16 +212,16 @@
Sets the worker tasks queue options in this pool.
Returns void
set Worker Choice Strategy
+Readonly
setType declaration
-- (workerChoiceStrategy, workerChoiceStrategyOptions?): void
+- (workerChoiceStrategy, workerChoiceStrategyOptions?): void
-
@@ -216,16 +241,16 @@
Sets the worker choice strategy in this pool.
Returns void
set Worker Choice Strategy Options
+Readonly
setType declaration
-- (workerChoiceStrategyOptions): void
+- (workerChoiceStrategyOptions): void
-
@@ -240,15 +265,15 @@
Sets the worker choice strategy options in this pool.
Returns void
Nodes
-Readonly
workerPool worker nodes.