From: Documentation Bot Date: Mon, 18 Dec 2023 10:05:52 +0000 (+0000) Subject: docs: generate documentation X-Git-Tag: v3.1.5~6 X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=3e030cbac2cbd1043c9dfdee6580ce494cbc50a1;p=poolifier.git docs: generate documentation --- diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index 766a2342..375b7912 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,8 +1,8 @@ -AbstractPool | poolifier - v3.1.3

Class AbstractPool<Worker, Data, Response>Abstract

Base class that implements some shared logic for all poolifier pools.

+AbstractPool | poolifier - v3.1.4

Class AbstractPool<Worker, Data, Response>Abstract

Base class that implements some shared logic for all poolifier pools.

Type Parameters

  • Worker extends IWorker

    Type of worker which manages this pool.

  • Data = unknown

    Type of data sent to the worker. This can only be structured-cloneable data.

  • Response = unknown

    Type of execution response. This can only be structured-cloneable data.

    -

Hierarchy

Implements

  • IPool<Worker, Data, Response>

Constructors

constructor +

Hierarchy

Implements

  • IPool<Worker, Data, Response>

Constructors

constructor

Properties

destroying emitter? filePath @@ -112,8 +112,8 @@

Type Parameters

  • Worker extends IWorker

  • Data = unknown

  • Response = unknown

Parameters

  • numberOfWorkers: number

    Number of workers that this pool should manage.

  • filePath: string

    Path to the worker file.

  • opts: PoolOptions<Worker>

    Options for the pool.

    -

Returns AbstractPool<Worker, Data, Response>

Properties

Private destroying

destroying: boolean

Whether the pool is destroying or not.

-

Optional emitter

emitter?: EventEmitterAsyncResource

Event emitter integrated with async resource on which events can be listened to. +

Returns AbstractPool<Worker, Data, Response>

Properties

Private destroying

destroying: boolean

Whether the pool is destroying or not.

+

Optional emitter

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

    @@ -125,147 +125,147 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
  • 'taskError': Emitted when an error occurs while executing a task.
  • 'backPressure': Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size >= maximum queue size).
-

Protected Readonly filePath

filePath: string

Path to the worker file.

-

Protected Optional Readonly max

max?: number

Dynamic pool maximum size property placeholder.

-

Protected Readonly numberOfWorkers

numberOfWorkers: number

Number of workers that this pool should manage.

-

Protected Readonly opts

opts: PoolOptions<Worker>

Options for the pool.

-

Protected promiseResponseMap

promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...

The task execution response promise map:

+

Protected Readonly filePath

filePath: string

Path to the worker file.

+

Protected Optional Readonly max

max?: number

Dynamic pool maximum size property placeholder.

+

Protected Readonly numberOfWorkers

numberOfWorkers: number

Number of workers that this pool should manage.

+

Protected Readonly opts

opts: PoolOptions<Worker>

Options for the pool.

+

Protected promiseResponseMap

promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...

The task execution response promise map:

  • key: The message id of each submitted task.
  • value: An object that contains the worker, the execution response promise resolve and reject callbacks.

When we receive a message from the worker, we get a map entry with the promise resolve/reject bound to the message id.

-

Private readyEventEmitted

readyEventEmitted: boolean

Whether the pool ready event has been emitted or not.

-

Private Readonly startTimestamp

startTimestamp: number

The start timestamp of the pool.

-

Private started

started: boolean

Whether the pool is started or not.

-

Private starting

starting: boolean

Whether the pool is starting or not.

-

Private Readonly taskFunctions

taskFunctions: Map<string, TaskFunction<Data, Response>>

The task functions added at runtime map:

+

Private readyEventEmitted

readyEventEmitted: boolean

Whether the pool ready event has been emitted or not.

+

Private Readonly startTimestamp

startTimestamp: number

The start timestamp of the pool.

+

Private started

started: boolean

Whether the pool is started or not.

+

Private starting

starting: boolean

Whether the pool is starting or not.

+

Private Readonly taskFunctions

taskFunctions: Map<string, TaskFunction<Data, Response>>

The task functions added at runtime map:

  • key: The task function name.
  • value: The task function itself.
-

Protected workerChoiceStrategyContext

workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>

Worker choice strategy context referencing a worker choice algorithm implementation.

-

Readonly Internal workerNodes

workerNodes: IWorkerNode<Worker, Data>[] = []

Pool worker nodes.

-

Accessors

Protected Abstract busy

Protected workerChoiceStrategyContext

workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>

Worker choice strategy context referencing a worker choice algorithm implementation.

+

Readonly Internal workerNodes

workerNodes: IWorkerNode<Worker, Data>[] = []

Pool worker nodes.

+

Accessors

Protected Abstract busy

Protected full

Protected full

info

Protected maxSize

Protected minSize

Private ready

Protected Abstract type

info

Protected maxSize

Protected minSize

Private ready

Protected Abstract type

  • get type(): "fixed" | "dynamic"

  • The pool type.

    If it is 'dynamic', it provides the max property.

    -

    Returns "fixed" | "dynamic"

Private utilization

Private utilization

Protected Abstract worker

Methods

addTaskFunction

Protected Abstract worker

Methods

addTaskFunction

Private addWorkerNode

Private addWorkerNode

Protected afterTaskExecutionHook

Protected afterTaskExecutionHook

  • afterTaskExecutionHook(workerNodeKey, message): void

  • Hook executed after the worker task execution. Can be overridden.

    Parameters

    • workerNodeKey: number

      The worker node key.

    • message: MessageValue<Response, unknown>

      The received message.

      -

    Returns void

Protected afterWorkerNodeSetup

  • afterWorkerNodeSetup(workerNodeKey): void

  • Method hooked up after a worker node has been newly created. +

Returns void

Protected afterWorkerNodeSetup

  • afterWorkerNodeSetup(workerNodeKey): void

  • Method hooked up after a worker node has been newly created. Can be overridden.

    Parameters

    • workerNodeKey: number

      The newly created worker node key.

      -

    Returns void

Protected beforeTaskExecutionHook

  • beforeTaskExecutionHook(workerNodeKey, task): void

  • Hook executed before the worker task execution. +

Returns void

Protected beforeTaskExecutionHook

  • beforeTaskExecutionHook(workerNodeKey, task): void

  • Hook executed before the worker task execution. Can be overridden.

    Parameters

    • workerNodeKey: number

      The worker node key.

    • task: Task<Data>

      The task to execute.

      -

    Returns void

Private buildTasksQueueOptions

Private checkAndEmitDynamicWorkerCreationEvents

Private checkAndEmitTaskExecutionEvents

Private checkAndEmitTaskQueuingEvents

Private checkMessageWorkerId

  • checkMessageWorkerId(message): void

  • Checks if the worker id sent in the received message from a worker is valid.

    +

Returns void

Private buildTasksQueueOptions

Private checkAndEmitDynamicWorkerCreationEvents

Private checkAndEmitTaskExecutionEvents

Private checkAndEmitTaskQueuingEvents

Private checkMessageWorkerId

Private checkNumberOfWorkers

Private checkPoolOptions

Private checkValidWorkerChoiceStrategyOptions

Private chooseWorkerNode

Private checkNumberOfWorkers

Private checkPoolOptions

Private checkValidWorkerChoiceStrategyOptions

Private chooseWorkerNode

  • chooseWorkerNode(): number

  • Chooses a worker node for the next task.

    The default worker choice strategy uses a round robin algorithm to distribute the tasks.

    Returns number

    The chosen worker node key

    -

Protected createAndSetupDynamicWorkerNode

Protected createAndSetupDynamicWorkerNode

  • createAndSetupDynamicWorkerNode(): number

  • Creates a new, completely set up dynamic worker node.

    Returns number

    New, completely set up dynamic worker node key.

    -

Protected createAndSetupWorkerNode

Protected createAndSetupWorkerNode

  • createAndSetupWorkerNode(): number

  • Creates a new, completely set up worker node.

    Returns number

    New, completely set up worker node key.

    -

Private createWorkerNode

Private createWorkerNode

Private deleteTaskFunctionWorkerUsages

Private dequeueTask

Protected Abstract deregisterWorkerMessageListener

  • deregisterWorkerMessageListener<Message>(workerNodeKey, listener): void

  • Deregisters a listener callback on the worker given its worker node key.

    +

Private deleteTaskFunctionWorkerUsages

Private dequeueTask

Protected Abstract deregisterWorkerMessageListener

  • deregisterWorkerMessageListener<Message>(workerNodeKey, listener): void

  • Deregisters a listener callback on the worker given its worker node key.

    Type Parameters

    • Message

    Parameters

    • workerNodeKey: number

      The worker node key.

    • listener: ((message) => void)

      The message listener callback.

      -
        • (message): void

        • Parameters

          Returns void

    Returns void

destroy

Protected destroyWorkerNode

  • destroyWorkerNode(workerNodeKey): Promise<void>

  • Terminates the worker node given its worker node key.

    +
      • (message): void

      • Parameters

        Returns void

Returns void

destroy

Protected destroyWorkerNode

  • destroyWorkerNode(workerNodeKey): Promise<void>

  • Terminates the worker node given its worker node key.

    Parameters

    • workerNodeKey: number

      The worker node key.

      -

    Returns Promise<void>

enableTasksQueue

  • enableTasksQueue(enable, tasksQueueOptions?): void

  • Enables/disables the worker node tasks queue in this pool.

    +

Returns Promise<void>

enableTasksQueue

  • enableTasksQueue(enable, tasksQueueOptions?): void

  • Enables/disables the worker node tasks queue in this pool.

    Parameters

    • enable: boolean

      Whether to enable or disable the worker node tasks queue.

    • Optional tasksQueueOptions: TasksQueueOptions

      The worker node tasks queue options.

      -

    Returns void

Private enqueueTask

execute

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

  • Executes the specified function in the worker constructor with the task data input parameter.

    +

Returns void

Private enqueueTask

execute

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

  • Executes the specified function in the worker constructor with the task data input parameter.

    Parameters

    • Optional data: Data

      The optional task input data for the specified task function. This can only be structured-cloneable data.

    • Optional name: string

      The optional name of the task function to execute. If not specified, the default task function will be executed.

    • Optional transferList: TransferListItem[]

      An optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the chosen pool's worker_threads worker and they should not be used in the main thread afterwards.

    Returns Promise<Response>

    Promise that will be fulfilled when the task is completed.

    -

Private executeTask

Private executeTask

  • executeTask(workerNodeKey, task): void

  • Executes the given task on the worker given its worker node key.

    Parameters

    • workerNodeKey: number

      The worker node key.

    • task: Task<Data>

      The task to execute.

      -

    Returns void

Protected flagWorkerNodeAsNotReady

Protected flushTasksQueue

Private flushTasksQueues

Protected getWorkerInfo

  • getWorkerInfo(workerNodeKey): WorkerInfo

  • Gets the worker information given its worker node key.

    +

Returns void

Protected flagWorkerNodeAsNotReady

Protected flushTasksQueue

Private flushTasksQueues

Protected getWorkerInfo

Private getWorkerNodeKeyByWorker

Private getWorkerNodeKeyByWorker

  • getWorkerNodeKeyByWorker(worker): number

  • Gets the given worker its worker node key.

    Parameters

    • worker: Worker

      The worker.

    Returns number

    The worker node key if found in the pool worker nodes, -1 otherwise.

    -

Private getWorkerNodeKeyByWorkerId

Private getWorkerNodeKeyByWorkerId

  • getWorkerNodeKeyByWorkerId(workerId): number

  • Gets the worker node key given its worker id.

    Parameters

    • workerId: undefined | number

      The worker id.

    Returns number

    The worker node key if the worker id is found in the pool worker nodes, -1 otherwise.

    -

Private Readonly handleBackPressureEvent

Private Readonly handleIdleWorkerNodeEvent

Private handleTask

Private handleTaskExecutionResponse

Private handleWorkerReadyResponse

Private hasBackPressure

hasTaskFunction

Private Readonly handleBackPressureEvent

Private Readonly handleIdleWorkerNodeEvent

Private handleTask

Private handleTaskExecutionResponse

Private handleWorkerReadyResponse

Private hasBackPressure

