IWorkerNode | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIWorkerNode.html;h=ebd0f4a3ba3dd73ef33e64eb3db0afe854ff382d;hb=7daf8b1ee6ee28ba8c39c63067cf7071f8638177;hp=7e209d4ea9950d17954d05ebb270a974b19f7dcb;hpb=c65efde664ab9e4dcd2ed9e827d8171e7e081359;p=poolifier.git diff --git a/docs/interfaces/IWorkerNode.html b/docs/interfaces/IWorkerNode.html index 7e209d4e..ebd0f4a3 100644 --- a/docs/interfaces/IWorkerNode.html +++ b/docs/interfaces/IWorkerNode.html @@ -1,4 +1,4 @@ -IWorkerNode | poolifier - v2.6.24

+IWorkerNode | poolifier - v2.6.30

@@ -37,7 +37,7 @@

IWorkerNode

Defined in src/pools/worker.ts:205

@@ -49,8 +49,10 @@ closeChannel dequeueTask enqueueTask -getTaskWorkerUsage +getTaskFunctionWorkerUsage +hasBackPressure info +messageChannel? resetUsage tasksQueueSize usage @@ -73,7 +75,7 @@

Returns void

Defined in src/pools/worker.ts:244

`Readonly` closeChannel

closeChannel: (() => void)

@@ -84,12 +86,12 @@

(): void
-
Close communication channel.
+
Closes communication channel.

Returns void

Defined in src/pools/worker.ts:258

`Readonly` dequeueTask

dequeueTask: (() => undefined | Task<Data>)

@@ -106,7 +108,7 @@

Defined in src/pools/worker.ts:240

`Readonly` enqueueTask

enqueueTask: ((task) => number)

@@ -127,32 +129,53 @@

The task to queue.

Returns number

The task queue size.

Returns number

The tasks queue size.

`Readonly` getTaskWorkerUsage

getTaskWorkerUsage: ((name) => undefined | WorkerUsage)

Defined in src/pools/worker.ts:234

`Readonly` getTaskFunctionWorkerUsage

getTaskFunctionWorkerUsage: ((name) => undefined | WorkerUsage)

Type declaration

- (name): undefined | WorkerUsage
- (name): undefined | WorkerUsage
- -
  Gets task worker usage statistics.
  +
  Gets task function worker usage statistics.
  Parameters
  - -
    name: string
  -
  Returns undefined | WorkerUsage
  +
  name: string
  +
  The task function name.
  +
  +

Returns undefined | WorkerUsage

The task function worker usage statistics if the task function worker usage statistics are initialized, undefined otherwise.

Defined in src/pools/worker.ts:265

`Readonly` hasBackPressure

hasBackPressure: (() => boolean)

Type declaration

+
- (): boolean
- +
  Whether the worker node has back pressure (i.e. its tasks queue is full).
  +
  +
  Returns boolean
  true if the worker node has back pressure, false otherwise.
  + +