X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=e8b72506f4c49ce6987cf3c620b54dd1296f57f9;hb=6cd5248f7b289828220cac63f8fe77d021c572e9;hp=78d7a5444b3643a0c2f85c1795080a1f98dd3dae;hpb=a84c4698b83aaa02b9f10e52aa9c76eff5b5871f;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 78d7a544..e8b72506 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,4 +1,4 @@ -IPool | poolifier - v2.6.35
+IPool | poolifier - v2.6.36
  • Preparing search index...
    • -
  • The search index is not available
poolifier - v2.6.35
+
  • The search index is not available
    • poolifier - v2.6.36
    @@ -46,7 +46,7 @@ +
  • Defined in src/pools/pool.ts:182
    • @@ -83,7 +83,7 @@

    Returns Promise<void>

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

    • Optional Readonly emitter

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

    • Readonly enableTasksQueue

    enableTasksQueue: ((enable, tasksQueueOptions?) => void)
    @@ -120,17 +120,15 @@
  • 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:266

    • Readonly execute

    execute: ((data?, name?, transferList?) => Promise<Response>)
    @@ -149,23 +147,20 @@
  • 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:227

    • Readonly hasWorkerNodeBackPressure

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

    The worker node key.

    -
    -
    • +

    Returns boolean

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

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

    • Readonly info

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

    • Readonly listTaskFunctions

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

    • Readonly setTasksQueueOptions

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

    The worker node tasks queue options.

    -
    -
    • +

    Returns void

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

    • Readonly setWorkerChoiceStrategy

    setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void)
    @@ -258,17 +251,15 @@
  • 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:248

    • Readonly setWorkerChoiceStrategyOptions

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

    The worker choice strategy options.

    -
    -
    • +

    Returns void

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

    • Readonly Internal workerNodes

    workerNodes: IWorkerNode<Worker, Data>[]
    @@ -300,7 +290,7 @@
    +
  • Defined in src/pools/pool.ts:196
    • @@ -332,7 +322,7 @@
  • setWorkerChoiceStrategyOptions
  • workerNodes
    • -
    -

    Generated using TypeDoc

    +

    Generated using TypeDoc

    \ No newline at end of file