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

    Returns void

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

    • Readonly closeChannel

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

    Returns void

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

    • Readonly dequeueTask

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

    • 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:257

    • 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:301

    • Readonly hasBackPressure

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

    • Readonly info

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

    • Optional Readonly messageChannel

    messageChannel?: MessageChannel
    @@ -195,31 +194,27 @@
    +
  • Defined in src/pools/worker.ts:227

    • Optional onBackPressure

    -
    onBackPressure?: ((workerId) => void)
    -
    -

    Type declaration

    -
      -
    • -
        -
      • (workerId): void
        • -
      • +
        onBackPressure?: WorkerNodeEventCallback

        Callback invoked when worker node tasks queue is back pressured.

        -
        -

        Parameters

        -
    +
    +

    Optional onEmptyQueue

    +
    onEmptyQueue?: WorkerNodeEventCallback
    +

    Callback invoked when worker node tasks queue is empty.

    -
    -

    Returns void

    -
    +
  • Defined in src/pools/worker.ts:244

    • Readonly popTask

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

    • Readonly resetUsage

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

    • tasksQueueBackPressureSize

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

    • Readonly tasksQueueSize

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

    • Readonly unshiftTask

    unshiftTask: ((task) => number)
    @@ -287,7 +282,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:264

    • usage

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

    • Readonly worker

    worker: Worker
    @@ -319,7 +313,7 @@ This is the number of tasks that can be enqueued before the worker node has back
    +
  • Defined in src/pools/worker.ts:215
    • @@ -348,6 +342,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 +351,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