X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=7ea1c393837e025c202e4411c6a7ff46a9b4ef0b;hb=c2d2417cb80d8c14637fe6a19d58bcf5ce18ae98;hp=6ad17b4cd4fe5f86d56a0b43772e8aab964041eb;hpb=5e5a659e2b415c7d533dad095eda082989983f8e;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 6ad17b4c..7ea1c393 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.
@@ -67,7 +67,7 @@
-
destroy: (() => Promise<void>)
- (): Promise<void>
-
-
+ - Defined in src/pools/pool.ts:199
emitter?: PoolEmitter
@@ -96,9 +96,9 @@
+Defined in src/pools/pool.ts:187
- Tasks Queue
enable Tasks Queue: ((enable, tasksQueueOptions?) => void)
+Defined in src/pools/pool.ts:224
Properties
destroy
+Readonly
destroyType declaration
@@ -76,12 +76,12 @@Shutdowns every current worker in this pool.
+Terminates every current worker in this pool.
Returns Promise<void>
Optional
Readonly
emitterenable Tasks Queue
+Readonly
enableType declaration
@@ -125,9 +125,9 @@Returns void
execute
+Readonly
executeType declaration
@@ -143,7 +143,7 @@
-Optional
data: DataThe task input data for the specified worker function. This can only be serializable data.
+The task input data for the specified worker function. This can only be structured-cloneable data.
Readonly
infoset Tasks Queue Options
+Readonly
setType declaration
@@ -187,9 +187,9 @@Returns void
set Worker Choice Strategy
+Readonly
setType declaration
@@ -216,9 +216,9 @@Returns void
set Worker Choice Strategy Options
+Readonly
setType declaration
@@ -240,15 +240,15 @@Returns void
Nodes
-Readonly
workerPool worker nodes.