X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIWorkerNode.html;h=7f7dad3c89e7a8388105d6642903ae1ef2c809c9;hb=9fe8fd698590c2494dc6793cfd8c08026fe88a31;hp=a2b1da92de18131c65469cabaf6afc4fabf807ea;hpb=b7ca12ae3bfb54a42c0e9879067fc3a976685bb7;p=poolifier.git diff --git a/docs/interfaces/IWorkerNode.html b/docs/interfaces/IWorkerNode.html index a2b1da92..7f7dad3c 100644 --- a/docs/interfaces/IWorkerNode.html +++ b/docs/interfaces/IWorkerNode.html @@ -1,4 +1,4 @@ -IWorkerNode | poolifier - v2.6.32
+IWorkerNode | poolifier - v2.6.36
  • Preparing search index...
    • -
  • The search index is not available
poolifier - v2.6.32
+
  • The search index is not available
    • poolifier - v2.6.36
    @@ -37,7 +37,7 @@
    • IWorkerNode
    +
  • Defined in src/pools/worker.ts:209
    • @@ -54,6 +54,7 @@ info messageChannel? onBackPressure? +onEmptyQueue? popTask resetUsage tasksQueueBackPressureSize @@ -79,7 +80,7 @@

    Returns void

    +
  • Defined in src/pools/worker.ts:278

    • Readonly closeChannel

    closeChannel: (() => void)
    @@ -95,7 +96,7 @@

    Returns void

    +
  • Defined in src/pools/worker.ts:292

    • Readonly dequeueTask

    dequeueTask: (() => undefined | Task<Data>)
    @@ -112,7 +113,7 @@
    +
  • Defined in src/pools/worker.ts:268

    • Readonly enqueueTask

    enqueueTask: ((task) => number)
    @@ -131,13 +132,12 @@
  • task: Task<Data>

    The task to queue.

    -
    -
    • +

    Returns number

    The tasks queue size.

    +
  • Defined in src/pools/worker.ts:255

    • Readonly getTaskFunctionWorkerUsage

    getTaskFunctionWorkerUsage: ((name) => undefined | WorkerUsage)
    @@ -156,13 +156,12 @@
  • 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:299

    • Readonly hasBackPressure

    hasBackPressure: (() => boolean)
    @@ -179,7 +178,7 @@
    +
  • Defined in src/pools/worker.ts:284

    • Readonly info

    info: WorkerInfo
    @@ -187,7 +186,7 @@
    +
  • Defined in src/pools/worker.ts:217

    • Optional Readonly messageChannel

    messageChannel?: MessageChannel
    @@ -195,7 +194,7 @@
    +
  • Defined in src/pools/worker.ts:225

    • Optional onBackPressure

    onBackPressure?: ((workerId) => void)
    @@ -214,12 +213,34 @@
  • workerId: number

    The worker id.

    +
    • +

    Returns void

    +
    +
    +

    Optional onEmptyQueue

    +
    onEmptyQueue?: ((workerId) => void)
    +
    +

    Type declaration

    +
      +
    • +
        +
      • (workerId): void
        • +
      • +

        Callback invoked when worker node tasks queue is empty.

        -
    +
    +

    Parameters

    +
      +
    • +
      workerId: number
      +

      The worker id.

      +

    Returns void

    +
  • Defined in src/pools/worker.ts:242

    • Readonly popTask

    popTask: (() => undefined | Task<Data>)
    @@ -228,7 +249,7 @@
    +
  • Defined in src/pools/worker.ts:274

    • Readonly resetUsage

    resetUsage: (() => void)
    @@ -245,14 +266,14 @@
    +
  • Defined in src/pools/worker.ts:288

    • tasksQueueBackPressureSize

    tasksQueueBackPressureSize: number
    @@ -261,7 +282,7 @@ This is the number of tasks that can be enqueued before the worker node has back
    +
  • Defined in src/pools/worker.ts:230

    • Readonly tasksQueueSize

    tasksQueueSize: (() => number)
    @@ -270,7 +291,7 @@ This is the number of tasks that can be enqueued before the worker node has back
    +
  • Defined in src/pools/worker.ts:248

    • Readonly unshiftTask

    unshiftTask: ((task) => number)
    @@ -287,7 +308,7 @@ This is the number of tasks that can be enqueued before the worker node has back

    Returns number

    The tasks queue size.

    +
  • Defined in src/pools/worker.ts:262

    • usage

    usage: WorkerUsage
    @@ -311,7 +331,7 @@ This is the number of tasks that can be enqueued before the worker node has back
    +
  • Defined in src/pools/worker.ts:221

    • Readonly worker

    worker: Worker
    @@ -319,7 +339,7 @@ This is the number of tasks that can be enqueued before the worker node has back
    +
  • Defined in src/pools/worker.ts:213
    • @@ -348,6 +368,7 @@ This is the number of tasks that can be enqueued before the worker node has back
  • info
  • messageChannel
  • onBackPressure
    • +
  • onEmptyQueue
  • popTask
  • resetUsage
  • tasksQueueBackPressureSize
    • @@ -356,7 +377,7 @@ This is the number of tasks that can be enqueued before the worker node has back
  • usage
  • worker
    • -
    -

    Generated using TypeDoc

    +

    Generated using TypeDoc

    \ No newline at end of file