X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=51ef02e20e63318e8cbe7ef108635e213520282c;hb=2de80350c43436f87fca7de401d213c0d93fe208;hp=6296404dc43c8d23a451091e88d0635ea92b0a0e;hpb=b9da9d7e74c720f83482a09d1b883fc83d04f4ed;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 6296404d..51ef02e2 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,13 +1,13 @@ -IPool | poolifier - v2.6.37
+IPool | poolifier - v2.6.45
-
+
  • The search index is not available
    • poolifier - v2.6.45 +
    @@ -46,15 +46,15 @@ +
  • Defined in src/pools/pool.ts:205
    • - +

    Properties

    -
    destroy +
    destroy emitter? enableTasksQueue execute @@ -64,12 +64,13 @@ setTasksQueueOptions setWorkerChoiceStrategy setWorkerChoiceStrategyOptions +start workerNodes

    Properties

    -

    Readonly destroy

    +

    Readonly destroy

    destroy: (() => Promise<void>)

    Type declaration

    @@ -83,7 +84,7 @@

    Returns Promise<void>

    +
  • Defined in src/pools/pool.ts:262

    • Optional Readonly emitter

    emitter?: PoolEmitter
    @@ -101,7 +102,7 @@
    +
  • Defined in src/pools/pool.ts:241

    • Readonly enableTasksQueue

    enableTasksQueue: ((enable, tasksQueueOptions?) => void)
    @@ -120,15 +121,17 @@
  • enable: boolean

    Whether to enable or disable the worker node tasks queue.

    -
    • +
    +
  • Optional tasksQueueOptions: TasksQueueOptions

    The worker node tasks queue options.

    -
    Optional
    • + +

    Returns void

    +
  • Defined in src/pools/pool.ts:293

    • Readonly execute

    execute: ((data?, name?, transferList?) => Promise<Response>)
    @@ -147,20 +150,23 @@
  • Optional data: Data

    The optional task input data for the specified task function. This can only be structured-cloneable data.

    -
    Optional
    • + +
  • Optional name: string

    The optional name of the task function to execute. If not specified, the default task function will be executed.

    -
    Optional
    • + +
  • Optional transferList: TransferListItem[]

    An optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the pool's worker_threads worker and they should not be used in the main thread afterwards.

    -
    Optional
    • + +

    Returns Promise<Response>

    Promise that will be fulfilled when the task is completed.

    +
  • Defined in src/pools/pool.ts:250

    • Readonly hasWorkerNodeBackPressure

    hasWorkerNodeBackPressure: ((workerNodeKey) => boolean)
    @@ -179,12 +185,13 @@
  • workerNodeKey: number

    The worker node key.

    -
    • + +

    Returns boolean

    true if the worker node has back pressure, false otherwise.

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

    • Readonly info

    info: PoolInfo
    @@ -192,7 +199,7 @@
    +
  • Defined in src/pools/pool.ts:213

    • Readonly listTaskFunctions

    listTaskFunctions: (() => string[])
    @@ -209,7 +216,7 @@
    +
  • Defined in src/pools/pool.ts:268

    • Readonly setTasksQueueOptions

    setTasksQueueOptions: ((tasksQueueOptions) => void)
    @@ -228,11 +235,12 @@
  • tasksQueueOptions: TasksQueueOptions

    The worker node tasks queue options.

    -
    • + +

    Returns void

    +
  • Defined in src/pools/pool.ts:302

    • Readonly setWorkerChoiceStrategy

    setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void)
    @@ -251,15 +259,17 @@
  • workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"

    The worker choice strategy.

    -
    • + +
  • Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptions

    The worker choice strategy options.

    -
    Optional
    • + +

    Returns void

    +
  • Defined in src/pools/pool.ts:275

    • Readonly setWorkerChoiceStrategyOptions

    setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)
    @@ -278,11 +288,28 @@
  • workerChoiceStrategyOptions: WorkerChoiceStrategyOptions

    The worker choice strategy options.

    -
    • + +
    +

    Returns void

    +
    +
    +

    Readonly start

    +
    start: (() => void)
    +
    +

    Type declaration

    +
    +
  • Defined in src/pools/pool.ts:258

    • Readonly Internal workerNodes

    workerNodes: IWorkerNode<Worker, Data>[]
    @@ -290,20 +317,20 @@
    +
  • Defined in src/pools/pool.ts:219
    • -

    Settings

     +

    Settings

    Member Visibility

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

    • Theme

    @@ -320,73 +347,33 @@
  • setTasksQueueOptions
  • setWorkerChoiceStrategy
  • setWorkerChoiceStrategyOptions
    • +
  • start
  • workerNodes
    • -
    +

    Generated using TypeDoc

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