IPool | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIPool.html;h=b13db3bd94fe758b1c7995771be76339065a6d93;hb=353260e334c7f801b1236890f3a0cb8a98ed2b8e;hp=61d1b615339d614f5a4bdc682e20f12d7041e67f;hpb=812ad701baefad24cad2df8f9a60bf4d581d8697;p=poolifier.git diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 61d1b615..b13db3bd 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,4 +1,4 @@ -IPool | poolifier

+IPool | poolifier

Contract definition for a poolifier pool.

Type Parameters

-
Data = unknown
+
Worker extends IWorker
+
Type of worker which manages this pool.
+
+
Data = unknown

Type of data sent to the worker. This can only be serializable data.
-
Response = unknown
-
Type of response of execution. This can only be serializable data.
+
Response = unknown
+
Type of execution response. This can only be serializable data.

Hierarchy

IPool

Implemented by

AbstractPool

Defined in src/pools/pool.ts:119

@@ -42,31 +50,37 @@

Properties

destroy -emitter? -execute -setWorkerChoiceStrategy +

destroy +emitter? +enableTasksQueue +execute +setTasksQueueOptions +setWorkerChoiceStrategy +setWorkerChoiceStrategyOptions +size +type +workerNodes

Properties

destroy

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

Type declaration

-
- (): Promise<void>

Defined in src/pools/pool.ts:158

`Optional` `Readonly` emitter

emitter?: PoolEmitter

Emitter on which events can be listened to.

Events that can currently be listened to:

@@ -75,40 +89,91 @@

Defined in src/pools/pool.ts:146

enableTasksQueue

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

Type declaration

+
- (enable, tasksQueueOptions?): void
- +
  Enables/disables the worker tasks queue in this pool.
  +
  +
  +
  Parameters
  +
  - +
    enable: boolean
    +
    Whether to enable or disable the worker tasks queue.
    +
  - +
    Optional tasksQueueOptions: TasksQueueOptions
    +
    The worker tasks queue options.
    +
  +
  Returns void

execute

execute: ((data: Data) => Promise<Response>)

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

Type declaration

+
- (data?, name?): Promise<Response>
- +
  Executes the specified function in the worker constructor with the task data input parameter.
  +
  +
  +
  Parameters
  +
  - +
    Optional data: Data
    +
    The task input data for the specified worker function. This can only be serializable data.
    +
  - +
    Optional name: string
    +
    The name of the worker function to execute. If not specified, the default worker function will be executed.
    +
  +
  Returns Promise<Response>
  Promise that will be fulfilled when the task is completed.
  +

setTasksQueueOptions

setTasksQueueOptions: ((tasksQueueOptions) => void)

Type declaration

-
- (data: Data): Promise<Response>

Defined in src/pools/pool.ts:192

setWorkerChoiceStrategy

setWorkerChoiceStrategy: ((workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN") => void)

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

Type declaration

-
- (workerChoiceStrategy: "ROUND_ROBIN" | "LESS_USED" | "LESS_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN"): void

Returns void

Defined in src/pools/pool.ts:165

setWorkerChoiceStrategyOptions

setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)

Type declaration

+
- (workerChoiceStrategyOptions): void
- +
  Sets the worker choice strategy options in this pool.
  +
  +
  +
  Parameters
  +
  - +
    workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
    +
    The worker choice strategy options.
    +
  +
  Returns void