From: Documentation Bot Date: Fri, 10 May 2024 15:18:28 +0000 (+0000) Subject: docs: generate documentation X-Git-Tag: v4.0.7~13 X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=e372fd5367a524fd030b507e0acc842634c24ad9;p=poolifier.git docs: generate documentation --- diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index 445dea7c..87ad21f6 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,8 +1,8 @@ -AbstractPool | poolifier - v4.0.5

Class AbstractPool<Worker, Data, Response>Abstract

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

+AbstractPool | poolifier - v4.0.6

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 (view full)

Implements

Constructors

constructor +

Hierarchy (view full)

Implements

Constructors

constructor

Properties

destroying emitter? filePath @@ -113,8 +113,8 @@
  • filePath: string

    Path to the worker file.

  • opts: PoolOptions<Worker>

    Options for the pool.

  • Optional maximumNumberOfWorkers: number

    Maximum number of workers that this pool manages.

    -

    • Returns AbstractPool<Worker, Data, Response>

    Properties

    Private destroying

    destroying: boolean

    Whether the pool is destroying or not.

    -

    Optional emitter

    emitter?: EventEmitterAsyncResource

    Pool event emitter integrated with async resource. +

    Returns AbstractPool<Worker, Data, Response>

    Properties

    Private destroying

    destroying: boolean

    Whether the pool is destroying or not.

    +

    Optional emitter

    emitter?: EventEmitterAsyncResource

    Pool event emitter integrated with async resource. The async tracking tooling identifier is poolifier:<PoolType>-<WorkerType>-pool.

    Events that can currently be listened to:

      @@ -127,120 +127,120 @@ 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 maximumNumberOfWorkers

    maximumNumberOfWorkers?: number

    Maximum number of workers that this pool manages.

    -

    Protected Readonly minimumNumberOfWorkers

    minimumNumberOfWorkers: number

    Minimum number of workers that this pool manages.

    -

    Protected Readonly opts

    opts: PoolOptions<Worker>

    Options for the pool.

    -

    Protected promiseResponseMap

    promiseResponseMap: Map<`${string}-${string}-${string}-${string}-${string}`, PromiseResponseWrapper<Response>> = ...

    The task execution response promise map:

    +

    Protected Readonly filePath

    filePath: string

    Path to the worker file.

    +

    Protected Optional Readonly maximumNumberOfWorkers

    maximumNumberOfWorkers?: number

    Maximum number of workers that this pool manages.

    +

    Protected Readonly minimumNumberOfWorkers

    minimumNumberOfWorkers: number

    Minimum number of workers that this pool manages.

    +

    Protected Readonly opts

    opts: PoolOptions<Worker>

    Options for the pool.

    +

    Protected promiseResponseMap

    promiseResponseMap: Map<`${string}-${string}-${string}-${string}-${string}`, PromiseResponseWrapper<Response>> = ...

    The task execution response promise map:

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

    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 Optional 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 startingMinimumNumberOfWorkers

    startingMinimumNumberOfWorkers: boolean

    Whether the minimum number of workers is starting or not.

    -

    Private Readonly taskFunctions

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

    The task functions added at runtime map:

    +

    Private readyEventEmitted

    readyEventEmitted: boolean

    Whether the pool ready event has been emitted or not.

    +

    Private Optional 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 startingMinimumNumberOfWorkers

    startingMinimumNumberOfWorkers: boolean

    Whether the minimum number of workers is starting or not.

    +

    Private Readonly taskFunctions

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

    The task functions added at runtime map:

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

    Protected Optional workerChoiceStrategiesContext

    workerChoiceStrategiesContext?: WorkerChoiceStrategiesContext<Worker, Data, Response>

    Worker choice strategies context referencing worker choice algorithms implementation.

    -

    Readonly Internal workerNodes

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

    Pool worker nodes.

    -

    Accessors

    Protected Abstract busy

    Protected Optional workerChoiceStrategiesContext

    workerChoiceStrategiesContext?: WorkerChoiceStrategiesContext<Worker, Data, Response>

    Worker choice strategies context referencing worker choice algorithms implementation.

    +

    Readonly Internal workerNodes

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

    Pool worker nodes.

    +

    Accessors

    Protected Abstract busy

    Protected empty

    Protected full

    Protected empty

    Protected full

    info

    Private ready

    Protected Abstract type

    info

    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

    Private addWorkerNode

    Protected Abstract worker

    Methods

    addTaskFunction

    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 cannotStealTask

    Protected Abstract checkAndEmitDynamicWorkerCreationEvents

    Private checkAndEmitEmptyEvent

    Private checkAndEmitReadyEvent

    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 cannotStealTask

    Protected Abstract checkAndEmitDynamicWorkerCreationEvents

    Private checkAndEmitEmptyEvent

    Private checkAndEmitReadyEvent

    Private checkAndEmitTaskExecutionEvents

    Private checkAndEmitTaskQueuingEvents

    Private checkMessageWorkerId

    Private checkMinimumNumberOfWorkers

    • checkMinimumNumberOfWorkers(minimumNumberOfWorkers): void

    • Parameters

      • minimumNumberOfWorkers: undefined | number

      Returns void

    Private checkPoolOptions

    Private checkPoolType

    Private checkValidWorkerChoiceStrategyOptions

    Private chooseWorkerNode

    • chooseWorkerNode(workerChoiceStrategy?): number

    • Chooses a worker node for the next task given the worker choice strategy.

      +

    Private checkMinimumNumberOfWorkers

    • checkMinimumNumberOfWorkers(minimumNumberOfWorkers): void

    • Parameters

      • minimumNumberOfWorkers: undefined | number

      Returns void

    Private checkPoolOptions

    Private checkPoolType

    Private checkValidWorkerChoiceStrategyOptions

    Private chooseWorkerNode

    • chooseWorkerNode(workerChoiceStrategy?): number

    • Chooses a worker node for the next task given the worker choice strategy.

      Parameters

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

        The worker choice strategy.

      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 dequeueTask

    Protected Abstract deregisterWorkerMessageListener

    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.

        -

      Returns void

    destroy

    Protected destroyWorkerNode

    • destroyWorkerNode(workerNodeKey): Promise<void>

    • Terminates the worker node given its worker node key.

      +

    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

    Private enqueueTask

    execute

    Private executeTask

    • executeTask(workerNodeKey, task): void

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

      +

    Returns Promise<void>

    enableTasksQueue

    Private enqueueTask

    execute

    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

    Private Readonly getTaskFunctionWorkerWorkerChoiceStrategy

    • getTaskFunctionWorkerWorkerChoiceStrategy(name?): undefined | "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"

    • Gets task function strategy, if any.

      +

    Returns void

    Protected flagWorkerNodeAsNotReady

    Protected flushTasksQueue

    Private flushTasksQueues

    Private Readonly getTaskFunctionWorkerWorkerChoiceStrategy

    • getTaskFunctionWorkerWorkerChoiceStrategy(name?): undefined | "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"

    • Gets task function strategy, if any.

      Parameters

      • Optional name: string

        The task function name.

      Returns undefined | "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"

      The task function worker choice strategy if the task function worker choice strategy is defined, undefined otherwise.

      -

    Protected getWorkerInfo

    Protected getWorkerInfo

    • getWorkerInfo(workerNodeKey): undefined | WorkerInfo

    • Gets the worker information given its worker node key.

      Parameters

      • workerNodeKey: number

        The worker node key.

      Returns undefined | WorkerInfo

      The worker information.

      -

    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 getWorkerNodeTaskFunctionPriority

    • getWorkerNodeTaskFunctionPriority(workerNodeKey, name?): undefined | number

    • Gets worker node task function priority, if any.

      +

    Private Readonly getWorkerNodeTaskFunctionPriority

    • getWorkerNodeTaskFunctionPriority(workerNodeKey, name?): undefined | number

    • Gets worker node task function priority, if any.

      Parameters

      • workerNodeKey: number

        The worker node key.

      • Optional name: string

        The task function name.

      Returns undefined | number

      The task function worker choice priority if the task function worker choice priority is defined, undefined otherwise.

      -

    Private Readonly getWorkerWorkerChoiceStrategies

    • getWorkerWorkerChoiceStrategies(): Set<"ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN">

    • Gets the worker choice strategies registered in this pool.

      +

    Private Readonly getWorkerWorkerChoiceStrategies

    • getWorkerWorkerChoiceStrategies(): Set<"ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN">

    • Gets the worker choice strategies registered in this pool.

      Returns Set<"ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN">

      The worker choice strategies.

      -

    Private handleTask

    Private handleTaskExecutionResponse

    Private Readonly handleWorkerNodeBackPressureEvent

    Private Readonly handleWorkerNodeIdleEvent

    Private handleWorkerReadyResponse

    Private hasBackPressure

    hasTaskFunction

    Private initEventEmitter

    Private initWorkerNodeUsage

    • initWorkerNodeUsage(workerNode): void

    • Initializes the worker node usage with sensible default values gathered during runtime.

      +

    Private handleTask

    Private handleTaskExecutionResponse

    Private Readonly handleWorkerNodeBackPressureEvent

    Private Readonly handleWorkerNodeIdleEvent

    Private handleWorkerReadyResponse

    Private hasBackPressure

    hasTaskFunction

    Private initEventEmitter

    Private initWorkerNodeUsage

    Protected internalBusy

    • internalBusy(): boolean

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

      +

    Returns void

    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

    Protected Abstract isMain

    • isMain(): boolean

    • Returns whether the worker is the main worker or not.

      Returns boolean

      true if the worker is the main worker, false otherwise.

      -

    Private isWorkerNodeBusy

    listTaskFunctionsProperties

    Private redistributeQueuedTasks

    Protected Abstract registerOnceWorkerMessageListener

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

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

      +

    Private isWorkerNodeBusy

    listTaskFunctionsProperties

    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.

        -

      Returns void

    Protected Abstract registerWorkerMessageListener

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

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

      +

    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.

        -

      Returns void

    removeTaskFunction

    Private removeWorkerNode

    • removeWorkerNode(workerNode): void

    • Removes the worker node from the pool worker nodes.

      +

    Returns void

    removeTaskFunction

    Private removeWorkerNode

    Private resetTaskSequentiallyStolenStatisticsWorkerUsage

    • resetTaskSequentiallyStolenStatisticsWorkerUsage(workerNodeKey, taskName): void

    • Parameters

      • workerNodeKey: number
      • taskName: string

      Returns void

    Private sendKillMessageToWorker

    Protected Abstract sendStartupMessageToWorker

    • sendStartupMessageToWorker(workerNodeKey): void

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

      +

    Returns void

    Private resetTaskSequentiallyStolenStatisticsWorkerUsage

    • resetTaskSequentiallyStolenStatisticsWorkerUsage(workerNodeKey, taskName): void

    • Parameters

      • workerNodeKey: number
      • taskName: string

      Returns void

    Private 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: readonly TransferListItem[]

        The optional array of transferable objects.

        -

      Returns void

    setDefaultTaskFunction

    Private setTaskStealing

    setTasksQueueOptions

    Private setTasksQueueSize

    Private setTasksStealingOnBackPressure

    setWorkerChoiceStrategy

    setWorkerChoiceStrategyOptions

    Protected setupHook

    • setupHook(): void

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

    Returns void

    setDefaultTaskFunction

    Private setTaskStealing

    setTasksQueueOptions

    Private setTasksQueueSize

    Private setTasksStealingOnBackPressure

    setWorkerChoiceStrategy

    setWorkerChoiceStrategyOptions

    Protected setupHook

    • setupHook(): void

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

      -

      Returns void

    Protected Abstract shallCreateDynamicWorker

    Protected Abstract 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 startMinimumNumberOfWorkers

    • startMinimumNumberOfWorkers(initWorkerNodeUsage?): void

    • Starts the minimum number of workers.

      -

      Parameters

      • initWorkerNodeUsage: boolean = false

      Returns void

    Private tasksQueueSize

    Private unsetTaskStealing

    Private unsetTasksStealingOnBackPressure

    Private updateTaskSequentiallyStolenStatisticsWorkerUsage

    • updateTaskSequentiallyStolenStatisticsWorkerUsage(workerNodeKey, taskName, previousTaskName?): void

    • Parameters

      • workerNodeKey: number
      • taskName: string
      • Optional previousTaskName: string

      Returns void

    Private updateTaskStolenStatisticsWorkerUsage

    • updateTaskStolenStatisticsWorkerUsage(workerNodeKey, taskName): void

    • Parameters

      • workerNodeKey: number
      • taskName: string

      Returns void

    Protected Readonly workerMessageListener

    Private Readonly workerNodeStealTask

    Settings

    Member Visibility

    Theme

    On This Page

    constructordestroyingemitterfilePathmaximumNumberOfWorkersminimumNumberOfWorkersoptspromiseResponseMapreadyEventEmittedstartTimestampstartedstartingstartingMinimumNumberOfWorkerstaskFunctionsworkerChoiceStrategiesContextworkerNodesbusyemptyfullinforeadytypeutilizationworkeraddTaskFunctionaddWorkerNodeafterTaskExecutionHookafterWorkerNodeSetupbeforeTaskExecutionHookbuildTasksQueueOptionscannotStealTaskcheckAndEmitDynamicWorkerCreationEventscheckAndEmitEmptyEventcheckAndEmitReadyEventcheckAndEmitTaskExecutionEventscheckAndEmitTaskQueuingEventscheckMessageWorkerIdcheckMinimumNumberOfWorkerscheckPoolOptionscheckPoolTypecheckValidWorkerChoiceStrategyOptionschooseWorkerNodecreateAndSetupDynamicWorkerNodecreateAndSetupWorkerNodecreateWorkerNodedequeueTaskderegisterWorkerMessageListenerdestroydestroyWorkerNodeenableTasksQueueenqueueTaskexecuteexecuteTaskflagWorkerNodeAsNotReadyflushTasksQueueflushTasksQueuesgetTaskFunctionWorkerWorkerChoiceStrategygetWorkerInfogetWorkerNodeKeyByWorkerIdgetWorkerNodeTaskFunctionPrioritygetWorkerWorkerChoiceStrategieshandleTaskhandleTaskExecutionResponsehandleWorkerNodeBackPressureEventhandleWorkerNodeIdleEventhandleWorkerReadyResponsehasBackPressurehasTaskFunctioninitEventEmitterinitWorkerNodeUsageinternalBusyisMainisWorkerNodeBusylistTaskFunctionsPropertiesredistributeQueuedTasksregisterOnceWorkerMessageListenerregisterWorkerMessageListenerremoveTaskFunctionremoveWorkerNoderesetTaskSequentiallyStolenStatisticsWorkerUsagesendKillMessageToWorkersendStartupMessageToWorkersendStatisticsMessageToWorkersendTaskFunctionOperationToWorkersendTaskFunctionOperationToWorkerssendToWorkersetDefaultTaskFunctionsetTaskStealingsetTasksQueueOptionssetTasksQueueSizesetTasksStealingOnBackPressuresetWorkerChoiceStrategysetWorkerChoiceStrategyOptionssetupHookshallCreateDynamicWorkershallExecuteTaskshallUpdateTaskFunctionWorkerUsagestartstartMinimumNumberOfWorkerstasksQueueSizeunsetTaskStealingunsetTasksStealingOnBackPressureupdateTaskSequentiallyStolenStatisticsWorkerUsageupdateTaskStolenStatisticsWorkerUsageworkerMessageListenerworkerNodeStealTask
    \ No newline at end of file +

    start

    Private startMinimumNumberOfWorkers

    • startMinimumNumberOfWorkers(initWorkerNodeUsage?): void

    • Starts the minimum number of workers.

      +

      Parameters

      • initWorkerNodeUsage: boolean = false

      Returns void

    Private tasksQueueSize

    Private unsetTaskStealing

    Private unsetTasksStealingOnBackPressure

    Private updateTaskSequentiallyStolenStatisticsWorkerUsage

    • updateTaskSequentiallyStolenStatisticsWorkerUsage(workerNodeKey, taskName, previousTaskName?): void

    • Parameters

      • workerNodeKey: number
      • taskName: string
      • Optional previousTaskName: string

      Returns void

    Private updateTaskStolenStatisticsWorkerUsage

    • updateTaskStolenStatisticsWorkerUsage(workerNodeKey, taskName): void

    • Parameters

      • workerNodeKey: number
      • taskName: string

      Returns void

    Protected Readonly workerMessageListener

    Private Readonly workerNodeStealTask

    Settings

    Member Visibility

    Theme

    On This Page

    constructordestroyingemitterfilePathmaximumNumberOfWorkersminimumNumberOfWorkersoptspromiseResponseMapreadyEventEmittedstartTimestampstartedstartingstartingMinimumNumberOfWorkerstaskFunctionsworkerChoiceStrategiesContextworkerNodesbusyemptyfullinforeadytypeutilizationworkeraddTaskFunctionaddWorkerNodeafterTaskExecutionHookafterWorkerNodeSetupbeforeTaskExecutionHookbuildTasksQueueOptionscannotStealTaskcheckAndEmitDynamicWorkerCreationEventscheckAndEmitEmptyEventcheckAndEmitReadyEventcheckAndEmitTaskExecutionEventscheckAndEmitTaskQueuingEventscheckMessageWorkerIdcheckMinimumNumberOfWorkerscheckPoolOptionscheckPoolTypecheckValidWorkerChoiceStrategyOptionschooseWorkerNodecreateAndSetupDynamicWorkerNodecreateAndSetupWorkerNodecreateWorkerNodedequeueTaskderegisterWorkerMessageListenerdestroydestroyWorkerNodeenableTasksQueueenqueueTaskexecuteexecuteTaskflagWorkerNodeAsNotReadyflushTasksQueueflushTasksQueuesgetTaskFunctionWorkerWorkerChoiceStrategygetWorkerInfogetWorkerNodeKeyByWorkerIdgetWorkerNodeTaskFunctionPrioritygetWorkerWorkerChoiceStrategieshandleTaskhandleTaskExecutionResponsehandleWorkerNodeBackPressureEventhandleWorkerNodeIdleEventhandleWorkerReadyResponsehasBackPressurehasTaskFunctioninitEventEmitterinitWorkerNodeUsageinternalBusyisMainisWorkerNodeBusylistTaskFunctionsPropertiesredistributeQueuedTasksregisterOnceWorkerMessageListenerregisterWorkerMessageListenerremoveTaskFunctionremoveWorkerNoderesetTaskSequentiallyStolenStatisticsWorkerUsagesendKillMessageToWorkersendStartupMessageToWorkersendStatisticsMessageToWorkersendTaskFunctionOperationToWorkersendTaskFunctionOperationToWorkerssendToWorkersetDefaultTaskFunctionsetTaskStealingsetTasksQueueOptionssetTasksQueueSizesetTasksStealingOnBackPressuresetWorkerChoiceStrategysetWorkerChoiceStrategyOptionssetupHookshallCreateDynamicWorkershallExecuteTaskshallUpdateTaskFunctionWorkerUsagestartstartMinimumNumberOfWorkerstasksQueueSizeunsetTaskStealingunsetTasksStealingOnBackPressureupdateTaskSequentiallyStolenStatisticsWorkerUsageupdateTaskStolenStatisticsWorkerUsageworkerMessageListenerworkerNodeStealTask
    \ No newline at end of file diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index a8193e3e..109cecd1 100644 --- a/docs/classes/AbstractWorker.html +++ b/docs/classes/AbstractWorker.html @@ -1,8 +1,8 @@ -AbstractWorker | poolifier - v4.0.5

    Class AbstractWorker<MainWorker, Data, Response>Abstract

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

    +AbstractWorker | poolifier - v4.0.6

    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 (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    activeInterval? id isMain @@ -41,58 +41,58 @@
  • mainWorker: undefined | null | 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: undefined | 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: undefined | null | MainWorker

    Reference to main worker.

    -

    Protected opts

    opts: WorkerOptions = DEFAULT_WORKER_OPTIONS

    Options for the worker.

    -

    Protected Optional statistics

    statistics?: WorkerStatistics

    Performance statistics computation requirements.

    -

    Protected taskFunctions

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

    Task function object(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: undefined | 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: undefined | null | MainWorker

    Reference to main worker.

    +

    Protected opts

    opts: WorkerOptions = DEFAULT_WORKER_OPTIONS

    Options for the worker.

    +

    Protected Optional statistics

    statistics?: WorkerStatistics

    Performance statistics computation requirements.

    +

    Protected taskFunctions

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

    Task function object(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 checkTaskFunctions

    Private checkTaskFunctions

    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

    listTaskFunctionsProperties

    listTaskFunctionsProperties

    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 sendTaskFunctionsPropertiesToMainWorker

    Protected Abstract sendToMainWorker

    • sendToMainWorker(message): void

    • Sends a message to main worker.

      +

    Returns void

    Protected sendTaskFunctionsPropertiesToMainWorker

    Protected Abstract sendToMainWorker

    setDefaultTaskFunction

    Returns void

    setDefaultTaskFunction

    Private startCheckActive

    Private stopCheckActive

    Private updateLastTaskTimestamp

    Settings

    Member Visibility

    Theme

    On This Page

    constructoractiveIntervalidisMainlastTaskTimestampmainWorkeroptsstatisticstaskFunctionsaddTaskFunctionbeginTaskPerformancecheckActivecheckMessageWorkerIdcheckTaskFunctionscheckWorkerOptionsendTaskPerformancegetMainWorkerhandleErrorhandleKillMessagehandleReadyMessagehandleTaskFunctionOperationMessagehasTaskFunctionlistTaskFunctionsPropertiesmessageListenerremoveTaskFunctionrunrunAsyncrunSyncsendTaskFunctionsPropertiesToMainWorkersendToMainWorkersetDefaultTaskFunctionstartCheckActivestopCheckActiveupdateLastTaskTimestamp
    \ No newline at end of file +

    Private startCheckActive

    Private stopCheckActive

    Private updateLastTaskTimestamp

    Settings

    Member Visibility

    Theme

    On This Page

    constructoractiveIntervalidisMainlastTaskTimestampmainWorkeroptsstatisticstaskFunctionsaddTaskFunctionbeginTaskPerformancecheckActivecheckMessageWorkerIdcheckTaskFunctionscheckWorkerOptionsendTaskPerformancegetMainWorkerhandleErrorhandleKillMessagehandleReadyMessagehandleTaskFunctionOperationMessagehasTaskFunctionlistTaskFunctionsPropertiesmessageListenerremoveTaskFunctionrunrunAsyncrunSyncsendTaskFunctionsPropertiesToMainWorkersendToMainWorkersetDefaultTaskFunctionstartCheckActivestopCheckActiveupdateLastTaskTimestamp
    \ No newline at end of file diff --git a/docs/classes/CircularArray.html b/docs/classes/CircularArray.html index 2cccb176..f0b77b9f 100644 --- a/docs/classes/CircularArray.html +++ b/docs/classes/CircularArray.html @@ -1,6 +1,6 @@ -CircularArray | poolifier - v4.0.5

    Class CircularArray<T>Internal

    Array with a maximum length and shifting items when full.

    +CircularArray | poolifier - v4.0.6

    Class CircularArray<T>Internal

    Array with a maximum length and shifting items when full.

    Type Parameters

    • T

      Type of items.

      -

    Hierarchy

    • Array<T>
      • CircularArray

    Constructors

    constructor +

    Hierarchy

    • Array<T>
      • CircularArray

    Constructors

    constructor

    Properties

    [unscopables] length size @@ -45,23 +45,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?): this

    • 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?): this

    • 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 this

    empty

    entries

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

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

      +

    Returns this

    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 @@ -113,7 +113,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.

      @@ -130,7 +130,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.

        @@ -140,7 +140,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.

      @@ -164,9 +164,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

          Returns number

    Returns this

    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

          Returns number

    Returns this

    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.

      @@ -181,4 +181,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

    constructor[unscopables]lengthsize[species][iterator]atcheckSizeconcatcopyWithinemptyentrieseveryfillfilterfindfindIndexflatflatMapforEachfullincludesindexOfjoinkeyslastIndexOfmappoppushreducereduceRightresizereverseshiftslicesomesortsplicetoLocaleStringtoStringunshiftvaluesfromisArrayof
    \ No newline at end of file +

    Returns T[]

    Settings

    Member Visibility

    Theme

    On This Page

    constructor[unscopables]lengthsize[species][iterator]atcheckSizeconcatcopyWithinemptyentrieseveryfillfilterfindfindIndexflatflatMapforEachfullincludesindexOfjoinkeyslastIndexOfmappoppushreducereduceRightresizereverseshiftslicesomesortsplicetoLocaleStringtoStringunshiftvaluesfromisArrayof
    \ No newline at end of file diff --git a/docs/classes/ClusterWorker.html b/docs/classes/ClusterWorker.html index f5fa2d2d..ddc157c4 100644 --- a/docs/classes/ClusterWorker.html +++ b/docs/classes/ClusterWorker.html @@ -1,4 +1,4 @@ -ClusterWorker | poolifier - v4.0.5

    Class ClusterWorker<Data, Response>

    A cluster worker used by a poolifier ClusterPool.

    +ClusterWorker | poolifier - v4.0.6

    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 (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    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: undefined | 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 Optional statistics

    statistics?: WorkerStatistics

    Performance statistics computation requirements.

    -

    Protected taskFunctions

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

    Task function object(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: undefined | 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 Optional statistics

    statistics?: WorkerStatistics

    Performance statistics computation requirements.

    +

    Protected taskFunctions

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

    Task function object(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

    listTaskFunctionsProperties

    listTaskFunctionsProperties

    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 sendTaskFunctionsPropertiesToMainWorker

    Protected Readonly sendToMainWorker

    • sendToMainWorker(message): void

    • Sends a message to main worker.

      +

    Returns void

    Protected sendTaskFunctionsPropertiesToMainWorker

    Protected Readonly sendToMainWorker

    setDefaultTaskFunction

    Returns void

    setDefaultTaskFunction

    Settings

    Member Visibility

    Theme

    On This Page

    constructoractiveIntervalisMainlastTaskTimestampoptsstatisticstaskFunctionsidaddTaskFunctiongetMainWorkerhandleErrorhandleKillMessagehandleReadyMessagehandleTaskFunctionOperationMessagehasTaskFunctionlistTaskFunctionsPropertiesmessageListenerremoveTaskFunctionrunrunAsyncrunSyncsendTaskFunctionsPropertiesToMainWorkersendToMainWorkersetDefaultTaskFunction
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    constructoractiveIntervalisMainlastTaskTimestampoptsstatisticstaskFunctionsidaddTaskFunctiongetMainWorkerhandleErrorhandleKillMessagehandleReadyMessagehandleTaskFunctionOperationMessagehasTaskFunctionlistTaskFunctionsPropertiesmessageListenerremoveTaskFunctionrunrunAsyncrunSyncsendTaskFunctionsPropertiesToMainWorkersendToMainWorkersetDefaultTaskFunction
    \ No newline at end of file diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index 07e6e85d..f064c759 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -1,11 +1,11 @@ -DynamicClusterPool | poolifier - v4.0.5

    Class DynamicClusterPool<Data, Response>

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

    +DynamicClusterPool | poolifier - v4.0.6

    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 (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    emitter? filePath maximumNumberOfWorkers? @@ -59,7 +59,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: ClusterPoolOptions = {}

    Options for this dynamic cluster pool.

    -

    • Returns DynamicClusterPool<Data, Response>

    Properties

    Optional emitter

    emitter?: EventEmitterAsyncResource

    Pool event emitter integrated with async resource. +

    Returns DynamicClusterPool<Data, Response>

    Properties

    Optional emitter

    emitter?: EventEmitterAsyncResource

    Pool event emitter integrated with async resource. The async tracking tooling identifier is poolifier:<PoolType>-<WorkerType>-pool.

    Events that can currently be listened to:

      @@ -72,72 +72,72 @@ 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 maximumNumberOfWorkers

    maximumNumberOfWorkers?: number

    Maximum number of workers that this pool manages.

    -

    Protected Readonly minimumNumberOfWorkers

    minimumNumberOfWorkers: number

    Minimum number of workers that this pool manages.

    -

    Protected Readonly opts

    opts: PoolOptions<Worker>

    Options for the pool.

    -

    Protected promiseResponseMap

    promiseResponseMap: Map<`${string}-${string}-${string}-${string}-${string}`, PromiseResponseWrapper<Response>> = ...

    The task execution response promise map:

    +

    Protected Readonly filePath

    filePath: string

    Path to the worker file.

    +

    Protected Optional Readonly maximumNumberOfWorkers

    maximumNumberOfWorkers?: number

    Maximum number of workers that this pool manages.

    +

    Protected Readonly minimumNumberOfWorkers

    minimumNumberOfWorkers: number

    Minimum number of workers that this pool manages.

    +

    Protected Readonly opts

    opts: PoolOptions<Worker>

    Options for the pool.

    +

    Protected promiseResponseMap

    promiseResponseMap: Map<`${string}-${string}-${string}-${string}-${string}`, PromiseResponseWrapper<Response>> = ...

    The task execution response promise map:

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

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

    -

    Protected Optional workerChoiceStrategiesContext

    workerChoiceStrategiesContext?: WorkerChoiceStrategiesContext<Worker, Data, Response>

    Worker choice strategies context referencing worker choice algorithms implementation.

    -

    Readonly Internal workerNodes

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

    Pool worker nodes.

    -

    Accessors

    Protected busy

    Protected Optional workerChoiceStrategiesContext

    workerChoiceStrategiesContext?: WorkerChoiceStrategiesContext<Worker, Data, Response>

    Worker choice strategies context referencing worker choice algorithms 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 empty

    Protected full

    Protected empty

    Protected full

    • get full(): boolean

    • Whether the pool is full or not.

      The pool filling boolean status.

      -

      Returns boolean

    info

    Private ready

    Protected type

    info

    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

    Protected afterTaskExecutionHook

    • afterTaskExecutionHook(workerNodeKey, message): void

    • Hook executed after the worker task execution. +

    Protected worker

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

    • The worker type.

      +

      Returns "thread" | "cluster"

    Methods

    addTaskFunction

    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 checkAndEmitDynamicWorkerCreationEvents

    Protected createAndSetupDynamicWorkerNode

    • createAndSetupDynamicWorkerNode(): number

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

      +

    Returns void

    Protected checkAndEmitDynamicWorkerCreationEvents

    Protected createAndSetupDynamicWorkerNode

    Protected createAndSetupWorkerNode

    Protected createAndSetupWorkerNode

    Protected deregisterWorkerMessageListener

    Protected deregisterWorkerMessageListener

    destroy

    Protected destroyWorkerNode

    • destroyWorkerNode(workerNodeKey): Promise<void>

    • Terminates the worker node given its worker node key.

      +

    Returns void

    destroy

    Protected destroyWorkerNode

    enableTasksQueue

    execute

    Protected flagWorkerNodeAsNotReady

    Protected flushTasksQueue

    Protected getWorkerInfo

    • getWorkerInfo(workerNodeKey): undefined | WorkerInfo

    • Gets the worker information given its worker node key.

      +

    Returns Promise<void>

    enableTasksQueue

    execute

    Protected flagWorkerNodeAsNotReady

    Protected flushTasksQueue

    Protected getWorkerInfo

    hasTaskFunction

    Protected internalBusy

    hasTaskFunction

    Protected internalBusy

    Protected isMain

    Protected isMain

    listTaskFunctionsProperties

    Protected registerOnceWorkerMessageListener

    listTaskFunctionsProperties

    Protected registerOnceWorkerMessageListener

    Protected registerWorkerMessageListener

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

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

      +

    Returns void

    Protected registerWorkerMessageListener

    removeTaskFunction

    Protected sendStartupMessageToWorker

    • sendStartupMessageToWorker(workerNodeKey): void

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

      +

    Returns void

    removeTaskFunction

    Protected sendStartupMessageToWorker

    Protected sendToWorker

    • sendToWorker(workerNodeKey, message): void

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

      +

    Returns void

    Protected sendToWorker

    setDefaultTaskFunction

    setTasksQueueOptions

    setWorkerChoiceStrategy

    setWorkerChoiceStrategyOptions

    Protected setupHook

    • setupHook(): void

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

    Returns void

    setDefaultTaskFunction

    setTasksQueueOptions

    setWorkerChoiceStrategy

    setWorkerChoiceStrategyOptions

    Protected setupHook

    Protected shallCreateDynamicWorker

    Protected shallCreateDynamicWorker

    start

    Protected Readonly workerMessageListener

    Settings

    Member Visibility

    Theme

    On This Page

    constructoremitterfilePathmaximumNumberOfWorkersminimumNumberOfWorkersoptspromiseResponseMapworkerChoiceStrategiesContextworkerNodesbusyemptyfullinforeadytypeutilizationworkeraddTaskFunctionafterTaskExecutionHookafterWorkerNodeSetupbeforeTaskExecutionHookcheckAndEmitDynamicWorkerCreationEventscreateAndSetupDynamicWorkerNodecreateAndSetupWorkerNodederegisterWorkerMessageListenerdestroydestroyWorkerNodeenableTasksQueueexecuteflagWorkerNodeAsNotReadyflushTasksQueuegetWorkerInfohasTaskFunctioninternalBusyisMainlistTaskFunctionsPropertiesregisterOnceWorkerMessageListenerregisterWorkerMessageListenerremoveTaskFunctionsendStartupMessageToWorkersendToWorkersetDefaultTaskFunctionsetTasksQueueOptionssetWorkerChoiceStrategysetWorkerChoiceStrategyOptionssetupHookshallCreateDynamicWorkerstartworkerMessageListener
    \ No newline at end of file +

    start

    Protected Readonly workerMessageListener

    Settings

    Member Visibility

    Theme

    On This Page

    constructoremitterfilePathmaximumNumberOfWorkersminimumNumberOfWorkersoptspromiseResponseMapworkerChoiceStrategiesContextworkerNodesbusyemptyfullinforeadytypeutilizationworkeraddTaskFunctionafterTaskExecutionHookafterWorkerNodeSetupbeforeTaskExecutionHookcheckAndEmitDynamicWorkerCreationEventscreateAndSetupDynamicWorkerNodecreateAndSetupWorkerNodederegisterWorkerMessageListenerdestroydestroyWorkerNodeenableTasksQueueexecuteflagWorkerNodeAsNotReadyflushTasksQueuegetWorkerInfohasTaskFunctioninternalBusyisMainlistTaskFunctionsPropertiesregisterOnceWorkerMessageListenerregisterWorkerMessageListenerremoveTaskFunctionsendStartupMessageToWorkersendToWorkersetDefaultTaskFunctionsetTasksQueueOptionssetWorkerChoiceStrategysetWorkerChoiceStrategyOptionssetupHookshallCreateDynamicWorkerstartworkerMessageListener
    \ No newline at end of file diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index 1a32c9b6..f70a49d0 100644 --- a/docs/classes/DynamicThreadPool.html +++ b/docs/classes/DynamicThreadPool.html @@ -1,11 +1,11 @@ -DynamicThreadPool | poolifier - v4.0.5

    Class DynamicThreadPool<Data, Response>

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

    +DynamicThreadPool | poolifier - v4.0.6

    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 (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    emitter? filePath maximumNumberOfWorkers? @@ -59,7 +59,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: ThreadPoolOptions = {}

    Options for this dynamic thread pool.

    -

    • Returns DynamicThreadPool<Data, Response>

    Properties

    Optional emitter

    emitter?: EventEmitterAsyncResource

    Pool event emitter integrated with async resource. +

    Returns DynamicThreadPool<Data, Response>

    Properties

    Optional emitter

    emitter?: EventEmitterAsyncResource

    Pool event emitter integrated with async resource. The async tracking tooling identifier is poolifier:<PoolType>-<WorkerType>-pool.

    Events that can currently be listened to:

      @@ -72,73 +72,73 @@ 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 maximumNumberOfWorkers

    maximumNumberOfWorkers?: number

    Maximum number of workers that this pool manages.

    -

    Protected Readonly minimumNumberOfWorkers

    minimumNumberOfWorkers: number

    Minimum number of workers that this pool manages.

    -

    Protected Readonly opts

    opts: PoolOptions<Worker>

    Options for the pool.

    -

    Protected promiseResponseMap

    promiseResponseMap: Map<`${string}-${string}-${string}-${string}-${string}`, PromiseResponseWrapper<Response>> = ...

    The task execution response promise map:

    +

    Protected Readonly filePath

    filePath: string

    Path to the worker file.

    +

    Protected Optional Readonly maximumNumberOfWorkers

    maximumNumberOfWorkers?: number

    Maximum number of workers that this pool manages.

    +

    Protected Readonly minimumNumberOfWorkers

    minimumNumberOfWorkers: number

    Minimum number of workers that this pool manages.

    +

    Protected Readonly opts

    opts: PoolOptions<Worker>

    Options for the pool.

    +

    Protected promiseResponseMap

    promiseResponseMap: Map<`${string}-${string}-${string}-${string}-${string}`, PromiseResponseWrapper<Response>> = ...

    The task execution response promise map:

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

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

    -

    Protected Optional workerChoiceStrategiesContext

    workerChoiceStrategiesContext?: WorkerChoiceStrategiesContext<Worker, Data, Response>

    Worker choice strategies context referencing worker choice algorithms implementation.

    -

    Readonly Internal workerNodes

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

    Pool worker nodes.

    -

    Accessors

    Protected busy

    Protected Optional workerChoiceStrategiesContext

    workerChoiceStrategiesContext?: WorkerChoiceStrategiesContext<Worker, Data, Response>

    Worker choice strategies context referencing worker choice algorithms 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 empty

    Protected full

    Protected empty

    Protected full

    • get full(): boolean

    • Whether the pool is full or not.

      The pool filling boolean status.

      -

      Returns boolean

    info

    Private ready

    Protected type

    info

    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

    Protected afterTaskExecutionHook

    • afterTaskExecutionHook(workerNodeKey, message): void

    • Hook executed after the worker task execution. +

    Protected worker

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

    • The worker type.

      +

      Returns "thread" | "cluster"

    Methods

    addTaskFunction

    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 checkAndEmitDynamicWorkerCreationEvents

    Protected createAndSetupDynamicWorkerNode

    • createAndSetupDynamicWorkerNode(): number

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

      +

    Returns void

    Protected checkAndEmitDynamicWorkerCreationEvents

    Protected createAndSetupDynamicWorkerNode

    Protected createAndSetupWorkerNode

    Protected createAndSetupWorkerNode

    Protected deregisterWorkerMessageListener

    Protected deregisterWorkerMessageListener

    destroy

    Protected destroyWorkerNode

    • destroyWorkerNode(workerNodeKey): Promise<void>

    • Terminates the worker node given its worker node key.

      +

    Returns void

    destroy

    Protected destroyWorkerNode

    enableTasksQueue

    execute

    Protected flagWorkerNodeAsNotReady

    Protected flushTasksQueue

    Protected getWorkerInfo

    • getWorkerInfo(workerNodeKey): undefined | WorkerInfo

    • Gets the worker information given its worker node key.

      +

    Returns Promise<void>

    enableTasksQueue

    execute

    Protected flagWorkerNodeAsNotReady

    Protected flushTasksQueue

    Protected getWorkerInfo

    hasTaskFunction

    Protected internalBusy

    hasTaskFunction

    Protected internalBusy

    Protected isMain

    Protected isMain

    listTaskFunctionsProperties

    Protected registerOnceWorkerMessageListener

    listTaskFunctionsProperties

    Protected registerOnceWorkerMessageListener

    Protected registerWorkerMessageListener

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

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

      +

    Returns void

    Protected registerWorkerMessageListener

    removeTaskFunction

    Protected sendStartupMessageToWorker

    • sendStartupMessageToWorker(workerNodeKey): void

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

      +

    Returns void

    removeTaskFunction

    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: readonly TransferListItem[]

        The optional array of transferable objects.

        -

      Returns void

    setDefaultTaskFunction

    setTasksQueueOptions

    setWorkerChoiceStrategy

    setWorkerChoiceStrategyOptions

    Protected setupHook

    • setupHook(): void

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

    Returns void

    setDefaultTaskFunction

    setTasksQueueOptions

    setWorkerChoiceStrategy

    setWorkerChoiceStrategyOptions

    Protected setupHook

    Protected shallCreateDynamicWorker

    Protected shallCreateDynamicWorker

    start

    Protected Readonly workerMessageListener

    Settings

    Member Visibility

    Theme

    On This Page

    constructoremitterfilePathmaximumNumberOfWorkersminimumNumberOfWorkersoptspromiseResponseMapworkerChoiceStrategiesContextworkerNodesbusyemptyfullinforeadytypeutilizationworkeraddTaskFunctionafterTaskExecutionHookafterWorkerNodeSetupbeforeTaskExecutionHookcheckAndEmitDynamicWorkerCreationEventscreateAndSetupDynamicWorkerNodecreateAndSetupWorkerNodederegisterWorkerMessageListenerdestroydestroyWorkerNodeenableTasksQueueexecuteflagWorkerNodeAsNotReadyflushTasksQueuegetWorkerInfohasTaskFunctioninternalBusyisMainlistTaskFunctionsPropertiesregisterOnceWorkerMessageListenerregisterWorkerMessageListenerremoveTaskFunctionsendStartupMessageToWorkersendToWorkersetDefaultTaskFunctionsetTasksQueueOptionssetWorkerChoiceStrategysetWorkerChoiceStrategyOptionssetupHookshallCreateDynamicWorkerstartworkerMessageListener
    \ No newline at end of file +

    start

    Protected Readonly workerMessageListener

    Settings

    Member Visibility

    Theme

    On This Page

    constructoremitterfilePathmaximumNumberOfWorkersminimumNumberOfWorkersoptspromiseResponseMapworkerChoiceStrategiesContextworkerNodesbusyemptyfullinforeadytypeutilizationworkeraddTaskFunctionafterTaskExecutionHookafterWorkerNodeSetupbeforeTaskExecutionHookcheckAndEmitDynamicWorkerCreationEventscreateAndSetupDynamicWorkerNodecreateAndSetupWorkerNodederegisterWorkerMessageListenerdestroydestroyWorkerNodeenableTasksQueueexecuteflagWorkerNodeAsNotReadyflushTasksQueuegetWorkerInfohasTaskFunctioninternalBusyisMainlistTaskFunctionsPropertiesregisterOnceWorkerMessageListenerregisterWorkerMessageListenerremoveTaskFunctionsendStartupMessageToWorkersendToWorkersetDefaultTaskFunctionsetTasksQueueOptionssetWorkerChoiceStrategysetWorkerChoiceStrategyOptionssetupHookshallCreateDynamicWorkerstartworkerMessageListener
    \ No newline at end of file diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index ad6419cf..ab10b541 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -1,9 +1,9 @@ -FixedClusterPool | poolifier - v4.0.5

    Class FixedClusterPool<Data, Response>

    A cluster pool with a fixed number of workers.

    +FixedClusterPool | poolifier - v4.0.6

    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 (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    emitter? filePath maximumNumberOfWorkers? @@ -56,7 +56,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: ClusterPoolOptions = {}

      Options for this fixed cluster pool.

      -
    • Optional maximumNumberOfWorkers: number

    Returns FixedClusterPool<Data, Response>

    Properties

    Optional emitter

    emitter?: EventEmitterAsyncResource

    Pool event emitter integrated with async resource. +

  • Optional maximumNumberOfWorkers: number

    • Returns FixedClusterPool<Data, Response>

    Properties

    Optional emitter

    emitter?: EventEmitterAsyncResource

    Pool event emitter integrated with async resource. The async tracking tooling identifier is poolifier:<PoolType>-<WorkerType>-pool.

    Events that can currently be listened to:

      @@ -69,72 +69,72 @@ 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 maximumNumberOfWorkers

    maximumNumberOfWorkers?: number

    Maximum number of workers that this pool manages.

    -

    Protected Readonly minimumNumberOfWorkers

    minimumNumberOfWorkers: number

    Minimum number of workers that this pool manages.

    -

    Protected Readonly opts

    opts: PoolOptions<Worker>

    Options for the pool.

    -

    Protected promiseResponseMap

    promiseResponseMap: Map<`${string}-${string}-${string}-${string}-${string}`, PromiseResponseWrapper<Response>> = ...

    The task execution response promise map:

    +

    Protected Readonly filePath

    filePath: string

    Path to the worker file.

    +

    Protected Optional Readonly maximumNumberOfWorkers

    maximumNumberOfWorkers?: number

    Maximum number of workers that this pool manages.

    +

    Protected Readonly minimumNumberOfWorkers

    minimumNumberOfWorkers: number

    Minimum number of workers that this pool manages.

    +

    Protected Readonly opts

    opts: PoolOptions<Worker>

    Options for the pool.

    +

    Protected promiseResponseMap

    promiseResponseMap: Map<`${string}-${string}-${string}-${string}-${string}`, PromiseResponseWrapper<Response>> = ...

    The task execution response promise map:

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

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

    -

    Protected Optional workerChoiceStrategiesContext

    workerChoiceStrategiesContext?: WorkerChoiceStrategiesContext<Worker, Data, Response>

    Worker choice strategies context referencing worker choice algorithms implementation.

    -

    Readonly Internal workerNodes

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

    Pool worker nodes.

    -

    Accessors

    Protected busy

    Protected Optional workerChoiceStrategiesContext

    workerChoiceStrategiesContext?: WorkerChoiceStrategiesContext<Worker, Data, Response>

    Worker choice strategies context referencing worker choice algorithms 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 empty

    Protected full

    Protected empty

    Protected full

    • get full(): boolean

    • Whether the pool is full or not.

      The pool filling boolean status.

      -

      Returns boolean

    info

    Private ready

    Protected type

    info

    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

    Protected afterTaskExecutionHook

    • afterTaskExecutionHook(workerNodeKey, message): void

    • Hook executed after the worker task execution. +

    Protected worker

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

    • The worker type.

      +

      Returns "thread" | "cluster"

    Methods

    addTaskFunction

    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 checkAndEmitDynamicWorkerCreationEvents

    Protected createAndSetupDynamicWorkerNode

    • createAndSetupDynamicWorkerNode(): number

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

      +

    Returns void

    Protected checkAndEmitDynamicWorkerCreationEvents

    Protected createAndSetupDynamicWorkerNode

    Protected createAndSetupWorkerNode

    Protected createAndSetupWorkerNode

    Protected deregisterWorkerMessageListener

    Protected deregisterWorkerMessageListener

    destroy

    Protected destroyWorkerNode

    • destroyWorkerNode(workerNodeKey): Promise<void>

    • Terminates the worker node given its worker node key.

      +

    Returns void

    destroy

    Protected destroyWorkerNode

    enableTasksQueue

    execute

    Protected flagWorkerNodeAsNotReady

    Protected flushTasksQueue

    Protected getWorkerInfo

    • getWorkerInfo(workerNodeKey): undefined | WorkerInfo

    • Gets the worker information given its worker node key.

      +

    Returns Promise<void>

    enableTasksQueue

    execute

    Protected flagWorkerNodeAsNotReady

    Protected flushTasksQueue

    Protected getWorkerInfo

    hasTaskFunction

    Protected internalBusy

    hasTaskFunction

    Protected internalBusy

    Protected isMain

    Protected isMain

    listTaskFunctionsProperties

    Protected registerOnceWorkerMessageListener

    listTaskFunctionsProperties

    Protected registerOnceWorkerMessageListener

    Protected registerWorkerMessageListener

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

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

      +

    Returns void

    Protected registerWorkerMessageListener

    removeTaskFunction

    Protected sendStartupMessageToWorker

    • sendStartupMessageToWorker(workerNodeKey): void

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

      +

    Returns void

    removeTaskFunction

    Protected sendStartupMessageToWorker

    Protected sendToWorker

    • sendToWorker(workerNodeKey, message): void

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

      +

    Returns void

    Protected sendToWorker

    setDefaultTaskFunction

    setTasksQueueOptions

    setWorkerChoiceStrategy

    setWorkerChoiceStrategyOptions

    Protected setupHook

    • setupHook(): void

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

    Returns void

    setDefaultTaskFunction

    setTasksQueueOptions

    setWorkerChoiceStrategy

    setWorkerChoiceStrategyOptions

    Protected setupHook

    Protected shallCreateDynamicWorker

    Protected shallCreateDynamicWorker

    start

    Protected Readonly workerMessageListener

    Settings

    Member Visibility

    Theme

    On This Page

    constructoremitterfilePathmaximumNumberOfWorkersminimumNumberOfWorkersoptspromiseResponseMapworkerChoiceStrategiesContextworkerNodesbusyemptyfullinforeadytypeutilizationworkeraddTaskFunctionafterTaskExecutionHookafterWorkerNodeSetupbeforeTaskExecutionHookcheckAndEmitDynamicWorkerCreationEventscreateAndSetupDynamicWorkerNodecreateAndSetupWorkerNodederegisterWorkerMessageListenerdestroydestroyWorkerNodeenableTasksQueueexecuteflagWorkerNodeAsNotReadyflushTasksQueuegetWorkerInfohasTaskFunctioninternalBusyisMainlistTaskFunctionsPropertiesregisterOnceWorkerMessageListenerregisterWorkerMessageListenerremoveTaskFunctionsendStartupMessageToWorkersendToWorkersetDefaultTaskFunctionsetTasksQueueOptionssetWorkerChoiceStrategysetWorkerChoiceStrategyOptionssetupHookshallCreateDynamicWorkerstartworkerMessageListener
    \ No newline at end of file +

    start

    Protected Readonly workerMessageListener

    Settings

    Member Visibility

    Theme

    On This Page

    constructoremitterfilePathmaximumNumberOfWorkersminimumNumberOfWorkersoptspromiseResponseMapworkerChoiceStrategiesContextworkerNodesbusyemptyfullinforeadytypeutilizationworkeraddTaskFunctionafterTaskExecutionHookafterWorkerNodeSetupbeforeTaskExecutionHookcheckAndEmitDynamicWorkerCreationEventscreateAndSetupDynamicWorkerNodecreateAndSetupWorkerNodederegisterWorkerMessageListenerdestroydestroyWorkerNodeenableTasksQueueexecuteflagWorkerNodeAsNotReadyflushTasksQueuegetWorkerInfohasTaskFunctioninternalBusyisMainlistTaskFunctionsPropertiesregisterOnceWorkerMessageListenerregisterWorkerMessageListenerremoveTaskFunctionsendStartupMessageToWorkersendToWorkersetDefaultTaskFunctionsetTasksQueueOptionssetWorkerChoiceStrategysetWorkerChoiceStrategyOptionssetupHookshallCreateDynamicWorkerstartworkerMessageListener
    \ No newline at end of file diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index 8bae6cd6..e550978e 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.html @@ -1,9 +1,9 @@ -FixedThreadPool | poolifier - v4.0.5

    Class FixedThreadPool<Data, Response>

    A thread pool with a fixed number of threads.

    +FixedThreadPool | poolifier - v4.0.6

    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 (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    emitter? filePath maximumNumberOfWorkers? @@ -56,7 +56,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: ThreadPoolOptions = {}

      Options for this fixed thread pool.

      -
    • Optional maximumNumberOfThreads: number

    Returns FixedThreadPool<Data, Response>

    Properties

    Optional emitter

    emitter?: EventEmitterAsyncResource

    Pool event emitter integrated with async resource. +

  • Optional maximumNumberOfThreads: number

    • Returns FixedThreadPool<Data, Response>

    Properties

    Optional emitter

    emitter?: EventEmitterAsyncResource

    Pool event emitter integrated with async resource. The async tracking tooling identifier is poolifier:<PoolType>-<WorkerType>-pool.

    Events that can currently be listened to:

      @@ -69,73 +69,73 @@ 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 maximumNumberOfWorkers

    maximumNumberOfWorkers?: number

    Maximum number of workers that this pool manages.

    -

    Protected Readonly minimumNumberOfWorkers

    minimumNumberOfWorkers: number

    Minimum number of workers that this pool manages.

    -

    Protected Readonly opts

    opts: PoolOptions<Worker>

    Options for the pool.

    -

    Protected promiseResponseMap

    promiseResponseMap: Map<`${string}-${string}-${string}-${string}-${string}`, PromiseResponseWrapper<Response>> = ...

    The task execution response promise map:

    +

    Protected Readonly filePath

    filePath: string

    Path to the worker file.

    +

    Protected Optional Readonly maximumNumberOfWorkers

    maximumNumberOfWorkers?: number

    Maximum number of workers that this pool manages.

    +

    Protected Readonly minimumNumberOfWorkers

    minimumNumberOfWorkers: number

    Minimum number of workers that this pool manages.

    +

    Protected Readonly opts

    opts: PoolOptions<Worker>

    Options for the pool.

    +

    Protected promiseResponseMap

    promiseResponseMap: Map<`${string}-${string}-${string}-${string}-${string}`, PromiseResponseWrapper<Response>> = ...

    The task execution response promise map:

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

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

    -

    Protected Optional workerChoiceStrategiesContext

    workerChoiceStrategiesContext?: WorkerChoiceStrategiesContext<Worker, Data, Response>

    Worker choice strategies context referencing worker choice algorithms implementation.

    -

    Readonly Internal workerNodes

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

    Pool worker nodes.

    -

    Accessors

    Protected busy

    Protected Optional workerChoiceStrategiesContext

    workerChoiceStrategiesContext?: WorkerChoiceStrategiesContext<Worker, Data, Response>

    Worker choice strategies context referencing worker choice algorithms 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 empty

    Protected full

    Protected empty

    Protected full

    • get full(): boolean

    • Whether the pool is full or not.

      The pool filling boolean status.

      -

      Returns boolean

    info

    Private ready

    Protected type

    info

    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

    Protected afterTaskExecutionHook

    • afterTaskExecutionHook(workerNodeKey, message): void

    • Hook executed after the worker task execution. +

    Protected worker

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

    • The worker type.

      +

      Returns "thread" | "cluster"

    Methods

    addTaskFunction

    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 checkAndEmitDynamicWorkerCreationEvents

    Protected createAndSetupDynamicWorkerNode

    • createAndSetupDynamicWorkerNode(): number

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

      +

    Returns void

    Protected checkAndEmitDynamicWorkerCreationEvents

    Protected createAndSetupDynamicWorkerNode

    Protected createAndSetupWorkerNode

    Protected createAndSetupWorkerNode

    Protected deregisterWorkerMessageListener

    Protected deregisterWorkerMessageListener

    destroy

    Protected destroyWorkerNode

    • destroyWorkerNode(workerNodeKey): Promise<void>

    • Terminates the worker node given its worker node key.

      +

    Returns void

    destroy

    Protected destroyWorkerNode

    enableTasksQueue

    execute

    Protected flagWorkerNodeAsNotReady

    Protected flushTasksQueue

    Protected getWorkerInfo

    • getWorkerInfo(workerNodeKey): undefined | WorkerInfo

    • Gets the worker information given its worker node key.

      +

    Returns Promise<void>

    enableTasksQueue

    execute

    Protected flagWorkerNodeAsNotReady

    Protected flushTasksQueue

    Protected getWorkerInfo

    hasTaskFunction

    Protected internalBusy

    hasTaskFunction

    Protected internalBusy

    Protected isMain

    Protected isMain

    listTaskFunctionsProperties

    Protected registerOnceWorkerMessageListener

    listTaskFunctionsProperties

    Protected registerOnceWorkerMessageListener

    Protected registerWorkerMessageListener

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

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

      +

    Returns void

    Protected registerWorkerMessageListener

    removeTaskFunction

    Protected sendStartupMessageToWorker

    • sendStartupMessageToWorker(workerNodeKey): void

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

      +

    Returns void

    removeTaskFunction

    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: readonly TransferListItem[]

        The optional array of transferable objects.

        -

      Returns void

    setDefaultTaskFunction

    setTasksQueueOptions

    setWorkerChoiceStrategy

    setWorkerChoiceStrategyOptions

    Protected setupHook

    • setupHook(): void

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

    Returns void

    setDefaultTaskFunction

    setTasksQueueOptions

    setWorkerChoiceStrategy

    setWorkerChoiceStrategyOptions

    Protected setupHook

    Protected shallCreateDynamicWorker

    Protected shallCreateDynamicWorker

    start

    Protected Readonly workerMessageListener

    Settings

    Member Visibility

    Theme

    On This Page

    constructoremitterfilePathmaximumNumberOfWorkersminimumNumberOfWorkersoptspromiseResponseMapworkerChoiceStrategiesContextworkerNodesbusyemptyfullinforeadytypeutilizationworkeraddTaskFunctionafterTaskExecutionHookafterWorkerNodeSetupbeforeTaskExecutionHookcheckAndEmitDynamicWorkerCreationEventscreateAndSetupDynamicWorkerNodecreateAndSetupWorkerNodederegisterWorkerMessageListenerdestroydestroyWorkerNodeenableTasksQueueexecuteflagWorkerNodeAsNotReadyflushTasksQueuegetWorkerInfohasTaskFunctioninternalBusyisMainlistTaskFunctionsPropertiesregisterOnceWorkerMessageListenerregisterWorkerMessageListenerremoveTaskFunctionsendStartupMessageToWorkersendToWorkersetDefaultTaskFunctionsetTasksQueueOptionssetWorkerChoiceStrategysetWorkerChoiceStrategyOptionssetupHookshallCreateDynamicWorkerstartworkerMessageListener
    \ No newline at end of file +

    start

    Protected Readonly workerMessageListener

    Settings

    Member Visibility

    Theme

    On This Page

    constructoremitterfilePathmaximumNumberOfWorkersminimumNumberOfWorkersoptspromiseResponseMapworkerChoiceStrategiesContextworkerNodesbusyemptyfullinforeadytypeutilizationworkeraddTaskFunctionafterTaskExecutionHookafterWorkerNodeSetupbeforeTaskExecutionHookcheckAndEmitDynamicWorkerCreationEventscreateAndSetupDynamicWorkerNodecreateAndSetupWorkerNodederegisterWorkerMessageListenerdestroydestroyWorkerNodeenableTasksQueueexecuteflagWorkerNodeAsNotReadyflushTasksQueuegetWorkerInfohasTaskFunctioninternalBusyisMainlistTaskFunctionsPropertiesregisterOnceWorkerMessageListenerregisterWorkerMessageListenerremoveTaskFunctionsendStartupMessageToWorkersendToWorkersetDefaultTaskFunctionsetTasksQueueOptionssetWorkerChoiceStrategysetWorkerChoiceStrategyOptionssetupHookshallCreateDynamicWorkerstartworkerMessageListener
    \ No newline at end of file diff --git a/docs/classes/PriorityQueue.html b/docs/classes/PriorityQueue.html index caeb9a87..e7fa7601 100644 --- a/docs/classes/PriorityQueue.html +++ b/docs/classes/PriorityQueue.html @@ -1,6 +1,6 @@ -PriorityQueue | poolifier - v4.0.5

    Class PriorityQueue<T>Internal

    Priority queue.

    +PriorityQueue | poolifier - v4.0.6

    Class PriorityQueue<T>Internal

    Priority queue.

    Type Parameters

    • T

      Type of priority queue data.

      -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    k maxSize nodeArray @@ -17,27 +17,27 @@

    Type Parameters

    • T

    Parameters

    • k: number = Infinity

      Prioritized bucket size.

    Returns PriorityQueue<T>

    Default Value

    Infinity
    -

    Properties

    Private Readonly k

    k: number

    Prioritized bucket size.

    -

    maxSize

    maxSize: number

    The maximum size of the priority queue.

    -

    Private nodeArray

    nodeArray: PriorityQueueNode<T>[]

    size

    size: number

    The size of the priority queue.

    -

    Accessors

    buckets

    Methods

    [iterator]

    Properties

    Private Readonly k

    k: number

    Prioritized bucket size.

    +

    maxSize

    maxSize: number

    The maximum size of the priority queue.

    +

    Private nodeArray

    nodeArray: PriorityQueueNode<T>[]

    size

    size: number

    The size of the priority queue.

    +

    Accessors

    buckets

    Methods

    [iterator]

    clear

    dequeue

    clear

    dequeue

    • dequeue(bucket?): undefined | T

    • Dequeue data from the priority queue.

      Parameters

      • bucket: number = 0

        The prioritized bucket to dequeue from.

      Returns undefined | T

      The dequeued data or undefined if the priority queue is empty.

      Default Value

      0
      -

    enqueue

    enqueue

    • enqueue(data, priority?): number

    • Enqueue data into the priority queue.

      Parameters

      • data: T

        Data to enqueue.

      • Optional priority: number

        Priority of the data. Lower values have higher priority.

      Returns number

      The new size of the priority queue.

      -

    Private incrementSize

    Private incrementSize

    • incrementSize(): number

    • Increments the size of the priority queue.

      Returns number

      The new size of the priority queue.

      -

    peekFirst

    peekFirst

    • peekFirst(): undefined | T

    • Peeks at the first data.

      Returns undefined | T

      The first data or undefined if the priority queue is empty.

      -

    peekLast

    peekLast

    • peekLast(): undefined | T

    • Peeks at the last data.

      Returns undefined | T

      The last data or undefined if the priority queue is empty.

      -

    Settings

    Member Visibility

    Theme

    On This Page

    constructorkmaxSizenodeArraysizebuckets[iterator]cleardequeueenqueueincrementSizepeekFirstpeekLast
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    constructorkmaxSizenodeArraysizebuckets[iterator]cleardequeueenqueueincrementSizepeekFirstpeekLast
    \ No newline at end of file diff --git a/docs/classes/ThreadWorker.html b/docs/classes/ThreadWorker.html index 9d762d94..74ca7774 100644 --- a/docs/classes/ThreadWorker.html +++ b/docs/classes/ThreadWorker.html @@ -1,4 +1,4 @@ -ThreadWorker | poolifier - v4.0.5

    Class ThreadWorker<Data, Response>

    A thread worker used by a poolifier ThreadPool.

    +ThreadWorker | poolifier - v4.0.6

    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 (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    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: undefined | 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 Optional statistics

    statistics?: WorkerStatistics

    Performance statistics computation requirements.

    -

    Protected taskFunctions

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

    Task function object(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: undefined | 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 Optional statistics

    statistics?: WorkerStatistics

    Performance statistics computation requirements.

    +

    Protected taskFunctions

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

    Task function object(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

    listTaskFunctionsProperties

    listTaskFunctionsProperties

    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 sendTaskFunctionsPropertiesToMainWorker

    Protected Readonly sendToMainWorker

    • sendToMainWorker(message): void

    • Sends a message to main worker.

      +

    Returns void

    Protected sendTaskFunctionsPropertiesToMainWorker

    Protected Readonly sendToMainWorker

    setDefaultTaskFunction

    Returns void

    setDefaultTaskFunction

    Settings

    Member Visibility

    Theme

    On This Page

    constructoractiveIntervalisMainlastTaskTimestampoptsportstatisticstaskFunctionsidaddTaskFunctiongetMainWorkerhandleErrorhandleKillMessagehandleReadyMessagehandleTaskFunctionOperationMessagehasTaskFunctionlistTaskFunctionsPropertiesmessageListenerremoveTaskFunctionrunrunAsyncrunSyncsendTaskFunctionsPropertiesToMainWorkersendToMainWorkersetDefaultTaskFunction
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    constructoractiveIntervalisMainlastTaskTimestampoptsportstatisticstaskFunctionsidaddTaskFunctiongetMainWorkerhandleErrorhandleKillMessagehandleReadyMessagehandleTaskFunctionOperationMessagehasTaskFunctionlistTaskFunctionsPropertiesmessageListenerremoveTaskFunctionrunrunAsyncrunSyncsendTaskFunctionsPropertiesToMainWorkersendToMainWorkersetDefaultTaskFunction
    \ No newline at end of file diff --git a/docs/classes/WorkerChoiceStrategiesContext.html b/docs/classes/WorkerChoiceStrategiesContext.html index 3ef937c0..5333ba27 100644 --- a/docs/classes/WorkerChoiceStrategiesContext.html +++ b/docs/classes/WorkerChoiceStrategiesContext.html @@ -1,8 +1,8 @@ -WorkerChoiceStrategiesContext | poolifier - v4.0.5

    Class WorkerChoiceStrategiesContext<Worker, Data, Response>

    The worker choice strategies context.

    +WorkerChoiceStrategiesContext | poolifier - v4.0.6

    Class WorkerChoiceStrategiesContext<Worker, Data, Response>

    The worker choice strategies 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

    defaultWorkerChoiceStrategy pool retries @@ -27,45 +27,45 @@
  • Optional opts: WorkerChoiceStrategyOptions

    The worker choice strategy options.

    • Returns WorkerChoiceStrategiesContext<Worker, Data, Response>

    Default Value

    [WorkerChoiceStrategies.ROUND_ROBIN]
    -

    Properties

    Private defaultWorkerChoiceStrategy

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

    The default worker choice strategy in the context.

    -

    Private Readonly pool

    pool: IPool<Worker, Data, Response>

    The pool instance.

    -

    Private Readonly retries

    retries: number

    The maximum number of worker choice strategies execution retries.

    -

    retriesCount

    retriesCount: number

    The number of worker choice strategies execution retries.

    -

    Private Readonly workerChoiceStrategies

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

    The worker choice strategies registered in the context.

    -

    Private workerChoiceStrategiesPolicy

    workerChoiceStrategiesPolicy: StrategyPolicy

    The active worker choice strategies in the context policy.

    -

    Private workerChoiceStrategiesTaskStatisticsRequirements

    workerChoiceStrategiesTaskStatisticsRequirements: TaskStatisticsRequirements

    The active worker choice strategies in the context task statistics requirements.

    -

    Methods

    Private addWorkerChoiceStrategy

    Properties

    Private defaultWorkerChoiceStrategy

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

    The default worker choice strategy in the context.

    +

    Private Readonly pool

    pool: IPool<Worker, Data, Response>

    The pool instance.

    +

    Private Readonly retries

    retries: number

    The maximum number of worker choice strategies execution retries.

    +

    retriesCount

    retriesCount: number

    The number of worker choice strategies execution retries.

    +

    Private Readonly workerChoiceStrategies

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

    The worker choice strategies registered in the context.

    +

    Private workerChoiceStrategiesPolicy

    workerChoiceStrategiesPolicy: StrategyPolicy

    The active worker choice strategies in the context policy.

    +

    Private workerChoiceStrategiesTaskStatisticsRequirements

    workerChoiceStrategiesTaskStatisticsRequirements: TaskStatisticsRequirements

    The active worker choice strategies in the context task statistics requirements.

    +

    Methods

    Private addWorkerChoiceStrategy

    • addWorkerChoiceStrategy(workerChoiceStrategy, pool, opts?): Map<"ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN", IWorkerChoiceStrategy>

    • Adds a worker choice strategy to 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 add.

      • pool: IPool<Worker, Data, Response>
      • Optional opts: WorkerChoiceStrategyOptions

        The worker choice strategy options.

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

      The worker choice strategies.

      -

    execute

    execute

    • execute(workerChoiceStrategy?): number

    • Executes the given worker choice strategy in the context algorithm.

      Parameters

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

        The worker choice strategy algorithm to execute.

      Returns number

      The key of the worker node.

      Default Value

      this.defaultWorkerChoiceStrategy

      Throws

      https://nodejs.org/api/errors.html#class-error If after computed retries the worker node key is null or undefined.

      -

    Private executeStrategy

    Private executeStrategy

    getPolicy

    getPolicy

    getTaskStatisticsRequirements

    getTaskStatisticsRequirements

    remove

    remove

    Private removeWorkerChoiceStrategy

    Private removeWorkerChoiceStrategy

    • removeWorkerChoiceStrategy(workerChoiceStrategy): boolean

    • Removes a worker choice strategy from 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 remove.

      Returns boolean

      true if the worker choice strategy is removed, false otherwise.

      -

    setDefaultWorkerChoiceStrategy

    setDefaultWorkerChoiceStrategy

    • setDefaultWorkerChoiceStrategy(workerChoiceStrategy, opts?): void

    • Sets the default 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 default worker choice strategy to set.

      • Optional opts: WorkerChoiceStrategyOptions

        The worker choice strategy options.

        -

      Returns void

    setOptions

    • setOptions(opts): void

    • Sets the active worker choice strategies in the context options.

      +

    Returns void

    setOptions

    syncWorkerChoiceStrategies

    • syncWorkerChoiceStrategies(workerChoiceStrategies, opts?): void

    • Synchronizes the active worker choice strategies in the context with the given worker choice strategies.

      +

    Returns void

    syncWorkerChoiceStrategies

    • syncWorkerChoiceStrategies(workerChoiceStrategies, opts?): void

    • Synchronizes the active worker choice strategies in the context with the given worker choice strategies.

      Parameters

      • workerChoiceStrategies: Set<"ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN">

        The worker choice strategies to synchronize.

      • Optional opts: WorkerChoiceStrategyOptions

        The worker choice strategy options.

        -

      Returns void

    update

    • update(workerNodeKey): boolean

    • Updates the worker node key in the active worker choice strategies in the context internals.

      +

    Returns void

    update

    Settings

    Member Visibility

    Theme

    On This Page

    constructordefaultWorkerChoiceStrategypoolretriesretriesCountworkerChoiceStrategiesworkerChoiceStrategiesPolicyworkerChoiceStrategiesTaskStatisticsRequirementsaddWorkerChoiceStrategyexecuteexecuteStrategygetPolicygetTaskStatisticsRequirementsremoveremoveWorkerChoiceStrategysetDefaultWorkerChoiceStrategysetOptionssyncWorkerChoiceStrategiesupdate
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    constructordefaultWorkerChoiceStrategypoolretriesretriesCountworkerChoiceStrategiesworkerChoiceStrategiesPolicyworkerChoiceStrategiesTaskStatisticsRequirementsaddWorkerChoiceStrategyexecuteexecuteStrategygetPolicygetTaskStatisticsRequirementsremoveremoveWorkerChoiceStrategysetDefaultWorkerChoiceStrategysetOptionssyncWorkerChoiceStrategiesupdate
    \ No newline at end of file diff --git a/docs/functions/availableParallelism.html b/docs/functions/availableParallelism.html index 08622f2e..64a32886 100644 --- a/docs/functions/availableParallelism.html +++ b/docs/functions/availableParallelism.html @@ -1,4 +1,4 @@ -availableParallelism | poolifier - v4.0.5

    Function availableParallelism

    • availableParallelism(): number

    • Returns safe host OS optimized estimate of the default amount of parallelism a pool should use. +availableParallelism | poolifier - v4.0.6

      Function availableParallelism

      • availableParallelism(): number

      • Returns safe host OS optimized estimate of the default amount of parallelism a pool should use. Always returns a value greater than zero.

        Returns number

        The host OS optimized maximum pool size.

        -

      Settings

      Member Visibility

      Theme

      \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/hierarchy.html b/docs/hierarchy.html index 425597d9..1c9eca7b 100644 --- a/docs/hierarchy.html +++ b/docs/hierarchy.html @@ -1 +1 @@ -poolifier - v4.0.5

    poolifier - v4.0.5

    Class Hierarchy

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +poolifier - v4.0.6

    poolifier - v4.0.6

    Class Hierarchy

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index cc1ca7ba..fe02b438 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,4 +1,4 @@ -poolifier - v4.0.5

    poolifier - v4.0.5

    Index

    Classes

    AbstractPool +poolifier - v4.0.6

    poolifier - v4.0.6

    Index

    Classes

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

    Functions

    availableParallelism -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/interfaces/EventLoopUtilizationMeasurementStatistics.html b/docs/interfaces/EventLoopUtilizationMeasurementStatistics.html index cfdd1402..1bd966c4 100644 --- a/docs/interfaces/EventLoopUtilizationMeasurementStatistics.html +++ b/docs/interfaces/EventLoopUtilizationMeasurementStatistics.html @@ -1,5 +1,5 @@ -EventLoopUtilizationMeasurementStatistics | poolifier - v4.0.5

    Interface EventLoopUtilizationMeasurementStatisticsInternal

    Event loop utilization measurement statistics.

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

    Properties

    active +EventLoopUtilizationMeasurementStatistics | poolifier - v4.0.6

    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

    activeidleutilization
    \ 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

    activeidleutilization
    \ No newline at end of file diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index 7f6c4a10..c049d055 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,8 +1,8 @@ -IPool | poolifier - v4.0.5

    Interface IPool<Worker, Data, Response>

    Contract definition for a poolifier pool.

    +IPool | poolifier - v4.0.6

    Interface IPool<Worker, Data, Response>

    Contract definition for a poolifier pool.

    interface IPool<Worker, Data, Response> {
        addTaskFunction: ((name, fn) => Promise<boolean>);
        destroy: (() => Promise<void>);
        emitter?: EventEmitterAsyncResource;
        enableTasksQueue: ((enable, tasksQueueOptions?) => void);
        execute: ((data?, name?, transferList?) => Promise<Response>);
        hasTaskFunction: ((name) => boolean);
        info: PoolInfo;
        listTaskFunctionsProperties: (() => TaskFunctionProperties[]);
        removeTaskFunction: ((name) => Promise<boolean>);
        setDefaultTaskFunction: ((name) => Promise<boolean>);
        setTasksQueueOptions: ((tasksQueueOptions) => void);
        setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void);
        setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => boolean);
        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 @@ -20,12 +20,12 @@

    Properties

    Readonly addTaskFunction

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

    Adds a task function to this pool. If a task function with the same name already exists, it will be overwritten.

    Type declaration

    Returns

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

    Terminates all workers in this pool.

    -

    Type declaration

      • (): Promise<void>

      • Returns Promise<void>

    Optional Readonly emitter

    emitter?: EventEmitterAsyncResource

    Pool event emitter integrated with async resource. +

    Throws

    https://nodejs.org/api/errors.html#class-typeerror If the fn parameter is not a function or task function object.

    +

    Readonly destroy

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

    Terminates all workers in this pool.

    +

    Type declaration

      • (): Promise<void>

      • Returns Promise<void>

    Optional Readonly emitter

    emitter?: EventEmitterAsyncResource

    Pool event emitter integrated with async resource. The async tracking tooling identifier is poolifier:<PoolType>-<WorkerType>-pool.

    Events that can currently be listened to:

      @@ -38,34 +38,34 @@ 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)

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

    +

    Readonly enableTasksQueue

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

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

    Type declaration

      • (enable, tasksQueueOptions?): void

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

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

    +

    Returns void

    Readonly execute

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

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

    Type declaration

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

      • 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: readonly 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>

    Returns

    Promise that will be fulfilled when the task is completed.

    -

    Readonly hasTaskFunction

    hasTaskFunction: ((name) => boolean)

    Whether the specified task function exists in this pool.

    +

    Readonly hasTaskFunction

    hasTaskFunction: ((name) => boolean)

    Whether the specified task function exists in this pool.

    Type declaration

      • (name): boolean

      • Parameters

        • name: string

          The name of the task function.

        Returns boolean

    Returns

    true if the task function exists, false otherwise.

    -

    Readonly info

    info: PoolInfo

    Pool information.

    -

    Readonly listTaskFunctionsProperties

    listTaskFunctionsProperties: (() => TaskFunctionProperties[])

    Lists the properties of task functions available in this pool.

    +

    Readonly info

    info: PoolInfo

    Pool information.

    +

    Readonly listTaskFunctionsProperties

    listTaskFunctionsProperties: (() => TaskFunctionProperties[])

    Lists the properties of task functions available in this pool.

    Type declaration

    Returns

    The properties of task functions available in this pool.

    -

    Readonly removeTaskFunction

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

    Removes a task function from this pool.

    +

    Readonly removeTaskFunction

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

    Removes a task function from this pool.

    Type declaration

      • (name): Promise<boolean>

      • Parameters

        • name: string

          The name of the task function.

        Returns Promise<boolean>

    Returns

    true if the task function was removed, false otherwise.

    -

    Readonly setDefaultTaskFunction

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

    Sets the default task function in this pool.

    +

    Readonly setDefaultTaskFunction

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

    Sets the default task function in this pool.

    Type declaration

      • (name): Promise<boolean>

      • Parameters

        • name: string

          The name of the task function.

        Returns Promise<boolean>

    Returns

    true if the default task function was set, false otherwise.

    -

    Readonly setTasksQueueOptions

    setTasksQueueOptions: ((tasksQueueOptions) => void)

    Sets the worker node tasks queue options in this pool.

    +

    Readonly setTasksQueueOptions

    setTasksQueueOptions: ((tasksQueueOptions) => void)

    Sets the worker node tasks queue options in this pool.

    Type declaration

      • (tasksQueueOptions): void

      • Parameters

        Returns void

    Readonly setWorkerChoiceStrategy

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

    Sets the default worker choice strategy in this pool.

    +

    Returns void

    Readonly setWorkerChoiceStrategy

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

    Sets the default worker choice strategy in this pool.

    Type declaration

      • (workerChoiceStrategy, workerChoiceStrategyOptions?): void

      • Parameters

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

          The default worker choice strategy.

        • Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptions

          The worker choice strategy options.

          -

        Returns void

    Readonly setWorkerChoiceStrategyOptions

    setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => boolean)

    Sets the worker choice strategy options in this pool.

    +

    Returns void

    Readonly setWorkerChoiceStrategyOptions

    setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => boolean)

    Sets the worker choice strategy options in this pool.

    Type declaration

      • (workerChoiceStrategyOptions): boolean

      • Parameters

        Returns boolean

    Returns

    true if the worker choice strategy options were set, false otherwise.

    -

    Readonly start

    start: (() => void)

    Starts the minimum number of workers in this pool.

    -

    Type declaration

      • (): void

      • Returns void

    Readonly Internal workerNodes

    workerNodes: IWorkerNode<Worker, Data>[]

    Pool worker nodes.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    addTaskFunctiondestroyemitterenableTasksQueueexecutehasTaskFunctioninfolistTaskFunctionsPropertiesremoveTaskFunctionsetDefaultTaskFunctionsetTasksQueueOptionssetWorkerChoiceStrategysetWorkerChoiceStrategyOptionsstartworkerNodes
    \ No newline at end of file +

    Readonly start

    start: (() => void)

    Starts the minimum number of workers in this pool.

    +

    Type declaration

      • (): void

      • Returns void

    Readonly Internal workerNodes

    workerNodes: IWorkerNode<Worker, Data>[]

    Pool worker nodes.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    addTaskFunctiondestroyemitterenableTasksQueueexecutehasTaskFunctioninfolistTaskFunctionsPropertiesremoveTaskFunctionsetDefaultTaskFunctionsetTasksQueueOptionssetWorkerChoiceStrategysetWorkerChoiceStrategyOptionsstartworkerNodes
    \ No newline at end of file diff --git a/docs/interfaces/IWorker.html b/docs/interfaces/IWorker.html index dfbb6103..9d347661 100644 --- a/docs/interfaces/IWorker.html +++ b/docs/interfaces/IWorker.html @@ -1,5 +1,5 @@ -IWorker | poolifier - v4.0.5

    Interface IWorker

    Worker interface.

    -
    interface IWorker {
        disconnect?: (() => void);
        id?: number;
        kill?: ((signal?) => void);
        on: ((event, handler) => this);
        once: ((event, handler) => this);
        terminate?: (() => Promise<number>);
        threadId?: number;
        unref?: (() => void);
        [captureRejectionSymbol]?<K>(error, event, ...args): void;
        addListener<K>(eventName, listener): this;
        emit<K>(eventName, ...args): boolean;
        eventNames(): (string | symbol)[];
        getMaxListeners(): number;
        listenerCount<K>(eventName, listener?): number;
        listeners<K>(eventName): Function[];
        off<K>(eventName, listener): this;
        prependListener<K>(eventName, listener): this;
        prependOnceListener<K>(eventName, listener): this;
        rawListeners<K>(eventName): Function[];
        removeAllListeners(eventName?): this;
        removeListener<K>(eventName, listener): this;
        setMaxListeners(n): this;
    }

    Hierarchy

    • EventEmitter
      • IWorker

    Properties

    disconnect? +IWorker | poolifier - v4.0.6

    Interface IWorker

    Worker interface.

    +
    interface IWorker {
        disconnect?: (() => void);
        id?: number;
        kill?: ((signal?) => void);
        on: ((event, handler) => this);
        once: ((event, handler) => this);
        terminate?: (() => Promise<number>);
        threadId?: number;
        unref?: (() => void);
        [captureRejectionSymbol]?<K>(error, event, ...args): void;
        addListener<K>(eventName, listener): this;
        emit<K>(eventName, ...args): boolean;
        eventNames(): (string | symbol)[];
        getMaxListeners(): number;
        listenerCount<K>(eventName, listener?): number;
        listeners<K>(eventName): Function[];
        off<K>(eventName, listener): this;
        prependListener<K>(eventName, listener): this;
        prependOnceListener<K>(eventName, listener): this;
        rawListeners<K>(eventName): Function[];
        removeAllListeners(eventName?): this;
        removeListener<K>(eventName, listener): this;
        setMaxListeners(n): this;
    }

    Hierarchy

    • EventEmitter
      • IWorker

    Properties

    disconnect? id? kill? on @@ -22,21 +22,21 @@ removeListener setMaxListeners

    Properties

    Optional Readonly disconnect

    disconnect?: (() => void)

    Cluster worker disconnect.

    -

    Type declaration

      • (): void

      • Returns void

    Optional Readonly id

    id?: number

    Cluster worker id.

    -

    Optional Readonly kill

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

    Cluster worker kill.

    -

    Type declaration

      • (signal?): void

      • Parameters

        • Optional signal: string

        Returns void

    Readonly on

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

    Registers an event handler.

    +

    Type declaration

      • (): void

      • Returns void

    Optional Readonly id

    id?: number

    Cluster worker id.

    +

    Optional Readonly kill

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

    Cluster worker kill.

    +

    Type declaration

      • (signal?): void

      • Parameters

        • Optional signal: string

        Returns void

    Readonly on

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

    Registers an event handler.

    Type declaration

      • (event, handler): this

      • Parameters

        Returns this

    Readonly once

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

    Registers once an event handler.

    +

    Returns this

    Readonly once

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

    Registers once an event handler.

    Type declaration

      • (event, handler): this

      • Parameters

        Returns this

    Optional Readonly terminate

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

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

    Returns this

    Optional Readonly terminate

    terminate?: (() => 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.

    -

    Type declaration

      • (): Promise<number>

      • Returns Promise<number>

    Optional Readonly threadId

    threadId?: number

    Worker thread worker id.

    -

    Optional Readonly unref

    unref?: (() => void)

    Calling unref() on a worker allows the thread to exit if this is the only +

    Type declaration

      • (): Promise<number>

      • Returns Promise<number>

    Optional Readonly threadId

    threadId?: number

    Worker thread worker id.

    +

    Optional Readonly unref

    unref?: (() => void)

    Calling unref() on a worker allows the thread to exit if this is the only active handle in the event system. If the worker is already unref()ed callingunref() again has no effect.

    Type declaration

      • (): void

      • Returns void

    Since

    v10.5.0

    -

    Methods

    Optional [captureRejectionSymbol]

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

    • Type Parameters

      • K

      Parameters

      • error: Error
      • event: string | symbol
      • Rest ...args: AnyRest

      Returns void

    addListener

    Methods

    Optional [captureRejectionSymbol]

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

    • Type Parameters

      • K

      Parameters

      • error: Error
      • event: string | symbol
      • Rest ...args: AnyRest

      Returns void

    addListener

    • addListener<K>(eventName, listener): this

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

      Type Parameters

      • K

      Parameters

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

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns this

      Since

      v0.1.26

    emit

    • emit<K>(eventName, ...args): boolean

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

      @@ -123,4 +123,4 @@ memory leaks. The emitter.setMaxListeners() method allows the limit modified for this specific EventEmitter instance. The value can be set to Infinity (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 this

      Since

      v0.3.5

      -

    Settings

    Member Visibility

    Theme

    On This Page

    disconnectidkillononceterminatethreadIdunref[captureRejectionSymbol]addListeneremiteventNamesgetMaxListenerslistenerCountlistenersoffprependListenerprependOnceListenerrawListenersremoveAllListenersremoveListenersetMaxListeners
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    disconnectidkillononceterminatethreadIdunref[captureRejectionSymbol]addListeneremiteventNamesgetMaxListenerslistenerCountlistenersoffprependListenerprependOnceListenerrawListenersremoveAllListenersremoveListenersetMaxListeners
    \ No newline at end of file diff --git a/docs/interfaces/IWorkerChoiceStrategy.html b/docs/interfaces/IWorkerChoiceStrategy.html index c2969107..be9e5eb3 100644 --- a/docs/interfaces/IWorkerChoiceStrategy.html +++ b/docs/interfaces/IWorkerChoiceStrategy.html @@ -1,5 +1,5 @@ -IWorkerChoiceStrategy | poolifier - v4.0.5

    Interface IWorkerChoiceStrategyInternal

    Worker choice strategy interface.

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

    Properties

    choose +IWorkerChoiceStrategy | poolifier - v4.0.6

    Interface IWorkerChoiceStrategyInternal

    Worker choice strategy interface.

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

    Properties

    choose remove reset setOptions @@ -10,16 +10,16 @@ If no worker nodes are not eligible, undefined is returned. If undefined is returned, the caller retry.

    Type declaration

      • (): undefined | number

      • Returns undefined | number

    Returns

    The worker node key or undefined.

    -

    Readonly remove

    remove: ((workerNodeKey) => boolean)

    Removes the worker node key from strategy internals.

    +

    Readonly remove

    remove: ((workerNodeKey) => boolean)

    Removes the worker node key from strategy internals.

    Type declaration

      • (workerNodeKey): boolean

      • Parameters

        • workerNodeKey: number

          The worker node key.

        Returns boolean

    Returns

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

    -

    Readonly reset

    reset: (() => boolean)

    Resets strategy internals.

    +

    Readonly reset

    reset: (() => boolean)

    Resets strategy internals.

    Type declaration

      • (): boolean

      • Returns boolean

    Returns

    true if the reset is successful, false otherwise.

    -

    Readonly setOptions

    setOptions: ((opts) => void)

    Sets the worker choice strategy options.

    +

    Readonly setOptions

    setOptions: ((opts) => void)

    Sets the worker choice strategy options.

    Type declaration

    Readonly strategyPolicy

    strategyPolicy: StrategyPolicy

    Strategy policy.

    -

    Readonly taskStatisticsRequirements

    taskStatisticsRequirements: TaskStatisticsRequirements

    Tasks statistics requirements.

    -

    Readonly update

    update: ((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)

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

    Type declaration

      • (workerNodeKey): boolean

      • Parameters

        • workerNodeKey: number

        Returns boolean

    Returns

    true if the update is successful, false otherwise.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    chooseremoveresetsetOptionsstrategyPolicytaskStatisticsRequirementsupdate
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    chooseremoveresetsetOptionsstrategyPolicytaskStatisticsRequirementsupdate
    \ No newline at end of file diff --git a/docs/interfaces/IWorkerNode.html b/docs/interfaces/IWorkerNode.html index 074be2a9..808b6969 100644 --- a/docs/interfaces/IWorkerNode.html +++ b/docs/interfaces/IWorkerNode.html @@ -1,7 +1,7 @@ -IWorkerNode | poolifier - v4.0.5

    Interface IWorkerNode<Worker, Data>Internal

    Worker node interface.

    +IWorkerNode | poolifier - v4.0.6

    Interface IWorkerNode<Worker, Data>Internal

    Worker node interface.

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

    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 dequeueLastPrioritizedTask dequeueTask @@ -35,42 +35,42 @@ removeListener setMaxListeners

    Properties

    Readonly clearTasksQueue

    clearTasksQueue: (() => void)

    Clears tasks queue.

    -

    Type declaration

      • (): void

      • Returns void

    Readonly deleteTaskFunctionWorkerUsage

    deleteTaskFunctionWorkerUsage: ((name) => boolean)

    Deletes task function worker usage statistics.

    +

    Type declaration

      • (): void

      • Returns void

    Readonly deleteTaskFunctionWorkerUsage

    deleteTaskFunctionWorkerUsage: ((name) => boolean)

    Deletes task function worker usage statistics.

    Type declaration

      • (name): boolean

      • Parameters

        • name: string

          The task function name.

        Returns boolean

    Returns

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

    -

    Readonly dequeueLastPrioritizedTask

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

    Dequeue last prioritized task.

    +

    Readonly dequeueLastPrioritizedTask

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

    Dequeue last prioritized task.

    Type declaration

    Returns

    The dequeued task.

    -

    Readonly dequeueTask

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

    Dequeue task.

    +

    Readonly dequeueTask

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

    Dequeue task.

    Type declaration

      • (bucket?): undefined | Task<Data>

      • Parameters

        • Optional bucket: number

          The prioritized bucket to dequeue from.

        Returns undefined | Task<Data>

    Default Value

    0

    Returns

    The dequeued task.

    -

    Readonly enqueueTask

    enqueueTask: ((task) => number)

    Enqueue task.

    +

    Readonly enqueueTask

    enqueueTask: ((task) => number)

    Enqueue task.

    Type declaration

      • (task): number

      • Parameters

        Returns number

    Returns

    The tasks queue size.

    -

    Readonly getTaskFunctionWorkerUsage

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

    Gets task function worker usage statistics.

    +

    Readonly getTaskFunctionWorkerUsage

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

    Gets task function worker usage statistics.

    Type declaration

    Returns

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

    -

    Readonly hasBackPressure

    hasBackPressure: (() => boolean)

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

    +

    Readonly hasBackPressure

    hasBackPressure: (() => boolean)

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

    Type declaration

      • (): boolean

      • Returns boolean

    Returns

    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 registerOnceWorkerEventHandler

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

    Registers once a worker event handler.

    +

    Readonly info

    info: WorkerInfo

    Worker info.

    +

    Optional Readonly messageChannel

    messageChannel?: MessageChannel

    Message channel (worker thread only).

    +

    Readonly registerOnceWorkerEventHandler

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

    Registers once a worker event handler.

    Type declaration

      • (event, handler): void

      • Parameters

        Returns void

    Readonly registerWorkerEventHandler

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

    Registers a worker event handler.

    +

    Returns void

    Readonly registerWorkerEventHandler

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

    Registers a worker event handler.

    Type declaration

      • (event, handler): void

      • Parameters

        Returns void

    Optional strategyData

    strategyData?: StrategyData

    Worker choice strategy data. +

    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)

    Tasks queue size.

    +

    Readonly tasksQueueSize

    tasksQueueSize: (() => number)

    Tasks queue size.

    Type declaration

      • (): number

      • Returns number

    Returns

    The tasks queue size.

    -

    Readonly terminate

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

    Terminates the worker node.

    -

    Type declaration

      • (): Promise<void>

      • Returns Promise<void>

    Readonly usage

    usage: WorkerUsage

    Worker usage statistics.

    -

    Readonly worker

    worker: Worker

    Worker.

    -

    Methods

    Optional [captureRejectionSymbol]

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

    • Type Parameters

      • K

      Parameters

      • error: Error
      • event: string | symbol
      • Rest ...args: AnyRest

      Returns void

    addListener

    Readonly terminate

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

    Terminates the worker node.

    +

    Type declaration

      • (): Promise<void>

      • Returns Promise<void>

    Readonly usage

    usage: WorkerUsage

    Worker usage statistics.

    +

    Readonly worker

    worker: Worker

    Worker.

    +

    Methods

    Optional [captureRejectionSymbol]

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

    • Type Parameters

      • K

      Parameters

      • error: Error
      • event: string | symbol
      • Rest ...args: AnyRest

      Returns void

    addListener

    • addListener<K>(eventName, listener): this

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

      Type Parameters

      • K

      Parameters

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

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns this

      Since

      v0.1.26

    emit

    • emit<K>(eventName, ...args): boolean

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

      @@ -183,4 +183,4 @@ memory leaks. The emitter.setMaxListeners() method allows the limit modified for this specific EventEmitter instance. The value can be set to Infinity (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 this

      Since

      v0.3.5

      -

    Settings

    Member Visibility

    Theme

    On This Page

    clearTasksQueuedeleteTaskFunctionWorkerUsagedequeueLastPrioritizedTaskdequeueTaskenqueueTaskgetTaskFunctionWorkerUsagehasBackPressureinfomessageChannelregisterOnceWorkerEventHandlerregisterWorkerEventHandlerstrategyDatatasksQueueBackPressureSizetasksQueueSizeterminateusageworker[captureRejectionSymbol]addListeneremiteventNamesgetMaxListenerslistenerCountlistenersoffononceprependListenerprependOnceListenerrawListenersremoveAllListenersremoveListenersetMaxListeners
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    clearTasksQueuedeleteTaskFunctionWorkerUsagedequeueLastPrioritizedTaskdequeueTaskenqueueTaskgetTaskFunctionWorkerUsagehasBackPressureinfomessageChannelregisterOnceWorkerEventHandlerregisterWorkerEventHandlerstrategyDatatasksQueueBackPressureSizetasksQueueSizeterminateusageworker[captureRejectionSymbol]addListeneremiteventNamesgetMaxListenerslistenerCountlistenersoffononceprependListenerprependOnceListenerrawListenersremoveAllListenersremoveListenersetMaxListeners
    \ No newline at end of file diff --git a/docs/interfaces/MeasurementOptions.html b/docs/interfaces/MeasurementOptions.html index 13121441..14a5fe96 100644 --- a/docs/interfaces/MeasurementOptions.html +++ b/docs/interfaces/MeasurementOptions.html @@ -1,4 +1,4 @@ -MeasurementOptions | poolifier - v4.0.5

    Interface MeasurementOptions

    Measurement options.

    -
    interface MeasurementOptions {
        median: boolean;
    }

    Properties

    median +MeasurementOptions | poolifier - v4.0.6

    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

    median
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    median
    \ No newline at end of file diff --git a/docs/interfaces/MeasurementStatistics.html b/docs/interfaces/MeasurementStatistics.html index 7259060a..e62290bf 100644 --- a/docs/interfaces/MeasurementStatistics.html +++ b/docs/interfaces/MeasurementStatistics.html @@ -1,14 +1,14 @@ -MeasurementStatistics | poolifier - v4.0.5

    Interface MeasurementStatisticsInternal

    Measurement statistics.

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

    Properties

    aggregate? +MeasurementStatistics | poolifier - v4.0.6

    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

    aggregateaveragehistorymaximummedianminimum
    \ 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

    aggregateaveragehistorymaximummedianminimum
    \ No newline at end of file diff --git a/docs/interfaces/MeasurementStatisticsRequirements.html b/docs/interfaces/MeasurementStatisticsRequirements.html index 359cf53b..b9abda8f 100644 --- a/docs/interfaces/MeasurementStatisticsRequirements.html +++ b/docs/interfaces/MeasurementStatisticsRequirements.html @@ -1,8 +1,8 @@ -MeasurementStatisticsRequirements | poolifier - v4.0.5

    Interface MeasurementStatisticsRequirementsInternal

    Measurement statistics requirements.

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

    Properties

    aggregate +MeasurementStatisticsRequirements | poolifier - v4.0.6

    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

    aggregateaveragemedian
    \ 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

    aggregateaveragemedian
    \ No newline at end of file diff --git a/docs/interfaces/MessageValue.html b/docs/interfaces/MessageValue.html index c2a0ac81..d1d63730 100644 --- a/docs/interfaces/MessageValue.html +++ b/docs/interfaces/MessageValue.html @@ -1,7 +1,7 @@ -MessageValue | poolifier - v4.0.5

    Interface MessageValue<Data, ErrorData>Internal

    Message object that is passed between main worker and worker.

    +MessageValue | poolifier - v4.0.6

    Interface MessageValue<Data, ErrorData>Internal

    Message object that is passed between main worker and worker.

    interface MessageValue<Data, ErrorData> {
        checkActive?: boolean;
        data?: Data;
        kill?: true | "success" | "SOFT" | "HARD" | "failure";
        name?: string;
        port?: MessagePort;
        priority?: number;
        ready?: boolean;
        statistics?: WorkerStatistics;
        strategy?: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN";
        taskFunction?: string;
        taskFunctionOperation?: "add" | "default" | "remove";
        taskFunctionOperationStatus?: boolean;
        taskFunctionProperties?: TaskFunctionProperties;
        taskFunctionsProperties?: TaskFunctionProperties[];
        taskId?: `${string}-${string}-${string}-${string}-${string}`;
        taskPerformance?: TaskPerformance;
        timestamp?: number;
        transferList?: readonly 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 (view full)

    Properties

    checkActive? +

    Hierarchy (view full)

    Properties

    checkActive? data? kill? name? @@ -22,30 +22,30 @@ 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 priority

    priority?: number

    Task priority. Lower values have higher priority.

    +

    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 priority

    priority?: number

    Task priority. Lower values have higher priority.

    Default Value

    0
    -

    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 strategy

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

    Task worker choice strategy.

    -

    Optional Readonly taskFunction

    taskFunction?: string

    Task function serialized to string.

    -

    Optional Readonly taskFunctionOperation

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

    Task function operation:

    +

    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 strategy

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

    Task worker choice strategy.

    +

    Optional Readonly taskFunction

    taskFunction?: string

    Task function serialized to string.

    +

    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 taskFunctionProperties

    taskFunctionProperties?: TaskFunctionProperties

    Task function properties.

    -

    Optional Readonly taskFunctionsProperties

    taskFunctionsProperties?: TaskFunctionProperties[]

    Task functions properties.

    -

    Optional Readonly taskId

    taskId?: `${string}-${string}-${string}-${string}-${string}`

    Task UUID.

    -

    Optional Readonly taskPerformance

    taskPerformance?: TaskPerformance

    Task performance.

    -

    Optional Readonly timestamp

    timestamp?: number

    Timestamp.

    -

    Optional Readonly transferList

    transferList?: readonly 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

    checkActivedatakillnameportpriorityreadystatisticsstrategytaskFunctiontaskFunctionOperationtaskFunctionOperationStatustaskFunctionPropertiestaskFunctionsPropertiestaskIdtaskPerformancetimestamptransferListworkerErrorworkerId
    \ No newline at end of file +

    Optional Readonly taskFunctionOperationStatus

    taskFunctionOperationStatus?: boolean

    Whether the task function operation is successful or not.

    +

    Optional Readonly taskFunctionProperties

    taskFunctionProperties?: TaskFunctionProperties

    Task function properties.

    +

    Optional Readonly taskFunctionsProperties

    taskFunctionsProperties?: TaskFunctionProperties[]

    Task functions properties.

    +

    Optional Readonly taskId

    taskId?: `${string}-${string}-${string}-${string}-${string}`

    Task UUID.

    +

    Optional Readonly taskPerformance

    taskPerformance?: TaskPerformance

    Task performance.

    +

    Optional Readonly timestamp

    timestamp?: number

    Timestamp.

    +

    Optional Readonly transferList

    transferList?: readonly 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

    checkActivedatakillnameportpriorityreadystatisticsstrategytaskFunctiontaskFunctionOperationtaskFunctionOperationStatustaskFunctionPropertiestaskFunctionsPropertiestaskIdtaskPerformancetimestamptransferListworkerErrorworkerId
    \ No newline at end of file diff --git a/docs/interfaces/PoolInfo.html b/docs/interfaces/PoolInfo.html index 06f7fdc8..73824fa4 100644 --- a/docs/interfaces/PoolInfo.html +++ b/docs/interfaces/PoolInfo.html @@ -1,5 +1,5 @@ -PoolInfo | poolifier - v4.0.5

    Interface PoolInfo

    Pool information.

    -
    interface PoolInfo {
        backPressure?: boolean;
        busyWorkerNodes: number;
        defaultStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN";
        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;
        stealingWorkerNodes?: number;
        stolenTasks?: number;
        strategyRetries: number;
        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 - v4.0.6

    Interface PoolInfo

    Pool information.

    +
    interface PoolInfo {
        backPressure?: boolean;
        busyWorkerNodes: number;
        defaultStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN";
        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;
        stealingWorkerNodes?: number;
        stolenTasks?: number;
        strategyRetries: number;
        type: "fixed" | "dynamic";
        utilization?: number;
        version: string;
        waitTime?: {
            average?: number;
            maximum: number;
            median?: number;
            minimum: number;
        };
        worker: "thread" | "cluster";
        workerNodes: number;
    }

    Properties

    backPressure? busyWorkerNodes defaultStrategy executedTasks @@ -22,9 +22,9 @@ waitTime? worker workerNodes -

    Properties

    Optional Readonly backPressure

    backPressure?: boolean

    Readonly busyWorkerNodes

    busyWorkerNodes: number

    Pool busy worker nodes.

    -

    Readonly defaultStrategy

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

    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 stealingWorkerNodes

    stealingWorkerNodes?: number

    Pool stealing worker nodes.

    -

    Optional Readonly stolenTasks

    stolenTasks?: number

    Readonly strategyRetries

    strategyRetries: number

    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

    backPressurebusyWorkerNodesdefaultStrategyexecutedTasksexecutingTasksfailedTasksidleWorkerNodesmaxQueuedTasksmaxSizeminSizequeuedTasksreadyrunTimestartedstealingWorkerNodesstolenTasksstrategyRetriestypeutilizationversionwaitTimeworkerworkerNodes
    \ No newline at end of file +

    Properties

    Optional Readonly backPressure

    backPressure?: boolean

    Readonly busyWorkerNodes

    busyWorkerNodes: number

    Pool busy worker nodes.

    +

    Readonly defaultStrategy

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

    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 stealingWorkerNodes

    stealingWorkerNodes?: number

    Pool stealing worker nodes.

    +

    Optional Readonly stolenTasks

    stolenTasks?: number

    Readonly strategyRetries

    strategyRetries: number

    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

    backPressurebusyWorkerNodesdefaultStrategyexecutedTasksexecutingTasksfailedTasksidleWorkerNodesmaxQueuedTasksmaxSizeminSizequeuedTasksreadyrunTimestartedstealingWorkerNodesstolenTasksstrategyRetriestypeutilizationversionwaitTimeworkerworkerNodes
    \ No newline at end of file diff --git a/docs/interfaces/PoolOptions.html b/docs/interfaces/PoolOptions.html index ffa1ef78..4eef088c 100644 --- a/docs/interfaces/PoolOptions.html +++ b/docs/interfaces/PoolOptions.html @@ -1,6 +1,6 @@ -PoolOptions | poolifier - v4.0.5

    Interface PoolOptions<Worker>

    Options for a poolifier pool.

    +PoolOptions | poolifier - v4.0.6

    Interface PoolOptions<Worker>

    Options for a poolifier pool.

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

    Type Parameters

    • Worker extends IWorker

      Type of worker.

      -

    Properties

    enableEvents? +

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

    Default Value

    WorkerChoiceStrategies.ROUND_ROBIN
    -

    Optional workerChoiceStrategyOptions

    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions

    The worker choice strategy options.

    -

    Optional workerOptions

    workerOptions?: WorkerOptions

    Worker options.

    +

    Optional workerChoiceStrategyOptions

    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions

    The worker choice strategy options.

    +

    Optional workerOptions

    workerOptions?: WorkerOptions

    Worker options.

    See

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

    -

    Settings

    Member Visibility

    Theme

    On This Page

    enableEventsenableTasksQueueenverrorHandlerexitHandlermessageHandleronlineHandlerrestartWorkerOnErrorsettingsstartWorkerstasksQueueOptionsworkerChoiceStrategyworkerChoiceStrategyOptionsworkerOptions
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    enableEventsenableTasksQueueenverrorHandlerexitHandlermessageHandleronlineHandlerrestartWorkerOnErrorsettingsstartWorkerstasksQueueOptionsworkerChoiceStrategyworkerChoiceStrategyOptionsworkerOptions
    \ No newline at end of file diff --git a/docs/interfaces/PriorityQueueNode.html b/docs/interfaces/PriorityQueueNode.html index ca16fdef..857c5760 100644 --- a/docs/interfaces/PriorityQueueNode.html +++ b/docs/interfaces/PriorityQueueNode.html @@ -1,5 +1,5 @@ -PriorityQueueNode | poolifier - v4.0.5

    Interface PriorityQueueNode<T>Internal

    Priority queue node.

    +PriorityQueueNode | poolifier - v4.0.6

    Interface PriorityQueueNode<T>Internal

    Priority queue node.

    interface PriorityQueueNode<T> {
        data: T;
        priority: number;
    }

    Type Parameters

    • T

      Type of priority queue node data.

      -

    Properties

    data +

    Properties

    data priority -

    Properties

    data

    data: T

    priority

    priority: number

    Settings

    Member Visibility

    Theme

    On This Page

    datapriority
    \ No newline at end of file +

    Properties

    data

    data: T

    priority

    priority: number

    Settings

    Member Visibility

    Theme

    On This Page

    datapriority
    \ No newline at end of file diff --git a/docs/interfaces/PromiseResponseWrapper.html b/docs/interfaces/PromiseResponseWrapper.html index ef86a882..1f2a496c 100644 --- a/docs/interfaces/PromiseResponseWrapper.html +++ b/docs/interfaces/PromiseResponseWrapper.html @@ -1,11 +1,11 @@ -PromiseResponseWrapper | poolifier - v4.0.5

    Interface PromiseResponseWrapper<Response>Internal

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

    +PromiseResponseWrapper | poolifier - v4.0.6

    Interface PromiseResponseWrapper<Response>Internal

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

    interface PromiseResponseWrapper<Response> {
        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)

    Reject callback to reject the promise.

    -

    Type declaration

      • (reason?): void

      • Parameters

        • Optional reason: unknown

        Returns void

    Readonly resolve

    resolve: ((value) => void)

    Resolve callback to fulfill the promise.

    -

    Type declaration

    Readonly workerNodeKey

    workerNodeKey: number

    The worker node key executing the task.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    asyncResourcerejectresolveworkerNodeKey
    \ No newline at end of file +

    Readonly reject

    reject: ((reason?) => void)

    Reject callback to reject the promise.

    +

    Type declaration

      • (reason?): void

      • Parameters

        • Optional reason: unknown

        Returns void

    Readonly resolve

    resolve: ((value) => void)

    Resolve callback to fulfill the promise.

    +

    Type declaration

    Readonly workerNodeKey

    workerNodeKey: number

    The worker node key executing the task.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    asyncResourcerejectresolveworkerNodeKey
    \ No newline at end of file diff --git a/docs/interfaces/StrategyData.html b/docs/interfaces/StrategyData.html index 1f7f8538..690c7458 100644 --- a/docs/interfaces/StrategyData.html +++ b/docs/interfaces/StrategyData.html @@ -1,3 +1,3 @@ -StrategyData | poolifier - v4.0.5

    Interface StrategyDataInternal

    Worker choice strategy data.

    -
    interface StrategyData {
        virtualTaskEndTimestamp?: number;
    }

    Properties

    virtualTaskEndTimestamp? -

    Properties

    Optional virtualTaskEndTimestamp

    virtualTaskEndTimestamp?: number

    Settings

    Member Visibility

    Theme

    On This Page

    virtualTaskEndTimestamp
    \ No newline at end of file +StrategyData | poolifier - v4.0.6

    Interface StrategyDataInternal

    Worker choice strategy data.

    +
    interface StrategyData {
        virtualTaskEndTimestamp?: number;
    }

    Properties

    virtualTaskEndTimestamp? +

    Properties

    Optional virtualTaskEndTimestamp

    virtualTaskEndTimestamp?: number

    Settings

    Member Visibility

    Theme

    On This Page

    virtualTaskEndTimestamp
    \ No newline at end of file diff --git a/docs/interfaces/StrategyPolicy.html b/docs/interfaces/StrategyPolicy.html index c4a47f1c..89e326cf 100644 --- a/docs/interfaces/StrategyPolicy.html +++ b/docs/interfaces/StrategyPolicy.html @@ -1,6 +1,6 @@ -StrategyPolicy | poolifier - v4.0.5

    Interface StrategyPolicyInternal

    Strategy policy.

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

    Properties

    dynamicWorkerReady +StrategyPolicy | poolifier - v4.0.6

    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

    dynamicWorkerReadydynamicWorkerUsage
    \ 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

    dynamicWorkerReadydynamicWorkerUsage
    \ No newline at end of file diff --git a/docs/interfaces/Task.html b/docs/interfaces/Task.html index 650d0f60..c21f56ac 100644 --- a/docs/interfaces/Task.html +++ b/docs/interfaces/Task.html @@ -1,6 +1,6 @@ -Task | poolifier - v4.0.5

    Interface Task<Data>Internal

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

    +Task | poolifier - v4.0.6

    Interface Task<Data>Internal

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

    interface Task<Data> {
        data?: Data;
        name?: string;
        priority?: number;
        strategy?: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN";
        taskId?: `${string}-${string}-${string}-${string}-${string}`;
        timestamp?: number;
        transferList?: readonly TransferListItem[];
    }

    Type Parameters

    • Data = unknown

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

      -

    Hierarchy (view full)

    Properties

    data? +

    Hierarchy (view full)

    Properties

    data? name? priority? strategy? @@ -8,12 +8,12 @@ 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 priority

    priority?: number

    Task priority. Lower values have higher priority.

    +

    Optional Readonly name

    name?: string

    Task name.

    +

    Optional Readonly priority

    priority?: number

    Task priority. Lower values have higher priority.

    Default Value

    0
    -

    Optional Readonly strategy

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

    Task worker choice strategy.

    -

    Optional Readonly taskId

    taskId?: `${string}-${string}-${string}-${string}-${string}`

    Task UUID.

    -

    Optional Readonly timestamp

    timestamp?: number

    Timestamp.

    -

    Optional Readonly transferList

    transferList?: readonly TransferListItem[]

    Array of transferable objects.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    datanameprioritystrategytaskIdtimestamptransferList
    \ No newline at end of file +

    Optional Readonly strategy

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

    Task worker choice strategy.

    +

    Optional Readonly taskId

    taskId?: `${string}-${string}-${string}-${string}-${string}`

    Task UUID.

    +

    Optional Readonly timestamp

    timestamp?: number

    Timestamp.

    +

    Optional Readonly transferList

    transferList?: readonly TransferListItem[]

    Array of transferable objects.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    datanameprioritystrategytaskIdtimestamptransferList
    \ No newline at end of file diff --git a/docs/interfaces/TaskFunctionObject.html b/docs/interfaces/TaskFunctionObject.html index 02304cba..c92986b3 100644 --- a/docs/interfaces/TaskFunctionObject.html +++ b/docs/interfaces/TaskFunctionObject.html @@ -1,10 +1,10 @@ -TaskFunctionObject | poolifier - v4.0.5

    Interface TaskFunctionObject<Data, Response>

    Task function object.

    +TaskFunctionObject | poolifier - v4.0.6

    Interface TaskFunctionObject<Data, Response>

    Task function object.

    interface TaskFunctionObject<Data, Response> {
        priority?: number;
        strategy?: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN";
        taskFunction: TaskFunction<Data, Response>;
    }

    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.

      -

    Properties

    priority? +

    Properties

    priority? strategy? taskFunction

    Properties

    Optional priority

    priority?: number

    Task function priority. Lower values have higher priority.

    -

    Optional strategy

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

    Task function worker choice strategy.

    -

    taskFunction

    taskFunction: TaskFunction<Data, Response>

    Task function.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    prioritystrategytaskFunction
    \ No newline at end of file +

    Optional strategy

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

    Task function worker choice strategy.

    +

    taskFunction

    taskFunction: TaskFunction<Data, Response>

    Task function.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    prioritystrategytaskFunction
    \ No newline at end of file diff --git a/docs/interfaces/TaskFunctionOperationResult.html b/docs/interfaces/TaskFunctionOperationResult.html index 0446e39d..fa33fd2a 100644 --- a/docs/interfaces/TaskFunctionOperationResult.html +++ b/docs/interfaces/TaskFunctionOperationResult.html @@ -1,4 +1,4 @@ -TaskFunctionOperationResult | poolifier - v4.0.5

    Interface TaskFunctionOperationResult

    Task function operation result.

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

    Properties

    error? +TaskFunctionOperationResult | poolifier - v4.0.6

    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

    errorstatus
    \ No newline at end of file +

    Properties

    Optional error

    error?: Error

    status

    status: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    errorstatus
    \ No newline at end of file diff --git a/docs/interfaces/TaskFunctionProperties.html b/docs/interfaces/TaskFunctionProperties.html index a69070f6..8fbfdad3 100644 --- a/docs/interfaces/TaskFunctionProperties.html +++ b/docs/interfaces/TaskFunctionProperties.html @@ -1,8 +1,8 @@ -TaskFunctionProperties | poolifier - v4.0.5

    Interface TaskFunctionProperties

    Task function properties.

    -
    interface TaskFunctionProperties {
        name: string;
        priority?: number;
        strategy?: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN";
    }

    Properties

    name +TaskFunctionProperties | poolifier - v4.0.6

    Interface TaskFunctionProperties

    Task function properties.

    +
    interface TaskFunctionProperties {
        name: string;
        priority?: number;
        strategy?: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN";
    }

    Properties

    name priority? strategy?

    Properties

    Readonly name

    name: string

    Task function name.

    -

    Optional Readonly priority

    priority?: number

    Task function priority. Lower values have higher priority.

    -

    Optional Readonly strategy

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

    Task function worker choice strategy.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    nameprioritystrategy
    \ No newline at end of file +

    Optional Readonly priority

    priority?: number

    Task function priority. Lower values have higher priority.

    +

    Optional Readonly strategy

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

    Task function worker choice strategy.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    nameprioritystrategy
    \ No newline at end of file diff --git a/docs/interfaces/TaskPerformance.html b/docs/interfaces/TaskPerformance.html index 57cc7991..8c243dc2 100644 --- a/docs/interfaces/TaskPerformance.html +++ b/docs/interfaces/TaskPerformance.html @@ -1,10 +1,10 @@ -TaskPerformance | poolifier - v4.0.5

    Interface TaskPerformanceInternal

    Task performance.

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

    Properties

    elu? +TaskPerformance | poolifier - v4.0.6

    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

    elunamerunTimetimestamp
    \ 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

    elunamerunTimetimestamp
    \ No newline at end of file diff --git a/docs/interfaces/TaskStatistics.html b/docs/interfaces/TaskStatistics.html index 99082ff0..97734911 100644 --- a/docs/interfaces/TaskStatistics.html +++ b/docs/interfaces/TaskStatistics.html @@ -1,5 +1,5 @@ -TaskStatistics | poolifier - v4.0.5

    Interface TaskStatisticsInternal

    Task statistics.

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

    Properties

    executed +TaskStatistics | poolifier - v4.0.6

    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

    executedexecutingfailedmaxQueuedqueuedsequentiallyStolenstolen
    \ 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

    executedexecutingfailedmaxQueuedqueuedsequentiallyStolenstolen
    \ No newline at end of file diff --git a/docs/interfaces/TaskStatisticsRequirements.html b/docs/interfaces/TaskStatisticsRequirements.html index 33fa13e0..752facf1 100644 --- a/docs/interfaces/TaskStatisticsRequirements.html +++ b/docs/interfaces/TaskStatisticsRequirements.html @@ -1,8 +1,8 @@ -TaskStatisticsRequirements | poolifier - v4.0.5

    Interface TaskStatisticsRequirementsInternal

    Pool worker node worker usage statistics requirements.

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

    Properties

    elu +TaskStatisticsRequirements | poolifier - v4.0.6

    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

    elurunTimewaitTime
    \ 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

    elurunTimewaitTime
    \ No newline at end of file diff --git a/docs/interfaces/TasksQueueOptions.html b/docs/interfaces/TasksQueueOptions.html index 9d8d0e20..5b01adbe 100644 --- a/docs/interfaces/TasksQueueOptions.html +++ b/docs/interfaces/TasksQueueOptions.html @@ -1,5 +1,5 @@ -TasksQueueOptions | poolifier - v4.0.5

    Interface TasksQueueOptions

    Worker node tasks queue options.

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

    Properties

    concurrency? +TasksQueueOptions | poolifier - v4.0.6

    Interface TasksQueueOptions

    Worker node tasks queue options.

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

    Properties

    concurrency? size? taskStealing? tasksFinishedTimeout? @@ -7,16 +7,16 @@

    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 tasksFinishedTimeout

    tasksFinishedTimeout?: number

    Queued tasks finished timeout in milliseconds at worker node termination.

    +

    Optional Readonly tasksFinishedTimeout

    tasksFinishedTimeout?: number

    Queued tasks finished timeout in milliseconds at worker node termination.

    Default Value

    2000
    -

    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

    false
    -

    Settings

    Member Visibility

    Theme

    On This Page

    concurrencysizetaskStealingtasksFinishedTimeouttasksStealingOnBackPressure
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    concurrencysizetaskStealingtasksFinishedTimeouttasksStealingOnBackPressure
    \ No newline at end of file diff --git a/docs/interfaces/WorkerChoiceStrategyOptions.html b/docs/interfaces/WorkerChoiceStrategyOptions.html index ec78f087..ec5ab084 100644 --- a/docs/interfaces/WorkerChoiceStrategyOptions.html +++ b/docs/interfaces/WorkerChoiceStrategyOptions.html @@ -1,5 +1,5 @@ -WorkerChoiceStrategyOptions | poolifier - v4.0.5

    Interface WorkerChoiceStrategyOptions

    Worker choice strategy options.

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

    Properties

    elu? +WorkerChoiceStrategyOptions | poolifier - v4.0.6

    Interface WorkerChoiceStrategyOptions

    Worker choice strategy options.

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

    Properties

    elu? measurement? runTime? waitTime? @@ -7,15 +7,15 @@

    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 runTime

    runTime?: MeasurementOptions

    Runtime options.

    +

    Optional Readonly measurement

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

    Measurement to use in worker choice strategy supporting it.

    +

    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 weights

    weights?: Record<number, number>

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

    Optional 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

    elumeasurementrunTimewaitTimeweights
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    elumeasurementrunTimewaitTimeweights
    \ No newline at end of file diff --git a/docs/interfaces/WorkerError.html b/docs/interfaces/WorkerError.html index 9aaab46f..0ddf186e 100644 --- a/docs/interfaces/WorkerError.html +++ b/docs/interfaces/WorkerError.html @@ -1,9 +1,9 @@ -WorkerError | poolifier - v4.0.5

    Interface WorkerError<Data>

    Worker error.

    +WorkerError | poolifier - v4.0.6

    Interface WorkerError<Data>

    Worker error.

    interface WorkerError<Data> {
        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

    datamessagename
    \ 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

    datamessagename
    \ No newline at end of file diff --git a/docs/interfaces/WorkerInfo.html b/docs/interfaces/WorkerInfo.html index 67239954..acb27f01 100644 --- a/docs/interfaces/WorkerInfo.html +++ b/docs/interfaces/WorkerInfo.html @@ -1,5 +1,5 @@ -WorkerInfo | poolifier - v4.0.5

    Interface WorkerInfoInternal

    Worker information.

    -
    interface WorkerInfo {
        backPressure: boolean;
        dynamic: boolean;
        id: undefined | number;
        ready: boolean;
        stealing: boolean;
        taskFunctionsProperties?: TaskFunctionProperties[];
        type: "thread" | "cluster";
    }

    Properties

    backPressure +WorkerInfo | poolifier - v4.0.6

    Interface WorkerInfoInternal

    Worker information.

    +
    interface WorkerInfo {
        backPressure: boolean;
        dynamic: boolean;
        id: undefined | number;
        ready: boolean;
        stealing: boolean;
        taskFunctionsProperties?: TaskFunctionProperties[];
        type: "thread" | "cluster";
    }

    Properties

    backPressure dynamic id ready @@ -8,11 +8,11 @@ type

    Properties

    backPressure

    backPressure: boolean

    Back pressure flag. This flag is set to true when worker node tasks queue has back pressure.

    -

    dynamic

    dynamic: boolean

    Dynamic flag.

    -

    Readonly id

    id: undefined | number

    Worker id.

    -

    ready

    ready: boolean

    Ready flag.

    -

    stealing

    stealing: boolean

    Stealing flag. +

    dynamic

    dynamic: boolean

    Dynamic flag.

    +

    Readonly id

    id: undefined | number

    Worker id.

    +

    ready

    ready: boolean

    Ready flag.

    +

    stealing

    stealing: boolean

    Stealing flag. This flag is set to true when worker node is stealing tasks from another worker node.

    -

    Optional taskFunctionsProperties

    taskFunctionsProperties?: TaskFunctionProperties[]

    Task functions properties.

    -

    Readonly type

    type: "thread" | "cluster"

    Worker type.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    backPressuredynamicidreadystealingtaskFunctionsPropertiestype
    \ No newline at end of file +

    Optional taskFunctionsProperties

    taskFunctionsProperties?: TaskFunctionProperties[]

    Task functions properties.

    +

    Readonly type

    type: "thread" | "cluster"

    Worker type.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    backPressuredynamicidreadystealingtaskFunctionsPropertiestype
    \ No newline at end of file diff --git a/docs/interfaces/WorkerNodeEventDetail.html b/docs/interfaces/WorkerNodeEventDetail.html index b8641c92..054e4a4c 100644 --- a/docs/interfaces/WorkerNodeEventDetail.html +++ b/docs/interfaces/WorkerNodeEventDetail.html @@ -1,4 +1,4 @@ -WorkerNodeEventDetail | poolifier - v4.0.5

    Interface WorkerNodeEventDetailInternal

    Worker node event detail.

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

    Properties

    workerId? +WorkerNodeEventDetail | poolifier - v4.0.6

    Interface WorkerNodeEventDetailInternal

    Worker node event detail.

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

    Properties

    workerId? workerNodeKey? -

    Properties

    Optional workerId

    workerId?: number

    Optional workerNodeKey

    workerNodeKey?: number

    Settings

    Member Visibility

    Theme

    On This Page

    workerIdworkerNodeKey
    \ No newline at end of file +

    Properties

    Optional workerId

    workerId?: number

    Optional workerNodeKey

    workerNodeKey?: number

    Settings

    Member Visibility

    Theme

    On This Page

    workerIdworkerNodeKey
    \ No newline at end of file diff --git a/docs/interfaces/WorkerNodeOptions.html b/docs/interfaces/WorkerNodeOptions.html index 4ec44626..33be219b 100644 --- a/docs/interfaces/WorkerNodeOptions.html +++ b/docs/interfaces/WorkerNodeOptions.html @@ -1,6 +1,6 @@ -WorkerNodeOptions | poolifier - v4.0.5

    Interface WorkerNodeOptionsInternal

    Worker node options.

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

    Properties

    env? +WorkerNodeOptions | poolifier - v4.0.6

    Interface WorkerNodeOptionsInternal

    Worker node options.

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

    Properties

    env? tasksQueueBackPressureSize tasksQueueBucketSize workerOptions? -

    Properties

    Optional env

    env?: Record<string, unknown>

    tasksQueueBackPressureSize

    tasksQueueBackPressureSize: undefined | number

    tasksQueueBucketSize

    tasksQueueBucketSize: undefined | number

    Optional workerOptions

    workerOptions?: WorkerOptions

    Settings

    Member Visibility

    Theme

    On This Page

    envtasksQueueBackPressureSizetasksQueueBucketSizeworkerOptions
    \ No newline at end of file +

    Properties

    Optional env

    env?: Record<string, unknown>

    tasksQueueBackPressureSize

    tasksQueueBackPressureSize: undefined | number

    tasksQueueBucketSize

    tasksQueueBucketSize: undefined | number

    Optional workerOptions

    workerOptions?: WorkerOptions

    Settings

    Member Visibility

    Theme

    On This Page

    envtasksQueueBackPressureSizetasksQueueBucketSizeworkerOptions
    \ No newline at end of file diff --git a/docs/interfaces/WorkerOptions.html b/docs/interfaces/WorkerOptions.html index 31d3a013..4a8ea22b 100644 --- a/docs/interfaces/WorkerOptions.html +++ b/docs/interfaces/WorkerOptions.html @@ -1,5 +1,5 @@ -WorkerOptions | poolifier - v4.0.5

    Interface WorkerOptions

    Options for workers.

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

    Properties

    killBehavior? +WorkerOptions | poolifier - v4.0.6

    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

    killBehaviorkillHandlermaxInactiveTime
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    killBehaviorkillHandlermaxInactiveTime
    \ No newline at end of file diff --git a/docs/interfaces/WorkerStatistics.html b/docs/interfaces/WorkerStatistics.html index 9cac06f6..be1093c2 100644 --- a/docs/interfaces/WorkerStatistics.html +++ b/docs/interfaces/WorkerStatistics.html @@ -1,6 +1,6 @@ -WorkerStatistics | poolifier - v4.0.5

    Interface WorkerStatisticsInternal

    Worker task performance statistics computation settings.

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

    Properties

    elu +WorkerStatistics | poolifier - v4.0.6

    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

    elurunTime
    \ 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

    elurunTime
    \ No newline at end of file diff --git a/docs/interfaces/WorkerUsage.html b/docs/interfaces/WorkerUsage.html index 58c8c6f2..740b623a 100644 --- a/docs/interfaces/WorkerUsage.html +++ b/docs/interfaces/WorkerUsage.html @@ -1,10 +1,10 @@ -WorkerUsage | poolifier - v4.0.5

    Interface WorkerUsageInternal

    Worker usage statistics.

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

    Properties

    elu +WorkerUsage | poolifier - v4.0.6

    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

    elurunTimetaskswaitTime
    \ 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

    elurunTimetaskswaitTime
    \ No newline at end of file diff --git a/docs/types/ClusterPoolOptions.html b/docs/types/ClusterPoolOptions.html index 9b625e1c..5fcdc3c9 100644 --- a/docs/types/ClusterPoolOptions.html +++ b/docs/types/ClusterPoolOptions.html @@ -1,2 +1,2 @@ -ClusterPoolOptions | poolifier - v4.0.5

    Type alias ClusterPoolOptions

    ClusterPoolOptions: PoolOptions<Worker>

    Options for a poolifier cluster pool.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +ClusterPoolOptions | poolifier - v4.0.6

    Type alias ClusterPoolOptions

    ClusterPoolOptions: PoolOptions<Worker>

    Options for a poolifier cluster pool.

    +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/ErrorHandler.html b/docs/types/ErrorHandler.html index 887654e8..0938ef93 100644 --- a/docs/types/ErrorHandler.html +++ b/docs/types/ErrorHandler.html @@ -1,3 +1,3 @@ -ErrorHandler | poolifier - v4.0.5

    Type alias ErrorHandler<Worker>

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

    Callback invoked if the worker raised an error.

    +ErrorHandler | poolifier - v4.0.6

    Type alias ErrorHandler<Worker>

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

    Callback invoked if the worker raised an error.

    Type Parameters

    • Worker extends IWorker

      Type of worker.

      -

    Type declaration

      • (this, error): void

      • Parameters

        Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

      • (this, error): void

      • Parameters

        Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/EventHandler.html b/docs/types/EventHandler.html index d6fccd41..958cd802 100644 --- a/docs/types/EventHandler.html +++ b/docs/types/EventHandler.html @@ -1,3 +1,3 @@ -EventHandler | poolifier - v4.0.5

    Type alias EventHandler<Worker>

    EventHandler<Worker>: OnlineHandler<Worker> | MessageHandler<Worker> | ErrorHandler<Worker> | ExitHandler<Worker>

    Worker event handler.

    +EventHandler | poolifier - v4.0.6

    Type alias EventHandler<Worker>

    EventHandler<Worker>: OnlineHandler<Worker> | MessageHandler<Worker> | ErrorHandler<Worker> | ExitHandler<Worker>

    Worker event handler.

    Type Parameters

    • Worker extends IWorker

      Type of worker.

      -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/ExitHandler.html b/docs/types/ExitHandler.html index 887d677d..0860c88a 100644 --- a/docs/types/ExitHandler.html +++ b/docs/types/ExitHandler.html @@ -1,3 +1,3 @@ -ExitHandler | poolifier - v4.0.5

    Type alias ExitHandler<Worker>

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

    Callback invoked when the worker exits successfully.

    +ExitHandler | poolifier - v4.0.6

    Type alias ExitHandler<Worker>

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

    Callback invoked when the worker exits successfully.

    Type Parameters

    • Worker extends IWorker

      Type of worker.

      -

    Type declaration

      • (this, exitCode): void

      • Parameters

        Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

      • (this, exitCode): void

      • Parameters

        Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/KillBehavior.html b/docs/types/KillBehavior.html index fbc262bc..38bebcf7 100644 --- a/docs/types/KillBehavior.html +++ b/docs/types/KillBehavior.html @@ -1,2 +1,2 @@ -KillBehavior | poolifier - v4.0.5

    Type alias KillBehavior

    KillBehavior: keyof typeof KillBehaviors

    Kill behavior.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +KillBehavior | poolifier - v4.0.6

    Type alias KillBehavior

    KillBehavior: keyof typeof KillBehaviors

    Kill behavior.

    +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/KillHandler.html b/docs/types/KillHandler.html index a61c240c..2d15c5b0 100644 --- a/docs/types/KillHandler.html +++ b/docs/types/KillHandler.html @@ -1,2 +1,2 @@ -KillHandler | poolifier - v4.0.5

    Type alias KillHandler

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

    Handler called when a worker is killed.

    -

    Type declaration

      • (): void | Promise<void>

      • Returns void | Promise<void>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +KillHandler | poolifier - v4.0.6

    Type alias KillHandler

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

    Handler called when a worker is killed.

    +

    Type declaration

      • (): void | Promise<void>

      • Returns void | Promise<void>

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/Measurement.html b/docs/types/Measurement.html index d3a04151..dcf358f6 100644 --- a/docs/types/Measurement.html +++ b/docs/types/Measurement.html @@ -1,2 +1,2 @@ -Measurement | poolifier - v4.0.5

    Type alias Measurement

    Measurement: keyof typeof Measurements

    Measurement.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +Measurement | poolifier - v4.0.6

    Type alias Measurement

    Measurement: keyof typeof Measurements

    Measurement.

    +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/MessageHandler.html b/docs/types/MessageHandler.html index eab3e00b..83022175 100644 --- a/docs/types/MessageHandler.html +++ b/docs/types/MessageHandler.html @@ -1,3 +1,3 @@ -MessageHandler | poolifier - v4.0.5

    Type alias MessageHandler<Worker>

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

    Callback invoked if the worker has received a message.

    +MessageHandler | poolifier - v4.0.6

    Type alias MessageHandler<Worker>

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

    Callback invoked if the worker has received a message.

    Type Parameters

    • Worker extends IWorker

      Type of worker.

      -

    Type declaration

      • (this, message): void

      • Parameters

        Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

      • (this, message): void

      • Parameters

        Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/OnlineHandler.html b/docs/types/OnlineHandler.html index 200fb219..5d12c68b 100644 --- a/docs/types/OnlineHandler.html +++ b/docs/types/OnlineHandler.html @@ -1,3 +1,3 @@ -OnlineHandler | poolifier - v4.0.5

    Type alias OnlineHandler<Worker>

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

    Callback invoked when the worker has started successfully.

    +OnlineHandler | poolifier - v4.0.6

    Type alias OnlineHandler<Worker>

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

    Callback invoked when the worker has started successfully.

    Type Parameters

    • Worker extends IWorker

      Type of worker.

      -

    Type declaration

      • (this): void

      • Parameters

        Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

      • (this): void

      • Parameters

        Returns void

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/PoolEvent.html b/docs/types/PoolEvent.html index f51f47ba..dc326a93 100644 --- a/docs/types/PoolEvent.html +++ b/docs/types/PoolEvent.html @@ -1,2 +1,2 @@ -PoolEvent | poolifier - v4.0.5

    Type alias PoolEvent

    PoolEvent: keyof typeof PoolEvents

    Pool event.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +PoolEvent | poolifier - v4.0.6

    Type alias PoolEvent

    PoolEvent: keyof typeof PoolEvents

    Pool event.

    +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/PoolType.html b/docs/types/PoolType.html index 9ba56ccd..78279c98 100644 --- a/docs/types/PoolType.html +++ b/docs/types/PoolType.html @@ -1,2 +1,2 @@ -PoolType | poolifier - v4.0.5

    Type alias PoolType

    PoolType: keyof typeof PoolTypes

    Pool type.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +PoolType | poolifier - v4.0.6

    Type alias PoolType

    PoolType: keyof typeof PoolTypes

    Pool type.

    +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/TaskAsyncFunction.html b/docs/types/TaskAsyncFunction.html index 63d61da2..2c390df5 100644 --- a/docs/types/TaskAsyncFunction.html +++ b/docs/types/TaskAsyncFunction.html @@ -1,7 +1,7 @@ -TaskAsyncFunction | poolifier - v4.0.5

    Type alias TaskAsyncFunction<Data, Response>

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

    Task asynchronous function that can be executed. +TaskAsyncFunction | poolifier - v4.0.6

    Type alias TaskAsyncFunction<Data, Response>

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

    Task asynchronous function that can be executed. This function must return a promise.

    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.

    Type declaration

      • (data?): Promise<Response>

      • Parameters

        • Optional data: Data

          Data sent to the worker.

        Returns Promise<Response>

    Returns

    Execution response promise.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/TaskFunction.html b/docs/types/TaskFunction.html index 12243241..c9d81f09 100644 --- a/docs/types/TaskFunction.html +++ b/docs/types/TaskFunction.html @@ -1,5 +1,5 @@ -TaskFunction | poolifier - v4.0.5

    Type alias TaskFunction<Data, Response>

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

    Task function that can be executed. +TaskFunction | poolifier - v4.0.6

    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

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/TaskFunctions.html b/docs/types/TaskFunctions.html index 2ee2aa79..62769345 100644 --- a/docs/types/TaskFunctions.html +++ b/docs/types/TaskFunctions.html @@ -1,6 +1,6 @@ -TaskFunctions | poolifier - v4.0.5

    Type alias TaskFunctions<Data, Response>

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

    Tasks functions that can be executed. +TaskFunctions | poolifier - v4.0.6

    Type alias TaskFunctions<Data, Response>

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

    Tasks functions that can be executed. The key is the name of the task function or task function object. The value is the task function or task function object.

    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

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/TaskSyncFunction.html b/docs/types/TaskSyncFunction.html index 12005187..091efe02 100644 --- a/docs/types/TaskSyncFunction.html +++ b/docs/types/TaskSyncFunction.html @@ -1,6 +1,6 @@ -TaskSyncFunction | poolifier - v4.0.5

    Type alias TaskSyncFunction<Data, Response>

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

    Task synchronous function that can be executed.

    +TaskSyncFunction | poolifier - v4.0.6

    Type alias TaskSyncFunction<Data, Response>

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

    Task synchronous function that can be executed.

    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.

    Type declaration

    Returns

    Execution response.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/ThreadPoolOptions.html b/docs/types/ThreadPoolOptions.html index e8c40137..bb8fccab 100644 --- a/docs/types/ThreadPoolOptions.html +++ b/docs/types/ThreadPoolOptions.html @@ -1,2 +1,2 @@ -ThreadPoolOptions | poolifier - v4.0.5

    Type alias ThreadPoolOptions

    ThreadPoolOptions: PoolOptions<Worker>

    Options for a poolifier thread pool.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +ThreadPoolOptions | poolifier - v4.0.6

    Type alias ThreadPoolOptions

    ThreadPoolOptions: PoolOptions<Worker>

    Options for a poolifier thread pool.

    +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/WorkerChoiceStrategy.html b/docs/types/WorkerChoiceStrategy.html index 433e93d4..e19554be 100644 --- a/docs/types/WorkerChoiceStrategy.html +++ b/docs/types/WorkerChoiceStrategy.html @@ -1,2 +1,2 @@ -WorkerChoiceStrategy | poolifier - v4.0.5

    Type alias WorkerChoiceStrategy

    WorkerChoiceStrategy: keyof typeof WorkerChoiceStrategies

    Worker choice strategy.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +WorkerChoiceStrategy | poolifier - v4.0.6

    Type alias WorkerChoiceStrategy

    WorkerChoiceStrategy: keyof typeof WorkerChoiceStrategies

    Worker choice strategy.

    +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/WorkerType.html b/docs/types/WorkerType.html index b5b43c42..d763e78b 100644 --- a/docs/types/WorkerType.html +++ b/docs/types/WorkerType.html @@ -1,2 +1,2 @@ -WorkerType | poolifier - v4.0.5

    Type alias WorkerType

    WorkerType: keyof typeof WorkerTypes

    Worker type.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +WorkerType | poolifier - v4.0.6

    Type alias WorkerType

    WorkerType: keyof typeof WorkerTypes

    Worker type.

    +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/Writable.html b/docs/types/Writable.html index 4d88f60c..916ed0c0 100644 --- a/docs/types/Writable.html +++ b/docs/types/Writable.html @@ -1 +1 @@ -Writable | poolifier - v4.0.5

    Type alias Writable<T>

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

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +Writable | poolifier - v4.0.6

    Type alias Writable<T>

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

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/variables/KillBehaviors.html b/docs/variables/KillBehaviors.html index 3bf982b9..8ea21a35 100644 --- a/docs/variables/KillBehaviors.html +++ b/docs/variables/KillBehaviors.html @@ -1,2 +1,2 @@ -KillBehaviors | poolifier - v4.0.5

    Variable KillBehaviorsConst

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

    Enumeration of kill behaviors.

    -

    Type declaration

    • HARD: "HARD"
    • SOFT: "SOFT"

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +KillBehaviors | poolifier - v4.0.6

    Variable KillBehaviorsConst

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

    Enumeration of kill behaviors.

    +

    Type declaration

    • HARD: "HARD"
    • SOFT: "SOFT"

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/variables/Measurements.html b/docs/variables/Measurements.html index c20fad3d..d786e409 100644 --- a/docs/variables/Measurements.html +++ b/docs/variables/Measurements.html @@ -1,2 +1,2 @@ -Measurements | poolifier - v4.0.5

    Variable MeasurementsConst

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

    Enumeration of measurements.

    -

    Type declaration

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

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +Measurements | poolifier - v4.0.6

    Variable MeasurementsConst

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

    Enumeration of measurements.

    +

    Type declaration

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

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/variables/PoolEvents.html b/docs/variables/PoolEvents.html index a48d3630..67d99ac6 100644 --- a/docs/variables/PoolEvents.html +++ b/docs/variables/PoolEvents.html @@ -1,2 +1,2 @@ -PoolEvents | poolifier - v4.0.5

    Variable PoolEventsConst

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

    Enumeration of pool events.

    -

    Type declaration

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

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +PoolEvents | poolifier - v4.0.6

    Variable PoolEventsConst

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

    Enumeration of pool events.

    +

    Type declaration

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

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/variables/PoolTypes.html b/docs/variables/PoolTypes.html index bf2aaeda..fb9789c3 100644 --- a/docs/variables/PoolTypes.html +++ b/docs/variables/PoolTypes.html @@ -1,2 +1,2 @@ -PoolTypes | poolifier - v4.0.5

    Variable PoolTypesConst

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

    Enumeration of pool types.

    -

    Type declaration

    • dynamic: "dynamic"
    • fixed: "fixed"

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +PoolTypes | poolifier - v4.0.6

    Variable PoolTypesConst

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

    Enumeration of pool types.

    +

    Type declaration

    • dynamic: "dynamic"
    • fixed: "fixed"

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/variables/WorkerChoiceStrategies.html b/docs/variables/WorkerChoiceStrategies.html index f29c30e4..44076d20 100644 --- a/docs/variables/WorkerChoiceStrategies.html +++ b/docs/variables/WorkerChoiceStrategies.html @@ -1,2 +1,2 @@ -WorkerChoiceStrategies | poolifier - v4.0.5

    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

    • 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"

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +WorkerChoiceStrategies | poolifier - v4.0.6

    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

    • 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"

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/variables/WorkerTypes.html b/docs/variables/WorkerTypes.html index d0ce09ec..3030f6a7 100644 --- a/docs/variables/WorkerTypes.html +++ b/docs/variables/WorkerTypes.html @@ -1,2 +1,2 @@ -WorkerTypes | poolifier - v4.0.5

    Variable WorkerTypesConst

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

    Enumeration of worker types.

    -

    Type declaration

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

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +WorkerTypes | poolifier - v4.0.6

    Variable WorkerTypesConst

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

    Enumeration of worker types.

    +

    Type declaration

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

    Settings

    Member Visibility

    Theme

    \ No newline at end of file