X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIWorkerNode.html;h=b356e715268aa556b89a7576b26a12bc9a6b6096;hb=1ed7fb6c99f2fcb5f319d9c1fa2aefc5434f82e4;hp=13891582ae872541278a431d24fb0d467a717a15;hpb=c4d8442aed5e5a9d6cde9f3bfd721be3033c1eef;p=poolifier.git diff --git a/docs/interfaces/IWorkerNode.html b/docs/interfaces/IWorkerNode.html index 13891582..b356e715 100644 --- a/docs/interfaces/IWorkerNode.html +++ b/docs/interfaces/IWorkerNode.html @@ -1,4 +1,4 @@ -IWorkerNode | poolifier - v2.6.44
+IWorkerNode | poolifier - v3.0.2
  • Preparing search index...
    • -
  • The search index is not available
poolifier - v2.6.44
+
  • The search index is not available
    • poolifier - v3.0.2
    @@ -35,9 +35,11 @@

    Hierarchy

      -
    • IWorkerNode
    @@ -47,14 +49,13 @@

    Properties

    clearTasksQueue closeChannel +deleteTaskFunctionWorkerUsage dequeueTask enqueueTask getTaskFunctionWorkerUsage hasBackPressure info messageChannel? -onBackPressure? -onEmptyQueue? popTask resetUsage strategyData? @@ -63,6 +64,12 @@ unshiftTask usage worker +
    +
    +

    Methods

    +
    addEventListener +dispatchEvent +removeEventListener

    Properties

    @@ -81,7 +88,7 @@

    Returns void

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

    • Readonly closeChannel

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

    Returns void

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

    Readonly deleteTaskFunctionWorkerUsage

    +
    deleteTaskFunctionWorkerUsage: ((name) => boolean)
    +
    +

    Type declaration

    +
      +
    • +
        +
      • (name): boolean
        • +
      • +

        Deletes task function worker usage statistics.

        +
        +
        +

        Parameters

        +
          +
        • +
          name: string
          +

          The task function name.

          +
          +
        +

        Returns boolean

        true if the task function worker usage statistics were deleted, false otherwise.

        + +

    Readonly dequeueTask

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

    • Readonly enqueueTask

    enqueueTask: ((task) => number)
    @@ -123,7 +155,7 @@
    +
  • Defined in src/pools/worker.ts:267

    • Readonly getTaskFunctionWorkerUsage

    getTaskFunctionWorkerUsage: ((name) => undefined | WorkerUsage)
    @@ -148,7 +180,7 @@
    +
  • Defined in src/pools/worker.ts:311

    • Readonly hasBackPressure

    hasBackPressure: (() => boolean)
    @@ -173,7 +205,7 @@
    +
  • Defined in src/pools/worker.ts:296

    • Readonly info

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

    • Optional Readonly messageChannel

    messageChannel?: MessageChannel
    @@ -197,23 +229,7 @@
    -
    -

    Optional onBackPressure

    -
    onBackPressure?: WorkerNodeEventCallback
    -

    Callback invoked when worker node tasks queue is back pressured.

    -
    -
    -
    -

    Optional onEmptyQueue

    -
    onEmptyQueue?: WorkerNodeEventCallback
    -

    Callback invoked when worker node tasks queue is empty.

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

    • Readonly popTask

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

    • Readonly resetUsage

    resetUsage: (() => void)
    @@ -239,23 +255,23 @@
    +
  • Defined in src/pools/worker.ts:300

    • Optional strategyData

    strategyData?: StrategyData

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

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

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

    • tasksQueueBackPressureSize

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

    • Readonly tasksQueueSize

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

    • Readonly unshiftTask

    unshiftTask: ((task) => number)
    @@ -290,7 +306,7 @@ This is the number of tasks that can be enqueued before the worker node has back
    +
  • Defined in src/pools/worker.ts:274

    • Readonly usage

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

    • Readonly worker

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

    Methods

    +
    +

    addEventListener

    +
      + +
    • +

      Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

      +

      The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

      +

      When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

      +

      When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

      +

      When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

      +

      If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

      +

      The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

      +

      MDN Reference

      +
      +
      +

      Parameters

      +
        +
      • +
        type: string
        • +
      • +
        callback: null | EventListenerOrEventListenerObject
        • +
      • +
        Optional options: boolean | AddEventListenerOptions
      +

      Returns void

      +
    +
    +

    dispatchEvent

    +
      + +
    • +

      Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

      +

      MDN Reference

      +
      +
      +

      Parameters

      +
        +
      • +
        event: Event
      +

      Returns boolean

      +
    +
    +

    removeEventListener

    +
      + +
    • +

      Removes the event listener in target's event listener list with the same type, callback, and options.

      +

      MDN Reference

      +
      +
      +

      Parameters

      +
        +
      • +
        type: string
        • +
      • +
        callback: null | EventListenerOrEventListenerObject
        • +
      • +
        Optional options: boolean | EventListenerOptions
      +

      Returns void

      +
    @@ -332,10 +418,10 @@ This is the number of tasks that can be enqueued before the worker node has back

    Member Visibility

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

    • Theme

    @@ -344,14 +430,13 @@ This is the number of tasks that can be enqueued before the worker node has back
    +
  • worker
    • +
  • addEventListener
    • +
  • dispatchEvent
    • +
  • removeEventListener
    • -

    Generated using TypeDoc

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