IWorkerNode | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIWorkerNode.html;h=ebd0f4a3ba3dd73ef33e64eb3db0afe854ff382d;hb=edc0cdb11d19cc5993ca98004a7dbbf49439acd8;hp=9eaac0eaf5f1b5a5c5bbf16d833f66b646ff0a8d;hpb=44b95861ed9dfa91b25f397c9b3cad9586454546;p=poolifier.git diff --git a/docs/interfaces/IWorkerNode.html b/docs/interfaces/IWorkerNode.html index 9eaac0ea..ebd0f4a3 100644 --- a/docs/interfaces/IWorkerNode.html +++ b/docs/interfaces/IWorkerNode.html @@ -1,4 +1,4 @@ -IWorkerNode | poolifier - v2.6.15

+IWorkerNode | poolifier - v2.6.30

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

IWorkerNode

Defined in src/pools/worker.ts:205

@@ -46,10 +46,13 @@

Properties

clearTasksQueue +closeChannel dequeueTask enqueueTask -getTaskWorkerUsage +getTaskFunctionWorkerUsage +hasBackPressure info +messageChannel? resetUsage tasksQueueSize usage @@ -72,7 +75,23 @@

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>)

@@ -81,7 +100,7 @@

- (): undefined | Task<Data>
- (): undefined | Task<Data>
- Dequeue task.
  
  @@ -89,7 +108,7 @@

Defined in src/pools/worker.ts:240

`Readonly` enqueueTask

enqueueTask: ((task) => number)

@@ -98,7 +117,7 @@

- (task): number
- (task): number
- Enqueue task.
  
  @@ -110,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.
  + +