hasTaskFunction

  • hasTaskFunction(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.

    -

hasWorkerNodeBackPressure

hasWorkerNodeBackPressure

  • hasWorkerNodeBackPressure(workerNodeKey): boolean
  • Internal

    Whether the worker node has back pressure (i.e. its tasks queue is full).

    Parameters

    • workerNodeKey: number

      The worker node key.

    Returns boolean

    true if the worker node has back pressure, false otherwise.

    -

Private initializeEventEmitter

Protected internalBusy

Private initializeEventEmitter

Protected internalBusy

  • internalBusy(): boolean

  • Whether worker nodes are executing concurrently their tasks quota or not.

    Returns boolean

    Worker nodes busyness boolean status.

    -

Protected Abstract isMain

Private isWorkerNodeBusy

listTaskFunctionNames

Protected Abstract isMain

Private isWorkerNodeBusy

listTaskFunctionNames

Private redistributeQueuedTasks

Protected Abstract registerOnceWorkerMessageListener

Private redistributeQueuedTasks

Protected Abstract registerOnceWorkerMessageListener

  • registerOnceWorkerMessageListener<Message>(workerNodeKey, listener): void

  • Registers once a listener callback on the worker given its worker node key.

    Type Parameters

    • Message

    Parameters

    • workerNodeKey: number

      The worker node key.

    • listener: ((message) => void)

      The message listener callback.

      -
        • (message): void

        • Parameters

          Returns void

    Returns void

Protected Abstract registerWorkerMessageListener

  • registerWorkerMessageListener<Message>(workerNodeKey, listener): void

  • Registers a listener callback on the worker given its worker node key.

    +
      • (message): void

      • Parameters

        Returns void

Returns void

Protected Abstract registerWorkerMessageListener

  • registerWorkerMessageListener<Message>(workerNodeKey, listener): void

  • Registers a listener callback on the worker given its worker node key.

    Type Parameters

    • Message

    Parameters

    • workerNodeKey: number

      The worker node key.

    • listener: ((message) => void)

      The message listener callback.

      -
        • (message): void

        • Parameters

          Returns void

    Returns void

removeTaskFunction

  • removeTaskFunction(name): Promise<boolean>

  • Removes a task function from this pool.

    +
      • (message): void

      • Parameters

        Returns void

Returns void

removeTaskFunction

  • removeTaskFunction(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.

    -

Private removeWorkerNode

Private removeWorkerNode

Private resetTaskSequentiallyStolenStatisticsTaskFunctionWorkerUsage

  • resetTaskSequentiallyStolenStatisticsTaskFunctionWorkerUsage(workerNodeKey, taskName): void

  • Parameters

    • workerNodeKey: number
    • taskName: string

    Returns void

Private resetTaskSequentiallyStolenStatisticsWorkerUsage

Protected sendKillMessageToWorker

Protected Abstract sendStartupMessageToWorker

  • sendStartupMessageToWorker(workerNodeKey): void

  • Sends the startup message to worker given its worker node key.

    +

Returns void

Private resetTaskSequentiallyStolenStatisticsTaskFunctionWorkerUsage

  • resetTaskSequentiallyStolenStatisticsTaskFunctionWorkerUsage(workerNodeKey, taskName): void

  • Parameters

    • workerNodeKey: number
    • taskName: string

    Returns void

Private resetTaskSequentiallyStolenStatisticsWorkerUsage

Protected sendKillMessageToWorker

Protected Abstract sendStartupMessageToWorker

  • sendStartupMessageToWorker(workerNodeKey): void

  • Sends the startup message to worker given its worker node key.

    Parameters

    • workerNodeKey: number

      The worker node key.

      -

    Returns void

Private sendStatisticsMessageToWorker

  • sendStatisticsMessageToWorker(workerNodeKey): void

  • Sends the statistics message to worker given its worker node key.

    +

Returns void

Private sendStatisticsMessageToWorker

  • sendStatisticsMessageToWorker(workerNodeKey): void

  • Sends the statistics message to worker given its worker node key.

    Parameters

    • workerNodeKey: number

      The worker node key.

      -

    Returns void

Private sendTaskFunctionOperationToWorker

Private sendTaskFunctionOperationToWorkers

Protected Abstract sendToWorker

  • sendToWorker(workerNodeKey, message, transferList?): void

  • Sends a message to worker given its worker node key.

    +

Returns void

Private sendTaskFunctionOperationToWorker

Private sendTaskFunctionOperationToWorkers

Protected Abstract sendToWorker

  • sendToWorker(workerNodeKey, message, transferList?): void

  • Sends a message to worker given its worker node key.

    Parameters

    • workerNodeKey: number

      The worker node key.

    • message: MessageValue<Data, unknown>

      The message.

    • Optional transferList: TransferListItem[]

      The optional array of transferable objects.

      -

    Returns void

setDefaultTaskFunction

  • setDefaultTaskFunction(name): Promise<boolean>

  • Sets the default task function in this pool.

    +

Returns void

setDefaultTaskFunction

  • setDefaultTaskFunction(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.

    -

Private setTaskStealing

setTasksQueueOptions

Private setTaskStealing

setTasksQueueOptions

Private setTasksQueueSize

Private setTasksStealingOnBackPressure

setWorkerChoiceStrategy

  • setWorkerChoiceStrategy(workerChoiceStrategy, workerChoiceStrategyOptions?): void

  • Sets the worker choice strategy in this pool.

    +

Returns void

Private setTasksQueueSize

Private setTasksStealingOnBackPressure

setWorkerChoiceStrategy

  • setWorkerChoiceStrategy(workerChoiceStrategy, workerChoiceStrategyOptions?): void

  • Sets the worker choice strategy in this pool.

    Parameters

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

      The worker choice strategy.

    • Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptions

      The worker choice strategy options.

      -

    Returns void

setWorkerChoiceStrategyOptions

  • setWorkerChoiceStrategyOptions(workerChoiceStrategyOptions): void

  • Sets the worker choice strategy options in this pool.

    +

Returns void

setWorkerChoiceStrategyOptions

Protected setupHook

  • setupHook(): void

  • Setup hook to execute code before worker nodes are created in the abstract constructor. +

Returns void

Protected setupHook

  • setupHook(): void

  • Setup hook to execute code before worker nodes are created in the abstract constructor. Can be overridden.

    -

    Returns void

Private shallCreateDynamicWorker

Private shallCreateDynamicWorker

  • shallCreateDynamicWorker(): boolean

  • Conditions for dynamic worker creation.

    Returns boolean

    Whether to create a dynamic worker or not.

    -

Private shallExecuteTask

Private shallUpdateTaskFunctionWorkerUsage

  • shallUpdateTaskFunctionWorkerUsage(workerNodeKey): boolean

  • Whether the worker node shall update its task function worker usage or not.

    +

Private shallExecuteTask

Private shallUpdateTaskFunctionWorkerUsage

  • shallUpdateTaskFunctionWorkerUsage(workerNodeKey): boolean

  • Whether the worker node shall update its task function worker usage or not.

    Parameters

    • workerNodeKey: number

      The worker node key.

    Returns boolean

    true if the worker node shall update its task function worker usage, false otherwise.

    -

start

Private tasksQueueSize

Private unsetTaskStealing

Private unsetTasksStealingOnBackPressure

Private updateEluWorkerUsage

Private updateRunTimeWorkerUsage

Private updateTaskSequentiallyStolenStatisticsTaskFunctionWorkerUsage

  • updateTaskSequentiallyStolenStatisticsTaskFunctionWorkerUsage(workerNodeKey, taskName): void

  • Parameters

    • workerNodeKey: number
    • taskName: string

    Returns void

Private updateTaskSequentiallyStolenStatisticsWorkerUsage

  • updateTaskSequentiallyStolenStatisticsWorkerUsage(workerNodeKey): void

  • Parameters

    • workerNodeKey: number

    Returns void

Private updateTaskStatisticsWorkerUsage

Private updateTaskStolenStatisticsWorkerUsage

  • updateTaskStolenStatisticsWorkerUsage(workerNodeKey, taskName): void

  • Parameters

    • workerNodeKey: number
    • taskName: string

    Returns void

Private updateWaitTimeWorkerUsage

Protected Readonly workerMessageListener

Private Readonly workerNodeStealTask

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

start

Private tasksQueueSize

Private unsetTaskStealing

Private unsetTasksStealingOnBackPressure

Private updateEluWorkerUsage

Private updateRunTimeWorkerUsage

Private updateTaskSequentiallyStolenStatisticsTaskFunctionWorkerUsage

  • updateTaskSequentiallyStolenStatisticsTaskFunctionWorkerUsage(workerNodeKey, taskName): void

  • Parameters

    • workerNodeKey: number
    • taskName: string

    Returns void

Private updateTaskSequentiallyStolenStatisticsWorkerUsage

  • updateTaskSequentiallyStolenStatisticsWorkerUsage(workerNodeKey): void

  • Parameters

    • workerNodeKey: number

    Returns void

Private updateTaskStatisticsWorkerUsage

Private updateTaskStolenStatisticsWorkerUsage

  • updateTaskStolenStatisticsWorkerUsage(workerNodeKey, taskName): void

  • Parameters

    • workerNodeKey: number
    • taskName: string

    Returns void

Private updateWaitTimeWorkerUsage

Protected Readonly workerMessageListener

Private Readonly workerNodeStealTask

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index 5cb99ebf..8d96c798 100644 --- a/docs/classes/AbstractWorker.html +++ b/docs/classes/AbstractWorker.html @@ -1,8 +1,8 @@ -AbstractWorker | poolifier - v3.1.3

Class AbstractWorker<MainWorker, Data, Response>Abstract

Base class that implements some shared logic for all poolifier workers.

+AbstractWorker | poolifier - v3.1.4

Class AbstractWorker<MainWorker, Data, Response>Abstract

Base class that implements some shared logic for all poolifier workers.

Type Parameters

  • MainWorker extends Worker | MessagePort

    Type of main worker.

  • Data = unknown

    Type of data this worker receives from pool's execution. This can only be structured-cloneable data.

  • Response = unknown

    Type of response the worker sends back to the main worker. This can only be structured-cloneable data.

    -

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

activeInterval? id isMain @@ -42,58 +42,58 @@
  • mainWorker: MainWorker

    Reference to main worker.

  • taskFunctions: TaskFunction<Data, Response> | TaskFunctions<Data, Response>

    Task function(s) processed by the worker when the pool's execution function is invoked. The first function is the default function.

  • opts: WorkerOptions = DEFAULT_WORKER_OPTIONS

    Options for the worker.

    -

    • Returns AbstractWorker<MainWorker, Data, Response>

    Properties

    Protected Optional activeInterval

    activeInterval?: Timeout

    Handler id of the activeInterval worker activity check.

    -

    Protected Abstract id

    id: number

    Worker id.

    -

    Protected Readonly isMain

    isMain: boolean

    Whether this is the main worker or not.

    -

    Protected lastTaskTimestamp

    lastTaskTimestamp: number

    Timestamp of the last task processed by this worker.

    -

    Private Readonly mainWorker

    mainWorker: MainWorker

    Reference to main worker.

    -

    Protected opts

    opts: WorkerOptions = DEFAULT_WORKER_OPTIONS

    Options for the worker.

    -

    Protected statistics

    statistics: WorkerStatistics

    Performance statistics computation requirements.

    -

    Protected taskFunctions

    taskFunctions: Map<string, TaskFunction<Data, Response>>

    Task function(s) processed by the worker when the pool's execution function is invoked.

    -

    Methods

    addTaskFunction

    Returns AbstractWorker<MainWorker, Data, Response>

    Properties

    Protected Optional activeInterval

    activeInterval?: Timeout

    Handler id of the activeInterval worker activity check.

    +

    Protected Abstract id

    id: number

    Worker id.

    +

    Protected Readonly isMain

    isMain: boolean

    Whether this is the main worker or not.

    +

    Protected lastTaskTimestamp

    lastTaskTimestamp: number

    Timestamp of the last task processed by this worker.

    +

    Private Readonly mainWorker

    mainWorker: MainWorker

    Reference to main worker.

    +

    Protected opts

    opts: WorkerOptions = DEFAULT_WORKER_OPTIONS

    Options for the worker.

    +

    Protected statistics

    statistics: WorkerStatistics

    Performance statistics computation requirements.

    +

    Protected taskFunctions

    taskFunctions: Map<string, TaskFunction<Data, Response>>

    Task function(s) processed by the worker when the pool's execution function is invoked.

    +

    Methods

    addTaskFunction

    Private beginTaskPerformance

    Private checkActive

    Private checkMessageWorkerId

    Private beginTaskPerformance

    Private checkActive

    Private checkMessageWorkerId

    Private checkStatistics

    Private checkTaskFunctions

    Private checkStatistics

    Private checkTaskFunctions

    • checkTaskFunctions(taskFunctions): void

    • Checks if the taskFunctions parameter is passed to the constructor and valid.

      Parameters

      • taskFunctions: TaskFunction<Data, Response> | TaskFunctions<Data, Response>

        The task function(s) parameter that should be checked.

        -

      Returns void

    Private checkWorkerOptions

    Private endTaskPerformance

    Protected getMainWorker

    • getMainWorker(): MainWorker

    • Returns the main worker.

      +

    Returns void

    Private checkWorkerOptions

    Private endTaskPerformance

    Protected getMainWorker

    Protected handleError

    Protected handleError

    • handleError(error): string

    • Handles an error and convert it to a string so it can be sent back to the main worker.

      Parameters

      • error: string | Error

        The error raised by the worker.

      Returns string

      The error message.

      -

    Protected handleKillMessage

    Protected Abstract handleReadyMessage

    Protected handleKillMessage

    Protected Abstract handleReadyMessage

    Protected handleTaskFunctionOperationMessage

    hasTaskFunction

    Returns void

    Protected handleTaskFunctionOperationMessage

    hasTaskFunction

    listTaskFunctionNames

    listTaskFunctionNames

    • listTaskFunctionNames(): string[]

    • Lists the names of the worker's task functions.

      Returns string[]

      The names of the worker's task functions.

      -

    Protected messageListener

    Protected messageListener

    removeTaskFunction

    Returns void

    removeTaskFunction

    Protected Readonly run

    Protected Readonly run

    Protected Readonly runAsync

    • runAsync(fn, task): void

    • Runs the given task function asynchronously.

      +

    Returns void

    Protected Readonly runAsync

    Protected Readonly runSync

    • runSync(fn, task): void

    • Runs the given task function synchronously.

      +

    Returns void

    Protected Readonly runSync

    Protected sendTaskFunctionNamesToMainWorker

    Protected Abstract sendToMainWorker

    • sendToMainWorker(message): void

    • Sends a message to main worker.

      +

    Returns void

    Protected sendTaskFunctionNamesToMainWorker

    Protected Abstract sendToMainWorker

    setDefaultTaskFunction

    Returns void

    setDefaultTaskFunction

    Private startCheckActive

    Private stopCheckActive

    Private updateLastTaskTimestamp

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Private startCheckActive

    Private stopCheckActive

    Private updateLastTaskTimestamp

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/CircularArray.html b/docs/classes/CircularArray.html index 3d68c82d..65a46f90 100644 --- a/docs/classes/CircularArray.html +++ b/docs/classes/CircularArray.html @@ -1,5 +1,5 @@ -CircularArray | poolifier - v3.1.3

    Class CircularArray<T>Internal

    Array with a maximum length and shifting items when full.

    -

    Type Parameters

    • T

    Hierarchy

    • Array<T>
      • CircularArray

    Constructors

    constructor +CircularArray | poolifier - v3.1.4

    Class CircularArray<T>Internal

    Array with a maximum length and shifting items when full.

    +

    Type Parameters

    • T

    Hierarchy

    • Array<T>
      • CircularArray

    Constructors

    constructor

    Properties

    [unscopables] length size @@ -44,23 +44,23 @@ from isArray of -

    Constructors

    constructor

    Properties

    Readonly [unscopables]

    [unscopables]: {
        [unscopables]?: boolean;
        length?: boolean;
        [iterator]?: any;
        at?: any;
        concat?: any;
        copyWithin?: any;
        entries?: any;
        every?: any;
        fill?: any;
        filter?: any;
        find?: any;
        findIndex?: any;
        flat?: any;
        flatMap?: any;
        forEach?: any;
        includes?: any;
        indexOf?: any;
        join?: any;
        keys?: any;
        lastIndexOf?: any;
        map?: any;
        pop?: any;
        push?: any;
        reduce?: any;
        reduceRight?: any;
        reverse?: any;
        shift?: any;
        slice?: any;
        some?: any;
        sort?: any;
        splice?: any;
        toLocaleString?: any;
        toString?: any;
        unshift?: any;
        values?: any;
    }

    Is an object whose properties have the value 'true' +

    Constructors

    constructor

    Properties

    Readonly [unscopables]

    [unscopables]: {
        [unscopables]?: boolean;
        length?: boolean;
        [iterator]?: any;
        at?: any;
        concat?: any;
        copyWithin?: any;
        entries?: any;
        every?: any;
        fill?: any;
        filter?: any;
        find?: any;
        findIndex?: any;
        flat?: any;
        flatMap?: any;
        forEach?: any;
        includes?: any;
        indexOf?: any;
        join?: any;
        keys?: any;
        lastIndexOf?: any;
        map?: any;
        pop?: any;
        push?: any;
        reduce?: any;
        reduceRight?: any;
        reverse?: any;
        shift?: any;
        slice?: any;
        some?: any;
        sort?: any;
        splice?: any;
        toLocaleString?: any;
        toString?: any;
        unshift?: any;
        values?: any;
    }

    Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    Type declaration

    • Optional Readonly [unscopables]?: boolean

      Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

    • Optional length?: boolean

      Gets or sets the length of the array. This is a number one higher than the highest index in the array.

    length

    length: number

    Gets or sets the length of the array. This is a number one higher than the highest index in the array.

    -

    size

    size: number

    Static Readonly [species]

    [species]: ArrayConstructor

    Methods

    [iterator]

    • [iterator](): IterableIterator<T>

    • Iterator

      +

    size

    size: number

    Static Readonly [species]

    [species]: ArrayConstructor

    Methods

    [iterator]

    • [iterator](): IterableIterator<T>

    • Iterator

      Returns IterableIterator<T>

    at

    • at(index): undefined | T

    • Returns the item located at the specified index.

      Parameters

      • index: number

        The zero-based index of the desired code unit. A negative index will count back from the last item.

        -

      Returns undefined | T

    Private checkSize

    concat

    copyWithin

    • copyWithin(target, start, end?): CircularArray<T>

    • Returns the this object after copying a section of the array identified by start and end +

    Returns undefined | T

    Private checkSize

    concat

    copyWithin

    • copyWithin(target, start, end?): CircularArray<T>

    • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

      Parameters

      • target: number

        If target is negative, it is treated as length+target where length is the length of the array.

      • start: number

        If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

      • Optional end: number

        If not specified, length of the this object is used as its default value.

        -

      Returns CircularArray<T>

    empty

    entries

    • entries(): IterableIterator<[number, T]>

    • Returns an iterable of key, value pairs for every entry in the array

      +

    Returns CircularArray<T>

    empty

    entries

    • entries(): IterableIterator<[number, T]>

    • Returns an iterable of key, value pairs for every entry in the array

      Returns IterableIterator<[number, T]>

    every

    • every<S>(predicate, thisArg?): this is S[]

    • Determines whether all the members of an array satisfy the specified test.

      Type Parameters

      • S

      Parameters

      • predicate: ((value, index, array) => value is S)

        A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value @@ -112,7 +112,7 @@ thisArg is omitted, undefined is used as the this value.

      Returns U[]

    forEach

    • forEach(callbackfn, thisArg?): void

    • Performs the specified action for each element in an array.

      Parameters

      • callbackfn: ((value, index, array) => void)

        A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

          • (value, index, array): void

          • Parameters

            • value: T
            • index: number
            • array: T[]

            Returns void

      • Optional thisArg: any

        An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

        -

      Returns void

    full

    includes

    • includes(searchElement, fromIndex?): boolean

    • Determines whether an array includes a certain element, returning true or false as appropriate.

      +

    Returns void

    full

    includes

    • includes(searchElement, fromIndex?): boolean

    • Determines whether an array includes a certain element, returning true or false as appropriate.

      Parameters

      • searchElement: T

        The element to search for.

      • Optional fromIndex: number

        The position in this array at which to begin searching for searchElement.

      Returns boolean

    indexOf

    • indexOf(searchElement, fromIndex?): number

    • Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

      @@ -129,7 +129,7 @@ thisArg is omitted, undefined is used as the this value.

        • (value, index, array): U

        • Parameters

          • value: T
          • index: number
          • array: T[]

          Returns U

    • Optional thisArg: any

      An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

    Returns U[]

    pop

    • pop(): undefined | T

    • Removes the last element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.

      -

      Returns undefined | T

    push

    • push(...items): number

    • Parameters

      • Rest ...items: T[]

      Returns number

      Inherit Doc

    reduce

    • reduce(callbackfn): T

    • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

      +

      Returns undefined | T

    push

    • push(...items): number

    • Parameters

      • Rest ...items: T[]

      Returns number

      Inherit Doc

    reduce

    • reduce(callbackfn): T

    • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

      Parameters

      • callbackfn: ((previousValue, currentValue, currentIndex, array) => T)

        A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

          • (previousValue, currentValue, currentIndex, array): T

          • Parameters

            • previousValue: T
            • currentValue: T
            • currentIndex: number
            • array: T[]

            Returns T

      Returns T

    • reduce(callbackfn, initialValue): T

    • Parameters

      • callbackfn: ((previousValue, currentValue, currentIndex, array) => T)
          • (previousValue, currentValue, currentIndex, array): T

          • Parameters

            • previousValue: T
            • currentValue: T
            • currentIndex: number
            • array: T[]

            Returns T

      • initialValue: T

      Returns T

    • reduce<U>(callbackfn, initialValue): U

    • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

      Type Parameters

      • U

      Parameters

      • callbackfn: ((previousValue, currentValue, currentIndex, array) => U)

        A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

        @@ -139,7 +139,7 @@ If the array is empty, undefined is returned and the array is not modified.

          • (previousValue, currentValue, currentIndex, array): T

          • Parameters

            • previousValue: T
            • currentValue: T
            • currentIndex: number
            • array: T[]

            Returns T

      Returns T

    • reduceRight(callbackfn, initialValue): T

    • Parameters

      • callbackfn: ((previousValue, currentValue, currentIndex, array) => T)
          • (previousValue, currentValue, currentIndex, array): T

          • Parameters

            • previousValue: T
            • currentValue: T
            • currentIndex: number
            • array: T[]

            Returns T

      • initialValue: T

      Returns T

    • reduceRight<U>(callbackfn, initialValue): U

    • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

      Type Parameters

      • U

      Parameters

      • callbackfn: ((previousValue, currentValue, currentIndex, array) => U)

        A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

          • (previousValue, currentValue, currentIndex, array): U

          • Parameters

            • previousValue: U
            • currentValue: T
            • currentIndex: number
            • array: T[]

            Returns U

      • initialValue: U

        If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

        -

      Returns U

    resize

    reverse

    • reverse(): T[]

    • Reverses the elements in an array in place. +

    Returns U

    resize

    reverse

    • reverse(): T[]

    • Reverses the elements in an array in place. This method mutates the array and returns a reference to the same array.

      Returns T[]

    shift

    • shift(): undefined | T

    • Removes the first element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.

      @@ -163,9 +163,9 @@ a negative value if the first argument is less than the second argument, zero if value otherwise. If omitted, the elements are sorted in ascending, ASCII character order.

      [11,2,22,1].sort((a, b) => a - b)
      -
        • (a, b): number

        • Parameters

          • a: T
          • b: T

          Returns number

    Returns CircularArray<T>

    splice

    toLocaleString

    • toLocaleString(): string

    • Returns a string representation of an array. The elements are converted to string using their toLocaleString methods.

      +
        • (a, b): number

        • Parameters

          • a: T
          • b: T

          Returns number

    Returns CircularArray<T>

    splice

    toLocaleString

    • toLocaleString(): string

    • Returns a string representation of an array. The elements are converted to string using their toLocaleString methods.

      Returns string

    toString

    • toString(): string

    • Returns a string representation of an array.

      -

      Returns string

    unshift

    • unshift(...items): number

    • Parameters

      • Rest ...items: T[]

      Returns number

      Inherit Doc

    values

    • values(): IterableIterator<T>

    • Returns an iterable of values in the array

      +

      Returns string

    unshift

    • unshift(...items): number

    • Parameters

      • Rest ...items: T[]

      Returns number

      Inherit Doc

    values

    • values(): IterableIterator<T>

    • Returns an iterable of values in the array

      Returns IterableIterator<T>

    Static from

    • from<T>(arrayLike): T[]

    • Creates an array from an array-like object.

      Type Parameters

      • T

      Parameters

      • arrayLike: ArrayLike<T>

        An array-like object to convert to an array.

      Returns T[]

    • from<T, U>(arrayLike, mapfn, thisArg?): U[]

    • Creates an array from an iterable object.

      @@ -180,4 +180,4 @@ value otherwise. If omitted, the elements are sorted in ascending, ASCII charact
        • (v, k): U

        • Parameters

          • v: T
          • k: number

          Returns U

    • Optional thisArg: any

      Value of 'this' used to invoke the mapfn.

    Returns U[]

    Static isArray

    • isArray(arg): arg is any[]

    • Parameters

      • arg: any

      Returns arg is any[]

    Static of

    • of<T>(...items): T[]

    • Returns a new array from a set of elements.

      Type Parameters

      • T

      Parameters

      • Rest ...items: T[]

        A set of elements to include in the new array object.

        -

      Returns T[]

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns T[]

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/ClusterWorker.html b/docs/classes/ClusterWorker.html index 88872243..97f72d62 100644 --- a/docs/classes/ClusterWorker.html +++ b/docs/classes/ClusterWorker.html @@ -1,4 +1,4 @@ -ClusterWorker | poolifier - v3.1.3

    Class ClusterWorker<Data, Response>

    A cluster worker used by a poolifier ClusterPool.

    +ClusterWorker | poolifier - v3.1.4

    Class ClusterWorker<Data, Response>

    A cluster worker used by a poolifier ClusterPool.

    When this worker is inactive for more than the given maxInactiveTime, it will send a termination request to its main worker.

    If you use a DynamicClusterPool the extra workers that were created will be terminated, @@ -7,7 +7,7 @@ but the minimum number of workers will be guaranteed.

    Since

    2.0.0

    Type Parameters

    • Data = unknown

      Type of data this worker receives from pool's execution. This can only be structured-cloneable data.

    • Response = unknown

      Type of response the worker sends back to the main worker. This can only be structured-cloneable data.

      -

    Hierarchy

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Properties

    activeInterval? isMain lastTaskTimestamp @@ -34,49 +34,49 @@ but the minimum number of workers will be guaranteed.

    Constructors

    constructor

    Properties

    Protected Optional activeInterval

    activeInterval?: Timeout

    Handler id of the activeInterval worker activity check.

    -

    Protected Readonly isMain

    isMain: boolean

    Whether this is the main worker or not.

    -

    Protected lastTaskTimestamp

    lastTaskTimestamp: number

    Timestamp of the last task processed by this worker.

    -

    Protected opts

    opts: WorkerOptions = DEFAULT_WORKER_OPTIONS

    Options for the worker.

    -

    Protected statistics

    statistics: WorkerStatistics

    Performance statistics computation requirements.

    -

    Protected taskFunctions

    taskFunctions: Map<string, TaskFunction<Data, Response>>

    Task function(s) processed by the worker when the pool's execution function is invoked.

    -

    Accessors

    Protected id

    Methods

    addTaskFunction

    Returns ClusterWorker<Data, Response>

    Properties

    Protected Optional activeInterval

    activeInterval?: Timeout

    Handler id of the activeInterval worker activity check.

    +

    Protected Readonly isMain

    isMain: boolean

    Whether this is the main worker or not.

    +

    Protected lastTaskTimestamp

    lastTaskTimestamp: number

    Timestamp of the last task processed by this worker.

    +

    Protected opts

    opts: WorkerOptions = DEFAULT_WORKER_OPTIONS

    Options for the worker.

    +

    Protected statistics

    statistics: WorkerStatistics

    Performance statistics computation requirements.

    +

    Protected taskFunctions

    taskFunctions: Map<string, TaskFunction<Data, Response>>

    Task function(s) processed by the worker when the pool's execution function is invoked.

    +

    Accessors

    Protected id

    Methods

    addTaskFunction

    Protected getMainWorker

    Protected getMainWorker

    Protected handleError

    Protected handleError

    • handleError(error): string

    • Handles an error and convert it to a string so it can be sent back to the main worker.

      Parameters

      • error: string | Error

        The error raised by the worker.

      Returns string

      The error message.

      -

    Protected handleKillMessage

    Protected handleReadyMessage

    Protected handleKillMessage

    Protected handleReadyMessage

    Protected handleTaskFunctionOperationMessage

    hasTaskFunction

    Returns void

    Protected handleTaskFunctionOperationMessage

    hasTaskFunction

    listTaskFunctionNames

    listTaskFunctionNames

    Protected messageListener

    Protected messageListener

    removeTaskFunction

    Returns void

    removeTaskFunction

    Protected Readonly run

    Protected Readonly run

    Protected Readonly runAsync

    • runAsync(fn, task): void

    • Runs the given task function asynchronously.

      +

    Returns void

    Protected Readonly runAsync

    Protected Readonly runSync

    • runSync(fn, task): void

    • Runs the given task function synchronously.

      +

    Returns void

    Protected Readonly runSync

    Protected sendTaskFunctionNamesToMainWorker

    Protected Readonly sendToMainWorker

    • sendToMainWorker(message): void

    • Sends a message to main worker.

      +

    Returns void

    Protected sendTaskFunctionNamesToMainWorker

    Protected Readonly sendToMainWorker

    setDefaultTaskFunction

    Returns void

    setDefaultTaskFunction

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/Deque.html b/docs/classes/Deque.html index 1b5761aa..4fe63f32 100644 --- a/docs/classes/Deque.html +++ b/docs/classes/Deque.html @@ -1,7 +1,7 @@ -Deque | poolifier - v3.1.3

    Class Deque<T>Internal

    Deque. +Deque | poolifier - v3.1.4

    Class Deque<T>Internal

    Deque. Implemented with a doubly linked list.

    Type Parameters

    • T

      Type of deque data.

      -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    head? maxSize size @@ -16,27 +16,27 @@ Implemented with a doubly linked list.

    push shift unshift -

    Constructors

    constructor

    Properties

    Private Optional head

    head?: Node<T>

    maxSize

    maxSize: number

    The maximum size of the deque.

    -

    size

    size: number

    The size of the deque.

    -

    Private Optional tail

    tail?: Node<T>

    Methods

    [iterator]

    • [iterator](): Iterator<T, any, undefined>

    • Returns an iterator for the deque.

      +

    Constructors

    constructor

    Properties

    Private Optional head

    head?: Node<T>

    maxSize

    maxSize: number

    The maximum size of the deque.

    +

    size

    size: number

    The size of the deque.

    +

    Private Optional tail

    tail?: Node<T>

    Methods

    [iterator]

    backward

    • backward(): Iterable<T>

    • Returns an backward iterator for the deque.

      +

    backward

    clear

    Private incrementSize

    peekFirst

    clear

    Private incrementSize

    peekFirst

    • peekFirst(): undefined | T

    • Peeks at the first data.

      Returns undefined | T

      The first data or undefined if the deque is empty.

      -

    peekLast

    peekLast

    • peekLast(): undefined | T

    • Peeks at the last data.

      Returns undefined | T

      The last data or undefined if the deque is empty.

      -

    pop

    pop

    • pop(): undefined | T

    • Pops data from the deque.

      Returns undefined | T

      The popped data or undefined if the deque is empty.

      -

    push

    push

    • push(data): number

    • Appends data to the deque.

      Parameters

      • data: T

        Data to append.

      Returns number

      The new size of the queue.

      -

    shift

    • shift(): undefined | T

    • Shifts data from the deque.

      +

    shift

    • shift(): undefined | T

    • Shifts data from the deque.

      Returns undefined | T

      The shifted data or undefined if the deque is empty.

      -

    unshift

    • unshift(data): number

    • Prepends data to the deque.

      +

    unshift

    • unshift(data): number

    • Prepends data to the deque.

      Parameters

      • data: T

        Data to prepend.

      Returns number

      The new size of the queue.

      -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index 6867b630..c8f6afb4 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -1,11 +1,11 @@ -DynamicClusterPool | poolifier - v3.1.3

    Class DynamicClusterPool<Data, Response>

    A cluster pool with a dynamic number of workers, but a guaranteed minimum number of workers.

    +DynamicClusterPool | poolifier - v3.1.4

    Class DynamicClusterPool<Data, Response>

    A cluster pool with a dynamic number of workers, but a guaranteed minimum number of workers.

    This cluster pool creates new workers when the others are busy, up to the maximum number of workers. When the maximum number of workers is reached and workers are busy, an event is emitted. If you want to listen to this event, use the pool's emitter.

    Author

    Christopher Quadflieg

    Since

    2.0.0

    Type Parameters

    • Data = unknown

      Type of data sent to the worker. This can only be structured-cloneable data.

    • Response = unknown

      Type of execution response. This can only be structured-cloneable data.

      -

    Hierarchy

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Properties

    emitter? filePath max @@ -60,7 +60,7 @@ When the maximum number of workers is reached and workers are busy, an event is
  • max: number

    Maximum number of workers that can be created by this pool.

  • filePath: string

    Path to an implementation of a ClusterWorker file, which can be relative or absolute.

  • opts: PoolOptions<Worker> = {}

    Options for this dynamic cluster pool.

    -

    • Returns DynamicClusterPool<Data, Response>

    Properties

    Optional emitter

    emitter?: EventEmitterAsyncResource

    Event emitter integrated with async resource on which events can be listened to. +

    Returns DynamicClusterPool<Data, Response>

    Properties

    Optional emitter

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

      @@ -72,107 +72,107 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    • 'taskError': Emitted when an error occurs while executing a task.
    • 'backPressure': Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size >= maximum queue size).
    -

    Protected Readonly filePath

    filePath: string

    Path to the worker file.

    -

    Protected Readonly max

    max: number

    Maximum number of workers that can be created by this pool.

    -

    Protected Readonly numberOfWorkers

    numberOfWorkers: number

    Number of workers that this pool should manage.

    -

    Protected Readonly opts

    opts: PoolOptions<Worker> = {}

    Options for this fixed cluster pool.

    -

    Protected promiseResponseMap

    promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...

    The task execution response promise map:

    +

    Protected Readonly filePath

    filePath: string

    Path to the worker file.

    +

    Protected Readonly max

    max: number

    Maximum number of workers that can be created by this pool.

    +

    Protected Readonly numberOfWorkers

    numberOfWorkers: number

    Number of workers that this pool should manage.

    +

    Protected Readonly opts

    opts: PoolOptions<Worker> = {}

    Options for this fixed cluster pool.

    +

    Protected promiseResponseMap

    promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...

    The task execution response promise map:

    • key: The message id of each submitted task.
    • value: An object that contains the worker, the execution response promise resolve and reject callbacks.

    When we receive a message from the worker, we get a map entry with the promise resolve/reject bound to the message id.

    -

    Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>

    Worker choice strategy context referencing a worker choice algorithm implementation.

    -

    Readonly Internal workerNodes

    workerNodes: IWorkerNode<Worker, Data>[] = []

    Pool worker nodes.

    -

    Accessors

    Protected busy

    Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>

    Worker choice strategy context referencing a worker choice algorithm implementation.

    +

    Readonly Internal workerNodes

    workerNodes: IWorkerNode<Worker, Data>[] = []

    Pool worker nodes.

    +

    Accessors

    Protected busy

    • get busy(): boolean

    • Whether the pool is busy or not.

      The pool busyness boolean status.

      -

      Returns boolean

    Protected full

    Protected full

    • get full(): boolean

    • Whether the pool is full or not.

      The pool filling boolean status.

      -

      Returns boolean

    info

    Protected maxSize

    Protected minSize

    Private ready

    Protected type

    info

    Protected maxSize

    Protected minSize

    Private ready

    Protected type

    • get type(): "fixed" | "dynamic"

    • The pool type.

      If it is 'dynamic', it provides the max property.

      -

      Returns "fixed" | "dynamic"

    Private utilization

    • get utilization(): number

    • The approximate pool utilization.

      +

      Returns "fixed" | "dynamic"

    Private utilization

    • get utilization(): number

    • The approximate pool utilization.

      Returns number

      The pool utilization.

      -

    Protected worker

    • get worker(): "thread" | "cluster"

    • The worker type.

      -

      Returns "thread" | "cluster"

    Methods

    addTaskFunction

    • addTaskFunction(name, fn): Promise<boolean>

    • Adds a task function to this pool. +

    Protected worker

    • get worker(): "thread" | "cluster"

    • The worker type.

      +

      Returns "thread" | "cluster"

    Methods

    addTaskFunction

    Protected afterTaskExecutionHook

    Protected afterTaskExecutionHook

    Protected afterWorkerNodeSetup

    • afterWorkerNodeSetup(workerNodeKey): void

    • Method hooked up after a worker node has been newly created. +

    Returns void

    Protected afterWorkerNodeSetup

    Protected beforeTaskExecutionHook

    • beforeTaskExecutionHook(workerNodeKey, task): void

    • Hook executed before the worker task execution. +

    Returns void

    Protected beforeTaskExecutionHook

    Protected createAndSetupDynamicWorkerNode

    • createAndSetupDynamicWorkerNode(): number

    • Creates a new, completely set up dynamic worker node.

      +

    Returns void

    Protected createAndSetupDynamicWorkerNode

    Protected createAndSetupWorkerNode

    Protected createAndSetupWorkerNode

    Protected deregisterWorkerMessageListener

    Protected deregisterWorkerMessageListener

    • deregisterWorkerMessageListener<Message>(workerNodeKey, listener): void

    • Deregisters a listener callback on the worker given its worker node key.

      Type Parameters

      • Message

      Parameters

      • workerNodeKey: number

        The worker node key.

      • listener: ((message) => void)

        The message listener callback.

        -
          • (message): void

          • Parameters

            Returns void

      Returns void

    destroy

    Protected destroyWorkerNode

    • destroyWorkerNode(workerNodeKey): Promise<void>

    • Terminates the worker node given its worker node key.

      +
        • (message): void

        • Parameters

          Returns void

    Returns void

    destroy

    Protected destroyWorkerNode

    enableTasksQueue

    • enableTasksQueue(enable, tasksQueueOptions?): void

    • Enables/disables the worker node tasks queue in this pool.

      +

    Returns Promise<void>

    enableTasksQueue

    execute

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

    • Executes the specified function in the worker constructor with the task data input parameter.

      +

    Returns void

    execute

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

    • Executes the specified function in the worker constructor with the task data input parameter.

      Parameters

      • Optional data: Data

        The optional task input data for the specified task function. This can only be structured-cloneable data.

      • Optional name: string

        The optional name of the task function to execute. If not specified, the default task function will be executed.

      • Optional transferList: TransferListItem[]

        An optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the chosen pool's worker_threads worker and they should not be used in the main thread afterwards.

      Returns Promise<Response>

      Promise that will be fulfilled when the task is completed.

      -

    Protected flagWorkerNodeAsNotReady

    Protected flushTasksQueue

    Protected getWorkerInfo

    Protected flagWorkerNodeAsNotReady

    Protected flushTasksQueue

    Protected getWorkerInfo

    hasTaskFunction

    hasTaskFunction

    hasWorkerNodeBackPressure

    hasWorkerNodeBackPressure

    Protected internalBusy

    Protected internalBusy

    Protected isMain

    listTaskFunctionNames

    Protected isMain

    listTaskFunctionNames

    Protected registerOnceWorkerMessageListener

    Protected registerOnceWorkerMessageListener

    • registerOnceWorkerMessageListener<Message>(workerNodeKey, listener): void

    • Registers once a listener callback on the worker given its worker node key.

      Type Parameters

      • Message

      Parameters

      • workerNodeKey: number

        The worker node key.

      • listener: ((message) => void)

        The message listener callback.

        -
          • (message): void

          • Parameters

            Returns void

      Returns void

    Protected registerWorkerMessageListener

    • registerWorkerMessageListener<Message>(workerNodeKey, listener): void

    • Registers a listener callback on the worker given its worker node key.

      +
        • (message): void

        • Parameters

          Returns void

    Returns void

    Protected registerWorkerMessageListener

    • registerWorkerMessageListener<Message>(workerNodeKey, listener): void

    • Registers a listener callback on the worker given its worker node key.

      Type Parameters

      • Message

      Parameters

      • workerNodeKey: number

        The worker node key.

      • listener: ((message) => void)

        The message listener callback.

        -
          • (message): void

          • Parameters

            Returns void

      Returns void

    removeTaskFunction

    • removeTaskFunction(name): Promise<boolean>

    • Removes a task function from this pool.

      +
        • (message): void

        • Parameters

          Returns void

    Returns void

    removeTaskFunction

    Protected sendKillMessageToWorker

    Protected sendStartupMessageToWorker

    Protected sendKillMessageToWorker

    Protected sendStartupMessageToWorker

    Protected sendToWorker

    • sendToWorker(workerNodeKey, message): void

    • Sends a message to worker given its worker node key.

      +

    Returns void

    Protected sendToWorker

    setDefaultTaskFunction

    • setDefaultTaskFunction(name): Promise<boolean>

    • Sets the default task function in this pool.

      +

    Returns void

    setDefaultTaskFunction

    setTasksQueueOptions

    setTasksQueueOptions

    setWorkerChoiceStrategy

    • setWorkerChoiceStrategy(workerChoiceStrategy, workerChoiceStrategyOptions?): void

    • Sets the worker choice strategy in this pool.

      +

    Returns void

    setWorkerChoiceStrategy

    • setWorkerChoiceStrategy(workerChoiceStrategy, workerChoiceStrategyOptions?): void

    • Sets the worker choice strategy in this pool.

      Parameters

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

        The worker choice strategy.

      • Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptions

        The worker choice strategy options.

        -

      Returns void

    setWorkerChoiceStrategyOptions

    • setWorkerChoiceStrategyOptions(workerChoiceStrategyOptions): void

    • Sets the worker choice strategy options in this pool.

      +

    Returns void

    setWorkerChoiceStrategyOptions

    Protected setupHook

    • setupHook(): void

    • Setup hook to execute code before worker nodes are created in the abstract constructor. +

    Returns void

    Protected setupHook

    start

    Protected Readonly workerMessageListener

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    start

    Protected Readonly workerMessageListener

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index e7a3c610..da75e074 100644 --- a/docs/classes/DynamicThreadPool.html +++ b/docs/classes/DynamicThreadPool.html @@ -1,11 +1,11 @@ -DynamicThreadPool | poolifier - v3.1.3

    Class DynamicThreadPool<Data, Response>

    A thread pool with a dynamic number of threads, but a guaranteed minimum number of threads.

    +DynamicThreadPool | poolifier - v3.1.4

    Class DynamicThreadPool<Data, Response>

    A thread pool with a dynamic number of threads, but a guaranteed minimum number of threads.

    This thread pool creates new threads when the others are busy, up to the maximum number of threads. When the maximum number of threads is reached and workers are busy, an event is emitted. If you want to listen to this event, use the pool's emitter.

    Author

    Alessandro Pio Ardizio

    Since

    0.0.1

    Type Parameters

    • Data = unknown

      Type of data sent to the worker. This can only be structured-cloneable data.

    • Response = unknown

      Type of execution response. This can only be structured-cloneable data.

      -

    Hierarchy

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Properties

    emitter? filePath max @@ -60,7 +60,7 @@ When the maximum number of threads is reached and workers are busy, an event is
  • max: number

    Maximum number of threads that can be created by this pool.

  • filePath: string

    Path to an implementation of a ThreadWorker file, which can be relative or absolute.

  • opts: PoolOptions<Worker> = {}

    Options for this dynamic thread pool.

    -

    • Returns DynamicThreadPool<Data, Response>

    Properties

    Optional emitter

    emitter?: EventEmitterAsyncResource

    Event emitter integrated with async resource on which events can be listened to. +

    Returns DynamicThreadPool<Data, Response>

    Properties

    Optional emitter

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

      @@ -72,108 +72,108 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    • 'taskError': Emitted when an error occurs while executing a task.
    • 'backPressure': Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size >= maximum queue size).
    -

    Protected Readonly filePath

    filePath: string

    Path to the worker file.

    -

    Protected Readonly max

    max: number

    Maximum number of threads that can be created by this pool.

    -

    Protected Readonly numberOfWorkers

    numberOfWorkers: number

    Number of workers that this pool should manage.

    -

    Protected Readonly opts

    opts: PoolOptions<Worker> = {}

    Options for this fixed thread pool.

    -

    Protected promiseResponseMap

    promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...

    The task execution response promise map:

    +

    Protected Readonly filePath

    filePath: string

    Path to the worker file.

    +

    Protected Readonly max

    max: number

    Maximum number of threads that can be created by this pool.

    +

    Protected Readonly numberOfWorkers

    numberOfWorkers: number

    Number of workers that this pool should manage.

    +

    Protected Readonly opts

    opts: PoolOptions<Worker> = {}

    Options for this fixed thread pool.

    +

    Protected promiseResponseMap

    promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...

    The task execution response promise map:

    • key: The message id of each submitted task.
    • value: An object that contains the worker, the execution response promise resolve and reject callbacks.

    When we receive a message from the worker, we get a map entry with the promise resolve/reject bound to the message id.

    -

    Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>

    Worker choice strategy context referencing a worker choice algorithm implementation.

    -

    Readonly Internal workerNodes

    workerNodes: IWorkerNode<Worker, Data>[] = []

    Pool worker nodes.

    -

    Accessors

    Protected busy

    Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>

    Worker choice strategy context referencing a worker choice algorithm implementation.

    +

    Readonly Internal workerNodes

    workerNodes: IWorkerNode<Worker, Data>[] = []

    Pool worker nodes.

    +

    Accessors

    Protected busy

    • get busy(): boolean

    • Whether the pool is busy or not.

      The pool busyness boolean status.

      -

      Returns boolean

    Protected full

    Protected full

    • get full(): boolean

    • Whether the pool is full or not.

      The pool filling boolean status.

      -

      Returns boolean

    info

    Protected maxSize

    Protected minSize

    Private ready

    Protected type

    info

    Protected maxSize

    Protected minSize

    Private ready

    Protected type

    • get type(): "fixed" | "dynamic"

    • The pool type.

      If it is 'dynamic', it provides the max property.

      -

      Returns "fixed" | "dynamic"

    Private utilization

    • get utilization(): number

    • The approximate pool utilization.

      +

      Returns "fixed" | "dynamic"

    Private utilization

    • get utilization(): number

    • The approximate pool utilization.

      Returns number

      The pool utilization.

      -

    Protected worker

    • get worker(): "thread" | "cluster"

    • The worker type.

      -

      Returns "thread" | "cluster"

    Methods

    addTaskFunction

    • addTaskFunction(name, fn): Promise<boolean>

    • Adds a task function to this pool. +

    Protected worker

    • get worker(): "thread" | "cluster"

    • The worker type.

      +

      Returns "thread" | "cluster"

    Methods

    addTaskFunction

    Protected afterTaskExecutionHook

    Protected afterTaskExecutionHook

    Protected afterWorkerNodeSetup

    • afterWorkerNodeSetup(workerNodeKey): void

    • Method hooked up after a worker node has been newly created. +

    Returns void

    Protected afterWorkerNodeSetup

    Protected beforeTaskExecutionHook

    • beforeTaskExecutionHook(workerNodeKey, task): void

    • Hook executed before the worker task execution. +

    Returns void

    Protected beforeTaskExecutionHook

    Protected createAndSetupDynamicWorkerNode

    • createAndSetupDynamicWorkerNode(): number

    • Creates a new, completely set up dynamic worker node.

      +

    Returns void

    Protected createAndSetupDynamicWorkerNode

    Protected createAndSetupWorkerNode

    Protected createAndSetupWorkerNode

    Protected deregisterWorkerMessageListener

    Protected deregisterWorkerMessageListener

    • deregisterWorkerMessageListener<Message>(workerNodeKey, listener): void

    • Deregisters a listener callback on the worker given its worker node key.

      Type Parameters

      • Message

      Parameters

      • workerNodeKey: number

        The worker node key.

      • listener: ((message) => void)

        The message listener callback.

        -
          • (message): void

          • Parameters

            Returns void

      Returns void

    destroy

    Protected destroyWorkerNode

    • destroyWorkerNode(workerNodeKey): Promise<void>

    • Terminates the worker node given its worker node key.

      +
        • (message): void

        • Parameters

          Returns void

    Returns void

    destroy

    Protected destroyWorkerNode

    enableTasksQueue

    • enableTasksQueue(enable, tasksQueueOptions?): void

    • Enables/disables the worker node tasks queue in this pool.

      +

    Returns Promise<void>

    enableTasksQueue

    execute

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

    • Executes the specified function in the worker constructor with the task data input parameter.

      +

    Returns void

    execute

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

    • Executes the specified function in the worker constructor with the task data input parameter.

      Parameters

      • Optional data: Data

        The optional task input data for the specified task function. This can only be structured-cloneable data.

      • Optional name: string

        The optional name of the task function to execute. If not specified, the default task function will be executed.

      • Optional transferList: TransferListItem[]

        An optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the chosen pool's worker_threads worker and they should not be used in the main thread afterwards.

      Returns Promise<Response>

      Promise that will be fulfilled when the task is completed.

      -

    Protected flagWorkerNodeAsNotReady

    Protected flushTasksQueue

    Protected getWorkerInfo

    Protected flagWorkerNodeAsNotReady

    Protected flushTasksQueue

    Protected getWorkerInfo

    hasTaskFunction

    hasTaskFunction

    hasWorkerNodeBackPressure

    hasWorkerNodeBackPressure

    • hasWorkerNodeBackPressure(workerNodeKey): boolean
    • Internal

      Whether the worker node has back pressure (i.e. its tasks queue is full).

      Parameters

      • workerNodeKey: number

        The worker node key.

      Returns boolean

      true if the worker node has back pressure, false otherwise.

      -

    Protected internalBusy

    Protected internalBusy

    Protected isMain

    listTaskFunctionNames

    Protected isMain

    listTaskFunctionNames

    Protected registerOnceWorkerMessageListener

    Protected registerOnceWorkerMessageListener

    • registerOnceWorkerMessageListener<Message>(workerNodeKey, listener): void

    • Registers once a listener callback on the worker given its worker node key.

      Type Parameters

      • Message

      Parameters

      • workerNodeKey: number

        The worker node key.

      • listener: ((message) => void)

        The message listener callback.

        -
          • (message): void

          • Parameters

            Returns void

      Returns void

    Protected registerWorkerMessageListener

    • registerWorkerMessageListener<Message>(workerNodeKey, listener): void

    • Registers a listener callback on the worker given its worker node key.

      +
        • (message): void

        • Parameters

          Returns void

    Returns void

    Protected registerWorkerMessageListener

    • registerWorkerMessageListener<Message>(workerNodeKey, listener): void

    • Registers a listener callback on the worker given its worker node key.

      Type Parameters

      • Message

      Parameters

      • workerNodeKey: number

        The worker node key.

      • listener: ((message) => void)

        The message listener callback.

        -
          • (message): void

          • Parameters

            Returns void

      Returns void

    removeTaskFunction

    • removeTaskFunction(name): Promise<boolean>

    • Removes a task function from this pool.

      +
        • (message): void

        • Parameters

          Returns void

    Returns void

    removeTaskFunction

    Protected sendKillMessageToWorker

    Protected sendStartupMessageToWorker

    Protected sendKillMessageToWorker

    Protected sendStartupMessageToWorker

    Protected sendToWorker

    • sendToWorker(workerNodeKey, message, transferList?): void

    • Sends a message to worker given its worker node key.

      +

    Returns void

    Protected sendToWorker

    • sendToWorker(workerNodeKey, message, transferList?): void

    • Sends a message to worker given its worker node key.

      Parameters

      • workerNodeKey: number

        The worker node key.

      • message: MessageValue<Data, unknown>

        The message.

      • Optional transferList: TransferListItem[]

        The optional array of transferable objects.

        -

      Returns void

    setDefaultTaskFunction

    • setDefaultTaskFunction(name): Promise<boolean>

    • Sets the default task function in this pool.

      +

    Returns void

    setDefaultTaskFunction

    setTasksQueueOptions

    setTasksQueueOptions

    setWorkerChoiceStrategy

    • setWorkerChoiceStrategy(workerChoiceStrategy, workerChoiceStrategyOptions?): void

    • Sets the worker choice strategy in this pool.

      +

    Returns void

    setWorkerChoiceStrategy

    • setWorkerChoiceStrategy(workerChoiceStrategy, workerChoiceStrategyOptions?): void

    • Sets the worker choice strategy in this pool.

      Parameters

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

        The worker choice strategy.

      • Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptions

        The worker choice strategy options.

        -

      Returns void

    setWorkerChoiceStrategyOptions

    • setWorkerChoiceStrategyOptions(workerChoiceStrategyOptions): void

    • Sets the worker choice strategy options in this pool.

      +

    Returns void

    setWorkerChoiceStrategyOptions

    Protected setupHook

    • setupHook(): void

    • Setup hook to execute code before worker nodes are created in the abstract constructor. +

    Returns void

    Protected setupHook

    start

    Protected Readonly workerMessageListener

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    start

    Protected Readonly workerMessageListener

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index d2b58a6b..a95229e1 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -1,9 +1,9 @@ -FixedClusterPool | poolifier - v3.1.3

    Class FixedClusterPool<Data, Response>

    A cluster pool with a fixed number of workers.

    +FixedClusterPool | poolifier - v3.1.4

    Class FixedClusterPool<Data, Response>

    A cluster pool with a fixed number of workers.

    Author

    Christopher Quadflieg

    Since

    2.0.0

    Type Parameters

    • Data = unknown

      Type of data sent to the worker. This can only be structured-cloneable data.

    • Response = unknown

      Type of execution response. This can only be structured-cloneable data.

      -

    Hierarchy

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Properties

    emitter? filePath max? @@ -57,7 +57,7 @@

    Type Parameters

    • Data = unknown

    • Response = unknown

    Parameters

    • numberOfWorkers: number

      Number of workers for this pool.

    • filePath: string

      Path to an implementation of a ClusterWorker file, which can be relative or absolute.

    • opts: PoolOptions<Worker> = {}

      Options for this fixed cluster pool.

      -

    Returns FixedClusterPool<Data, Response>

    Properties

    Optional emitter

    emitter?: EventEmitterAsyncResource

    Event emitter integrated with async resource on which events can be listened to. +

    Returns FixedClusterPool<Data, Response>

    Properties

    Optional emitter

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

      @@ -69,107 +69,107 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    • 'taskError': Emitted when an error occurs while executing a task.
    • 'backPressure': Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size >= maximum queue size).
    -

    Protected Readonly filePath

    filePath: string

    Path to the worker file.

    -

    Protected Optional Readonly max

    max?: number

    Dynamic pool maximum size property placeholder.

    -

    Protected Readonly numberOfWorkers

    numberOfWorkers: number

    Number of workers that this pool should manage.

    -

    Protected Readonly opts

    opts: PoolOptions<Worker> = {}

    Options for this fixed cluster pool.

    -

    Protected promiseResponseMap

    promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...

    The task execution response promise map:

    +

    Protected Readonly filePath

    filePath: string

    Path to the worker file.

    +

    Protected Optional Readonly max

    max?: number

    Dynamic pool maximum size property placeholder.

    +

    Protected Readonly numberOfWorkers

    numberOfWorkers: number

    Number of workers that this pool should manage.

    +

    Protected Readonly opts

    opts: PoolOptions<Worker> = {}

    Options for this fixed cluster pool.

    +

    Protected promiseResponseMap

    promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...

    The task execution response promise map:

    • key: The message id of each submitted task.
    • value: An object that contains the worker, the execution response promise resolve and reject callbacks.

    When we receive a message from the worker, we get a map entry with the promise resolve/reject bound to the message id.

    -

    Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>

    Worker choice strategy context referencing a worker choice algorithm implementation.

    -

    Readonly Internal workerNodes

    workerNodes: IWorkerNode<Worker, Data>[] = []

    Pool worker nodes.

    -

    Accessors

    Protected busy

    Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>

    Worker choice strategy context referencing a worker choice algorithm implementation.

    +

    Readonly Internal workerNodes

    workerNodes: IWorkerNode<Worker, Data>[] = []

    Pool worker nodes.

    +

    Accessors

    Protected busy

    • get busy(): boolean

    • Whether the pool is busy or not.

      The pool busyness boolean status.

      -

      Returns boolean

    Protected full

    Protected full

    • get full(): boolean

    • Whether the pool is full or not.

      The pool filling boolean status.

      -

      Returns boolean

    info

    Protected maxSize

    Protected minSize

    Private ready

    Protected type

    info

    Protected maxSize

    Protected minSize

    Private ready

    Protected type

    • get type(): "fixed" | "dynamic"

    • The pool type.

      If it is 'dynamic', it provides the max property.

      -

      Returns "fixed" | "dynamic"

    Private utilization

    • get utilization(): number

    • The approximate pool utilization.

      +

      Returns "fixed" | "dynamic"

    Private utilization

    • get utilization(): number

    • The approximate pool utilization.

      Returns number

      The pool utilization.

      -

    Protected worker

    • get worker(): "thread" | "cluster"

    • The worker type.

      -

      Returns "thread" | "cluster"

    Methods

    addTaskFunction

    • addTaskFunction(name, fn): Promise<boolean>

    • Adds a task function to this pool. +

    Protected worker

    • get worker(): "thread" | "cluster"

    • The worker type.

      +

      Returns "thread" | "cluster"

    Methods

    addTaskFunction

    Protected afterTaskExecutionHook

    Protected afterTaskExecutionHook

    Protected afterWorkerNodeSetup

    • afterWorkerNodeSetup(workerNodeKey): void

    • Method hooked up after a worker node has been newly created. +

    Returns void

    Protected afterWorkerNodeSetup

    Protected beforeTaskExecutionHook

    • beforeTaskExecutionHook(workerNodeKey, task): void

    • Hook executed before the worker task execution. +

    Returns void

    Protected beforeTaskExecutionHook

    Protected createAndSetupDynamicWorkerNode

    • createAndSetupDynamicWorkerNode(): number

    • Creates a new, completely set up dynamic worker node.

      +

    Returns void

    Protected createAndSetupDynamicWorkerNode

    Protected createAndSetupWorkerNode

    Protected createAndSetupWorkerNode

    Protected deregisterWorkerMessageListener

    Protected deregisterWorkerMessageListener

    • deregisterWorkerMessageListener<Message>(workerNodeKey, listener): void

    • Deregisters a listener callback on the worker given its worker node key.

      Type Parameters

      • Message

      Parameters

      • workerNodeKey: number

        The worker node key.

      • listener: ((message) => void)

        The message listener callback.

        -
          • (message): void

          • Parameters

            Returns void

      Returns void

    destroy

    Protected destroyWorkerNode

    • destroyWorkerNode(workerNodeKey): Promise<void>

    • Terminates the worker node given its worker node key.

      +
        • (message): void

        • Parameters

          Returns void

    Returns void

    destroy

    Protected destroyWorkerNode

    enableTasksQueue

    • enableTasksQueue(enable, tasksQueueOptions?): void

    • Enables/disables the worker node tasks queue in this pool.

      +

    Returns Promise<void>

    enableTasksQueue

    execute

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

    • Executes the specified function in the worker constructor with the task data input parameter.

      +

    Returns void

    execute

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

    • Executes the specified function in the worker constructor with the task data input parameter.

      Parameters

      • Optional data: Data

        The optional task input data for the specified task function. This can only be structured-cloneable data.

      • Optional name: string

        The optional name of the task function to execute. If not specified, the default task function will be executed.

      • Optional transferList: TransferListItem[]

        An optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the chosen pool's worker_threads worker and they should not be used in the main thread afterwards.

      Returns Promise<Response>

      Promise that will be fulfilled when the task is completed.

      -

    Protected flagWorkerNodeAsNotReady

    Protected flushTasksQueue

    Protected getWorkerInfo

    Protected flagWorkerNodeAsNotReady

    Protected flushTasksQueue

    Protected getWorkerInfo

    hasTaskFunction

    hasTaskFunction

    • hasTaskFunction(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.

      -

    hasWorkerNodeBackPressure

    hasWorkerNodeBackPressure

    • hasWorkerNodeBackPressure(workerNodeKey): boolean
    • Internal

      Whether the worker node has back pressure (i.e. its tasks queue is full).

      Parameters

      • workerNodeKey: number

        The worker node key.

      Returns boolean

      true if the worker node has back pressure, false otherwise.

      -

    Protected internalBusy

    Protected internalBusy

    Protected isMain

    listTaskFunctionNames

    Protected isMain

    listTaskFunctionNames

    Protected registerOnceWorkerMessageListener

    Protected registerOnceWorkerMessageListener

    • registerOnceWorkerMessageListener<Message>(workerNodeKey, listener): void

    • Registers once a listener callback on the worker given its worker node key.

      Type Parameters

      • Message

      Parameters

      • workerNodeKey: number

        The worker node key.

      • listener: ((message) => void)

        The message listener callback.

        -
          • (message): void

          • Parameters

            Returns void

      Returns void

    Protected registerWorkerMessageListener

    • registerWorkerMessageListener<Message>(workerNodeKey, listener): void

    • Registers a listener callback on the worker given its worker node key.

      +
        • (message): void

        • Parameters

          Returns void

    Returns void

    Protected registerWorkerMessageListener

    • registerWorkerMessageListener<Message>(workerNodeKey, listener): void

    • Registers a listener callback on the worker given its worker node key.

      Type Parameters

      • Message

      Parameters

      • workerNodeKey: number

        The worker node key.

      • listener: ((message) => void)

        The message listener callback.

        -
          • (message): void

          • Parameters

            Returns void

      Returns void

    removeTaskFunction

    • removeTaskFunction(name): Promise<boolean>

    • Removes a task function from this pool.

      +
        • (message): void

        • Parameters

          Returns void

    Returns void

    removeTaskFunction

    • removeTaskFunction(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.

      -

    Protected sendKillMessageToWorker

    Protected sendStartupMessageToWorker

    Protected sendKillMessageToWorker

    Protected sendStartupMessageToWorker

    Protected sendToWorker

    • sendToWorker(workerNodeKey, message): void

    • Sends a message to worker given its worker node key.

      +

    Returns void

    Protected sendToWorker

    setDefaultTaskFunction

    • setDefaultTaskFunction(name): Promise<boolean>

    • Sets the default task function in this pool.

      +

    Returns void

    setDefaultTaskFunction

    • setDefaultTaskFunction(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.

      -

    setTasksQueueOptions

    setTasksQueueOptions

    setWorkerChoiceStrategy

    • setWorkerChoiceStrategy(workerChoiceStrategy, workerChoiceStrategyOptions?): void

    • Sets the worker choice strategy in this pool.

      +

    Returns void

    setWorkerChoiceStrategy

    • setWorkerChoiceStrategy(workerChoiceStrategy, workerChoiceStrategyOptions?): void

    • Sets the worker choice strategy in this pool.

      Parameters

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

        The worker choice strategy.

      • Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptions

        The worker choice strategy options.

        -

      Returns void

    setWorkerChoiceStrategyOptions

    • setWorkerChoiceStrategyOptions(workerChoiceStrategyOptions): void

    • Sets the worker choice strategy options in this pool.

      +

    Returns void

    setWorkerChoiceStrategyOptions

    Protected setupHook

    • setupHook(): void

    • Setup hook to execute code before worker nodes are created in the abstract constructor. +

    Returns void

    Protected setupHook

    start

    Protected Readonly workerMessageListener

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    start

    Protected Readonly workerMessageListener

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index 3dd18858..90ccfd50 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.html @@ -1,9 +1,9 @@ -FixedThreadPool | poolifier - v3.1.3

    Class FixedThreadPool<Data, Response>

    A thread pool with a fixed number of threads.

    +FixedThreadPool | poolifier - v3.1.4

    Class FixedThreadPool<Data, Response>

    A thread pool with a fixed number of threads.

    Author

    Alessandro Pio Ardizio

    Since

    0.0.1

    Type Parameters

    • Data = unknown

      Type of data sent to the worker. This can only be structured-cloneable data.

    • Response = unknown

      Type of execution response. This can only be structured-cloneable data.

      -

    Hierarchy

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Properties

    emitter? filePath max? @@ -57,7 +57,7 @@

    Type Parameters

    • Data = unknown

    • Response = unknown

    Parameters

    • numberOfThreads: number

      Number of threads for this pool.

    • filePath: string

      Path to an implementation of a ThreadWorker file, which can be relative or absolute.

    • opts: PoolOptions<Worker> = {}

      Options for this fixed thread pool.

      -

    Returns FixedThreadPool<Data, Response>

    Properties

    Optional emitter

    emitter?: EventEmitterAsyncResource

    Event emitter integrated with async resource on which events can be listened to. +

    Returns FixedThreadPool<Data, Response>

    Properties

    Optional emitter

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

      @@ -69,108 +69,108 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    • 'taskError': Emitted when an error occurs while executing a task.
    • 'backPressure': Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size >= maximum queue size).
    -

    Protected Readonly filePath

    filePath: string

    Path to the worker file.

    -

    Protected Optional Readonly max

    max?: number

    Dynamic pool maximum size property placeholder.

    -

    Protected Readonly numberOfWorkers

    numberOfWorkers: number

    Number of workers that this pool should manage.

    -

    Protected Readonly opts

    opts: PoolOptions<Worker> = {}

    Options for this fixed thread pool.

    -

    Protected promiseResponseMap

    promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...

    The task execution response promise map:

    +

    Protected Readonly filePath

    filePath: string

    Path to the worker file.

    +

    Protected Optional Readonly max

    max?: number

    Dynamic pool maximum size property placeholder.

    +

    Protected Readonly numberOfWorkers

    numberOfWorkers: number

    Number of workers that this pool should manage.

    +

    Protected Readonly opts

    opts: PoolOptions<Worker> = {}

    Options for this fixed thread pool.

    +

    Protected promiseResponseMap

    promiseResponseMap: Map<string, PromiseResponseWrapper<Response>> = ...

    The task execution response promise map:

    • key: The message id of each submitted task.
    • value: An object that contains the worker, the execution response promise resolve and reject callbacks.

    When we receive a message from the worker, we get a map entry with the promise resolve/reject bound to the message id.

    -

    Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>

    Worker choice strategy context referencing a worker choice algorithm implementation.

    -

    Readonly Internal workerNodes

    workerNodes: IWorkerNode<Worker, Data>[] = []

    Pool worker nodes.

    -

    Accessors

    Protected busy

    Protected workerChoiceStrategyContext

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>

    Worker choice strategy context referencing a worker choice algorithm implementation.

    +

    Readonly Internal workerNodes

    workerNodes: IWorkerNode<Worker, Data>[] = []

    Pool worker nodes.

    +

    Accessors

    Protected busy

    • get busy(): boolean

    • Whether the pool is busy or not.

      The pool busyness boolean status.

      -

      Returns boolean

    Protected full

    Protected full

    • get full(): boolean

    • Whether the pool is full or not.

      The pool filling boolean status.

      -

      Returns boolean

    info

    Protected maxSize

    Protected minSize

    Private ready

    Protected type

    info

    Protected maxSize

    Protected minSize

    Private ready

    Protected type

    • get type(): "fixed" | "dynamic"

    • The pool type.

      If it is 'dynamic', it provides the max property.

      -

      Returns "fixed" | "dynamic"

    Private utilization

    • get utilization(): number

    • The approximate pool utilization.

      +

      Returns "fixed" | "dynamic"

    Private utilization

    • get utilization(): number

    • The approximate pool utilization.

      Returns number

      The pool utilization.

      -

    Protected worker

    • get worker(): "thread" | "cluster"

    • The worker type.

      -

      Returns "thread" | "cluster"

    Methods

    addTaskFunction

    • addTaskFunction(name, fn): Promise<boolean>

    • Adds a task function to this pool. +

    Protected worker

    • get worker(): "thread" | "cluster"

    • The worker type.

      +

      Returns "thread" | "cluster"

    Methods

    addTaskFunction

    Protected afterTaskExecutionHook

    Protected afterTaskExecutionHook

    Protected afterWorkerNodeSetup

    • afterWorkerNodeSetup(workerNodeKey): void

    • Method hooked up after a worker node has been newly created. +

    Returns void

    Protected afterWorkerNodeSetup

    Protected beforeTaskExecutionHook

    • beforeTaskExecutionHook(workerNodeKey, task): void

    • Hook executed before the worker task execution. +

    Returns void

    Protected beforeTaskExecutionHook

    Protected createAndSetupDynamicWorkerNode

    • createAndSetupDynamicWorkerNode(): number

    • Creates a new, completely set up dynamic worker node.

      +

    Returns void

    Protected createAndSetupDynamicWorkerNode

    Protected createAndSetupWorkerNode

    Protected createAndSetupWorkerNode

    Protected deregisterWorkerMessageListener

    Protected deregisterWorkerMessageListener

    • deregisterWorkerMessageListener<Message>(workerNodeKey, listener): void

    • Deregisters a listener callback on the worker given its worker node key.

      Type Parameters

      • Message

      Parameters

      • workerNodeKey: number

        The worker node key.

      • listener: ((message) => void)

        The message listener callback.

        -
          • (message): void

          • Parameters

            Returns void

      Returns void

    destroy

    Protected destroyWorkerNode

    • destroyWorkerNode(workerNodeKey): Promise<void>

    • Terminates the worker node given its worker node key.

      +
        • (message): void

        • Parameters

          Returns void

    Returns void

    destroy

    Protected destroyWorkerNode

    enableTasksQueue

    • enableTasksQueue(enable, tasksQueueOptions?): void

    • Enables/disables the worker node tasks queue in this pool.

      +

    Returns Promise<void>

    enableTasksQueue

    execute

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

    • Executes the specified function in the worker constructor with the task data input parameter.

      +

    Returns void

    execute

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

    • Executes the specified function in the worker constructor with the task data input parameter.

      Parameters

      • Optional data: Data

        The optional task input data for the specified task function. This can only be structured-cloneable data.

      • Optional name: string

        The optional name of the task function to execute. If not specified, the default task function will be executed.

      • Optional transferList: TransferListItem[]

        An optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the chosen pool's worker_threads worker and they should not be used in the main thread afterwards.

      Returns Promise<Response>

      Promise that will be fulfilled when the task is completed.

      -

    Protected flagWorkerNodeAsNotReady

    Protected flushTasksQueue

    Protected getWorkerInfo

    Protected flagWorkerNodeAsNotReady

    Protected flushTasksQueue

    Protected getWorkerInfo

    hasTaskFunction

    hasTaskFunction

    • hasTaskFunction(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.

      -

    hasWorkerNodeBackPressure

    hasWorkerNodeBackPressure

    • hasWorkerNodeBackPressure(workerNodeKey): boolean
    • Internal

      Whether the worker node has back pressure (i.e. its tasks queue is full).

      Parameters

      • workerNodeKey: number

        The worker node key.

      Returns boolean

      true if the worker node has back pressure, false otherwise.

      -

    Protected internalBusy

    Protected internalBusy

    Protected isMain

    listTaskFunctionNames

    Protected isMain

    listTaskFunctionNames

    Protected registerOnceWorkerMessageListener

    Protected registerOnceWorkerMessageListener

    • registerOnceWorkerMessageListener<Message>(workerNodeKey, listener): void

    • Registers once a listener callback on the worker given its worker node key.

      Type Parameters

      • Message

      Parameters

      • workerNodeKey: number

        The worker node key.

      • listener: ((message) => void)

        The message listener callback.

        -
          • (message): void

          • Parameters

            Returns void

      Returns void

    Protected registerWorkerMessageListener

    • registerWorkerMessageListener<Message>(workerNodeKey, listener): void

    • Registers a listener callback on the worker given its worker node key.

      +
        • (message): void

        • Parameters

          Returns void

    Returns void

    Protected registerWorkerMessageListener

    • registerWorkerMessageListener<Message>(workerNodeKey, listener): void

    • Registers a listener callback on the worker given its worker node key.

      Type Parameters

      • Message

      Parameters

      • workerNodeKey: number

        The worker node key.

      • listener: ((message) => void)

        The message listener callback.

        -
          • (message): void

          • Parameters

            Returns void

      Returns void

    removeTaskFunction

    • removeTaskFunction(name): Promise<boolean>

    • Removes a task function from this pool.

      +
        • (message): void

        • Parameters

          Returns void

    Returns void

    removeTaskFunction

    • removeTaskFunction(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.

      -

    Protected sendKillMessageToWorker

    Protected sendStartupMessageToWorker

    Protected sendKillMessageToWorker

    Protected sendStartupMessageToWorker

    Protected sendToWorker

    • sendToWorker(workerNodeKey, message, transferList?): void

    • Sends a message to worker given its worker node key.

      +

    Returns void

    Protected sendToWorker

    • sendToWorker(workerNodeKey, message, transferList?): void

    • Sends a message to worker given its worker node key.

      Parameters

      • workerNodeKey: number

        The worker node key.

      • message: MessageValue<Data, unknown>

        The message.

      • Optional transferList: TransferListItem[]

        The optional array of transferable objects.

        -

      Returns void

    setDefaultTaskFunction

    • setDefaultTaskFunction(name): Promise<boolean>

    • Sets the default task function in this pool.

      +

    Returns void

    setDefaultTaskFunction

    • setDefaultTaskFunction(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.

      -

    setTasksQueueOptions

    setTasksQueueOptions

    setWorkerChoiceStrategy

    • setWorkerChoiceStrategy(workerChoiceStrategy, workerChoiceStrategyOptions?): void

    • Sets the worker choice strategy in this pool.

      +

    Returns void

    setWorkerChoiceStrategy

    • setWorkerChoiceStrategy(workerChoiceStrategy, workerChoiceStrategyOptions?): void

    • Sets the worker choice strategy in this pool.

      Parameters

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

        The worker choice strategy.

      • Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptions

        The worker choice strategy options.

        -

      Returns void

    setWorkerChoiceStrategyOptions

    • setWorkerChoiceStrategyOptions(workerChoiceStrategyOptions): void

    • Sets the worker choice strategy options in this pool.

      +

    Returns void

    setWorkerChoiceStrategyOptions

    Protected setupHook

    • setupHook(): void

    • Setup hook to execute code before worker nodes are created in the abstract constructor. +

    Returns void

    Protected setupHook

    start

    Protected Readonly workerMessageListener

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    start

    Protected Readonly workerMessageListener

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/Node.html b/docs/classes/Node.html index dbc2fd0c..5d06be07 100644 --- a/docs/classes/Node.html +++ b/docs/classes/Node.html @@ -1,7 +1,7 @@ -Node | poolifier - v3.1.3

    Class Node<T>Internal

    Node.

    +Node | poolifier - v3.1.4

    Class Node<T>Internal

    Node.

    Type Parameters

    • T

      Type of node data.

      -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    data next? prev? -

    Constructors

    constructor

    Properties

    data

    data: T

    Optional next

    next?: Node<T>

    Optional prev

    prev?: Node<T>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    constructor

    Properties

    data

    data: T

    Optional next

    next?: Node<T>

    Optional prev

    prev?: Node<T>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/ThreadWorker.html b/docs/classes/ThreadWorker.html index c8b2806c..dbe82338 100644 --- a/docs/classes/ThreadWorker.html +++ b/docs/classes/ThreadWorker.html @@ -1,4 +1,4 @@ -ThreadWorker | poolifier - v3.1.3

    Class ThreadWorker<Data, Response>

    A thread worker used by a poolifier ThreadPool.

    +ThreadWorker | poolifier - v3.1.4

    Class ThreadWorker<Data, Response>

    A thread worker used by a poolifier ThreadPool.

    When this worker is inactive for more than the given maxInactiveTime, it will send a termination request to its main thread.

    If you use a DynamicThreadPool the extra workers that were created will be terminated, @@ -7,7 +7,7 @@ but the minimum number of workers will be guaranteed.

    Since

    0.0.1

    Type Parameters

    • Data = unknown

      Type of data this worker receives from pool's execution. This can only be structured-cloneable data.

    • Response = unknown

      Type of response the worker sends back to the main thread. This can only be structured-cloneable data.

      -

    Hierarchy

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Properties

    activeInterval? isMain lastTaskTimestamp @@ -35,50 +35,50 @@ but the minimum number of workers will be guaranteed.

    Constructors

    constructor

    Properties

    Protected Optional activeInterval

    activeInterval?: Timeout

    Handler id of the activeInterval worker activity check.

    -

    Protected Readonly isMain

    isMain: boolean

    Whether this is the main worker or not.

    -

    Protected lastTaskTimestamp

    lastTaskTimestamp: number

    Timestamp of the last task processed by this worker.

    -

    Protected opts

    opts: WorkerOptions = DEFAULT_WORKER_OPTIONS

    Options for the worker.

    -

    Private Optional port

    port?: MessagePort

    Message port used to communicate with the main worker.

    -

    Protected statistics

    statistics: WorkerStatistics

    Performance statistics computation requirements.

    -

    Protected taskFunctions

    taskFunctions: Map<string, TaskFunction<Data, Response>>

    Task function(s) processed by the worker when the pool's execution function is invoked.

    -

    Accessors

    Protected id

    Methods

    addTaskFunction

    Returns ThreadWorker<Data, Response>

    Properties

    Protected Optional activeInterval

    activeInterval?: Timeout

    Handler id of the activeInterval worker activity check.

    +

    Protected Readonly isMain

    isMain: boolean

    Whether this is the main worker or not.

    +

    Protected lastTaskTimestamp

    lastTaskTimestamp: number

    Timestamp of the last task processed by this worker.

    +

    Protected opts

    opts: WorkerOptions = DEFAULT_WORKER_OPTIONS

    Options for the worker.

    +

    Private Optional port

    port?: MessagePort

    Message port used to communicate with the main worker.

    +

    Protected statistics

    statistics: WorkerStatistics

    Performance statistics computation requirements.

    +

    Protected taskFunctions

    taskFunctions: Map<string, TaskFunction<Data, Response>>

    Task function(s) processed by the worker when the pool's execution function is invoked.

    +

    Accessors

    Protected id

    Methods

    addTaskFunction

    Protected getMainWorker

    Protected getMainWorker

    Protected handleError

    Protected handleError

    • handleError(error): string

    • Handles an error and convert it to a string so it can be sent back to the main worker.

      Parameters

      • error: string | Error

        The error raised by the worker.

      Returns string

      The error message.

      -

    Protected handleKillMessage

    Protected handleReadyMessage

    Protected handleKillMessage

    Protected handleReadyMessage

    Protected handleTaskFunctionOperationMessage

    hasTaskFunction

    Returns void

    Protected handleTaskFunctionOperationMessage

    hasTaskFunction

    listTaskFunctionNames

    listTaskFunctionNames

    Protected messageListener

    Protected messageListener

    removeTaskFunction

    Returns void

    removeTaskFunction

    Protected Readonly run

    Protected Readonly run

    Protected Readonly runAsync

    • runAsync(fn, task): void

    • Runs the given task function asynchronously.

      +

    Returns void

    Protected Readonly runAsync

    Protected Readonly runSync

    • runSync(fn, task): void

    • Runs the given task function synchronously.

      +

    Returns void

    Protected Readonly runSync

    Protected sendTaskFunctionNamesToMainWorker

    Protected Readonly sendToMainWorker

    • sendToMainWorker(message): void

    • Sends a message to main worker.

      +

    Returns void

    Protected sendTaskFunctionNamesToMainWorker

    Protected Readonly sendToMainWorker

    setDefaultTaskFunction

    Returns void

    setDefaultTaskFunction

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/WorkerChoiceStrategyContext.html b/docs/classes/WorkerChoiceStrategyContext.html index 26217766..b2624777 100644 --- a/docs/classes/WorkerChoiceStrategyContext.html +++ b/docs/classes/WorkerChoiceStrategyContext.html @@ -1,8 +1,8 @@ -WorkerChoiceStrategyContext | poolifier - v3.1.3

    Class WorkerChoiceStrategyContext<Worker, Data, Response>

    The worker choice strategy context.

    +WorkerChoiceStrategyContext | poolifier - v3.1.4

    Class WorkerChoiceStrategyContext<Worker, Data, Response>

    The worker choice strategy context.

    Type Parameters

    • Worker extends IWorker

      Type of worker.

    • Data = unknown

      Type of data sent to the worker. This can only be structured-cloneable data.

    • Response = unknown

      Type of execution response. This can only be structured-cloneable data.

      -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    opts workerChoiceStrategies workerChoiceStrategy @@ -17,23 +17,23 @@

    Type Parameters

    • Worker extends IWorker

    • Data = unknown

    • Response = unknown

    Parameters

    • pool: IPool<Worker, Data, Response>

      The pool instance.

    • workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN" = WorkerChoiceStrategies.ROUND_ROBIN

      The worker choice strategy.

    • opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS

      The worker choice strategy options.

      -

    Returns WorkerChoiceStrategyContext<Worker, Data, Response>

    Properties

    Private opts

    opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS

    The worker choice strategy options.

    -

    Private Readonly workerChoiceStrategies

    workerChoiceStrategies: Map<"ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN", IWorkerChoiceStrategy>

    Private workerChoiceStrategy

    workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN" = WorkerChoiceStrategies.ROUND_ROBIN

    The worker choice strategy.

    -

    Methods

    execute

    • execute(): number

    • Executes the worker choice strategy in the context algorithm.

      +

    Returns WorkerChoiceStrategyContext<Worker, Data, Response>

    Properties

    Private opts

    opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS

    The worker choice strategy options.

    +

    Private Readonly workerChoiceStrategies

    workerChoiceStrategies: Map<"ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN", IWorkerChoiceStrategy>

    Private workerChoiceStrategy

    workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN" = WorkerChoiceStrategies.ROUND_ROBIN

    The worker choice strategy.

    +

    Methods

    execute

    getStrategyPolicy

    getStrategyPolicy

    getTaskStatisticsRequirements

    getTaskStatisticsRequirements

    remove

    remove

    setOptions

    setOptions

    setWorkerChoiceStrategy

    • setWorkerChoiceStrategy(workerChoiceStrategy): void

    • Sets the worker choice strategy to use in the context.

      +

    Returns void

    setWorkerChoiceStrategy

    • setWorkerChoiceStrategy(workerChoiceStrategy): void

    • Sets the worker choice strategy to use in the context.

      Parameters

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

        The worker choice strategy to set.

        -

      Returns void

    update

    • update(workerNodeKey): boolean

    • Updates the worker node key in the worker choice strategy in the context internals.

      +

    Returns void

    update

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/availableParallelism.html b/docs/functions/availableParallelism.html index 76d39453..eb140162 100644 --- a/docs/functions/availableParallelism.html +++ b/docs/functions/availableParallelism.html @@ -1,4 +1,4 @@ -availableParallelism | poolifier - v3.1.3

    Function availableParallelism

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 8efd92bd..d464ed15 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,4 +1,4 @@ -poolifier - v3.1.3

    poolifier - v3.1.3

    Index

    Classes

    AbstractPool +poolifier - v3.1.4

    poolifier - v3.1.4

    Index

    Classes

    AbstractPool AbstractWorker CircularArray ClusterWorker @@ -61,4 +61,4 @@ WorkerChoiceStrategies WorkerTypes

    Functions

    availableParallelism -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/EventLoopUtilizationMeasurementStatistics.html b/docs/interfaces/EventLoopUtilizationMeasurementStatistics.html index 44121a20..cc41232e 100644 --- a/docs/interfaces/EventLoopUtilizationMeasurementStatistics.html +++ b/docs/interfaces/EventLoopUtilizationMeasurementStatistics.html @@ -1,5 +1,5 @@ -EventLoopUtilizationMeasurementStatistics | poolifier - v3.1.3

    Interface EventLoopUtilizationMeasurementStatisticsInternal

    Event loop utilization measurement statistics.

    -
    interface EventLoopUtilizationMeasurementStatistics {
        active: MeasurementStatistics;
        idle: MeasurementStatistics;
        utilization?: number;
    }

    Properties

    active +EventLoopUtilizationMeasurementStatistics | poolifier - v3.1.4

    Interface EventLoopUtilizationMeasurementStatisticsInternal

    Event loop utilization measurement statistics.

    +
    interface EventLoopUtilizationMeasurementStatistics {
        active: MeasurementStatistics;
        idle: MeasurementStatistics;
        utilization?: number;
    }

    Properties

    active idle utilization? -

    Properties

    Readonly active

    active: MeasurementStatistics

    Readonly idle

    idle: MeasurementStatistics

    Optional utilization

    utilization?: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Readonly active

    active: MeasurementStatistics

    Readonly idle

    idle: MeasurementStatistics

    Optional utilization

    utilization?: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 8cb2b5e1..f7a74203 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,8 +1,8 @@ -IPool | poolifier - v3.1.3

    Interface IPool<Worker, Data, Response>

    Contract definition for a poolifier pool.

    +IPool | poolifier - v3.1.4

    Interface IPool<Worker, Data, Response>

    Contract definition for a poolifier pool.

    interface IPool {
        addTaskFunction: ((name, fn) => Promise<boolean>);
        destroy: (() => Promise<void>);
        emitter?: EventEmitterAsyncResource;
        enableTasksQueue: ((enable, tasksQueueOptions?) => void);
        execute: ((data?, name?, transferList?) => Promise<Response>);
        hasTaskFunction: ((name) => boolean);
        hasWorkerNodeBackPressure: ((workerNodeKey) => boolean);
        info: PoolInfo;
        listTaskFunctionNames: (() => string[]);
        removeTaskFunction: ((name) => Promise<boolean>);
        setDefaultTaskFunction: ((name) => Promise<boolean>);
        setTasksQueueOptions: ((tasksQueueOptions) => void);
        setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void);
        setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void);
        start: (() => void);
        workerNodes: IWorkerNode<Worker, Data>[];
    }

    Type Parameters

    • Worker extends IWorker

      Type of worker which manages this pool.

    • Data = unknown

      Type of data sent to the worker. This can only be structured-cloneable data.

    • Response = unknown

      Type of execution response. This can only be structured-cloneable data.

      -

    Implemented by

    Properties

    addTaskFunction +

    Implemented by

    Properties

    addTaskFunction destroy emitter? enableTasksQueue @@ -25,8 +25,8 @@ If a task function with the same name already exists, it will be overwritten.

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

    Type declaration

      • (): Promise<void>

      • Terminates all workers in this pool.

        -

        Returns Promise<void>

    Optional Readonly emitter

    emitter?: EventEmitterAsyncResource

    Event emitter integrated with async resource on which events can be listened to. +

    Readonly destroy

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

    Type declaration

      • (): Promise<void>

      • Terminates all workers in this pool.

        +

        Returns Promise<void>

    Optional Readonly emitter

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

      @@ -38,36 +38,36 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    • 'taskError': Emitted when an error occurs while executing a task.
    • 'backPressure': Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size >= maximum queue size).
    -

    Readonly enableTasksQueue

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

    Type declaration

      • (enable, tasksQueueOptions?): void

      • Enables/disables the worker node tasks queue in this pool.

        +

    Readonly enableTasksQueue

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

    Type declaration

      • (enable, tasksQueueOptions?): void

      • Enables/disables the worker node tasks queue in this pool.

        Parameters

        • enable: boolean

          Whether to enable or disable the worker node tasks queue.

        • Optional tasksQueueOptions: TasksQueueOptions

          The worker node tasks queue options.

          -

        Returns void

    Readonly execute

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

    Type declaration

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

      • Executes the specified function in the worker constructor with the task data input parameter.

        +

    Returns void

    Readonly execute

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

    Type declaration

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

      • Executes the specified function in the worker constructor with the task data input parameter.

        Parameters

        • Optional data: Data

          The optional task input data for the specified task function. This can only be structured-cloneable data.

        • Optional name: string

          The optional name of the task function to execute. If not specified, the default task function will be executed.

        • Optional transferList: TransferListItem[]

          An optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the chosen pool's worker_threads worker and they should not be used in the main thread afterwards.

        Returns Promise<Response>

        Promise that will be fulfilled when the task is completed.

        -

    Readonly hasTaskFunction

    hasTaskFunction: ((name) => boolean)

    Type declaration

      • (name): boolean

      • Whether the specified task function exists in this pool.

        +

    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)

    Type declaration

      • (workerNodeKey): boolean
      • Internal

        Whether the worker node has back pressure (i.e. its tasks queue is full).

        +

    Readonly hasWorkerNodeBackPressure

    hasWorkerNodeBackPressure: ((workerNodeKey) => boolean)

    Type declaration

      • (workerNodeKey): boolean
      • Internal

        Whether the worker node has back pressure (i.e. its tasks queue is full).

        Parameters

        • workerNodeKey: number

          The worker node key.

        Returns boolean

        true if the worker node has back pressure, false otherwise.

        -

    Readonly info

    info: PoolInfo

    Pool information.

    -

    Readonly listTaskFunctionNames

    listTaskFunctionNames: (() => string[])

    Type declaration

      • (): string[]

      • Lists the names of task function available in this pool.

        +

    Readonly info

    info: PoolInfo

    Pool information.

    +

    Readonly listTaskFunctionNames

    listTaskFunctionNames: (() => string[])

    Type declaration

      • (): string[]

      • Lists the names of task function available in this pool.

        Returns string[]

        The names of task function available in this pool.

        -

    Readonly removeTaskFunction

    removeTaskFunction: ((name) => Promise<boolean>)

    Type declaration

      • (name): Promise<boolean>

      • Removes a task function from this pool.

        +

    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.

        +

    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)

    Type declaration

      • (tasksQueueOptions): void

      • Sets the worker node tasks queue options in this pool.

        +

    Readonly setTasksQueueOptions

    setTasksQueueOptions: ((tasksQueueOptions) => void)

    Type declaration

      • (tasksQueueOptions): void

      • Sets the worker node tasks queue options in this pool.

        Parameters

        Returns void

    Readonly setWorkerChoiceStrategy

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

    Type declaration

      • (workerChoiceStrategy, workerChoiceStrategyOptions?): void

      • Sets the worker choice strategy in this pool.

        +

    Returns void

    Readonly setWorkerChoiceStrategy

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

    Type declaration

      • (workerChoiceStrategy, workerChoiceStrategyOptions?): void

      • Sets the worker choice strategy in this pool.

        Parameters

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

          The worker choice strategy.

        • Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptions

          The worker choice strategy options.

          -

        Returns void

    Readonly setWorkerChoiceStrategyOptions

    setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)

    Type declaration

      • (workerChoiceStrategyOptions): void

      • Sets the worker choice strategy options in this pool.

        +

    Returns void

    Readonly setWorkerChoiceStrategyOptions

    setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)

    Type declaration

      • (workerChoiceStrategyOptions): void

      • Sets the worker choice strategy options in this pool.

        Parameters

        Returns void

    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>[]

    Pool worker nodes.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    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>[]

    Pool worker nodes.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/IWorker.html b/docs/interfaces/IWorker.html index f21cb5a9..8fd429c7 100644 --- a/docs/interfaces/IWorker.html +++ b/docs/interfaces/IWorker.html @@ -1,5 +1,5 @@ -IWorker | poolifier - v3.1.3

    Interface IWorker

    Worker interface.

    -
    interface IWorker {
        disconnect?: (() => void);
        id?: number;
        kill?: ((signal?) => void);
        on: ((event, handler) => void);
        once: ((event, handler) => void);
        terminate?: (() => Promise<number>);
        threadId?: number;
    }

    Properties

    disconnect? +IWorker | poolifier - v3.1.4

    Interface IWorker

    Worker interface.

    +
    interface IWorker {
        disconnect?: (() => void);
        id?: number;
        kill?: ((signal?) => void);
        on: ((event, handler) => void);
        once: ((event, handler) => void);
        terminate?: (() => Promise<number>);
        threadId?: number;
    }

    Properties

    disconnect? id? kill? on @@ -7,15 +7,15 @@ terminate? threadId?

    Properties

    Optional Readonly disconnect

    disconnect?: (() => void)

    Type declaration

      • (): void

      • Cluster worker disconnect.

        -

        Returns void

    Optional Readonly id

    id?: number

    Cluster worker id.

    -

    Optional Readonly kill

    kill?: ((signal?) => void)

    Type declaration

      • (signal?): void

      • Cluster worker kill.

        -

        Parameters

        • Optional signal: string

        Returns void

    Readonly on

    on: ((event, handler) => void)

    Type declaration

      • (event, handler): void

      • Registers an event handler.

        +

        Returns void

    Optional Readonly id

    id?: number

    Cluster worker id.

    +

    Optional Readonly kill

    kill?: ((signal?) => void)

    Type declaration

      • (signal?): void

      • Cluster worker kill.

        +

        Parameters

        • Optional signal: string

        Returns void

    Readonly on

    on: ((event, handler) => void)

    Type declaration

    Readonly once

    once: ((event, handler) => void)

    Type declaration

      • (event, handler): void

      • Registers once an event handler.

        +

    Returns void

    Readonly once

    once: ((event, handler) => void)

    Type declaration

    Optional Readonly terminate

    terminate?: (() => Promise<number>)

    Type declaration

      • (): Promise<number>

      • Stop all JavaScript execution in the worker thread as soon as possible. +

    Returns void

    Optional Readonly terminate

    terminate?: (() => Promise<number>)

    Type declaration

      • (): Promise<number>

      • Stop all JavaScript execution in the worker thread as soon as possible. Returns a Promise for the exit code that is fulfilled when the 'exit' event is emitted.

        -

        Returns Promise<number>

    Optional Readonly threadId

    threadId?: number

    Worker thread worker id.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<number>

    Optional Readonly threadId

    threadId?: number

    Worker thread worker id.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/IWorkerChoiceStrategy.html b/docs/interfaces/IWorkerChoiceStrategy.html index b07414f9..0c877744 100644 --- a/docs/interfaces/IWorkerChoiceStrategy.html +++ b/docs/interfaces/IWorkerChoiceStrategy.html @@ -1,5 +1,5 @@ -IWorkerChoiceStrategy | poolifier - v3.1.3

    Interface IWorkerChoiceStrategyInternal

    Worker choice strategy interface.

    -
    interface IWorkerChoiceStrategy {
        choose: (() => undefined | number);
        hasPoolWorkerNodesReady: (() => boolean);
        remove: ((workerNodeKey) => boolean);
        reset: (() => boolean);
        setOptions: ((opts) => void);
        strategyPolicy: StrategyPolicy;
        taskStatisticsRequirements: TaskStatisticsRequirements;
        update: ((workerNodeKey) => boolean);
    }

    Properties

    choose +IWorkerChoiceStrategy | poolifier - v3.1.4

    Interface IWorkerChoiceStrategyInternal

    Worker choice strategy interface.

    +
    interface IWorkerChoiceStrategy {
        choose: (() => undefined | number);
        hasPoolWorkerNodesReady: (() => boolean);
        remove: ((workerNodeKey) => boolean);
        reset: (() => boolean);
        setOptions: ((opts) => void);
        strategyPolicy: StrategyPolicy;
        taskStatisticsRequirements: TaskStatisticsRequirements;
        update: ((workerNodeKey) => boolean);
    }

    Properties

    choose hasPoolWorkerNodesReady remove reset @@ -11,18 +11,18 @@ If no worker nodes are not eligible, undefined is returned. If undefined is returned, the caller retry.

    Returns undefined | number

    The worker node key or undefined.

    -

    Readonly hasPoolWorkerNodesReady

    hasPoolWorkerNodesReady: (() => boolean)

    Type declaration

      • (): boolean

      • Whether the pool has worker nodes ready or not.

        +

    Readonly hasPoolWorkerNodesReady

    hasPoolWorkerNodesReady: (() => boolean)

    Type declaration

      • (): boolean

      • Whether the pool has worker nodes ready or not.

        Returns boolean

        Whether the pool has worker nodes ready or not.

        -

    Readonly remove

    remove: ((workerNodeKey) => boolean)

    Type declaration

      • (workerNodeKey): boolean

      • Removes the worker node key from strategy internals.

        +

    Readonly remove

    remove: ((workerNodeKey) => boolean)

    Type declaration

      • (workerNodeKey): boolean

      • Removes the worker node key from strategy internals.

        Parameters

        • workerNodeKey: number

          The worker node key.

        Returns boolean

        true if the worker node key is removed, false otherwise.

        -

    Readonly reset

    reset: (() => boolean)

    Type declaration

      • (): boolean

      • Resets strategy internals.

        +

    Readonly reset

    reset: (() => boolean)

    Type declaration

      • (): boolean

      • Resets strategy internals.

        Returns boolean

        true if the reset is successful, false otherwise.

        -

    Readonly setOptions

    setOptions: ((opts) => void)

    Type declaration

      • (opts): void

      • Sets the worker choice strategy options.

        +

    Readonly setOptions

    setOptions: ((opts) => void)

    Type declaration

      • (opts): void

      • Sets the worker choice strategy options.

        Parameters

        Returns void

    Readonly strategyPolicy

    strategyPolicy: StrategyPolicy

    Strategy policy.

    -

    Readonly taskStatisticsRequirements

    taskStatisticsRequirements: TaskStatisticsRequirements

    Tasks statistics requirements.

    -

    Readonly update

    update: ((workerNodeKey) => boolean)

    Type declaration

      • (workerNodeKey): boolean

      • Updates the worker node key strategy internals. +

    Returns void

    Readonly strategyPolicy

    strategyPolicy: StrategyPolicy

    Strategy policy.

    +

    Readonly taskStatisticsRequirements

    taskStatisticsRequirements: TaskStatisticsRequirements

    Tasks statistics requirements.

    +

    Readonly update

    update: ((workerNodeKey) => boolean)

    Type declaration

      • (workerNodeKey): boolean

      • Updates the worker node key strategy internals. This is called after a task has been executed on a worker node.

        Parameters

        • workerNodeKey: number

        Returns boolean

        true if the update is successful, false otherwise.

        -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/IWorkerNode.html b/docs/interfaces/IWorkerNode.html index 48696214..58a8c125 100644 --- a/docs/interfaces/IWorkerNode.html +++ b/docs/interfaces/IWorkerNode.html @@ -1,7 +1,7 @@ -IWorkerNode | poolifier - v3.1.3

    Interface IWorkerNode<Worker, Data>Internal

    Worker node interface.

    +IWorkerNode | poolifier - v3.1.4

    Interface IWorkerNode<Worker, Data>Internal

    Worker node interface.

    interface IWorkerNode {
        clearTasksQueue: (() => void);
        deleteTaskFunctionWorkerUsage: ((name) => boolean);
        dequeueTask: (() => undefined | Task<Data>);
        enqueueTask: ((task) => number);
        getTaskFunctionWorkerUsage: ((name) => undefined | WorkerUsage);
        hasBackPressure: (() => boolean);
        info: WorkerInfo;
        messageChannel?: MessageChannel;
        popTask: (() => undefined | Task<Data>);
        registerOnceWorkerEventHandler: ((event, handler) => void);
        registerWorkerEventHandler: ((event, handler) => void);
        resetUsage: (() => void);
        strategyData?: StrategyData;
        tasksQueueBackPressureSize: number;
        tasksQueueSize: (() => number);
        terminate: (() => Promise<void>);
        unshiftTask: ((task) => number);
        usage: WorkerUsage;
        worker: Worker;
        [captureRejectionSymbol]?(error, event, ...args): void;
        addListener(eventName, listener): IWorkerNode<Worker, Data>;
        emit(eventName, ...args): boolean;
        eventNames(): (string | symbol)[];
        getMaxListeners(): number;
        listenerCount(eventName, listener?): number;
        listeners(eventName): Function[];
        off(eventName, listener): IWorkerNode<Worker, Data>;
        on(eventName, listener): IWorkerNode<Worker, Data>;
        once(eventName, listener): IWorkerNode<Worker, Data>;
        prependListener(eventName, listener): IWorkerNode<Worker, Data>;
        prependOnceListener(eventName, listener): IWorkerNode<Worker, Data>;
        rawListeners(eventName): Function[];
        removeAllListeners(event?): IWorkerNode<Worker, Data>;
        removeListener(eventName, listener): IWorkerNode<Worker, Data>;
        setMaxListeners(n): IWorkerNode<Worker, Data>;
    }

    Type Parameters

    • Worker extends IWorker

      Type of worker.

    • Data = unknown

      Type of data sent to the worker. This can only be structured-cloneable data.

      -

    Hierarchy

    • EventEmitter
      • IWorkerNode

    Properties

    clearTasksQueue +

    Hierarchy

    • EventEmitter
      • IWorkerNode

    Properties

    clearTasksQueue deleteTaskFunctionWorkerUsage dequeueTask enqueueTask @@ -37,43 +37,43 @@ removeListener setMaxListeners

    Properties

    Readonly clearTasksQueue

    clearTasksQueue: (() => void)

    Type declaration

      • (): void

      • Clears tasks queue.

        -

        Returns void

    Readonly deleteTaskFunctionWorkerUsage

    deleteTaskFunctionWorkerUsage: ((name) => boolean)

    Type declaration

      • (name): boolean

      • Deletes task function worker usage statistics.

        +

        Returns void

    Readonly deleteTaskFunctionWorkerUsage

    deleteTaskFunctionWorkerUsage: ((name) => boolean)

    Type declaration

      • (name): boolean

      • Deletes task function worker usage statistics.

        Parameters

        • name: string

          The task function name.

        Returns boolean

        true if the task function worker usage statistics were deleted, false otherwise.

        -

    Readonly dequeueTask

    dequeueTask: (() => undefined | Task<Data>)

    Type declaration

      • (): undefined | Task<Data>

      • Dequeue task.

        +

    Readonly dequeueTask

    dequeueTask: (() => undefined | Task<Data>)

    Type declaration

      • (): undefined | Task<Data>

      • Dequeue task.

        Returns undefined | Task<Data>

        The dequeued task.

        -

    Readonly enqueueTask

    enqueueTask: ((task) => number)

    Type declaration

      • (task): number

      • Enqueue task.

        +

    Readonly enqueueTask

    enqueueTask: ((task) => number)

    Type declaration

      • (task): number

      • Enqueue task.

        Parameters

        • task: Task<Data>

          The task to queue.

        Returns number

        The tasks queue size.

        -

    Readonly getTaskFunctionWorkerUsage

    getTaskFunctionWorkerUsage: ((name) => undefined | WorkerUsage)

    Type declaration

      • (name): undefined | WorkerUsage

      • Gets task function worker usage statistics.

        +

    Readonly getTaskFunctionWorkerUsage

    getTaskFunctionWorkerUsage: ((name) => undefined | WorkerUsage)

    Type declaration

      • (name): undefined | WorkerUsage

      • Gets task function worker usage statistics.

        Parameters

        • name: string

          The task function name.

        Returns undefined | WorkerUsage

        The task function worker usage statistics if the task function worker usage statistics are initialized, undefined otherwise.

        -

    Readonly hasBackPressure

    hasBackPressure: (() => boolean)

    Type declaration

      • (): boolean

      • Whether the worker node has back pressure (i.e. its tasks queue is full).

        +

    Readonly hasBackPressure

    hasBackPressure: (() => boolean)

    Type declaration

      • (): boolean

      • Whether the worker node has back pressure (i.e. its tasks queue is full).

        Returns boolean

        true if the worker node has back pressure, false otherwise.

        -

    Readonly info

    info: WorkerInfo

    Worker info.

    -

    Optional Readonly messageChannel

    messageChannel?: MessageChannel

    Message channel (worker thread only).

    -

    Readonly popTask

    popTask: (() => undefined | Task<Data>)

    Type declaration

      • (): undefined | Task<Data>

      • Pops a task from the tasks queue.

        +

    Readonly info

    info: WorkerInfo

    Worker info.

    +

    Optional Readonly messageChannel

    messageChannel?: MessageChannel

    Message channel (worker thread only).

    +

    Readonly popTask

    popTask: (() => undefined | Task<Data>)

    Type declaration

      • (): undefined | Task<Data>

      • Pops a task from the tasks queue.

        Returns undefined | Task<Data>

        The popped task.

        -

    Readonly registerOnceWorkerEventHandler

    registerOnceWorkerEventHandler: ((event, handler) => void)

    Type declaration

      • (event, handler): void

      • Registers once a worker event handler.

        +

    Readonly registerOnceWorkerEventHandler

    registerOnceWorkerEventHandler: ((event, handler) => void)

    Type declaration

    Readonly registerWorkerEventHandler

    registerWorkerEventHandler: ((event, handler) => void)

    Type declaration

      • (event, handler): void

      • Registers a worker event handler.

        +

    Returns void

    Readonly registerWorkerEventHandler

    registerWorkerEventHandler: ((event, handler) => void)

    Type declaration

    Readonly resetUsage

    resetUsage: (() => void)

    Type declaration

      • (): void

      • Resets usage statistics.

        -

        Returns void

    Optional strategyData

    strategyData?: StrategyData

    Worker choice strategy data. +

    Returns void

    Readonly resetUsage

    resetUsage: (() => void)

    Type declaration

      • (): void

      • Resets usage statistics.

        +

        Returns void

    Optional strategyData

    strategyData?: StrategyData

    Worker choice strategy data. This is used to store data that are specific to the worker choice strategy.

    -

    tasksQueueBackPressureSize

    tasksQueueBackPressureSize: number

    Tasks queue back pressure size. +

    tasksQueueBackPressureSize

    tasksQueueBackPressureSize: number

    Tasks queue back pressure size. This is the number of tasks that can be enqueued before the worker node has back pressure.

    -

    Readonly tasksQueueSize

    tasksQueueSize: (() => number)

    Type declaration

    Readonly tasksQueueSize

    tasksQueueSize: (() => number)

    Type declaration

      • (): number

      • Tasks queue size.

        Returns number

        The tasks queue size.

        -

    Readonly terminate

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

    Type declaration

      • (): Promise<void>

      • Terminates the worker node.

        -

        Returns Promise<void>

    Readonly unshiftTask

    unshiftTask: ((task) => number)

    Type declaration

      • (task): number

      • Prepends a task to the tasks queue.

        +

    Readonly terminate

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

    Type declaration

      • (): Promise<void>

      • Terminates the worker node.

        +

        Returns Promise<void>

    Readonly unshiftTask

    unshiftTask: ((task) => number)

    Type declaration

      • (task): number

      • Prepends a task to the tasks queue.

        Parameters

        • task: Task<Data>

          The task to prepend.

        Returns number

        The tasks queue size.

        -

    Readonly usage

    usage: WorkerUsage

    Worker usage statistics.

    -

    Readonly worker

    worker: Worker

    Worker.

    -

    Methods

    Optional [captureRejectionSymbol]

    • [captureRejectionSymbol](error, event, ...args): void

    • Parameters

      • error: Error
      • event: string
      • Rest ...args: any[]

      Returns void

    addListener

    • addListener(eventName, listener): IWorkerNode<Worker, Data>

    • Alias for emitter.on(eventName, listener).

      +

    Readonly usage

    usage: WorkerUsage

    Worker usage statistics.

    +

    Readonly worker

    worker: Worker

    Worker.

    +

    Methods

    Optional [captureRejectionSymbol]

    • [captureRejectionSymbol](error, event, ...args): void

    • Parameters

      • error: Error
      • event: string
      • Rest ...args: any[]

      Returns void

    addListener

    • addListener(eventName, listener): IWorkerNode<Worker, Data>

    • Alias for emitter.on(eventName, listener).

      Parameters

      • eventName: string | symbol
      • listener: ((...args) => void)
          • (...args): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns IWorkerNode<Worker, Data>

      Since

      v0.1.26

    emit

    • emit(eventName, ...args): boolean

    • Synchronously calls each of the listeners registered for the event namedeventName, in the order they were registered, passing the supplied arguments to each.

      @@ -186,4 +186,4 @@ memory leaks. The emitter.setMaxListeners() method allows the limit modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.

      Returns a reference to the EventEmitter, so that calls can be chained.

      Parameters

      • n: number

      Returns IWorkerNode<Worker, Data>

      Since

      v0.3.5

      -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/MeasurementOptions.html b/docs/interfaces/MeasurementOptions.html index 0727a228..c6e6e4b3 100644 --- a/docs/interfaces/MeasurementOptions.html +++ b/docs/interfaces/MeasurementOptions.html @@ -1,4 +1,4 @@ -MeasurementOptions | poolifier - v3.1.3

    Interface MeasurementOptions

    Measurement options.

    -
    interface MeasurementOptions {
        median: boolean;
    }

    Properties

    median +MeasurementOptions | poolifier - v3.1.4

    Interface MeasurementOptions

    Measurement options.

    +
    interface MeasurementOptions {
        median: boolean;
    }

    Properties

    median

    Properties

    Readonly median

    median: boolean

    Set measurement median.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/MeasurementStatistics.html b/docs/interfaces/MeasurementStatistics.html index 9e03269b..02f37ed1 100644 --- a/docs/interfaces/MeasurementStatistics.html +++ b/docs/interfaces/MeasurementStatistics.html @@ -1,14 +1,14 @@ -MeasurementStatistics | poolifier - v3.1.3

    Interface MeasurementStatisticsInternal

    Measurement statistics.

    -
    interface MeasurementStatistics {
        aggregate?: number;
        average?: number;
        history: CircularArray<number>;
        maximum?: number;
        median?: number;
        minimum?: number;
    }

    Properties

    aggregate? +MeasurementStatistics | poolifier - v3.1.4

    Interface MeasurementStatisticsInternal

    Measurement statistics.

    +
    interface MeasurementStatistics {
        aggregate?: number;
        average?: number;
        history: CircularArray<number>;
        maximum?: number;
        median?: number;
        minimum?: number;
    }

    Properties

    aggregate? average? history maximum? median? minimum?

    Properties

    Optional aggregate

    aggregate?: number

    Measurement aggregate.

    -

    Optional average

    average?: number

    Measurement average.

    -

    Readonly history

    history: CircularArray<number>

    Measurement history.

    -

    Optional maximum

    maximum?: number

    Measurement maximum.

    -

    Optional median

    median?: number

    Measurement median.

    -

    Optional minimum

    minimum?: number

    Measurement minimum.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Optional average

    average?: number

    Measurement average.

    +

    Readonly history

    history: CircularArray<number>

    Measurement history.

    +

    Optional maximum

    maximum?: number

    Measurement maximum.

    +

    Optional median

    median?: number

    Measurement median.

    +

    Optional minimum

    minimum?: number

    Measurement minimum.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/MeasurementStatisticsRequirements.html b/docs/interfaces/MeasurementStatisticsRequirements.html index aecf1703..eae84edc 100644 --- a/docs/interfaces/MeasurementStatisticsRequirements.html +++ b/docs/interfaces/MeasurementStatisticsRequirements.html @@ -1,8 +1,8 @@ -MeasurementStatisticsRequirements | poolifier - v3.1.3

    Interface MeasurementStatisticsRequirementsInternal

    Measurement statistics requirements.

    -
    interface MeasurementStatisticsRequirements {
        aggregate: boolean;
        average: boolean;
        median: boolean;
    }

    Properties

    aggregate +MeasurementStatisticsRequirements | poolifier - v3.1.4

    Interface MeasurementStatisticsRequirementsInternal

    Measurement statistics requirements.

    +
    interface MeasurementStatisticsRequirements {
        aggregate: boolean;
        average: boolean;
        median: boolean;
    }

    Properties

    aggregate average median

    Properties

    aggregate

    aggregate: boolean

    Requires measurement aggregate.

    -

    average

    average: boolean

    Requires measurement average.

    -

    median

    median: boolean

    Requires measurement median.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    average

    average: boolean

    Requires measurement average.

    +

    median

    median: boolean

    Requires measurement median.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/MessageValue.html b/docs/interfaces/MessageValue.html index 49299a69..21a22d0a 100644 --- a/docs/interfaces/MessageValue.html +++ b/docs/interfaces/MessageValue.html @@ -1,7 +1,7 @@ -MessageValue | poolifier - v3.1.3

    Interface MessageValue<Data, ErrorData>Internal

    Message object that is passed between main worker and worker.

    +MessageValue | poolifier - v3.1.4

    Interface MessageValue<Data, ErrorData>Internal

    Message object that is passed between main worker and worker.

    interface MessageValue {
        checkActive?: boolean;
        data?: Data;
        kill?: true | "success" | "SOFT" | "HARD" | "failure";
        name?: string;
        port?: MessagePort;
        ready?: boolean;
        statistics?: WorkerStatistics;
        taskFunction?: string;
        taskFunctionName?: string;
        taskFunctionNames?: string[];
        taskFunctionOperation?: "add" | "default" | "remove";
        taskFunctionOperationStatus?: boolean;
        taskId?: string;
        taskPerformance?: TaskPerformance;
        timestamp?: number;
        transferList?: TransferListItem[];
        workerError?: WorkerError<ErrorData>;
        workerId?: number;
    }

    Type Parameters

    • Data = unknown

      Type of data sent to the worker or execution response. This can only be structured-cloneable data.

    • ErrorData = unknown

      Type of data sent to the worker triggering an error. This can only be structured-cloneable data.

      -

    Hierarchy

    • Task<Data>
      • MessageValue

    Properties

    checkActive? +

    Hierarchy

    • Task<Data>
      • MessageValue

    Properties

    checkActive? data? kill? name? @@ -20,26 +20,26 @@ workerError? workerId?

    Properties

    Optional Readonly checkActive

    checkActive?: boolean

    Whether the worker starts or stops its activity check.

    -

    Optional Readonly data

    data?: Data

    Task input data that will be passed to the worker.

    -

    Optional Readonly kill

    kill?: true | "success" | "SOFT" | "HARD" | "failure"

    Kill code.

    -

    Optional Readonly name

    name?: string

    Task name.

    -

    Optional Readonly port

    port?: MessagePort

    Message port.

    -

    Optional Readonly ready

    ready?: boolean

    Whether the worker is ready or not.

    -

    Optional Readonly statistics

    statistics?: WorkerStatistics

    Whether the worker computes the given statistics or not.

    -

    Optional Readonly taskFunction

    taskFunction?: string

    Task function serialized to string.

    -

    Optional Readonly taskFunctionName

    taskFunctionName?: string

    Task function name.

    -

    Optional Readonly taskFunctionNames

    taskFunctionNames?: string[]

    Task function names.

    -

    Optional Readonly taskFunctionOperation

    taskFunctionOperation?: "add" | "default" | "remove"

    Task function operation:

    +

    Optional Readonly data

    data?: Data

    Task input data that will be passed to the worker.

    +

    Optional Readonly kill

    kill?: true | "success" | "SOFT" | "HARD" | "failure"

    Kill code.

    +

    Optional Readonly name

    name?: string

    Task name.

    +

    Optional Readonly port

    port?: MessagePort

    Message port.

    +

    Optional Readonly ready

    ready?: boolean

    Whether the worker is ready or not.

    +

    Optional Readonly statistics

    statistics?: WorkerStatistics

    Whether the worker computes the given statistics or not.

    +

    Optional Readonly taskFunction

    taskFunction?: string

    Task function serialized to string.

    +

    Optional Readonly taskFunctionName

    taskFunctionName?: string

    Task function name.

    +

    Optional Readonly taskFunctionNames

    taskFunctionNames?: string[]

    Task function names.

    +

    Optional Readonly taskFunctionOperation

    taskFunctionOperation?: "add" | "default" | "remove"

    Task function operation:

    • 'add' - Add a task function.
    • 'remove' - Remove a task function.
    • 'default' - Set a task function as default.
    -

    Optional Readonly taskFunctionOperationStatus

    taskFunctionOperationStatus?: boolean

    Whether the task function operation is successful or not.

    -

    Optional Readonly taskId

    taskId?: string

    Task UUID.

    -

    Optional Readonly taskPerformance

    taskPerformance?: TaskPerformance

    Task performance.

    -

    Optional Readonly timestamp

    timestamp?: number

    Timestamp.

    -

    Optional Readonly transferList

    transferList?: TransferListItem[]

    Array of transferable objects.

    -

    Optional Readonly workerError

    workerError?: WorkerError<ErrorData>

    Worker error.

    -

    Optional Readonly workerId

    workerId?: number

    Worker id.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Optional Readonly taskFunctionOperationStatus

    taskFunctionOperationStatus?: boolean

    Whether the task function operation is successful or not.

    +

    Optional Readonly taskId

    taskId?: string

    Task UUID.

    +

    Optional Readonly taskPerformance

    taskPerformance?: TaskPerformance

    Task performance.

    +

    Optional Readonly timestamp

    timestamp?: number

    Timestamp.

    +

    Optional Readonly transferList

    transferList?: TransferListItem[]

    Array of transferable objects.

    +

    Optional Readonly workerError

    workerError?: WorkerError<ErrorData>

    Worker error.

    +

    Optional Readonly workerId

    workerId?: number

    Worker id.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/PoolInfo.html b/docs/interfaces/PoolInfo.html index a9dc4d5d..410b9ac7 100644 --- a/docs/interfaces/PoolInfo.html +++ b/docs/interfaces/PoolInfo.html @@ -1,5 +1,5 @@ -PoolInfo | poolifier - v3.1.3

    Interface PoolInfo

    Pool information.

    -
    interface PoolInfo {
        backPressure?: boolean;
        busyWorkerNodes: number;
        executedTasks: number;
        executingTasks: number;
        failedTasks: number;
        idleWorkerNodes: number;
        maxQueuedTasks?: number;
        maxSize: number;
        minSize: number;
        queuedTasks?: number;
        ready: boolean;
        runTime?: {
            average?: number;
            maximum: number;
            median?: number;
            minimum: number;
        };
        started: boolean;
        stolenTasks?: number;
        strategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN";
        type: "fixed" | "dynamic";
        utilization?: number;
        version: string;
        waitTime?: {
            average?: number;
            maximum: number;
            median?: number;
            minimum: number;
        };
        worker: "thread" | "cluster";
        workerNodes: number;
    }

    Properties

    backPressure? +PoolInfo | poolifier - v3.1.4

    Interface PoolInfo

    Pool information.

    +
    interface PoolInfo {
        backPressure?: boolean;
        busyWorkerNodes: number;
        executedTasks: number;
        executingTasks: number;
        failedTasks: number;
        idleWorkerNodes: number;
        maxQueuedTasks?: number;
        maxSize: number;
        minSize: number;
        queuedTasks?: number;
        ready: boolean;
        runTime?: {
            average?: number;
            maximum: number;
            median?: number;
            minimum: number;
        };
        started: boolean;
        stolenTasks?: number;
        strategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN";
        type: "fixed" | "dynamic";
        utilization?: number;
        version: string;
        waitTime?: {
            average?: number;
            maximum: number;
            median?: number;
            minimum: number;
        };
        worker: "thread" | "cluster";
        workerNodes: number;
    }

    Properties

    backPressure? busyWorkerNodes executedTasks executingTasks @@ -20,8 +20,8 @@ waitTime? worker workerNodes -

    Properties

    Optional Readonly backPressure

    backPressure?: boolean

    Readonly busyWorkerNodes

    busyWorkerNodes: number

    Pool busy worker nodes.

    -

    Readonly executedTasks

    executedTasks: number

    Readonly executingTasks

    executingTasks: number

    Readonly failedTasks

    failedTasks: number

    Readonly idleWorkerNodes

    idleWorkerNodes: number

    Pool idle worker nodes.

    -

    Optional Readonly maxQueuedTasks

    maxQueuedTasks?: number

    Readonly maxSize

    maxSize: number

    Readonly minSize

    minSize: number

    Optional Readonly queuedTasks

    queuedTasks?: number

    Readonly ready

    ready: boolean

    Optional Readonly runTime

    runTime?: {
        average?: number;
        maximum: number;
        median?: number;
        minimum: number;
    }

    Type declaration

    • Optional Readonly average?: number
    • Readonly maximum: number
    • Optional Readonly median?: number
    • Readonly minimum: number

    Readonly started

    started: boolean

    Optional Readonly stolenTasks

    stolenTasks?: number

    Readonly strategy

    strategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"

    Readonly type

    type: "fixed" | "dynamic"

    Optional Readonly utilization

    utilization?: number

    Pool utilization.

    -

    Readonly version

    version: string

    Optional Readonly waitTime

    waitTime?: {
        average?: number;
        maximum: number;
        median?: number;
        minimum: number;
    }

    Type declaration

    • Optional Readonly average?: number
    • Readonly maximum: number
    • Optional Readonly median?: number
    • Readonly minimum: number

    Readonly worker

    worker: "thread" | "cluster"

    Readonly workerNodes

    workerNodes: number

    Pool total worker nodes.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional Readonly backPressure

    backPressure?: boolean

    Readonly busyWorkerNodes

    busyWorkerNodes: number

    Pool busy worker nodes.

    +

    Readonly executedTasks

    executedTasks: number

    Readonly executingTasks

    executingTasks: number

    Readonly failedTasks

    failedTasks: number

    Readonly idleWorkerNodes

    idleWorkerNodes: number

    Pool idle worker nodes.

    +

    Optional Readonly maxQueuedTasks

    maxQueuedTasks?: number

    Readonly maxSize

    maxSize: number

    Readonly minSize

    minSize: number

    Optional Readonly queuedTasks

    queuedTasks?: number

    Readonly ready

    ready: boolean

    Optional Readonly runTime

    runTime?: {
        average?: number;
        maximum: number;
        median?: number;
        minimum: number;
    }

    Type declaration

    • Optional Readonly average?: number
    • Readonly maximum: number
    • Optional Readonly median?: number
    • Readonly minimum: number

    Readonly started

    started: boolean

    Optional Readonly stolenTasks

    stolenTasks?: number

    Readonly strategy

    strategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"

    Readonly type

    type: "fixed" | "dynamic"

    Optional Readonly utilization

    utilization?: number

    Pool utilization.

    +

    Readonly version

    version: string

    Optional Readonly waitTime

    waitTime?: {
        average?: number;
        maximum: number;
        median?: number;
        minimum: number;
    }

    Type declaration

    • Optional Readonly average?: number
    • Readonly maximum: number
    • Optional Readonly median?: number
    • Readonly minimum: number

    Readonly worker

    worker: "thread" | "cluster"

    Readonly workerNodes

    workerNodes: number

    Pool total worker nodes.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/PoolOptions.html b/docs/interfaces/PoolOptions.html index 1ddb5bd8..487a8601 100644 --- a/docs/interfaces/PoolOptions.html +++ b/docs/interfaces/PoolOptions.html @@ -1,6 +1,6 @@ -PoolOptions | poolifier - v3.1.3

    Interface PoolOptions<Worker>

    Options for a poolifier pool.

    +PoolOptions | poolifier - v3.1.4

    Interface PoolOptions<Worker>

    Options for a poolifier pool.

    interface PoolOptions {
        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? +

    Properties

    enableEvents? enableTasksQueue? env? errorHandler? @@ -17,30 +17,30 @@

    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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/PromiseResponseWrapper.html b/docs/interfaces/PromiseResponseWrapper.html index 85aa8bbb..3d3ca050 100644 --- a/docs/interfaces/PromiseResponseWrapper.html +++ b/docs/interfaces/PromiseResponseWrapper.html @@ -1,11 +1,11 @@ -PromiseResponseWrapper | poolifier - v3.1.3

    Interface PromiseResponseWrapper<Response>Internal

    An object holding the task execution response promise resolve/reject callbacks.

    +PromiseResponseWrapper | poolifier - v3.1.4

    Interface PromiseResponseWrapper<Response>Internal

    An object holding the task execution response promise resolve/reject callbacks.

    interface PromiseResponseWrapper {
        asyncResource?: AsyncResource;
        reject: ((reason?) => void);
        resolve: ((value) => void);
        workerNodeKey: number;
    }

    Type Parameters

    • Response = unknown

      Type of execution response. This can only be structured-cloneable data.

      -

    Properties

    asyncResource? +

    Properties

    asyncResource? reject resolve workerNodeKey

    Properties

    Optional Readonly asyncResource

    asyncResource?: AsyncResource

    The asynchronous resource used to track the task execution.

    -

    Readonly reject

    reject: ((reason?) => void)

    Type declaration

      • (reason?): void

      • Reject callback to reject the promise.

        -

        Parameters

        • Optional reason: unknown

        Returns void

    Readonly resolve

    resolve: ((value) => void)

    Type declaration

      • (value): void

      • Resolve callback to fulfill the promise.

        -

        Parameters

        • value: Response | PromiseLike<Response>

        Returns void

    Readonly workerNodeKey

    workerNodeKey: number

    The worker node key executing the task.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Readonly reject

    reject: ((reason?) => void)

    Type declaration

      • (reason?): void

      • Reject callback to reject the promise.

        +

        Parameters

        • Optional reason: unknown

        Returns void

    Readonly resolve

    resolve: ((value) => void)

    Type declaration

      • (value): void

      • Resolve callback to fulfill the promise.

        +

        Parameters

        • value: Response | PromiseLike<Response>

        Returns void

    Readonly workerNodeKey

    workerNodeKey: number

    The worker node key executing the task.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/StrategyData.html b/docs/interfaces/StrategyData.html index 29a8b6b3..634dc187 100644 --- a/docs/interfaces/StrategyData.html +++ b/docs/interfaces/StrategyData.html @@ -1,3 +1,3 @@ -StrategyData | poolifier - v3.1.3

    Interface StrategyDataInternal

    Worker choice strategy data.

    -
    interface StrategyData {
        virtualTaskEndTimestamp?: number;
    }

    Properties

    virtualTaskEndTimestamp? -

    Properties

    Optional virtualTaskEndTimestamp

    virtualTaskEndTimestamp?: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +StrategyData | poolifier - v3.1.4

    Interface StrategyDataInternal

    Worker choice strategy data.

    +
    interface StrategyData {
        virtualTaskEndTimestamp?: number;
    }

    Properties

    virtualTaskEndTimestamp? +

    Properties

    Optional virtualTaskEndTimestamp

    virtualTaskEndTimestamp?: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/StrategyPolicy.html b/docs/interfaces/StrategyPolicy.html index 41a025ac..ed499029 100644 --- a/docs/interfaces/StrategyPolicy.html +++ b/docs/interfaces/StrategyPolicy.html @@ -1,6 +1,6 @@ -StrategyPolicy | poolifier - v3.1.3

    Interface StrategyPolicyInternal

    Strategy policy.

    -
    interface StrategyPolicy {
        dynamicWorkerReady: boolean;
        dynamicWorkerUsage: boolean;
    }

    Properties

    dynamicWorkerReady +StrategyPolicy | poolifier - v3.1.4

    Interface StrategyPolicyInternal

    Strategy policy.

    +
    interface StrategyPolicy {
        dynamicWorkerReady: boolean;
        dynamicWorkerUsage: boolean;
    }

    Properties

    dynamicWorkerReady dynamicWorkerUsage

    Properties

    Readonly dynamicWorkerReady

    dynamicWorkerReady: boolean

    Expects the newly created dynamic worker to be flagged as ready.

    -

    Readonly dynamicWorkerUsage

    dynamicWorkerUsage: boolean

    Expects tasks execution on the newly created dynamic worker.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Readonly dynamicWorkerUsage

    dynamicWorkerUsage: boolean

    Expects tasks execution on the newly created dynamic worker.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/Task.html b/docs/interfaces/Task.html index a3a7ee4d..b272b0ea 100644 --- a/docs/interfaces/Task.html +++ b/docs/interfaces/Task.html @@ -1,13 +1,13 @@ -Task | poolifier - v3.1.3

    Interface Task<Data>Internal

    Message object that is passed as a task between main worker and worker.

    +Task | poolifier - v3.1.4

    Interface Task<Data>Internal

    Message object that is passed as a task between main worker and worker.

    interface Task {
        data?: Data;
        name?: string;
        taskId?: string;
        timestamp?: number;
        transferList?: TransferListItem[];
    }

    Type Parameters

    • Data = unknown

      Type of data sent to the worker. This can only be structured-cloneable data.

      -

    Hierarchy

    Properties

    data? +

    Hierarchy

    Properties

    data? name? taskId? timestamp? transferList?

    Properties

    Optional Readonly data

    data?: Data

    Task input data that will be passed to the worker.

    -

    Optional Readonly name

    name?: string

    Task name.

    -

    Optional Readonly taskId

    taskId?: string

    Task UUID.

    -

    Optional Readonly timestamp

    timestamp?: number

    Timestamp.

    -

    Optional Readonly transferList

    transferList?: TransferListItem[]

    Array of transferable objects.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Optional Readonly name

    name?: string

    Task name.

    +

    Optional Readonly taskId

    taskId?: string

    Task UUID.

    +

    Optional Readonly timestamp

    timestamp?: number

    Timestamp.

    +

    Optional Readonly transferList

    transferList?: TransferListItem[]

    Array of transferable objects.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/TaskFunctionOperationResult.html b/docs/interfaces/TaskFunctionOperationResult.html index a6e0ccca..9e2a3cb6 100644 --- a/docs/interfaces/TaskFunctionOperationResult.html +++ b/docs/interfaces/TaskFunctionOperationResult.html @@ -1,4 +1,4 @@ -TaskFunctionOperationResult | poolifier - v3.1.3

    Interface TaskFunctionOperationResult

    Task function operation result.

    -
    interface TaskFunctionOperationResult {
        error?: Error;
        status: boolean;
    }

    Properties

    error? +TaskFunctionOperationResult | poolifier - v3.1.4

    Interface TaskFunctionOperationResult

    Task function operation result.

    +
    interface TaskFunctionOperationResult {
        error?: Error;
        status: boolean;
    }

    Properties

    error? status -

    Properties

    Optional error

    error?: Error

    status

    status: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional error

    error?: Error

    status

    status: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/TaskPerformance.html b/docs/interfaces/TaskPerformance.html index 0ac717aa..80813780 100644 --- a/docs/interfaces/TaskPerformance.html +++ b/docs/interfaces/TaskPerformance.html @@ -1,10 +1,10 @@ -TaskPerformance | poolifier - v3.1.3

    Interface TaskPerformanceInternal

    Task performance.

    -
    interface TaskPerformance {
        elu?: EventLoopUtilization;
        name: string;
        runTime?: number;
        timestamp: number;
    }

    Properties

    elu? +TaskPerformance | poolifier - v3.1.4

    Interface TaskPerformanceInternal

    Task performance.

    +
    interface TaskPerformance {
        elu?: EventLoopUtilization;
        name: string;
        runTime?: number;
        timestamp: number;
    }

    Properties

    elu? name runTime? timestamp

    Properties

    Optional Readonly elu

    elu?: EventLoopUtilization

    Task event loop utilization.

    -

    Readonly name

    name: string

    Task name.

    -

    Optional Readonly runTime

    runTime?: number

    Task runtime.

    -

    Readonly timestamp

    timestamp: number

    Task performance timestamp.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Readonly name

    name: string

    Task name.

    +

    Optional Readonly runTime

    runTime?: number

    Task runtime.

    +

    Readonly timestamp

    timestamp: number

    Task performance timestamp.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/TaskStatistics.html b/docs/interfaces/TaskStatistics.html index 41fa298e..b16e6600 100644 --- a/docs/interfaces/TaskStatistics.html +++ b/docs/interfaces/TaskStatistics.html @@ -1,5 +1,5 @@ -TaskStatistics | poolifier - v3.1.3

    Interface TaskStatisticsInternal

    Task statistics.

    -
    interface TaskStatistics {
        executed: number;
        executing: number;
        failed: number;
        maxQueued?: number;
        queued: number;
        sequentiallyStolen: number;
        stolen: number;
    }

    Properties

    executed +TaskStatistics | poolifier - v3.1.4

    Interface TaskStatisticsInternal

    Task statistics.

    +
    interface TaskStatistics {
        executed: number;
        executing: number;
        failed: number;
        maxQueued?: number;
        queued: number;
        sequentiallyStolen: number;
        stolen: number;
    }

    Properties

    executed executing failed maxQueued? @@ -7,10 +7,10 @@ sequentiallyStolen stolen

    Properties

    executed

    executed: number

    Number of executed tasks.

    -

    executing

    executing: number

    Number of executing tasks.

    -

    failed

    failed: number

    Number of failed tasks.

    -

    Optional Readonly maxQueued

    maxQueued?: number

    Maximum number of queued tasks.

    -

    Readonly queued

    queued: number

    Number of queued tasks.

    -

    sequentiallyStolen

    sequentiallyStolen: number

    Number of sequentially stolen tasks.

    -

    stolen

    stolen: number

    Number of stolen tasks.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    executing

    executing: number

    Number of executing tasks.

    +

    failed

    failed: number

    Number of failed tasks.

    +

    Optional Readonly maxQueued

    maxQueued?: number

    Maximum number of queued tasks.

    +

    Readonly queued

    queued: number

    Number of queued tasks.

    +

    sequentiallyStolen

    sequentiallyStolen: number

    Number of sequentially stolen tasks.

    +

    stolen

    stolen: number

    Number of stolen tasks.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/TaskStatisticsRequirements.html b/docs/interfaces/TaskStatisticsRequirements.html index 88075cf8..0a2a8caf 100644 --- a/docs/interfaces/TaskStatisticsRequirements.html +++ b/docs/interfaces/TaskStatisticsRequirements.html @@ -1,8 +1,8 @@ -TaskStatisticsRequirements | poolifier - v3.1.3

    Interface TaskStatisticsRequirementsInternal

    Pool worker node worker usage statistics requirements.

    -
    interface TaskStatisticsRequirements {
        elu: MeasurementStatisticsRequirements;
        runTime: MeasurementStatisticsRequirements;
        waitTime: MeasurementStatisticsRequirements;
    }

    Properties

    elu +TaskStatisticsRequirements | poolifier - v3.1.4

    Interface TaskStatisticsRequirementsInternal

    Pool worker node worker usage statistics requirements.

    +
    interface TaskStatisticsRequirements {
        elu: MeasurementStatisticsRequirements;
        runTime: MeasurementStatisticsRequirements;
        waitTime: MeasurementStatisticsRequirements;
    }

    Properties

    elu runTime waitTime

    Properties

    Readonly elu

    elu: MeasurementStatisticsRequirements

    Tasks event loop utilization requirements.

    -

    Readonly runTime

    runTime: MeasurementStatisticsRequirements

    Tasks runtime requirements.

    -

    Readonly waitTime

    waitTime: MeasurementStatisticsRequirements

    Tasks wait time requirements.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Readonly runTime

    runTime: MeasurementStatisticsRequirements

    Tasks runtime requirements.

    +

    Readonly waitTime

    waitTime: MeasurementStatisticsRequirements

    Tasks wait time requirements.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/TasksQueueOptions.html b/docs/interfaces/TasksQueueOptions.html index 61bcf45b..188cf5b8 100644 --- a/docs/interfaces/TasksQueueOptions.html +++ b/docs/interfaces/TasksQueueOptions.html @@ -1,18 +1,18 @@ -TasksQueueOptions | poolifier - v3.1.3

    Interface TasksQueueOptions

    Worker node tasks queue options.

    -
    interface TasksQueueOptions {
        concurrency?: number;
        size?: number;
        taskStealing?: boolean;
        tasksStealingOnBackPressure?: boolean;
    }

    Properties

    concurrency? +TasksQueueOptions | poolifier - v3.1.4

    Interface TasksQueueOptions

    Worker node tasks queue options.

    +
    interface TasksQueueOptions {
        concurrency?: number;
        size?: number;
        taskStealing?: boolean;
        tasksStealingOnBackPressure?: boolean;
    }

    Properties

    concurrency? size? taskStealing? tasksStealingOnBackPressure?

    Properties

    Optional Readonly concurrency

    concurrency?: number

    Maximum number of tasks that can be executed concurrently on a worker node.

    Default Value

    1
    -

    Optional Readonly size

    size?: number

    Maximum tasks queue size per worker node flagging it as back pressured.

    +

    Optional Readonly size

    size?: number

    Maximum tasks queue size per worker node flagging it as back pressured.

    Default Value

    (pool maximum size)^2
    -

    Optional Readonly taskStealing

    taskStealing?: boolean

    Whether to enable task stealing on idle.

    +

    Optional Readonly taskStealing

    taskStealing?: boolean

    Whether to enable task stealing on idle.

    Default Value

    true
    -

    Optional Readonly tasksStealingOnBackPressure

    tasksStealingOnBackPressure?: boolean

    Whether to enable tasks stealing under back pressure.

    +

    Optional Readonly tasksStealingOnBackPressure

    tasksStealingOnBackPressure?: boolean

    Whether to enable tasks stealing under back pressure.

    Default Value

    true
    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/WorkerChoiceStrategyOptions.html b/docs/interfaces/WorkerChoiceStrategyOptions.html index d2662b18..3c079508 100644 --- a/docs/interfaces/WorkerChoiceStrategyOptions.html +++ b/docs/interfaces/WorkerChoiceStrategyOptions.html @@ -1,5 +1,5 @@ -WorkerChoiceStrategyOptions | poolifier - v3.1.3

    Interface WorkerChoiceStrategyOptions

    Worker choice strategy options.

    -
    interface WorkerChoiceStrategyOptions {
        elu?: MeasurementOptions;
        measurement?: "runTime" | "waitTime" | "elu";
        retries?: number;
        runTime?: MeasurementOptions;
        waitTime?: MeasurementOptions;
        weights?: Record<number, number>;
    }

    Properties

    elu? +WorkerChoiceStrategyOptions | poolifier - v3.1.4

    Interface WorkerChoiceStrategyOptions

    Worker choice strategy options.

    +
    interface WorkerChoiceStrategyOptions {
        elu?: MeasurementOptions;
        measurement?: "runTime" | "waitTime" | "elu";
        retries?: number;
        runTime?: MeasurementOptions;
        waitTime?: MeasurementOptions;
        weights?: Record<number, number>;
    }

    Properties

    elu? measurement? retries? runTime? @@ -8,18 +8,18 @@

    Properties

    Optional Readonly elu

    elu?: MeasurementOptions

    Event loop utilization options.

    Default Value

    { median: false }
    -

    Optional Readonly measurement

    measurement?: "runTime" | "waitTime" | "elu"

    Measurement to use in worker choice strategy supporting it.

    -

    Optional Readonly retries

    retries?: number

    Number of worker choice retries to perform if no worker is eligible.

    +

    Optional Readonly measurement

    measurement?: "runTime" | "waitTime" | "elu"

    Measurement to use in worker choice strategy supporting it.

    +

    Optional Readonly retries

    retries?: number

    Number of worker choice retries to perform if no worker is eligible.

    Default Value

    6
    -

    Optional Readonly runTime

    runTime?: MeasurementOptions

    Runtime options.

    +

    Optional Readonly runTime

    runTime?: MeasurementOptions

    Runtime options.

    Default Value

    { median: false }
    -

    Optional Readonly waitTime

    waitTime?: MeasurementOptions

    Wait time options.

    +

    Optional Readonly waitTime

    waitTime?: MeasurementOptions

    Wait time options.

    Default Value

    { median: false }
    -

    Optional Readonly weights

    weights?: Record<number, number>

    Worker weights to use for weighted round robin worker selection strategies. +

    Optional Readonly weights

    weights?: Record<number, number>

    Worker weights to use for weighted round robin worker selection strategies. A weight is tasks maximum execution time in milliseconds for a worker node.

    Default Value

    Weights computed automatically given the CPU performance.
    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/WorkerError.html b/docs/interfaces/WorkerError.html index faa22358..033b911f 100644 --- a/docs/interfaces/WorkerError.html +++ b/docs/interfaces/WorkerError.html @@ -1,9 +1,9 @@ -WorkerError | poolifier - v3.1.3

    Interface WorkerError<Data>

    Worker error.

    +WorkerError | poolifier - v3.1.4

    Interface WorkerError<Data>

    Worker error.

    interface WorkerError {
        data?: Data;
        message: string;
        name: string;
    }

    Type Parameters

    • Data = unknown

      Type of data sent to the worker triggering an error. This can only be structured-cloneable data.

      -

    Properties

    data? +

    Properties

    data? message name

    Properties

    Optional Readonly data

    data?: Data

    Data triggering the error.

    -

    Readonly message

    message: string

    Error message.

    -

    Readonly name

    name: string

    Task function name triggering the error.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Readonly message

    message: string

    Error message.

    +

    Readonly name

    name: string

    Task function name triggering the error.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/WorkerInfo.html b/docs/interfaces/WorkerInfo.html index ec9dfebe..a8cea3f5 100644 --- a/docs/interfaces/WorkerInfo.html +++ b/docs/interfaces/WorkerInfo.html @@ -1,12 +1,12 @@ -WorkerInfo | poolifier - v3.1.3

    Interface WorkerInfoInternal

    Worker information.

    -
    interface WorkerInfo {
        dynamic: boolean;
        id: undefined | number;
        ready: boolean;
        taskFunctionNames?: string[];
        type: "thread" | "cluster";
    }

    Properties

    dynamic +WorkerInfo | poolifier - v3.1.4

    Interface WorkerInfoInternal

    Worker information.

    +
    interface WorkerInfo {
        dynamic: boolean;
        id: undefined | number;
        ready: boolean;
        taskFunctionNames?: string[];
        type: "thread" | "cluster";
    }

    Properties

    dynamic id ready taskFunctionNames? type

    Properties

    dynamic

    dynamic: boolean

    Dynamic flag.

    -

    Readonly id

    id: undefined | number

    Worker id.

    -

    ready

    ready: boolean

    Ready flag.

    -

    Optional taskFunctionNames

    taskFunctionNames?: string[]

    Task function names.

    -

    Readonly type

    type: "thread" | "cluster"

    Worker type.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Readonly id

    id: undefined | number

    Worker id.

    +

    ready

    ready: boolean

    Ready flag.

    +

    Optional taskFunctionNames

    taskFunctionNames?: string[]

    Task function names.

    +

    Readonly type

    type: "thread" | "cluster"

    Worker type.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/WorkerNodeEventDetail.html b/docs/interfaces/WorkerNodeEventDetail.html index f0af61b1..799891aa 100644 --- a/docs/interfaces/WorkerNodeEventDetail.html +++ b/docs/interfaces/WorkerNodeEventDetail.html @@ -1,4 +1,4 @@ -WorkerNodeEventDetail | poolifier - v3.1.3

    Interface WorkerNodeEventDetailInternal

    Worker node event detail.

    -
    interface WorkerNodeEventDetail {
        workerId: number;
        workerNodeKey?: number;
    }

    Properties

    workerId +WorkerNodeEventDetail | poolifier - v3.1.4

    Interface WorkerNodeEventDetailInternal

    Worker node event detail.

    +
    interface WorkerNodeEventDetail {
        workerId: number;
        workerNodeKey?: number;
    }

    Properties

    workerId workerNodeKey? -

    Properties

    workerId

    workerId: number

    Optional workerNodeKey

    workerNodeKey?: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    workerId

    workerId: number

    Optional workerNodeKey

    workerNodeKey?: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/WorkerNodeOptions.html b/docs/interfaces/WorkerNodeOptions.html index dcb42601..28d97051 100644 --- a/docs/interfaces/WorkerNodeOptions.html +++ b/docs/interfaces/WorkerNodeOptions.html @@ -1,5 +1,5 @@ -WorkerNodeOptions | poolifier - v3.1.3

    Interface WorkerNodeOptionsInternal

    Worker node options.

    -
    interface WorkerNodeOptions {
        env?: Record<string, unknown>;
        tasksQueueBackPressureSize: number;
        workerOptions?: WorkerOptions;
    }

    Properties

    env? +WorkerNodeOptions | poolifier - v3.1.4

    Interface WorkerNodeOptionsInternal

    Worker node options.

    +
    interface WorkerNodeOptions {
        env?: Record<string, unknown>;
        tasksQueueBackPressureSize: number;
        workerOptions?: WorkerOptions;
    }

    Properties

    env? tasksQueueBackPressureSize workerOptions? -

    Properties

    Optional env

    env?: Record<string, unknown>

    tasksQueueBackPressureSize

    tasksQueueBackPressureSize: number

    Optional workerOptions

    workerOptions?: WorkerOptions

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional env

    env?: Record<string, unknown>

    tasksQueueBackPressureSize

    tasksQueueBackPressureSize: number

    Optional workerOptions

    workerOptions?: WorkerOptions

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/WorkerOptions.html b/docs/interfaces/WorkerOptions.html index 2cbf5fc6..40bbd40f 100644 --- a/docs/interfaces/WorkerOptions.html +++ b/docs/interfaces/WorkerOptions.html @@ -1,5 +1,5 @@ -WorkerOptions | poolifier - v3.1.3

    Interface WorkerOptions

    Options for workers.

    -
    interface WorkerOptions {
        killBehavior?: "SOFT" | "HARD";
        killHandler?: KillHandler;
        maxInactiveTime?: number;
    }

    Properties

    killBehavior? +WorkerOptions | poolifier - v3.1.4

    Interface WorkerOptions

    Options for workers.

    +
    interface WorkerOptions {
        killBehavior?: "SOFT" | "HARD";
        killHandler?: KillHandler;
        maxInactiveTime?: number;
    }

    Properties

    killBehavior? killHandler? maxInactiveTime?

    Properties

    Optional killBehavior

    killBehavior?: "SOFT" | "HARD"

    killBehavior dictates if your worker will be deleted in case a task is active on it.

    @@ -10,9 +10,9 @@

    This option only apply to the newly created workers.

    Default Value

    KillBehaviors.SOFT
    -

    Optional killHandler

    killHandler?: KillHandler

    The function to call when a worker is killed.

    +

    Optional killHandler

    killHandler?: KillHandler

    The function to call when a worker is killed.

    Default Value

    () => {}

    -

    Optional maxInactiveTime

    maxInactiveTime?: number

    Maximum waiting time in milliseconds for tasks on newly created workers. It must be greater or equal than 5.

    +

    Optional maxInactiveTime

    maxInactiveTime?: number

    Maximum waiting time in milliseconds for tasks on newly created workers. It must be greater or equal than 5.

    After this time, newly created workers will be terminated. The last active time of your worker will be updated when it terminates a task.

      @@ -22,4 +22,4 @@ when this timeout expires your tasks is interrupted before completion and remove

    Default Value

    60000
    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/WorkerStatistics.html b/docs/interfaces/WorkerStatistics.html index 5b23e3fe..b0a2c9de 100644 --- a/docs/interfaces/WorkerStatistics.html +++ b/docs/interfaces/WorkerStatistics.html @@ -1,6 +1,6 @@ -WorkerStatistics | poolifier - v3.1.3

    Interface WorkerStatisticsInternal

    Worker task performance statistics computation settings.

    -
    interface WorkerStatistics {
        elu: boolean;
        runTime: boolean;
    }

    Properties

    elu +WorkerStatistics | poolifier - v3.1.4

    Interface WorkerStatisticsInternal

    Worker task performance statistics computation settings.

    +
    interface WorkerStatistics {
        elu: boolean;
        runTime: boolean;
    }

    Properties

    elu runTime

    Properties

    Readonly elu

    elu: boolean

    Whether the worker computes the task event loop utilization (ELU) or not.

    -

    Readonly runTime

    runTime: boolean

    Whether the worker computes the task runtime or not.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Readonly runTime

    runTime: boolean

    Whether the worker computes the task runtime or not.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/WorkerUsage.html b/docs/interfaces/WorkerUsage.html index 6052b004..65c15a38 100644 --- a/docs/interfaces/WorkerUsage.html +++ b/docs/interfaces/WorkerUsage.html @@ -1,10 +1,10 @@ -WorkerUsage | poolifier - v3.1.3

    Interface WorkerUsageInternal

    Worker usage statistics.

    -
    interface WorkerUsage {
        elu: EventLoopUtilizationMeasurementStatistics;
        runTime: MeasurementStatistics;
        tasks: TaskStatistics;
        waitTime: MeasurementStatistics;
    }

    Properties

    elu +WorkerUsage | poolifier - v3.1.4

    Interface WorkerUsageInternal

    Worker usage statistics.

    +
    interface WorkerUsage {
        elu: EventLoopUtilizationMeasurementStatistics;
        runTime: MeasurementStatistics;
        tasks: TaskStatistics;
        waitTime: MeasurementStatistics;
    }

    Properties

    elu runTime tasks waitTime

    Properties

    Readonly elu

    elu: EventLoopUtilizationMeasurementStatistics

    Tasks event loop utilization statistics.

    -

    Readonly runTime

    runTime: MeasurementStatistics

    Tasks runtime statistics.

    -

    Readonly tasks

    tasks: TaskStatistics

    Tasks statistics.

    -

    Readonly waitTime

    waitTime: MeasurementStatistics

    Tasks wait time statistics.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Readonly runTime

    runTime: MeasurementStatistics

    Tasks runtime statistics.

    +

    Readonly tasks

    tasks: TaskStatistics

    Tasks statistics.

    +

    Readonly waitTime

    waitTime: MeasurementStatistics

    Tasks wait time statistics.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/ErrorHandler.html b/docs/types/ErrorHandler.html index b9fee8db..73d3ca2c 100644 --- a/docs/types/ErrorHandler.html +++ b/docs/types/ErrorHandler.html @@ -1,3 +1,3 @@ -ErrorHandler | poolifier - v3.1.3

    Type alias ErrorHandler<Worker>

    ErrorHandler<Worker>: ((this, error) => void)

    Type Parameters

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/ExitHandler.html b/docs/types/ExitHandler.html index 48cb0e58..9835b9d6 100644 --- a/docs/types/ExitHandler.html +++ b/docs/types/ExitHandler.html @@ -1,3 +1,3 @@ -ExitHandler | poolifier - v3.1.3

    Type alias ExitHandler<Worker>

    ExitHandler<Worker>: ((this, exitCode) => void)

    Type Parameters

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/KillBehavior.html b/docs/types/KillBehavior.html index 14201cdb..5fbb7cf8 100644 --- a/docs/types/KillBehavior.html +++ b/docs/types/KillBehavior.html @@ -1,2 +1,2 @@ -KillBehavior | poolifier - v3.1.3

    Type alias KillBehavior

    KillBehavior: keyof typeof KillBehaviors

    Kill behavior.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +KillBehavior | poolifier - v3.1.4

    Type alias KillBehavior

    KillBehavior: keyof typeof KillBehaviors

    Kill behavior.

    +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/KillHandler.html b/docs/types/KillHandler.html index 46ff10ba..c61c7b1b 100644 --- a/docs/types/KillHandler.html +++ b/docs/types/KillHandler.html @@ -1,2 +1,2 @@ -KillHandler | poolifier - v3.1.3

    Type alias KillHandler

    KillHandler: (() => void | Promise<void>)

    Type declaration

      • (): void | Promise<void>

      • Handler called when a worker is killed.

        -

        Returns void | Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +KillHandler | poolifier - v3.1.4

    Type alias KillHandler

    KillHandler: (() => void | Promise<void>)

    Type declaration

      • (): void | Promise<void>

      • Handler called when a worker is killed.

        +

        Returns void | Promise<void>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/Measurement.html b/docs/types/Measurement.html index 4576c6a9..09dc34cb 100644 --- a/docs/types/Measurement.html +++ b/docs/types/Measurement.html @@ -1,2 +1,2 @@ -Measurement | poolifier - v3.1.3

    Type alias Measurement

    Measurement: keyof typeof Measurements

    Measurement.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +Measurement | poolifier - v3.1.4

    Type alias Measurement

    Measurement: keyof typeof Measurements

    Measurement.

    +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/MessageHandler.html b/docs/types/MessageHandler.html index 5dea2004..30da6680 100644 --- a/docs/types/MessageHandler.html +++ b/docs/types/MessageHandler.html @@ -1,3 +1,3 @@ -MessageHandler | poolifier - v3.1.3

    Type alias MessageHandler<Worker>

    MessageHandler<Worker>: ((this, message) => void)

    Type Parameters

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/OnlineHandler.html b/docs/types/OnlineHandler.html index e742793c..3c3bce3e 100644 --- a/docs/types/OnlineHandler.html +++ b/docs/types/OnlineHandler.html @@ -1,3 +1,3 @@ -OnlineHandler | poolifier - v3.1.3

    Type alias OnlineHandler<Worker>

    OnlineHandler<Worker>: ((this) => void)

    Type Parameters

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/PoolEvent.html b/docs/types/PoolEvent.html index 28eb0ee2..2f0c0590 100644 --- a/docs/types/PoolEvent.html +++ b/docs/types/PoolEvent.html @@ -1,2 +1,2 @@ -PoolEvent | poolifier - v3.1.3

    Type alias PoolEvent

    PoolEvent: keyof typeof PoolEvents

    Pool event.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +PoolEvent | poolifier - v3.1.4

    Type alias PoolEvent

    PoolEvent: keyof typeof PoolEvents

    Pool event.

    +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/PoolType.html b/docs/types/PoolType.html index a65f30f7..2be2ca7f 100644 --- a/docs/types/PoolType.html +++ b/docs/types/PoolType.html @@ -1,2 +1,2 @@ -PoolType | poolifier - v3.1.3

    Type alias PoolType

    PoolType: keyof typeof PoolTypes

    Pool type.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +PoolType | poolifier - v3.1.4

    Type alias PoolType

    PoolType: keyof typeof PoolTypes

    Pool type.

    +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/TaskAsyncFunction.html b/docs/types/TaskAsyncFunction.html index 3d70be15..0cda616b 100644 --- a/docs/types/TaskAsyncFunction.html +++ b/docs/types/TaskAsyncFunction.html @@ -1,6 +1,6 @@ -TaskAsyncFunction | poolifier - v3.1.3

    Type alias TaskAsyncFunction<Data, Response>

    TaskAsyncFunction<Data, Response>: ((data?) => Promise<Response>)

    Type Parameters

    Returns Promise<Response>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/TaskFunction.html b/docs/types/TaskFunction.html index ee6eff42..0cf1b08a 100644 --- a/docs/types/TaskFunction.html +++ b/docs/types/TaskFunction.html @@ -1,5 +1,5 @@ -TaskFunction | poolifier - v3.1.3

    Type alias TaskFunction<Data, Response>

    TaskFunction<Data, Response>: TaskSyncFunction<Data, Response> | TaskAsyncFunction<Data, Response>

    Task function that can be executed. +TaskFunction | poolifier - v3.1.4

    Type alias TaskFunction<Data, Response>

    TaskFunction<Data, Response>: TaskSyncFunction<Data, Response> | TaskAsyncFunction<Data, Response>

    Task function that can be executed. This function can be synchronous or asynchronous.

    Type Parameters

    • Data = unknown

      Type of data sent to the worker. This can only be structured-cloneable data.

    • Response = unknown

      Type of execution response. This can only be structured-cloneable data.

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/TaskFunctions.html b/docs/types/TaskFunctions.html index 19746117..1ab91788 100644 --- a/docs/types/TaskFunctions.html +++ b/docs/types/TaskFunctions.html @@ -1,7 +1,7 @@ -TaskFunctions | poolifier - v3.1.3

    Type alias TaskFunctions<Data, Response>

    TaskFunctions<Data, Response>: Record<string, TaskFunction<Data, Response>>

    Tasks functions that can be executed. +TaskFunctions | poolifier - v3.1.4

    Type alias TaskFunctions<Data, Response>

    TaskFunctions<Data, Response>: Record<string, TaskFunction<Data, Response>>

    Tasks functions that can be executed. This object can contain synchronous or asynchronous functions. The key is the name of the function. The value is the function itself.

    Type Parameters

    • Data = unknown

      Type of data sent to the worker. This can only be structured-cloneable data.

    • Response = unknown

      Type of execution response. This can only be structured-cloneable data.

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/TaskSyncFunction.html b/docs/types/TaskSyncFunction.html index ce38fb81..6bae8fb6 100644 --- a/docs/types/TaskSyncFunction.html +++ b/docs/types/TaskSyncFunction.html @@ -1,5 +1,5 @@ -TaskSyncFunction | poolifier - v3.1.3

    Type alias TaskSyncFunction<Data, Response>

    TaskSyncFunction<Data, Response>: ((data?) => Response)

    Type Parameters

    Returns Response

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/WorkerChoiceStrategy.html b/docs/types/WorkerChoiceStrategy.html index cd9e52f9..3b2da57d 100644 --- a/docs/types/WorkerChoiceStrategy.html +++ b/docs/types/WorkerChoiceStrategy.html @@ -1,2 +1,2 @@ -WorkerChoiceStrategy | poolifier - v3.1.3

    Type alias WorkerChoiceStrategy

    WorkerChoiceStrategy: keyof typeof WorkerChoiceStrategies

    Worker choice strategy.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +WorkerChoiceStrategy | poolifier - v3.1.4

    Type alias WorkerChoiceStrategy

    WorkerChoiceStrategy: keyof typeof WorkerChoiceStrategies

    Worker choice strategy.

    +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/WorkerType.html b/docs/types/WorkerType.html index 00658e18..0fedb51c 100644 --- a/docs/types/WorkerType.html +++ b/docs/types/WorkerType.html @@ -1,2 +1,2 @@ -WorkerType | poolifier - v3.1.3

    Type alias WorkerType

    WorkerType: keyof typeof WorkerTypes

    Worker type.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +WorkerType | poolifier - v3.1.4

    Type alias WorkerType

    WorkerType: keyof typeof WorkerTypes

    Worker type.

    +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/Writable.html b/docs/types/Writable.html index 95410451..462acf49 100644 --- a/docs/types/Writable.html +++ b/docs/types/Writable.html @@ -1 +1 @@ -Writable | poolifier - v3.1.3

    Type alias Writable<T>

    Writable<T>: {
        -readonly [P in keyof T]: T[P]
    }

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +Writable | poolifier - v3.1.4

    Type alias Writable<T>

    Writable<T>: {
        -readonly [P in keyof T]: T[P]
    }

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/KillBehaviors.html b/docs/variables/KillBehaviors.html index 86b458a5..54235293 100644 --- a/docs/variables/KillBehaviors.html +++ b/docs/variables/KillBehaviors.html @@ -1,4 +1,4 @@ -KillBehaviors | poolifier - v3.1.3

    Variable KillBehaviorsConst

    KillBehaviors: Readonly<{
        HARD: "HARD";
        SOFT: "SOFT";
    }> = ...

    Enumeration of kill behaviors.

    +KillBehaviors | poolifier - v3.1.4

    Variable KillBehaviorsConst

    KillBehaviors: Readonly<{
        HARD: "HARD";
        SOFT: "SOFT";
    }> = ...

    Enumeration of kill behaviors.

    Type declaration

    • Readonly HARD: "HARD"

      If currentTime - lastActiveTime is greater than maxInactiveTime but a task is still executing or queued, then the worker will be deleted.

    • Readonly SOFT: "SOFT"

      If currentTime - lastActiveTime is greater than maxInactiveTime but a task is still executing or queued, then the worker wont be deleted.

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/Measurements.html b/docs/variables/Measurements.html index d718204f..8fb19440 100644 --- a/docs/variables/Measurements.html +++ b/docs/variables/Measurements.html @@ -1,2 +1,2 @@ -Measurements | poolifier - v3.1.3

    Variable MeasurementsConst

    Measurements: Readonly<{
        elu: "elu";
        runTime: "runTime";
        waitTime: "waitTime";
    }> = ...

    Enumeration of measurements.

    -

    Type declaration

    • Readonly elu: "elu"
    • Readonly runTime: "runTime"
    • Readonly waitTime: "waitTime"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +Measurements | poolifier - v3.1.4

    Variable MeasurementsConst

    Measurements: Readonly<{
        elu: "elu";
        runTime: "runTime";
        waitTime: "waitTime";
    }> = ...

    Enumeration of measurements.

    +

    Type declaration

    • Readonly elu: "elu"
    • Readonly runTime: "runTime"
    • Readonly waitTime: "waitTime"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/PoolEvents.html b/docs/variables/PoolEvents.html index c7f26975..6f515c5c 100644 --- a/docs/variables/PoolEvents.html +++ b/docs/variables/PoolEvents.html @@ -1,2 +1,2 @@ -PoolEvents | poolifier - v3.1.3

    Variable PoolEventsConst

    PoolEvents: Readonly<{
        backPressure: "backPressure";
        busy: "busy";
        destroy: "destroy";
        error: "error";
        full: "full";
        ready: "ready";
        taskError: "taskError";
    }> = ...

    Enumeration of pool events.

    -

    Type declaration

    • Readonly backPressure: "backPressure"
    • Readonly busy: "busy"
    • Readonly destroy: "destroy"
    • Readonly error: "error"
    • Readonly full: "full"
    • Readonly ready: "ready"
    • Readonly taskError: "taskError"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +PoolEvents | poolifier - v3.1.4

    Variable PoolEventsConst

    PoolEvents: Readonly<{
        backPressure: "backPressure";
        busy: "busy";
        destroy: "destroy";
        error: "error";
        full: "full";
        ready: "ready";
        taskError: "taskError";
    }> = ...

    Enumeration of pool events.

    +

    Type declaration

    • Readonly backPressure: "backPressure"
    • Readonly busy: "busy"
    • Readonly destroy: "destroy"
    • Readonly error: "error"
    • Readonly full: "full"
    • Readonly ready: "ready"
    • Readonly taskError: "taskError"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/PoolTypes.html b/docs/variables/PoolTypes.html index 98f81120..578a3119 100644 --- a/docs/variables/PoolTypes.html +++ b/docs/variables/PoolTypes.html @@ -1,4 +1,4 @@ -PoolTypes | poolifier - v3.1.3

    Variable PoolTypesConst

    PoolTypes: Readonly<{
        dynamic: "dynamic";
        fixed: "fixed";
    }> = ...

    Enumeration of pool types.

    +PoolTypes | poolifier - v3.1.4

    Variable PoolTypesConst

    PoolTypes: Readonly<{
        dynamic: "dynamic";
        fixed: "fixed";
    }> = ...

    Enumeration of pool types.

    Type declaration

    • Readonly dynamic: "dynamic"

      Dynamic pool type.

    • Readonly fixed: "fixed"

      Fixed pool type.

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/WorkerChoiceStrategies.html b/docs/variables/WorkerChoiceStrategies.html index b0e5b126..4303e4f0 100644 --- a/docs/variables/WorkerChoiceStrategies.html +++ b/docs/variables/WorkerChoiceStrategies.html @@ -1,4 +1,4 @@ -WorkerChoiceStrategies | poolifier - v3.1.3

    Variable WorkerChoiceStrategiesConst

    WorkerChoiceStrategies: Readonly<{
        FAIR_SHARE: "FAIR_SHARE";
        INTERLEAVED_WEIGHTED_ROUND_ROBIN: "INTERLEAVED_WEIGHTED_ROUND_ROBIN";
        LEAST_BUSY: "LEAST_BUSY";
        LEAST_ELU: "LEAST_ELU";
        LEAST_USED: "LEAST_USED";
        ROUND_ROBIN: "ROUND_ROBIN";
        WEIGHTED_ROUND_ROBIN: "WEIGHTED_ROUND_ROBIN";
    }> = ...

    Enumeration of worker choice strategies.

    +WorkerChoiceStrategies | poolifier - v3.1.4

    Variable WorkerChoiceStrategiesConst

    WorkerChoiceStrategies: Readonly<{
        FAIR_SHARE: "FAIR_SHARE";
        INTERLEAVED_WEIGHTED_ROUND_ROBIN: "INTERLEAVED_WEIGHTED_ROUND_ROBIN";
        LEAST_BUSY: "LEAST_BUSY";
        LEAST_ELU: "LEAST_ELU";
        LEAST_USED: "LEAST_USED";
        ROUND_ROBIN: "ROUND_ROBIN";
        WEIGHTED_ROUND_ROBIN: "WEIGHTED_ROUND_ROBIN";
    }> = ...

    Enumeration of worker choice strategies.

    Type declaration

    • Readonly FAIR_SHARE: "FAIR_SHARE"

      Fair share worker selection strategy.

    • Readonly Experimental INTERLEAVED_WEIGHTED_ROUND_ROBIN: "INTERLEAVED_WEIGHTED_ROUND_ROBIN"

      Interleaved weighted round robin worker selection strategy.

    • Readonly LEAST_BUSY: "LEAST_BUSY"

      Least busy worker selection strategy.

      @@ -6,4 +6,4 @@
    • Readonly LEAST_USED: "LEAST_USED"

      Least used worker selection strategy.

    • Readonly ROUND_ROBIN: "ROUND_ROBIN"

      Round robin worker selection strategy.

    • Readonly WEIGHTED_ROUND_ROBIN: "WEIGHTED_ROUND_ROBIN"

      Weighted round robin worker selection strategy.

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/WorkerTypes.html b/docs/variables/WorkerTypes.html index 8697c5d3..d9d89681 100644 --- a/docs/variables/WorkerTypes.html +++ b/docs/variables/WorkerTypes.html @@ -1,2 +1,2 @@ -WorkerTypes | poolifier - v3.1.3

    Variable WorkerTypesConst

    WorkerTypes: Readonly<{
        cluster: "cluster";
        thread: "thread";
    }> = ...

    Enumeration of worker types.

    -

    Type declaration

    • Readonly cluster: "cluster"
    • Readonly thread: "thread"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +WorkerTypes | poolifier - v3.1.4

    Variable WorkerTypesConst

    WorkerTypes: Readonly<{
        cluster: "cluster";
        thread: "thread";
    }> = ...

    Enumeration of worker types.

    +

    Type declaration

    • Readonly cluster: "cluster"
    • Readonly thread: "thread"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file