X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIWorkerNode.html;h=227c19ad98cfa21a8e0395d5b1fa16239db7bee3;hb=010ae1ba98e5ab018fa09870982d511c9389b48b;hp=ebd0f4a3ba3dd73ef33e64eb3db0afe854ff382d;hpb=c90257c0b2d2c8ebdc6abbee02361cc2ddae36b9;p=poolifier.git diff --git a/docs/interfaces/IWorkerNode.html b/docs/interfaces/IWorkerNode.html index ebd0f4a3..227c19ad 100644 --- a/docs/interfaces/IWorkerNode.html +++ b/docs/interfaces/IWorkerNode.html @@ -1,4 +1,4 @@ -IWorkerNode | poolifier - v2.6.30
+IWorkerNode | poolifier - v2.6.37
  • Preparing search index...
    • -
  • The search index is not available
poolifier - v2.6.30
+
  • The search index is not available
    • poolifier - v2.6.37
    @@ -37,7 +37,7 @@
    • IWorkerNode
    +
  • Defined in src/pools/worker.ts:211
    • @@ -53,8 +53,13 @@ hasBackPressure info messageChannel? +onBackPressure? +onEmptyQueue? +popTask resetUsage +tasksQueueBackPressureSize tasksQueueSize +unshiftTask usage worker
    @@ -75,7 +80,7 @@

    Returns void

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

    • Readonly closeChannel

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

    Returns void

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

    • Readonly dequeueTask

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

    • Readonly enqueueTask

    enqueueTask: ((task) => number)
    @@ -127,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)
    @@ -152,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)
    @@ -175,7 +178,7 @@
    +
  • Defined in src/pools/worker.ts:286

    • Readonly info

    info: WorkerInfo
    @@ -183,15 +186,52 @@
    +
  • Defined in src/pools/worker.ts:219

    • Optional Readonly messageChannel

    messageChannel?: MessageChannel
    -

    Message channel.

    +

    Message channel (worker_threads only).

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

    Optional onBackPressure

    +
    onBackPressure?: WorkerNodeEventCallback
    +

    Callback invoked when worker node tasks queue is back pressured.

    +
    +
    +

    Param

    The worker id.

    +
    +
    +

    Optional onEmptyQueue

    +
    onEmptyQueue?: WorkerNodeEventCallback
    +

    Callback invoked when worker node tasks queue is empty.

    +
    +
    +

    Param

    The worker id.

    +
    +
    +

    Readonly popTask

    +
    popTask: (() => undefined | Task<Data>)
    +
    +

    Type declaration

    +
      +
    • +
        +
      • (): undefined | Task<Data>
        • +
      • +

        Pops a task from the tasks queue.

        +
        +

        Returns undefined | Task<Data>

        The popped task.

        + +

    Readonly resetUsage

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

    tasksQueueBackPressureSize

    +
    tasksQueueBackPressureSize: number
    +

    Tasks queue back pressure size. +This is the number of tasks that can be enqueued before the worker node has back pressure.

    +
    +

    Readonly tasksQueueSize

    tasksQueueSize: (() => number)
    @@ -216,7 +265,7 @@
    +
  • Defined in src/pools/worker.ts:250
    • +
    +

    Readonly unshiftTask

    +
    unshiftTask: ((task) => number)
    +
    +

    Type declaration

    +
      +
    • +
        +
      • (task): number
        • +
      • +

        Prepends a task to the tasks queue.

        +
        +
        +

        Parameters

        +
          +
        • +
          task: Task<Data>
          +

          The task to prepend.

          +
        +

        Returns number

        The tasks queue size.

        + +

    usage

    usage: WorkerUsage
    @@ -232,7 +305,7 @@
    +
  • Defined in src/pools/worker.ts:223

    • Readonly worker

    worker: Worker
    @@ -240,7 +313,7 @@
    +
  • Defined in src/pools/worker.ts:215
    • @@ -268,23 +341,29 @@
  • hasBackPressure
  • info
  • messageChannel
    • +
  • onBackPressure
    • +
  • onEmptyQueue
    • +
  • popTask
  • resetUsage
    • +
  • tasksQueueBackPressureSize
  • tasksQueueSize
    • +
  • unshiftTask
  • usage
  • worker
    • -
    -

    Generated using TypeDoc

    +

    Generated using TypeDoc

    \ No newline at end of file