X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIWorkerNode.html;h=8ca8426f69eb912f32deaafb6e71a1e66be6eb7f;hb=665702eef3ad8153279b344e0276687f7f50c10f;hp=2dd42be27714a254bf23f4877ebf54a7cacf8cbb;hpb=b9da9d7e74c720f83482a09d1b883fc83d04f4ed;p=poolifier.git diff --git a/docs/interfaces/IWorkerNode.html b/docs/interfaces/IWorkerNode.html index 2dd42be2..8ca8426f 100644 --- a/docs/interfaces/IWorkerNode.html +++ b/docs/interfaces/IWorkerNode.html @@ -1,13 +1,13 @@ -IWorkerNode | poolifier - v2.6.37
+IWorkerNode | poolifier - v2.6.42
-
+
  • The search index is not available
    • poolifier - v2.6.42 +
    @@ -37,15 +37,15 @@
    • IWorkerNode
    +
  • Defined in src/pools/worker.ts:226
    • - +

    Properties

    -
    clearTasksQueue +
    clearTasksQueue closeChannel dequeueTask enqueueTask @@ -57,6 +57,7 @@ onEmptyQueue? popTask resetUsage +strategyData? tasksQueueBackPressureSize tasksQueueSize unshiftTask @@ -66,7 +67,7 @@

    Properties

    -

    Readonly clearTasksQueue

    +

    Readonly clearTasksQueue

    clearTasksQueue: (() => void)

    Type declaration

    @@ -80,7 +81,7 @@

    Returns void

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

    • Readonly closeChannel

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

    Returns void

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

    • Readonly dequeueTask

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

    • Readonly enqueueTask

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

    The task to queue.

    -
    • +
    +

    Returns number

    The tasks queue size.

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

    • Readonly getTaskFunctionWorkerUsage

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

    • Readonly hasBackPressure

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

    • Readonly info

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

    • Optional Readonly messageChannel

    messageChannel?: MessageChannel
    @@ -194,27 +197,23 @@
    +
  • Defined in src/pools/worker.ts:247

    • Optional onBackPressure

    onBackPressure?: WorkerNodeEventCallback

    Callback invoked when worker node tasks queue is back pressured.

    -
    -

    Param

    The worker id.

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

    • Optional onEmptyQueue

    onEmptyQueue?: WorkerNodeEventCallback

    Callback invoked when worker node tasks queue is empty.

    -
    -

    Param

    The worker id.

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

    • Readonly popTask

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

    • Readonly resetUsage

    resetUsage: (() => void)
    @@ -247,7 +246,16 @@

    Returns void

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

    Optional strategyData

    +
    strategyData?: StrategyData
    +

    Worker choice strategy data. +This is used to store data that is specific to the worker choice strategy.

    +
    +

    tasksQueueBackPressureSize

    tasksQueueBackPressureSize: number
    @@ -256,7 +264,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 tasksQueueSize

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

    • Readonly unshiftTask

    unshiftTask: ((task) => number)
    @@ -292,20 +300,21 @@ This is the number of tasks that can be enqueued before the worker node has back
  • task: Task<Data>

    The task to prepend.

    -
    • + +

    Returns number

    The tasks queue size.

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

    usage

    +

    Readonly usage

    usage: WorkerUsage

    Worker usage statistics.

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

    • Readonly worker

    worker: Worker
    @@ -313,20 +322,20 @@ This is the number of tasks that can be enqueued before the worker node has back
    +
  • Defined in src/pools/worker.ts:230
    • -

    Settings

     +

    Settings

    Member Visibility

      -
      • -
      • -
      • -
    +
    • +
    • +
    • +

    • Theme

    @@ -345,77 +354,37 @@ This is the number of tasks that can be enqueued before the worker node has back
  • onEmptyQueue
  • popTask
  • resetUsage
    • +
  • strategyData
  • tasksQueueBackPressureSize
  • tasksQueueSize
  • unshiftTask
  • usage
  • worker
    • -
    +

    Generated using TypeDoc

    -
    \ No newline at end of file +
    \ No newline at end of file