X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=63d02663569f5e8169c67687f87ec0acd490d109;hb=fe443f3119b105ccb6dd6f95260de3809e817066;hp=beed097c431abe669beea06e3b9647594cb1a9b7;hpb=c11be5eddc7229e4b77105ed27e93697b65d0146;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index beed097c..63d02663 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,4 +1,4 @@ -IPool | poolifier - v2.7.2
+IPool | poolifier - v3.0.3
  • Preparing search index...
    • -
  • The search index is not available
poolifier - v2.7.2
+
  • The search index is not available
    • poolifier - v3.0.3
    @@ -46,7 +46,7 @@ +
  • Defined in src/pools/pool.ts:201
    • @@ -107,7 +107,7 @@ If a task function with the same name already exists, it will be overwritten.

    Throws

    https://nodejs.org/api/errors.html#class-typeerror If the fn parameter is not a function.

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

    • Readonly destroy

    destroy: (() => Promise<void>)
    @@ -123,11 +123,12 @@ If a task function with the same name already exists, it will be overwritten.

    Returns Promise<void>
    +
  • Defined in src/pools/pool.ts:259

    • Optional Readonly emitter

    -
    emitter?: PoolEmitter
    -

    Emitter on which events can be listened to.

    +
    emitter?: EventEmitterAsyncResource
    +

    Event emitter integrated with async resource on which events can be listened to. +The async tracking tooling identifier is poolifier:<PoolType>-<WorkerType>-pool.

    Events that can currently be listened to:

    • 'ready': Emitted when the number of workers created in the pool has reached the minimum size expected and are ready.
      • @@ -141,7 +142,7 @@ If a task function with the same name already exists, it will be overwritten.

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

    • Readonly enableTasksQueue

    enableTasksQueue: ((enable, tasksQueueOptions?) => void)
    @@ -170,7 +171,7 @@ If a task function with the same name already exists, it will be overwritten.

    Returns void
    +
  • Defined in src/pools/pool.ts:325

    • Readonly execute

    execute: ((data?, name?, transferList?) => Promise<Response>)
    @@ -205,7 +206,7 @@ If a task function with the same name already exists, it will be overwritten.

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

    • Readonly hasTaskFunction

    hasTaskFunction: ((name) => boolean)
    @@ -230,7 +231,7 @@ If a task function with the same name already exists, it will be overwritten.

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

    • Readonly hasWorkerNodeBackPressure

    hasWorkerNodeBackPressure: ((workerNodeKey) => boolean)
    @@ -255,7 +256,7 @@ If a task function with the same name already exists, it will be overwritten.

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

    • Readonly info

    info: PoolInfo
    @@ -263,7 +264,7 @@ If a task function with the same name already exists, it will be overwritten.

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

    • Readonly listTaskFunctionNames

    listTaskFunctionNames: (() => string[])
    @@ -280,7 +281,7 @@ If a task function with the same name already exists, it will be overwritten.

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

    • Readonly removeTaskFunction

    removeTaskFunction: ((name) => Promise<boolean>)
    @@ -305,7 +306,7 @@ If a task function with the same name already exists, it will be overwritten.

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

    • Readonly setDefaultTaskFunction

    setDefaultTaskFunction: ((name) => Promise<boolean>)
    @@ -330,7 +331,7 @@ If a task function with the same name already exists, it will be overwritten.

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

    • Readonly setTasksQueueOptions

    setTasksQueueOptions: ((tasksQueueOptions) => void)
    @@ -354,7 +355,7 @@ If a task function with the same name already exists, it will be overwritten.

    Returns void
    +
  • Defined in src/pools/pool.ts:334

    • Readonly setWorkerChoiceStrategy

    setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void)
    @@ -383,7 +384,7 @@ If a task function with the same name already exists, it will be overwritten.

    Returns void
    +
  • Defined in src/pools/pool.ts:307

    • Readonly setWorkerChoiceStrategyOptions

    setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)
    @@ -407,7 +408,7 @@ If a task function with the same name already exists, it will be overwritten.

    Returns void
    +
  • Defined in src/pools/pool.ts:316

    • Readonly start

    start: (() => void)
    @@ -423,7 +424,7 @@ If a task function with the same name already exists, it will be overwritten.

    Returns void
    +
  • Defined in src/pools/pool.ts:255

    • Readonly Internal workerNodes

    workerNodes: IWorkerNode<Worker, Data>[]
    @@ -431,7 +432,7 @@ If a task function with the same name already exists, it will be overwritten.

    +
  • Defined in src/pools/pool.ts:215
    • @@ -441,10 +442,10 @@ If a task function with the same name already exists, it will be overwritten.

    Member Visibility

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

    • Theme

    @@ -468,7 +469,7 @@ If a task function with the same name already exists, it will be overwritten.

    start
  • workerNodes
    • -

    Generated using TypeDoc

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