IWorkerNode | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIWorkerNode.html;h=ebd0f4a3ba3dd73ef33e64eb3db0afe854ff382d;hb=1416660efeb6aabf366295ebc79067ccc4df9897;hp=be1ccbdc5f15cf10cd8d2457f4ddad626ddd500b;hpb=04cb7adbacc7fb0d1b76db6122f86c52e33d136d;p=poolifier.git diff --git a/docs/interfaces/IWorkerNode.html b/docs/interfaces/IWorkerNode.html index be1ccbdc..ebd0f4a3 100644 --- a/docs/interfaces/IWorkerNode.html +++ b/docs/interfaces/IWorkerNode.html @@ -1,4 +1,4 @@ -IWorkerNode | poolifier - v2.6.10

+IWorkerNode | poolifier - v2.6.30

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

IWorkerNode

Defined in src/pools/worker.ts:205

@@ -46,9 +46,13 @@

Properties

clearTasksQueue +closeChannel dequeueTask enqueueTask +getTaskFunctionWorkerUsage +hasBackPressure info +messageChannel? resetUsage tasksQueueSize usage @@ -66,12 +70,28 @@

(): void
-
Worker node clear tasks queue.
+
Clears tasks queue.

Returns void

Defined in src/pools/worker.ts:244

`Readonly` closeChannel

closeChannel: (() => void)

Type declaration

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

`Readonly` dequeueTask

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

@@ -80,15 +100,15 @@

- (): undefined | Task<Data>
- (): undefined | Task<Data>
- -
  Worker node dequeue task.
  +
  Dequeue task.
  
  Returns undefined | Task<Data>
  The dequeued task.

Defined in src/pools/worker.ts:240

`Readonly` enqueueTask

enqueueTask: ((task) => number)

@@ -97,9 +117,9 @@

- (task): number
- (task): number
- -
  Worker node enqueue task.
  +
  Enqueue task.
  
  Parameters
  @@ -109,19 +129,69 @@
  The task to queue.

Returns number

The task queue size.

Returns number

The tasks queue size.

+ +

`Readonly` getTaskFunctionWorkerUsage

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

Type declaration

+
- (name): undefined | WorkerUsage
- +
  Gets task function worker usage statistics.
  +
  +
  +
  Parameters
  +
  - +
    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.
  + +

`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.