IPool | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=b410d044d298f91e3f64b94fe4504ba845dfa40d;hb=49fb18fe8d6e6a35ceabe2bce83b26073871e3b0;hp=e5ce7776aaadcacabd63e5b914d058cf287ab65b;hpb=cb4889b43e6935f6dd70d8011ba085c9ca7218ba;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index e5ce7776..b410d044 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,4 +1,4 @@ -IPool | poolifier - v2.6.41

+IPool | poolifier - v2.7.4

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

AbstractPool

Defined in src/pools/pool.ts:201

@@ -54,20 +54,60 @@

Properties

destroy +

addTaskFunction +destroy emitter? enableTasksQueue execute +hasTaskFunction hasWorkerNodeBackPressure info -listTaskFunctions +listTaskFunctionNames +removeTaskFunction +setDefaultTaskFunction setTasksQueueOptions setWorkerChoiceStrategy setWorkerChoiceStrategyOptions +start workerNodes

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>)

@@ -76,18 +116,19 @@

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

Defined in src/pools/pool.ts:259

`Optional` `Readonly` emitter

emitter?: PoolEmitter

Emitter on which events can be listened to.

emitter?: __module | 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.

Defined in src/pools/pool.ts:238

`Readonly` enableTasksQueue

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

@@ -110,7 +151,7 @@

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

Defined in src/pools/pool.ts:325

`Readonly` execute

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

@@ -139,7 +180,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.
  
  @@ -165,7 +206,32 @@

Defined in src/pools/pool.ts:247

`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)

@@ -174,7 +240,7 @@

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

Defined in src/pools/pool.ts:223

`Readonly` info

info: PoolInfo

@@ -198,16 +264,16 @@

`Readonly` listTaskFunctions

listTaskFunctions: (() => string[])

Defined in src/pools/pool.ts:209

`Readonly` listTaskFunctionNames

listTaskFunctionNames: (() => string[])

Type declaration

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

Defined in src/pools/pool.ts:293

`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)

@@ -224,7 +340,7 @@

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

Defined in src/pools/pool.ts:334

`Readonly` setWorkerChoiceStrategy

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

@@ -248,7 +364,7 @@

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

Defined in src/pools/pool.ts:307

`Readonly` setWorkerChoiceStrategyOptions

setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)

@@ -277,7 +393,7 @@

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

Defined in src/pools/pool.ts:316

`Readonly` start

start: (() => void)

Type declaration

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

`Readonly` `Internal` workerNodes

workerNodes: IWorkerNode<Worker, Data>[]

@@ -300,7 +432,7 @@

Defined in src/pools/pool.ts:215

Generated using TypeDoc

Properties

Parameters

name: string

fn: TaskFunction<Data, Response>

Returns Promise<boolean>

Throws

Throws

Returns Promise<void>

name: string

name: string

name: string