IPool | poolifier

Methods

destroy

destroy(): Promise<void>

Properties

destroy

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

Type declaration

+
- (): Promise<void>
- +
  Shutdowns every current worker in this pool.
  +
  +
  Returns Promise<void>
  +

`Optional` `Readonly` emitter

emitter?: PoolEmitter

Emitter on which events can be listened to.

Events that can currently be listened to:

'full': Emitted when the pool is dynamic and full.
'busy': Emitted when the pool is busy.
'error': Emitted when an uncaught error occurs.
'taskError': Emitted when an error occurs while executing a task.

enableTasksQueue

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

Type declaration

+
- (enable, tasksQueueOptions?): void
- -
  Shut down every current worker in this pool.
  +
  Enables/disables the worker tasks queue in this pool.
  
  -
  Returns Promise<void>
  +
  +
  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>
Defined in src/pools/pool.ts:216

execute

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

Type declaration

+
- (data?, name?): Promise<Response>
- -
  Perform the task specified in the constructor with the data parameter.
  +
  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.
  -
  Returns
  Promise that will be resolved when the task is successfully completed.
  +

`Readonly` info

info: PoolInfo

Pool information.

setTasksQueueOptions

setTasksQueueOptions: ((tasksQueueOptions) => void)

Type declaration

+
- (tasksQueueOptions): void
- +
  Sets the worker tasks queue options in this pool.
  Parameters
  - -
    data: Data
    -
    The input for the specified task. This can only be serializable data.
    -
  -
  Returns Promise<Response>
  +
  tasksQueueOptions: TasksQueueOptions
  +
  The worker tasks queue options.
  +
  +

Returns void

setWorkerChoiceStrategy

setWorkerChoiceStrategy(workerChoiceStrategy: "ROUND_ROBIN" | "LESS_RECENTLY_USED"): void
Defined in src/pools/pool.ts:225

setWorkerChoiceStrategy

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

Type declaration

+
- (workerChoiceStrategy, workerChoiceStrategyOptions?): void
- -
  Set the worker choice strategy in this pool.
  +
  Sets the worker choice strategy in this pool.
  Parameters
  - -
    workerChoiceStrategy: "ROUND_ROBIN" | "LESS_RECENTLY_USED"
    +
    workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
    
    The worker choice strategy.
    -
  -
  Returns void
  +
  +
- +
  Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
  +
  The worker choice strategy options.
  +
  +

Interface IPool<Data, Response>

Interface IPool<Worker, Data, Response>

Type Parameters

Worker extends IWorker

Data = unknown

Data = unknown

Response = unknown

Response = unknown

Hierarchy

Index

Methods

Properties

Methods

destroy

Properties

destroy

Type declaration

Returns Promise<void>

Optional Readonly emitter

enableTasksQueue

Type declaration

Returns Promise<void>

execute

execute

Type declaration

Parameters

Optional data: Data

Optional name: string

Returns Promise<Response>

Returns

Readonly info

setTasksQueueOptions

Type declaration

Parameters

data: Data

Returns Promise<Response>

Returns void

setWorkerChoiceStrategy

setWorkerChoiceStrategy

Type declaration

Parameters

workerChoiceStrategy: "ROUND_ROBIN" | "LESS_RECENTLY_USED"

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

Returns void

Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptions

Returns void

setWorkerChoiceStrategyOptions

Type declaration

Parameters

workerChoiceStrategyOptions: WorkerChoiceStrategyOptions

Returns void

Readonly workerNodes

Settings

Settings

Member Visibility

Theme

On This Page

`Optional` `Readonly` emitter

`Optional` data: Data

`Optional` name: string

`Readonly` info

`Optional` workerChoiceStrategyOptions: WorkerChoiceStrategyOptions

`Readonly` workerNodes