X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIWorkerNode.html;h=256667693fd302d3b023029cd8647fe1a2449677;hb=341ec6db3b66173fd9314338b736fabb0639914b;hp=cf70313d6eaebd422fe28ae74ae060a869f28bfb;hpb=95c333666812f5db34b93c20d8851f2755d1c920;p=poolifier.git diff --git a/docs/interfaces/IWorkerNode.html b/docs/interfaces/IWorkerNode.html index cf70313d..25666769 100644 --- a/docs/interfaces/IWorkerNode.html +++ b/docs/interfaces/IWorkerNode.html @@ -1,4 +1,4 @@ -IWorkerNode | poolifier - v2.6.34
+IWorkerNode | poolifier - v2.6.40
  • Preparing search index...
    • -
  • The search index is not available
poolifier - v2.6.34
+
  • The search index is not available
    • poolifier - v2.6.40
    @@ -37,7 +37,7 @@
    • IWorkerNode
    +
  • Defined in src/pools/worker.ts:217
    • @@ -80,7 +80,7 @@

    Returns void

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

    • Readonly closeChannel

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

    Returns void

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

    • Readonly dequeueTask

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

    • Readonly enqueueTask

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

    The task to queue.

    -
    -
    • +

    Returns number

    The tasks queue size.

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

    • Readonly getTaskFunctionWorkerUsage

    getTaskFunctionWorkerUsage: ((name) => undefined | WorkerUsage)
    @@ -157,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:303

    • Readonly hasBackPressure

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

    • Readonly info

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

    • Optional Readonly messageChannel

    messageChannel?: MessageChannel
    @@ -196,55 +194,23 @@
    +
  • Defined in src/pools/worker.ts:233

    • Optional onBackPressure

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

    Type declaration

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

        Callback invoked when worker node tasks queue is back pressured.

        -
        -

        Parameters

        -
          -
        • -
          workerId: number
          -

          The worker id.

          -
          -
        -

        Returns void

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

    • Optional onEmptyQueue

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

    Type declaration

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

        Callback invoked when worker node tasks queue is empty.

        -
        -

        Parameters

        -
          -
        • -
          workerId: number
          -

          The worker id.

          -
          -
        -

        Returns void

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

    • Readonly popTask

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

    • Readonly resetUsage

    resetUsage: (() => void)
    @@ -270,14 +236,14 @@
    +
  • Defined in src/pools/worker.ts:292

    • tasksQueueBackPressureSize

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

    • Readonly tasksQueueSize

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

    • Readonly unshiftTask

    unshiftTask: ((task) => number)
    @@ -312,7 +278,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:266
    • -

    usage

    +

    Readonly usage

    usage: WorkerUsage

    Worker usage statistics.

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

    • Readonly worker

    worker: Worker
    @@ -344,7 +309,7 @@ This is the number of tasks that can be enqueued before the worker node has back
    +
  • Defined in src/pools/worker.ts:221
    • @@ -382,7 +347,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