X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FPoolOptions.html;h=e01708d34bf8c979c6fff83a8ed0f291a3d0efff;hb=d67bed32f766d3db7c436ce1a1b9b8dfc3f4633a;hp=ecb388a72bd4ee999ed18e933e4a5392c4298427;hpb=926bdbf304ff660de1360e348517038a837c505f;p=poolifier.git diff --git a/docs/interfaces/PoolOptions.html b/docs/interfaces/PoolOptions.html index ecb388a7..e01708d3 100644 --- a/docs/interfaces/PoolOptions.html +++ b/docs/interfaces/PoolOptions.html @@ -1,46 +1,46 @@ -PoolOptions | poolifier - v3.1.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? -exitHandler? -messageHandler? -onlineHandler? -restartWorkerOnError? -settings? -startWorkers? -tasksQueueOptions? -workerChoiceStrategy? -workerChoiceStrategyOptions? -workerOptions? -

Properties

Optional enableEvents

enableEvents?: boolean

Pool events integrated with async resource emission.

+PoolOptions | poolifier - v3.1.21

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? +exitHandler? +messageHandler? +onlineHandler? +restartWorkerOnError? +settings? +startWorkers? +tasksQueueOptions? +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.

+

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.

+

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.

+

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.

+

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.

+

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.

+

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.

+

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.

+

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 worker choice strategy to use in this pool.

+

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

+

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

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

enableEventsenableTasksQueueenverrorHandlerexitHandlermessageHandleronlineHandlerrestartWorkerOnErrorsettingsstartWorkerstasksQueueOptionsworkerChoiceStrategyworkerChoiceStrategyOptionsworkerOptions

Generated using TypeDoc

\ No newline at end of file