IPool | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=66c5140b59b8e081abe82742ca6ed282fc050389;hb=dbf662afd2c11c4d18c4e648f90d392528a715f8;hp=ff7878f0b7e8b6b16d6551605d12b7ca51350006;hpb=da66e34cda2cbcb3a94865d24696c668f50a1437;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index ff7878f0..66c5140b 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,4 +1,4 @@ -IPool | poolifier - v2.6.45

+IPool | poolifier - v2.7.0

@@ -46,7 +46,7 @@

AbstractPool

Defined in src/pools/pool.ts:206

@@ -54,13 +54,17 @@

Properties

destroy +

addTaskFunction +destroy emitter? enableTasksQueue execute +hasTaskFunction hasWorkerNodeBackPressure info -listTaskFunctions +listTaskFunctionNames +removeTaskFunction +setDefaultTaskFunction setTasksQueueOptions setWorkerChoiceStrategy setWorkerChoiceStrategyOptions @@ -69,6 +73,41 @@

Properties

`Readonly` addTaskFunction

addTaskFunction: ((name, fn) => Promise<boolean>)

Type declaration

+
- (name, fn): Promise<boolean>
- +
  Adds a task function to this pool. +If a task function with the same name already exists, it will be overwritten.
  +
  +
  +
  Parameters
  +
  - +
    name: string
    +
    The name of the task function.
    +
    +
  - +
    fn: TaskFunction<Data, Response>
    +
    The task function.
    +
    +
  +
  Returns Promise<boolean>
  true if the task function was added, false otherwise.
  + +
  +
  Throws
  https://nodejs.org/api/errors.html#class-typeerror If the name parameter is not a string or an empty string.
  + +
  Throws
  https://nodejs.org/api/errors.html#class-typeerror If the fn parameter is not a function.
  +

`Readonly` destroy

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

@@ -77,14 +116,14 @@

- (): Promise<void>
- (): Promise<void>
- Terminates all workers in this pool.
  
  Returns Promise<void>

Defined in src/pools/pool.ts:263

`Optional` `Readonly` emitter

emitter?: PoolEmitter

@@ -102,7 +141,7 @@

Defined in src/pools/pool.ts:242

`Readonly` enableTasksQueue

enableTasksQueue: ((enable, tasksQueueOptions?) => void)

@@ -111,7 +150,7 @@

- (enable, tasksQueueOptions?): void
- (enable, tasksQueueOptions?): void
- Enables/disables the worker node tasks queue in this pool.
  
  @@ -131,7 +170,7 @@
  Returns void

Defined in src/pools/pool.ts:329

`Readonly` execute

execute: ((data?, name?, transferList?) => Promise<Response>)

@@ -140,7 +179,7 @@

- (data?, name?, transferList?): Promise<Response>
- (data?, name?, transferList?): Promise<Response>
- Executes the specified function in the worker constructor with the task data input parameter.
  
  @@ -166,7 +205,32 @@

Defined in src/pools/pool.ts:251

`Readonly` hasTaskFunction

hasTaskFunction: ((name) => boolean)

Type declaration

+
- (name): boolean
- +
  Whether the specified task function exists in this pool.
  +
  +
  +
  Parameters
  +
  - +
    name: string
    +
    The name of the task function.
    +
    +
  +
  Returns boolean
  true if the task function exists, false otherwise.
  + +

`Readonly` hasWorkerNodeBackPressure

hasWorkerNodeBackPressure: ((workerNodeKey) => boolean)

@@ -175,7 +239,7 @@

- (workerNodeKey): boolean
- (workerNodeKey): boolean
- Internal
  Whether the worker node has back pressure (i.e. its tasks queue is full).
  
  @@ -191,7 +255,7 @@

Defined in src/pools/pool.ts:228

`Readonly` info

info: PoolInfo

@@ -199,16 +263,16 @@

`Readonly` listTaskFunctions

listTaskFunctions: (() => string[])

Defined in src/pools/pool.ts:214

`Readonly` listTaskFunctionNames

listTaskFunctionNames: (() => string[])

Type declaration

- (): string[]
- (): string[]
- Lists the names of task function available in this pool.
  
  @@ -216,7 +280,57 @@

Defined in src/pools/pool.ts:297

`Readonly` removeTaskFunction

removeTaskFunction: ((name) => Promise<boolean>)

Type declaration

+
- (name): Promise<boolean>
- +
  Removes a task function from this pool.
  +
  +
  +
  Parameters
  +
  - +
    name: string
    +
    The name of the task function.
    +
    +
  +
  Returns Promise<boolean>
  true if the task function was removed, false otherwise.
  + +

`Readonly` setDefaultTaskFunction

setDefaultTaskFunction: ((name) => Promise<boolean>)

Type declaration

+
- (name): Promise<boolean>
- +
  Sets the default task function in this pool.
  +
  +
  +
  Parameters
  +
  - +
    name: string
    +
    The name of the task function.
    +
    +
  +
  Returns Promise<boolean>
  true if the default task function was set, false otherwise.
  + +

`Readonly` setTasksQueueOptions

setTasksQueueOptions: ((tasksQueueOptions) => void)

@@ -225,7 +339,7 @@

- (tasksQueueOptions): void
- (tasksQueueOptions): void
- Sets the worker node tasks queue options in this pool.
  
  @@ -240,7 +354,7 @@
  Returns void

Defined in src/pools/pool.ts:338

`Readonly` setWorkerChoiceStrategy

setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void)

@@ -249,7 +363,7 @@

- (workerChoiceStrategy, workerChoiceStrategyOptions?): void
- (workerChoiceStrategy, workerChoiceStrategyOptions?): void
- Sets the worker choice strategy in this pool.
  
  @@ -269,7 +383,7 @@
  Returns void

Defined in src/pools/pool.ts:311

`Readonly` setWorkerChoiceStrategyOptions

setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)

@@ -278,7 +392,7 @@

- (workerChoiceStrategyOptions): void
- (workerChoiceStrategyOptions): void
- Sets the worker choice strategy options in this pool.
  
  @@ -293,7 +407,7 @@
  Returns void

Defined in src/pools/pool.ts:320

`Readonly` start

start: (() => void)

@@ -302,14 +416,14 @@

- (): void
- (): void
- Starts the minimum number of workers in this pool.
  
  Returns void

Defined in src/pools/pool.ts:259

`Readonly` `Internal` workerNodes

workerNodes: IWorkerNode<Worker, Data>[]

@@ -317,7 +431,7 @@

Defined in src/pools/pool.ts:220

Properties

Parameters

name: string

fn: TaskFunction<Data, Response>

Returns Promise<boolean>

Throws

Throws

Returns Promise<void>

name: string

name: string

name: string