X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FPoolOptions.html;h=52df07038a4cf70086c339c6584f383ad83ae0e8;hb=224d008191f52fa20b93e1ba67919569f8d6e315;hp=af453fd7bf33c8170b7fa78d3c05117ea5cb84a4;hpb=f30cddb8f07ac919d75140469faab6e0883709da;p=poolifier.git diff --git a/docs/interfaces/PoolOptions.html b/docs/interfaces/PoolOptions.html index af453fd7..52df0703 100644 --- a/docs/interfaces/PoolOptions.html +++ b/docs/interfaces/PoolOptions.html @@ -1,6 +1,6 @@ -PoolOptions | poolifier - v4.0.3

Interface PoolOptions<Worker>

Options for a poolifier pool.

-
interface PoolOptions<Worker> {
    enableEvents?: boolean;
    enableTasksQueue?: boolean;
    env?: Record<string, unknown>;
    errorHandler?: ErrorHandler<Worker>;
    exitHandler?: ExitHandler<Worker>;
    messageHandler?: MessageHandler<Worker>;
    onlineHandler?: OnlineHandler<Worker>;
    restartWorkerOnError?: boolean;
    settings?: ClusterSettings;
    startWorkers?: boolean;
    tasksQueueOptions?: TasksQueueOptions;
    workerChoiceStrategy?: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN";
    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions;
    workerOptions?: WorkerOptions;
}

Type Parameters

  • Worker extends IWorker

    Type of worker.

    -

Properties

enableEvents? +PoolOptions | poolifier - v4.0.15

Interface PoolOptions<Worker>

Options for a poolifier pool.

+
interface PoolOptions<Worker> {
    enableEvents?: boolean;
    enableTasksQueue?: boolean;
    env?: Record<string, unknown>;
    errorHandler?: ErrorHandler<Worker>;
    exitHandler?: ExitHandler<Worker>;
    messageHandler?: MessageHandler<Worker>;
    onlineHandler?: OnlineHandler<Worker>;
    restartWorkerOnError?: boolean;
    settings?: ClusterSettings;
    startWorkers?: boolean;
    tasksQueueOptions?: TasksQueueOptions;
    workerChoiceStrategy?:
        | "ROUND_ROBIN"
        | "LEAST_USED"
        | "LEAST_BUSY"
        | "LEAST_ELU"
        | "FAIR_SHARE"
        | "WEIGHTED_ROUND_ROBIN"
        | "INTERLEAVED_WEIGHTED_ROUND_ROBIN";
    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions;
    workerOptions?: WorkerOptions;
}

Type Parameters

  • Worker extends IWorker

    Type of worker.

    +

Properties

enableEvents? enableTasksQueue? env? errorHandler? @@ -14,33 +14,37 @@ workerChoiceStrategy? workerChoiceStrategyOptions? workerOptions? -

Properties

Optional enableEvents

enableEvents?: boolean

Pool events integrated with async resource emission.

-

Default Value

true
-
-

Optional enableTasksQueue

enableTasksQueue?: boolean

Pool worker node tasks queue.

-

Default Value

false
-
-

Optional env

env?: Record<string, unknown>

Key/value pairs to add to worker process environment.

-

See

https://nodejs.org/api/cluster.html#cluster_cluster_fork_env

-

Optional errorHandler

errorHandler?: ErrorHandler<Worker>

A function that will listen for error event on each worker.

-

Default Value

() => {}

-

Optional exitHandler

exitHandler?: ExitHandler<Worker>

A function that will listen for exit event on each worker.

-

Default Value

() => {}

-

Optional messageHandler

messageHandler?: MessageHandler<Worker>

A function that will listen for message event on each worker.

-

Default Value

() => {}

-

Optional onlineHandler

onlineHandler?: OnlineHandler<Worker>

A function that will listen for online event on each worker.

-

Default Value

() => {}

-

Optional restartWorkerOnError

restartWorkerOnError?: boolean

Restart worker on error.

-

Optional settings

settings?: ClusterSettings

Cluster settings.

-

See

https://nodejs.org/api/cluster.html#cluster_cluster_settings

-

Optional startWorkers

startWorkers?: boolean

Whether to start the minimum number of workers at pool initialization.

-

Default Value

true
-
-

Optional tasksQueueOptions

tasksQueueOptions?: TasksQueueOptions

Pool worker node tasks queue options.

-

Optional workerChoiceStrategy

workerChoiceStrategy?: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"

The default worker choice strategy to use in this pool.

-

Default Value

WorkerChoiceStrategies.ROUND_ROBIN
-
-

Optional workerChoiceStrategyOptions

workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions

The worker choice strategy options.

-

Optional workerOptions

workerOptions?: WorkerOptions

Worker options.

-

See

https://nodejs.org/api/worker_threads.html#new-workerfilename-options

-

Settings

Member Visibility

Theme

On This Page

enableEventsenableTasksQueueenverrorHandlerexitHandlermessageHandleronlineHandlerrestartWorkerOnErrorsettingsstartWorkerstasksQueueOptionsworkerChoiceStrategyworkerChoiceStrategyOptionsworkerOptions
\ No newline at end of file +

Properties

OptionalenableEvents

enableEvents?: boolean

Pool events integrated with async resource emission.

+

Default Value

true
+
+ +

OptionalenableTasksQueue

enableTasksQueue?: boolean

Pool worker node tasks queue.

+

Default Value

false
+
+ +

Optionalenv

env?: Record<string, unknown>

Key/value pairs to add to worker process environment.

+

See

https://nodejs.org/api/cluster.html#cluster_cluster_fork_env

+

OptionalerrorHandler

errorHandler?: ErrorHandler<Worker>

A function that will listen for error event on each worker.

+

Default Value

() => {}

+

OptionalexitHandler

exitHandler?: ExitHandler<Worker>

A function that will listen for exit event on each worker.

+

Default Value

() => {}

+

OptionalmessageHandler

messageHandler?: MessageHandler<Worker>

A function that will listen for message event on each worker.

+

Default Value

() => {}

+

OptionalonlineHandler

onlineHandler?: OnlineHandler<Worker>

A function that will listen for online event on each worker.

+

Default Value

() => {}

+

OptionalrestartWorkerOnError

restartWorkerOnError?: boolean

Restart worker on error.

+

Optionalsettings

settings?: ClusterSettings

Cluster settings.

+

See

https://nodejs.org/api/cluster.html#cluster_cluster_settings

+

OptionalstartWorkers

startWorkers?: boolean

Whether to start the minimum number of workers at pool initialization.

+

Default Value

true
+
+ +

OptionaltasksQueueOptions

tasksQueueOptions?: TasksQueueOptions

Pool worker node tasks queue options.

+

OptionalworkerChoiceStrategy

workerChoiceStrategy?:
    | "ROUND_ROBIN"
    | "LEAST_USED"
    | "LEAST_BUSY"
    | "LEAST_ELU"
    | "FAIR_SHARE"
    | "WEIGHTED_ROUND_ROBIN"
    | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"

The default worker choice strategy to use in this pool.

+

Default Value

WorkerChoiceStrategies.ROUND_ROBIN
+
+ +

OptionalworkerChoiceStrategyOptions

workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions

The worker choice strategy options.

+

OptionalworkerOptions

workerOptions?: WorkerOptions

Worker options.

+

See

https://nodejs.org/api/worker_threads.html#new-workerfilename-options

+

Settings

Member Visibility

On This Page

Properties
\ No newline at end of file