X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Finterfaces%2FIWorkerNode.html;h=16bedd81a4516ef05e52a531d5d25feac0e9ccac;hb=0bb3df76aeab8a2af9e99ccf91d9e9cc5e751674;hp=ebd0f4a3ba3dd73ef33e64eb3db0afe854ff382d;hpb=bde3557b4daaacaea222926c3ac6934dcb90fdaa;p=poolifier.git
diff --git a/docs/interfaces/IWorkerNode.html b/docs/interfaces/IWorkerNode.html
index ebd0f4a3..16bedd81 100644
--- a/docs/interfaces/IWorkerNode.html
+++ b/docs/interfaces/IWorkerNode.html
@@ -1,4 +1,4 @@
-
IWorkerNode | poolifier - v2.6.30
+IWorkerNode | poolifier - v2.6.34
@@ -37,7 +37,7 @@
+
Defined in src/pools/worker.ts:205
@@ -75,7 +80,7 @@
Returns void
+Defined in src/pools/worker.ts:274
Readonly
closeChannel
closeChannel: (() => void)
@@ -91,7 +96,7 @@
Returns void
+Defined in src/pools/worker.ts:288
Readonly
dequeueTask
dequeueTask: (() => undefined | Task<Data>)
@@ -108,7 +113,7 @@
+Defined in src/pools/worker.ts:264
Readonly
enqueueTask
enqueueTask: ((task) => number)
@@ -133,7 +138,7 @@
+Defined in src/pools/worker.ts:251
Readonly
getTaskFunctionWorkerUsage
getTaskFunctionWorkerUsage: ((name) => undefined | WorkerUsage)
@@ -158,7 +163,7 @@
+Defined in src/pools/worker.ts:295
Readonly
hasBackPressure
hasBackPressure: (() => boolean)
@@ -175,7 +180,7 @@
+Defined in src/pools/worker.ts:280
Readonly
info
@@ -183,15 +188,80 @@
+Defined in src/pools/worker.ts:213
Optional
Readonly
messageChannel
messageChannel?: MessageChannel
-
+Defined in src/pools/worker.ts:284
+
+tasksQueueBackPressureSize
+tasksQueueBackPressureSize: number
+
+
Readonly
tasksQueueSize
tasksQueueSize: (() => number)
@@ -216,7 +295,7 @@
-
-- (): number
+- (): number
-
@@ -224,7 +303,32 @@
+Defined in src/pools/worker.ts:244
+
+Readonly
unshiftTask
+unshiftTask: ((task) => number)
+
+
Type declaration
+
+-
+
+- (task): number
+-
+
+
+
Returns number
The tasks queue size.
+
+
usage
@@ -232,7 +336,7 @@
+Defined in src/pools/worker.ts:221
Readonly
worker
worker: Worker
@@ -240,7 +344,7 @@
+Defined in src/pools/worker.ts:209
Message channel.
+Message channel (worker_threads only).
Back Pressure
+Optional
onType declaration
++-
+
+- (workerId): void
+-
+
+
+
+
Callback invoked when worker node tasks queue is back pressured.
+Parameters
++-
+
+
workerId: number
+The worker id.
+Returns void
+ Empty Queue
+Optional
onType declaration
++-
+
+- (workerId): void
+-
+
+
+
+
Callback invoked when worker node tasks queue is empty.
+Parameters
++-
+
+
workerId: number
+The worker id.
+Returns void
+ Task
+Readonly
popType declaration
++-
+
+- (): undefined | Task<Data>
+-
+
+
Pops a task from the tasks queue.
+Returns undefined | Task<Data>
The popped task.
+ +Readonly
reset-- (): void
+- (): void
-
Resets usage statistics.
Returns void