From 5ca8a250be7ec77da7a80f5ea3b7a9ef6ba2530a Mon Sep 17 00:00:00 2001 From: Documentation Bot Date: Sat, 24 Feb 2024 10:47:32 +0000 Subject: [PATCH] docs: generate documentation --- docs/classes/AbstractPool.html | 128 +++++++++--------- docs/classes/AbstractWorker.html | 62 ++++----- docs/classes/CircularArray.html | 24 ++-- docs/classes/ClusterWorker.html | 50 +++---- docs/classes/Deque.html | 28 ++-- docs/classes/DynamicClusterPool.html | 98 +++++++------- docs/classes/DynamicThreadPool.html | 98 +++++++------- docs/classes/FixedClusterPool.html | 98 +++++++------- docs/classes/FixedThreadPool.html | 98 +++++++------- docs/classes/ThreadWorker.html | 52 +++---- docs/classes/WorkerChoiceStrategyContext.html | 30 ++-- docs/functions/availableParallelism.html | 4 +- docs/hierarchy.html | 2 +- docs/index.html | 4 +- ...tLoopUtilizationMeasurementStatistics.html | 6 +- docs/interfaces/ILinkedListNode.html | 6 +- docs/interfaces/IPool.html | 34 ++--- docs/interfaces/IWorker.html | 46 +++---- docs/interfaces/IWorkerChoiceStrategy.html | 18 +-- docs/interfaces/IWorkerNode.html | 72 +++++----- docs/interfaces/MeasurementOptions.html | 6 +- docs/interfaces/MeasurementStatistics.html | 16 +-- .../MeasurementStatisticsRequirements.html | 10 +- docs/interfaces/MessageValue.html | 40 +++--- docs/interfaces/PoolInfo.html | 16 +-- docs/interfaces/PoolOptions.html | 32 ++--- docs/interfaces/PromiseResponseWrapper.html | 12 +- docs/interfaces/StrategyData.html | 6 +- docs/interfaces/StrategyPolicy.html | 8 +- docs/interfaces/Task.html | 14 +- .../TaskFunctionOperationResult.html | 6 +- docs/interfaces/TaskPerformance.html | 12 +- docs/interfaces/TaskStatistics.html | 18 +-- .../TaskStatisticsRequirements.html | 10 +- docs/interfaces/TasksQueueOptions.html | 14 +- .../WorkerChoiceStrategyOptions.html | 14 +- docs/interfaces/WorkerError.html | 10 +- docs/interfaces/WorkerInfo.html | 16 +-- docs/interfaces/WorkerNodeEventDetail.html | 6 +- docs/interfaces/WorkerNodeOptions.html | 6 +- docs/interfaces/WorkerOptions.html | 10 +- docs/interfaces/WorkerStatistics.html | 8 +- docs/interfaces/WorkerUsage.html | 12 +- docs/types/ClusterPoolOptions.html | 4 +- docs/types/ErrorHandler.html | 4 +- docs/types/EventHandler.html | 4 +- docs/types/ExitHandler.html | 4 +- docs/types/KillBehavior.html | 4 +- docs/types/KillHandler.html | 4 +- docs/types/Measurement.html | 4 +- docs/types/MessageHandler.html | 4 +- docs/types/OnlineHandler.html | 4 +- docs/types/PoolEvent.html | 4 +- docs/types/PoolType.html | 4 +- docs/types/TaskAsyncFunction.html | 4 +- docs/types/TaskFunction.html | 4 +- docs/types/TaskFunctions.html | 4 +- docs/types/TaskSyncFunction.html | 4 +- docs/types/ThreadPoolOptions.html | 4 +- docs/types/WorkerChoiceStrategy.html | 4 +- docs/types/WorkerType.html | 4 +- docs/types/Writable.html | 2 +- docs/variables/KillBehaviors.html | 4 +- docs/variables/Measurements.html | 4 +- docs/variables/PoolEvents.html | 4 +- docs/variables/PoolTypes.html | 4 +- docs/variables/WorkerChoiceStrategies.html | 4 +- docs/variables/WorkerTypes.html | 4 +- 68 files changed, 679 insertions(+), 679 deletions(-) diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index 22a8c860..c3d367e6 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,8 +1,8 @@ -AbstractPool | poolifier - v3.1.20

Class AbstractPool<Worker, Data, Response>Abstract

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

+AbstractPool | poolifier - v3.1.21

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 @@ -110,8 +110,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

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

    Returns AbstractPool<Worker, Data, Response>

    Properties

    Private destroying

    destroying: boolean

    Whether the pool is destroying or not.

    +

    Optional emitter

    emitter?: EventEmitterAsyncResource

    Event emitter integrated with async resource on which events can be listened to. The async tracking tooling identifier is poolifier:<PoolType>-<WorkerType>-pool.

    Events that can currently be listened to:

      @@ -124,141 +124,141 @@ 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, 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, PromiseResponseWrapper<Response>> = ...

    The task execution response promise map:

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

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

    -

    Private readyEventEmitted

    readyEventEmitted: boolean

    Whether the pool ready event has been emitted or not.

    -

    Private Readonly startTimestamp

    startTimestamp: number

    The start timestamp of the pool.

    -

    Private started

    started: boolean

    Whether the pool is started or not.

    -

    Private starting

    starting: boolean

    Whether the pool is starting or not.

    -

    Private Readonly taskFunctions

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

    The task functions added at runtime map:

    +

    Private readyEventEmitted

    readyEventEmitted: boolean

    Whether the pool ready event has been emitted or not.

    +

    Private Readonly startTimestamp

    startTimestamp: number

    The start timestamp of the pool.

    +

    Private started

    started: boolean

    Whether the pool is started or not.

    +

    Private starting

    starting: boolean

    Whether the pool is starting or not.

    +

    Private Readonly taskFunctions

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

    The task functions added at runtime map:

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

    Protected Optional workerChoiceStrategyContext

    workerChoiceStrategyContext?: WorkerChoiceStrategyContext<Worker, Data, Response>

    Worker choice strategy context referencing a worker choice algorithm implementation.

    -

    Readonly Internal workerNodes

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

    Pool worker nodes.

    -

    Accessors

    Protected Abstract busy

    Protected Optional workerChoiceStrategyContext

    workerChoiceStrategyContext?: WorkerChoiceStrategyContext<Worker, Data, Response>

    Worker choice strategy context referencing a worker choice algorithm implementation.

    +

    Readonly Internal workerNodes

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

    Pool worker nodes.

    +

    Accessors

    Protected Abstract busy

    Protected 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

    Protected Abstract worker

    Methods

    addTaskFunction

    Private addWorkerNode

    Private addWorkerNode

    Protected afterTaskExecutionHook

    Protected afterTaskExecutionHook

    • afterTaskExecutionHook(workerNodeKey, message): void

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

      Parameters

      • workerNodeKey: number

        The worker node key.

      • message: MessageValue<Response, unknown>

        The received message.

        -

      Returns void

    Protected afterWorkerNodeSetup

    • afterWorkerNodeSetup(workerNodeKey): void

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

    Returns void

    Protected afterWorkerNodeSetup

    • afterWorkerNodeSetup(workerNodeKey): void

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

      Parameters

      • workerNodeKey: number

        The newly created worker node key.

        -

      Returns void

    Protected beforeTaskExecutionHook

    • beforeTaskExecutionHook(workerNodeKey, task): void

    • Hook executed before the worker task execution. +

    Returns void

    Protected beforeTaskExecutionHook

    • beforeTaskExecutionHook(workerNodeKey, task): void

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

      Parameters

      • workerNodeKey: number

        The worker node key.

      • task: Task<Data>

        The task to execute.

        -

      Returns void

    Private buildTasksQueueOptions

    Private 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

    Private checkMinimumNumberOfWorkers

    • checkMinimumNumberOfWorkers(minimumNumberOfWorkers): void

    • Parameters

      • minimumNumberOfWorkers: undefined | number

      Returns void

    Private checkPoolOptions

    Private checkPoolType

    Private checkValidWorkerChoiceStrategyOptions

    Private chooseWorkerNode

    • chooseWorkerNode(): number

    • Chooses a worker node for the next task.

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

      Returns number

      The chosen worker node key

      -

    Protected createAndSetupDynamicWorkerNode

    Protected createAndSetupDynamicWorkerNode

    • createAndSetupDynamicWorkerNode(): number

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

      Returns number

      New, completely set up dynamic worker node key.

      -

    Protected createAndSetupWorkerNode

    Protected createAndSetupWorkerNode

    • createAndSetupWorkerNode(): number

    • Creates a new, completely set up worker node.

      Returns number

      New, completely set up worker node key.

      -

    Private createWorkerNode

    Private createWorkerNode

    Private deleteTaskFunctionWorkerUsages

    Private dequeueTask

    Protected Abstract deregisterWorkerMessageListener

    Private deleteTaskFunctionWorkerUsages

    Private dequeueTask

    Protected Abstract deregisterWorkerMessageListener

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

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

      Type Parameters

      • Message

      Parameters

      • workerNodeKey: number

        The worker node key.

      • listener: ((message) => void)

        The message listener callback.

        -

      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

    • enableTasksQueue(enable, tasksQueueOptions?): void

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

      +

    Returns Promise<void>

    enableTasksQueue

    • enableTasksQueue(enable, tasksQueueOptions?): void

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

      Parameters

      • enable: boolean

        Whether to enable or disable the worker node tasks queue.

      • Optional tasksQueueOptions: TasksQueueOptions

        The worker node tasks queue options.

        -

      Returns void

    Private enqueueTask

    execute

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

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

      +

    Returns void

    Private enqueueTask

    execute

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

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

      Parameters

      • Optional data: Data

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

      • Optional name: string

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

      • Optional transferList: TransferListItem[]

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

      Returns Promise<Response>

      Promise that will be fulfilled when the task is completed.

      -

    Private executeTask

    Private executeTask

    • executeTask(workerNodeKey, task): void

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

      Parameters

      • workerNodeKey: number

        The worker node key.

      • task: Task<Data>

        The task to execute.

        -

      Returns void

    Protected flagWorkerNodeAsNotReady

    Protected flushTasksQueue

    Private flushTasksQueues

    Protected getWorkerInfo

    • getWorkerInfo(workerNodeKey): undefined | WorkerInfo

    • Gets the worker information given its worker node key.

      +

    Returns void

    Protected flagWorkerNodeAsNotReady

    Protected flushTasksQueue

    Private flushTasksQueues

    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 handleTask

    Private handleTaskExecutionResponse

    Private Readonly handleWorkerNodeBackPressureEvent

    Private Readonly handleWorkerNodeIdleEvent

    Private handleWorkerReadyResponse

    Private hasBackPressure

    hasTaskFunction

    Private handleTask

    Private handleTaskExecutionResponse

    Private Readonly handleWorkerNodeBackPressureEvent

    Private Readonly handleWorkerNodeIdleEvent

    Private handleWorkerReadyResponse

    Private hasBackPressure

    hasTaskFunction

    • hasTaskFunction(name): boolean

    • Whether the specified task function exists in this pool.

      Parameters

      • name: string

        The name of the task function.

      Returns boolean

      true if the task function exists, false otherwise.

      -

    Private initializeEventEmitter

    Protected internalBusy

    Private initializeEventEmitter

    Protected internalBusy

    • internalBusy(): boolean

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

      Returns boolean

      Worker nodes busyness boolean status.

      -

    Protected Abstract isMain

    Private isWorkerNodeBusy

    listTaskFunctionNames

    Protected Abstract isMain

    Private isWorkerNodeBusy

    listTaskFunctionNames

    Private redistributeQueuedTasks

    Protected Abstract registerOnceWorkerMessageListener

    Private redistributeQueuedTasks

    Protected Abstract registerOnceWorkerMessageListener

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

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

      Type Parameters

      • Message

      Parameters

      • workerNodeKey: number

        The worker node key.

      • listener: ((message) => void)

        The message listener callback.

        -

      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

    • removeTaskFunction(name): Promise<boolean>

    • Removes a task function from this pool.

      +

    Returns void

    removeTaskFunction

    • removeTaskFunction(name): Promise<boolean>

    • Removes a task function from this pool.

      Parameters

      • name: string

        The name of the task function.

      Returns Promise<boolean>

      true if the task function was removed, false otherwise.

      -

    Private removeWorkerNode

    Private removeWorkerNode

    Private resetTaskSequentiallyStolenStatisticsTaskFunctionWorkerUsage

    • resetTaskSequentiallyStolenStatisticsTaskFunctionWorkerUsage(workerNodeKey, taskName): void

    • Parameters

      • workerNodeKey: number
      • taskName: string

      Returns void

    Private resetTaskSequentiallyStolenStatisticsWorkerUsage

    Private sendKillMessageToWorker

    Protected Abstract sendStartupMessageToWorker

    • sendStartupMessageToWorker(workerNodeKey): void

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

      +

    Returns void

    Private resetTaskSequentiallyStolenStatisticsTaskFunctionWorkerUsage

    • resetTaskSequentiallyStolenStatisticsTaskFunctionWorkerUsage(workerNodeKey, taskName): void

    • Parameters

      • workerNodeKey: number
      • taskName: string

      Returns void

    Private resetTaskSequentiallyStolenStatisticsWorkerUsage

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

        The optional array of transferable objects.

        -

      Returns void

    setDefaultTaskFunction

    • setDefaultTaskFunction(name): Promise<boolean>

    • Sets the default task function in this pool.

      +

    Returns void

    setDefaultTaskFunction

    • setDefaultTaskFunction(name): Promise<boolean>

    • Sets the default task function in this pool.

      Parameters

      • name: string

        The name of the task function.

      Returns Promise<boolean>

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

      -

    Private setTaskStealing

    setTasksQueueOptions

    Private setTaskStealing

    setTasksQueueOptions

    Private setTasksQueueSize

    Private setTasksStealingOnBackPressure

    setWorkerChoiceStrategy

    • setWorkerChoiceStrategy(workerChoiceStrategy, workerChoiceStrategyOptions?): void

    • Sets the worker choice strategy in this pool.

      +

    Returns void

    Private setTasksQueueSize

    Private setTasksStealingOnBackPressure

    setWorkerChoiceStrategy

    • setWorkerChoiceStrategy(workerChoiceStrategy, workerChoiceStrategyOptions?): void

    • Sets the worker choice strategy in this pool.

      Parameters

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

        The worker choice strategy.

      • Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptions

        The worker choice strategy options.

        -

      Returns void

    setWorkerChoiceStrategyOptions

    • setWorkerChoiceStrategyOptions(workerChoiceStrategyOptions): void

    • Sets the worker choice strategy options in this pool.

      +

    Returns void

    setWorkerChoiceStrategyOptions

    Protected setupHook

    • setupHook(): void

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

    Returns void

    Protected setupHook

    • setupHook(): void

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

      -

      Returns void

    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 tasksQueueSize

    Private unsetTaskStealing

    Private unsetTasksStealingOnBackPressure

    Private updateTaskSequentiallyStolenStatisticsTaskFunctionWorkerUsage

    • updateTaskSequentiallyStolenStatisticsTaskFunctionWorkerUsage(workerNodeKey, taskName): void

    • Parameters

      • workerNodeKey: number
      • taskName: string

      Returns void

    Private updateTaskSequentiallyStolenStatisticsWorkerUsage

    • updateTaskSequentiallyStolenStatisticsWorkerUsage(workerNodeKey): void

    • Parameters

      • workerNodeKey: number

      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

    Generated using TypeDoc

    \ No newline at end of file +

    start

    Private tasksQueueSize

    Private unsetTaskStealing

    Private unsetTasksStealingOnBackPressure

    Private updateTaskSequentiallyStolenStatisticsTaskFunctionWorkerUsage

    • updateTaskSequentiallyStolenStatisticsTaskFunctionWorkerUsage(workerNodeKey, taskName): void

    • Parameters

      • workerNodeKey: number
      • taskName: string

      Returns void

    Private updateTaskSequentiallyStolenStatisticsWorkerUsage

    • updateTaskSequentiallyStolenStatisticsWorkerUsage(workerNodeKey): void

    • Parameters

      • workerNodeKey: number

      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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index 9f8ebfec..e54d1b0f 100644 --- a/docs/classes/AbstractWorker.html +++ b/docs/classes/AbstractWorker.html @@ -1,8 +1,8 @@ -AbstractWorker | poolifier - v3.1.20

    Class AbstractWorker<MainWorker, Data, Response>Abstract

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

    +AbstractWorker | poolifier - v3.1.21

    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, TaskFunction<Data, Response>>

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

    -

    Methods

    addTaskFunction

    Returns AbstractWorker<MainWorker, Data, Response>

    Properties

    Protected Optional activeInterval

    activeInterval?: Timeout

    Handler id of the activeInterval worker activity check.

    +

    Protected Abstract id

    id: number

    Worker id.

    +

    Protected Readonly isMain

    isMain: 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, TaskFunction<Data, Response>>

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

    +

    Methods

    addTaskFunction

    Private beginTaskPerformance

    Private checkActive

    Private checkMessageWorkerId

    Private beginTaskPerformance

    Private checkActive

    Private checkMessageWorkerId

    Private 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

    listTaskFunctionNames

    listTaskFunctionNames

    • listTaskFunctionNames(): string[]

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

      Returns string[]

      The names of the worker's task functions.

      -

    Protected messageListener

    Protected messageListener

    removeTaskFunction

    Returns void

    removeTaskFunction

    Protected Readonly run

    Protected Readonly run

    Protected Readonly runAsync

    • runAsync(fn, task): void

    • Runs the given task function asynchronously.

      +

    Returns void

    Protected Readonly runAsync

    Protected Readonly runSync

    • runSync(fn, task): void

    • Runs the given task function synchronously.

      +

    Returns void

    Protected Readonly runSync

    Protected sendTaskFunctionNamesToMainWorker

    Protected Abstract sendToMainWorker

    • sendToMainWorker(message): void

    • Sends a message to main worker.

      +

    Returns void

    Protected sendTaskFunctionNamesToMainWorker

    Protected Abstract sendToMainWorker

    setDefaultTaskFunction

    Returns void

    setDefaultTaskFunction

    Private startCheckActive

    Private stopCheckActive

    Private updateLastTaskTimestamp

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Private startCheckActive

    Private stopCheckActive

    Private updateLastTaskTimestamp

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/CircularArray.html b/docs/classes/CircularArray.html index 6140080d..cf81e9d7 100644 --- a/docs/classes/CircularArray.html +++ b/docs/classes/CircularArray.html @@ -1,6 +1,6 @@ -CircularArray | poolifier - v3.1.20

    Class CircularArray<T>Internal

    Array with a maximum length and shifting items when full.

    +CircularArray | poolifier - v3.1.21

    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

    Generated using TypeDoc

    \ No newline at end of file +

    Returns T[]

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/ClusterWorker.html b/docs/classes/ClusterWorker.html index 06abaa65..52c4e2d4 100644 --- a/docs/classes/ClusterWorker.html +++ b/docs/classes/ClusterWorker.html @@ -1,4 +1,4 @@ -ClusterWorker | poolifier - v3.1.20

    Class ClusterWorker<Data, Response>

    A cluster worker used by a poolifier ClusterPool.

    +ClusterWorker | poolifier - v3.1.21

    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, TaskFunction<Data, Response>>

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

    -

    Accessors

    Protected id

    Methods

    addTaskFunction

    Returns ClusterWorker<Data, Response>

    Properties

    Protected Optional activeInterval

    activeInterval?: Timeout

    Handler id of the activeInterval worker activity check.

    +

    Protected Readonly isMain

    isMain: 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, TaskFunction<Data, Response>>

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

    +

    Accessors

    Protected id

    Methods

    addTaskFunction

    Protected getMainWorker

    Protected getMainWorker

    Protected handleError

    Protected handleError

    • handleError(error): string

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

      Parameters

      • error: string | Error

        The error raised by the worker.

      Returns string

      The error message.

      -

    Protected handleKillMessage

    Protected handleReadyMessage

    Protected handleKillMessage

    Protected handleReadyMessage

    Protected handleTaskFunctionOperationMessage

    hasTaskFunction

    Returns void

    Protected handleTaskFunctionOperationMessage

    hasTaskFunction

    listTaskFunctionNames

    listTaskFunctionNames

    Protected messageListener

    Protected messageListener

    removeTaskFunction

    Returns void

    removeTaskFunction

    Protected Readonly run

    Protected Readonly run

    Protected Readonly runAsync

    • runAsync(fn, task): void

    • Runs the given task function asynchronously.

      +

    Returns void

    Protected Readonly runAsync

    Protected Readonly runSync

    • runSync(fn, task): void

    • Runs the given task function synchronously.

      +

    Returns void

    Protected Readonly runSync

    Protected sendTaskFunctionNamesToMainWorker

    Protected Readonly sendToMainWorker

    • sendToMainWorker(message): void

    • Sends a message to main worker.

      +

    Returns void

    Protected sendTaskFunctionNamesToMainWorker

    Protected Readonly sendToMainWorker

    setDefaultTaskFunction

    Returns void

    setDefaultTaskFunction

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/Deque.html b/docs/classes/Deque.html index 20be06a5..aa982fe2 100644 --- a/docs/classes/Deque.html +++ b/docs/classes/Deque.html @@ -1,7 +1,7 @@ -Deque | poolifier - v3.1.20

    Class Deque<T>Internal

    Deque. +Deque | poolifier - v3.1.21

    Class Deque<T>Internal

    Deque. Implemented with a doubly linked list.

    Type Parameters

    • T

      Type of deque data.

      -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

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

    push shift unshift -

    Constructors

    constructor

    Properties

    Private Optional head

    head?: ILinkedListNode<T>

    maxSize

    maxSize: number

    The maximum size of the deque.

    -

    size

    size: number

    The size of the deque.

    -

    Private Optional tail

    tail?: ILinkedListNode<T>

    Methods

    [iterator]

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

    • Returns an iterator for the deque.

      +

    Constructors

    constructor

    Properties

    Private Optional head

    head?: ILinkedListNode<T>

    maxSize

    maxSize: number

    The maximum size of the deque.

    +

    size

    size: number

    The size of the deque.

    +

    Private Optional tail

    tail?: ILinkedListNode<T>

    Methods

    [iterator]

    backward

    • backward(): Iterable<T>

    • Returns an backward iterator for the deque.

      +

    backward

    clear

    Private incrementSize

    peekFirst

    clear

    Private incrementSize

    peekFirst

    • peekFirst(): undefined | T

    • Peeks at the first data.

      Returns undefined | T

      The first data or undefined if the deque is empty.

      -

    peekLast

    peekLast

    • peekLast(): undefined | T

    • Peeks at the last data.

      Returns undefined | T

      The last data or undefined if the deque is empty.

      -

    pop

    pop

    • pop(): undefined | T

    • Pops data from the deque.

      Returns undefined | T

      The popped data or undefined if the deque is empty.

      -

    push

    push

    • push(data): number

    • Appends data to the deque.

      Parameters

      • data: T

        Data to append.

      Returns number

      The new size of the deque.

      -

    shift

    shift

    • shift(): undefined | T

    • Shifts data from the deque.

      Returns undefined | T

      The shifted data or undefined if the deque is empty.

      -

    unshift

    • unshift(data): number

    • Prepends data to the deque.

      +

    unshift

    • unshift(data): number

    • Prepends data to the deque.

      Parameters

      • data: T

        Data to prepend.

      Returns number

      The new size of the deque.

      -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index 61289c0d..438e4c18 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -1,11 +1,11 @@ -DynamicClusterPool | poolifier - v3.1.20

    Class DynamicClusterPool<Data, Response>

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

    +DynamicClusterPool | poolifier - v3.1.21

    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

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

    Returns DynamicClusterPool<Data, Response>

    Properties

    Optional emitter

    emitter?: EventEmitterAsyncResource

    Event emitter integrated with async resource on which events can be listened to. The async tracking tooling identifier is poolifier:<PoolType>-<WorkerType>-pool.

    Events that can currently be listened to:

      @@ -72,106 +72,106 @@ 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, 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, PromiseResponseWrapper<Response>> = ...

    The task execution response promise map:

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

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

    -

    Protected Optional workerChoiceStrategyContext

    workerChoiceStrategyContext?: WorkerChoiceStrategyContext<Worker, Data, Response>

    Worker choice strategy context referencing a worker choice algorithm implementation.

    -

    Readonly Internal workerNodes

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

    Pool worker nodes.

    -

    Accessors

    Protected busy

    Protected Optional workerChoiceStrategyContext

    workerChoiceStrategyContext?: WorkerChoiceStrategyContext<Worker, Data, Response>

    Worker choice strategy context referencing a worker choice algorithm implementation.

    +

    Readonly Internal workerNodes

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

    Pool worker nodes.

    +

    Accessors

    Protected busy

    • get busy(): boolean

    • Whether the pool is busy or not.

      The pool busyness boolean status.

      -

      Returns boolean

    Protected 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

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

    • Adds a task function to this pool. +

    Protected worker

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

    • The worker type.

      +

      Returns "thread" | "cluster"

    Methods

    addTaskFunction

    Protected afterTaskExecutionHook

    Protected afterTaskExecutionHook

    Protected afterWorkerNodeSetup

    • afterWorkerNodeSetup(workerNodeKey): void

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

    Returns void

    Protected afterWorkerNodeSetup

    Protected beforeTaskExecutionHook

    • beforeTaskExecutionHook(workerNodeKey, task): void

    • Hook executed before the worker task execution. +

    Returns void

    Protected beforeTaskExecutionHook

    Protected 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

    • enableTasksQueue(enable, tasksQueueOptions?): void

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

      +

    Returns Promise<void>

    enableTasksQueue

    execute

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

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

      +

    Returns void

    execute

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

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

      Parameters

      • Optional data: Data

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

      • Optional name: string

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

      • Optional transferList: TransferListItem[]

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

      Returns Promise<Response>

      Promise that will be fulfilled when the task is completed.

      -

    Protected flagWorkerNodeAsNotReady

    Protected flushTasksQueue

    Protected getWorkerInfo

    Protected flagWorkerNodeAsNotReady

    Protected flushTasksQueue

    Protected getWorkerInfo

    hasTaskFunction

    hasTaskFunction

    Protected internalBusy

    Protected internalBusy

    Protected isMain

    listTaskFunctionNames

    Protected isMain

    listTaskFunctionNames

    Protected registerOnceWorkerMessageListener

    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

    • removeTaskFunction(name): Promise<boolean>

    • Removes a task function from this pool.

      +

    Returns void

    removeTaskFunction

    Protected sendStartupMessageToWorker

    Protected sendStartupMessageToWorker

    Protected sendToWorker

    • sendToWorker(workerNodeKey, message): void

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

      +

    Returns void

    Protected sendToWorker

    setDefaultTaskFunction

    • setDefaultTaskFunction(name): Promise<boolean>

    • Sets the default task function in this pool.

      +

    Returns void

    setDefaultTaskFunction

    setTasksQueueOptions

    setTasksQueueOptions

    setWorkerChoiceStrategy

    • setWorkerChoiceStrategy(workerChoiceStrategy, workerChoiceStrategyOptions?): void

    • Sets the worker choice strategy in this pool.

      +

    Returns void

    setWorkerChoiceStrategy

    • setWorkerChoiceStrategy(workerChoiceStrategy, workerChoiceStrategyOptions?): void

    • Sets the worker choice strategy in this pool.

      Parameters

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

        The worker choice strategy.

      • Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptions

        The worker choice strategy options.

        -

      Returns void

    setWorkerChoiceStrategyOptions

    • setWorkerChoiceStrategyOptions(workerChoiceStrategyOptions): void

    • Sets the worker choice strategy options in this pool.

      +

    Returns void

    setWorkerChoiceStrategyOptions

    Protected setupHook

    • setupHook(): void

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

    Returns void

    Protected setupHook

    Protected shallCreateDynamicWorker

    Protected shallCreateDynamicWorker

    start

    Protected Readonly workerMessageListener

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    start

    Protected Readonly workerMessageListener

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index 3cb5c4ff..51007eb6 100644 --- a/docs/classes/DynamicThreadPool.html +++ b/docs/classes/DynamicThreadPool.html @@ -1,11 +1,11 @@ -DynamicThreadPool | poolifier - v3.1.20

    Class DynamicThreadPool<Data, Response>

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

    +DynamicThreadPool | poolifier - v3.1.21

    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

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

    Returns DynamicThreadPool<Data, Response>

    Properties

    Optional emitter

    emitter?: EventEmitterAsyncResource

    Event emitter integrated with async resource on which events can be listened to. The async tracking tooling identifier is poolifier:<PoolType>-<WorkerType>-pool.

    Events that can currently be listened to:

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

    Protected Readonly filePath

    filePath: string

    Path to the worker file.

    -

    Protected 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, 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, PromiseResponseWrapper<Response>> = ...

    The task execution response promise map:

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

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

    -

    Protected Optional workerChoiceStrategyContext

    workerChoiceStrategyContext?: WorkerChoiceStrategyContext<Worker, Data, Response>

    Worker choice strategy context referencing a worker choice algorithm implementation.

    -

    Readonly Internal workerNodes

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

    Pool worker nodes.

    -

    Accessors

    Protected busy

    Protected Optional workerChoiceStrategyContext

    workerChoiceStrategyContext?: WorkerChoiceStrategyContext<Worker, Data, Response>

    Worker choice strategy context referencing a worker choice algorithm implementation.

    +

    Readonly Internal workerNodes

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

    Pool worker nodes.

    +

    Accessors

    Protected busy

    • get busy(): boolean

    • Whether the pool is busy or not.

      The pool busyness boolean status.

      -

      Returns boolean

    Protected 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

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

    • Adds a task function to this pool. +

    Protected worker

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

    • The worker type.

      +

      Returns "thread" | "cluster"

    Methods

    addTaskFunction

    Protected afterTaskExecutionHook

    Protected afterTaskExecutionHook

    Protected afterWorkerNodeSetup

    • afterWorkerNodeSetup(workerNodeKey): void

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

    Returns void

    Protected afterWorkerNodeSetup

    Protected beforeTaskExecutionHook

    • beforeTaskExecutionHook(workerNodeKey, task): void

    • Hook executed before the worker task execution. +

    Returns void

    Protected beforeTaskExecutionHook

    Protected 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

    • enableTasksQueue(enable, tasksQueueOptions?): void

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

      +

    Returns Promise<void>

    enableTasksQueue

    execute

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

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

      +

    Returns void

    execute

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

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

      Parameters

      • Optional data: Data

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

      • Optional name: string

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

      • Optional transferList: TransferListItem[]

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

      Returns Promise<Response>

      Promise that will be fulfilled when the task is completed.

      -

    Protected flagWorkerNodeAsNotReady

    Protected flushTasksQueue

    Protected getWorkerInfo

    Protected flagWorkerNodeAsNotReady

    Protected flushTasksQueue

    Protected getWorkerInfo

    hasTaskFunction

    hasTaskFunction

    Protected internalBusy

    Protected internalBusy

    Protected isMain

    listTaskFunctionNames

    Protected isMain

    listTaskFunctionNames

    Protected registerOnceWorkerMessageListener

    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

    • removeTaskFunction(name): Promise<boolean>

    • Removes a task function from this pool.

      +

    Returns void

    removeTaskFunction

    Protected sendStartupMessageToWorker

    Protected sendStartupMessageToWorker

    Protected sendToWorker

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

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

      +

    Returns void

    Protected sendToWorker

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

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

      Parameters

      • workerNodeKey: number

        The worker node key.

      • message: MessageValue<Data, unknown>

        The message.

      • Optional transferList: TransferListItem[]

        The optional array of transferable objects.

        -

      Returns void

    setDefaultTaskFunction

    • setDefaultTaskFunction(name): Promise<boolean>

    • Sets the default task function in this pool.

      +

    Returns void

    setDefaultTaskFunction

    setTasksQueueOptions

    setTasksQueueOptions

    setWorkerChoiceStrategy

    • setWorkerChoiceStrategy(workerChoiceStrategy, workerChoiceStrategyOptions?): void

    • Sets the worker choice strategy in this pool.

      +

    Returns void

    setWorkerChoiceStrategy

    • setWorkerChoiceStrategy(workerChoiceStrategy, workerChoiceStrategyOptions?): void

    • Sets the worker choice strategy in this pool.

      Parameters

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

        The worker choice strategy.

      • Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptions

        The worker choice strategy options.

        -

      Returns void

    setWorkerChoiceStrategyOptions

    • setWorkerChoiceStrategyOptions(workerChoiceStrategyOptions): void

    • Sets the worker choice strategy options in this pool.

      +

    Returns void

    setWorkerChoiceStrategyOptions

    Protected setupHook

    • setupHook(): void

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

    Returns void

    Protected setupHook

    Protected shallCreateDynamicWorker

    Protected shallCreateDynamicWorker

    start

    Protected Readonly workerMessageListener

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    start

    Protected Readonly workerMessageListener

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Class FixedClusterPool<Data, Response>

    A cluster pool with a fixed number of workers.

    +FixedClusterPool | poolifier - v3.1.21

    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

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

  • Optional maximumNumberOfWorkers: number

    • Returns FixedClusterPool<Data, Response>

    Properties

    Optional emitter

    emitter?: EventEmitterAsyncResource

    Event emitter integrated with async resource on which events can be listened to. The async tracking tooling identifier is poolifier:<PoolType>-<WorkerType>-pool.

    Events that can currently be listened to:

      @@ -69,106 +69,106 @@ 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, 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, PromiseResponseWrapper<Response>> = ...

    The task execution response promise map:

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

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

    -

    Protected Optional workerChoiceStrategyContext

    workerChoiceStrategyContext?: WorkerChoiceStrategyContext<Worker, Data, Response>

    Worker choice strategy context referencing a worker choice algorithm implementation.

    -

    Readonly Internal workerNodes

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

    Pool worker nodes.

    -

    Accessors

    Protected busy

    Protected Optional workerChoiceStrategyContext

    workerChoiceStrategyContext?: WorkerChoiceStrategyContext<Worker, Data, Response>

    Worker choice strategy context referencing a worker choice algorithm implementation.

    +

    Readonly Internal workerNodes

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

    Pool worker nodes.

    +

    Accessors

    Protected busy

    • get busy(): boolean

    • Whether the pool is busy or not.

      The pool busyness boolean status.

      -

      Returns boolean

    Protected 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

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

    • Adds a task function to this pool. +

    Protected worker

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

    • The worker type.

      +

      Returns "thread" | "cluster"

    Methods

    addTaskFunction

    Protected afterTaskExecutionHook

    Protected afterTaskExecutionHook

    Protected afterWorkerNodeSetup

    • afterWorkerNodeSetup(workerNodeKey): void

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

    Returns void

    Protected afterWorkerNodeSetup

    Protected beforeTaskExecutionHook

    • beforeTaskExecutionHook(workerNodeKey, task): void

    • Hook executed before the worker task execution. +

    Returns void

    Protected beforeTaskExecutionHook

    Protected 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

    • enableTasksQueue(enable, tasksQueueOptions?): void

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

      +

    Returns Promise<void>

    enableTasksQueue

    execute

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

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

      +

    Returns void

    execute

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

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

      Parameters

      • Optional data: Data

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

      • Optional name: string

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

      • Optional transferList: TransferListItem[]

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

      Returns Promise<Response>

      Promise that will be fulfilled when the task is completed.

      -

    Protected flagWorkerNodeAsNotReady

    Protected flushTasksQueue

    Protected getWorkerInfo

    Protected flagWorkerNodeAsNotReady

    Protected flushTasksQueue

    Protected getWorkerInfo

    hasTaskFunction

    hasTaskFunction

    • hasTaskFunction(name): boolean

    • Whether the specified task function exists in this pool.

      Parameters

      • name: string

        The name of the task function.

      Returns boolean

      true if the task function exists, false otherwise.

      -

    Protected internalBusy

    Protected internalBusy

    Protected isMain

    listTaskFunctionNames

    Protected isMain

    listTaskFunctionNames

    Protected registerOnceWorkerMessageListener

    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

    • removeTaskFunction(name): Promise<boolean>

    • Removes a task function from this pool.

      +

    Returns void

    removeTaskFunction

    • removeTaskFunction(name): Promise<boolean>

    • Removes a task function from this pool.

      Parameters

      • name: string

        The name of the task function.

      Returns Promise<boolean>

      true if the task function was removed, false otherwise.

      -

    Protected sendStartupMessageToWorker

    Protected sendStartupMessageToWorker

    Protected sendToWorker

    • sendToWorker(workerNodeKey, message): void

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

      +

    Returns void

    Protected sendToWorker

    setDefaultTaskFunction

    • setDefaultTaskFunction(name): Promise<boolean>

    • Sets the default task function in this pool.

      +

    Returns void

    setDefaultTaskFunction

    • setDefaultTaskFunction(name): Promise<boolean>

    • Sets the default task function in this pool.

      Parameters

      • name: string

        The name of the task function.

      Returns Promise<boolean>

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

      -

    setTasksQueueOptions

    setTasksQueueOptions

    setWorkerChoiceStrategy

    • setWorkerChoiceStrategy(workerChoiceStrategy, workerChoiceStrategyOptions?): void

    • Sets the worker choice strategy in this pool.

      +

    Returns void

    setWorkerChoiceStrategy

    • setWorkerChoiceStrategy(workerChoiceStrategy, workerChoiceStrategyOptions?): void

    • Sets the worker choice strategy in this pool.

      Parameters

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

        The worker choice strategy.

      • Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptions

        The worker choice strategy options.

        -

      Returns void

    setWorkerChoiceStrategyOptions

    • setWorkerChoiceStrategyOptions(workerChoiceStrategyOptions): void

    • Sets the worker choice strategy options in this pool.

      +

    Returns void

    setWorkerChoiceStrategyOptions

    Protected setupHook

    • setupHook(): void

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

    Returns void

    Protected setupHook

    Protected shallCreateDynamicWorker

    Protected shallCreateDynamicWorker

    start

    Protected Readonly workerMessageListener

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    start

    Protected Readonly workerMessageListener

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index c9547d3a..0ef1362e 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.html @@ -1,9 +1,9 @@ -FixedThreadPool | poolifier - v3.1.20

    Class FixedThreadPool<Data, Response>

    A thread pool with a fixed number of threads.

    +FixedThreadPool | poolifier - v3.1.21

    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

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

  • Optional maximumNumberOfThreads: number

    • Returns FixedThreadPool<Data, Response>

    Properties

    Optional emitter

    emitter?: EventEmitterAsyncResource

    Event emitter integrated with async resource on which events can be listened to. The async tracking tooling identifier is poolifier:<PoolType>-<WorkerType>-pool.

    Events that can currently be listened to:

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

    Protected Readonly filePath

    filePath: string

    Path to the worker file.

    -

    Protected Optional Readonly 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, 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, PromiseResponseWrapper<Response>> = ...

    The task execution response promise map:

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

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

    -

    Protected Optional workerChoiceStrategyContext

    workerChoiceStrategyContext?: WorkerChoiceStrategyContext<Worker, Data, Response>

    Worker choice strategy context referencing a worker choice algorithm implementation.

    -

    Readonly Internal workerNodes

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

    Pool worker nodes.

    -

    Accessors

    Protected busy

    Protected Optional workerChoiceStrategyContext

    workerChoiceStrategyContext?: WorkerChoiceStrategyContext<Worker, Data, Response>

    Worker choice strategy context referencing a worker choice algorithm implementation.

    +

    Readonly Internal workerNodes

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

    Pool worker nodes.

    +

    Accessors

    Protected busy

    • get busy(): boolean

    • Whether the pool is busy or not.

      The pool busyness boolean status.

      -

      Returns boolean

    Protected 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

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

    • Adds a task function to this pool. +

    Protected worker

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

    • The worker type.

      +

      Returns "thread" | "cluster"

    Methods

    addTaskFunction

    Protected afterTaskExecutionHook

    Protected afterTaskExecutionHook

    Protected afterWorkerNodeSetup

    • afterWorkerNodeSetup(workerNodeKey): void

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

    Returns void

    Protected afterWorkerNodeSetup

    Protected beforeTaskExecutionHook

    • beforeTaskExecutionHook(workerNodeKey, task): void

    • Hook executed before the worker task execution. +

    Returns void

    Protected beforeTaskExecutionHook

    Protected 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

    • enableTasksQueue(enable, tasksQueueOptions?): void

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

      +

    Returns Promise<void>

    enableTasksQueue

    execute

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

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

      +

    Returns void

    execute

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

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

      Parameters

      • Optional data: Data

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

      • Optional name: string

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

      • Optional transferList: TransferListItem[]

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

      Returns Promise<Response>

      Promise that will be fulfilled when the task is completed.

      -

    Protected flagWorkerNodeAsNotReady

    Protected flushTasksQueue

    Protected getWorkerInfo

    Protected flagWorkerNodeAsNotReady

    Protected flushTasksQueue

    Protected getWorkerInfo

    hasTaskFunction

    hasTaskFunction

    • hasTaskFunction(name): boolean

    • Whether the specified task function exists in this pool.

      Parameters

      • name: string

        The name of the task function.

      Returns boolean

      true if the task function exists, false otherwise.

      -

    Protected internalBusy

    Protected internalBusy

    Protected isMain

    listTaskFunctionNames

    Protected isMain

    listTaskFunctionNames

    Protected registerOnceWorkerMessageListener

    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

    • removeTaskFunction(name): Promise<boolean>

    • Removes a task function from this pool.

      +

    Returns void

    removeTaskFunction

    • removeTaskFunction(name): Promise<boolean>

    • Removes a task function from this pool.

      Parameters

      • name: string

        The name of the task function.

      Returns Promise<boolean>

      true if the task function was removed, false otherwise.

      -

    Protected sendStartupMessageToWorker

    Protected sendStartupMessageToWorker

    Protected sendToWorker

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

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

      +

    Returns void

    Protected sendToWorker

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

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

      Parameters

      • workerNodeKey: number

        The worker node key.

      • message: MessageValue<Data, unknown>

        The message.

      • Optional transferList: TransferListItem[]

        The optional array of transferable objects.

        -

      Returns void

    setDefaultTaskFunction

    • setDefaultTaskFunction(name): Promise<boolean>

    • Sets the default task function in this pool.

      +

    Returns void

    setDefaultTaskFunction

    • setDefaultTaskFunction(name): Promise<boolean>

    • Sets the default task function in this pool.

      Parameters

      • name: string

        The name of the task function.

      Returns Promise<boolean>

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

      -

    setTasksQueueOptions

    setTasksQueueOptions

    setWorkerChoiceStrategy

    • setWorkerChoiceStrategy(workerChoiceStrategy, workerChoiceStrategyOptions?): void

    • Sets the worker choice strategy in this pool.

      +

    Returns void

    setWorkerChoiceStrategy

    • setWorkerChoiceStrategy(workerChoiceStrategy, workerChoiceStrategyOptions?): void

    • Sets the worker choice strategy in this pool.

      Parameters

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

        The worker choice strategy.

      • Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptions

        The worker choice strategy options.

        -

      Returns void

    setWorkerChoiceStrategyOptions

    • setWorkerChoiceStrategyOptions(workerChoiceStrategyOptions): void

    • Sets the worker choice strategy options in this pool.

      +

    Returns void

    setWorkerChoiceStrategyOptions

    Protected setupHook

    • setupHook(): void

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

    Returns void

    Protected setupHook

    Protected shallCreateDynamicWorker

    Protected shallCreateDynamicWorker

    start

    Protected Readonly workerMessageListener

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    start

    Protected Readonly workerMessageListener

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Class ThreadWorker<Data, Response>

    A thread worker used by a poolifier ThreadPool.

    +ThreadWorker | poolifier - v3.1.21

    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, TaskFunction<Data, Response>>

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

    -

    Accessors

    Protected id

    Methods

    addTaskFunction

    Returns ThreadWorker<Data, Response>

    Properties

    Protected Optional activeInterval

    activeInterval?: Timeout

    Handler id of the activeInterval worker activity check.

    +

    Protected Readonly isMain

    isMain: 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, TaskFunction<Data, Response>>

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

    +

    Accessors

    Protected id

    Methods

    addTaskFunction

    Protected getMainWorker

    Protected getMainWorker

    Protected handleError

    Protected handleError

    • handleError(error): string

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

      Parameters

      • error: string | Error

        The error raised by the worker.

      Returns string

      The error message.

      -

    Protected handleKillMessage

    Protected handleReadyMessage

    Protected handleKillMessage

    Protected handleReadyMessage

    Protected handleTaskFunctionOperationMessage

    hasTaskFunction

    Returns void

    Protected handleTaskFunctionOperationMessage

    hasTaskFunction

    listTaskFunctionNames

    listTaskFunctionNames

    Protected messageListener

    Protected messageListener

    removeTaskFunction

    Returns void

    removeTaskFunction

    Protected Readonly run

    Protected Readonly run

    Protected Readonly runAsync

    • runAsync(fn, task): void

    • Runs the given task function asynchronously.

      +

    Returns void

    Protected Readonly runAsync

    Protected Readonly runSync

    • runSync(fn, task): void

    • Runs the given task function synchronously.

      +

    Returns void

    Protected Readonly runSync

    Protected sendTaskFunctionNamesToMainWorker

    Protected Readonly sendToMainWorker

    • sendToMainWorker(message): void

    • Sends a message to main worker.

      +

    Returns void

    Protected sendTaskFunctionNamesToMainWorker

    Protected Readonly sendToMainWorker

    setDefaultTaskFunction

    Returns void

    setDefaultTaskFunction

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Class WorkerChoiceStrategyContext<Worker, Data, Response>

    The worker choice strategy context.

    +WorkerChoiceStrategyContext | poolifier - v3.1.21

    Class WorkerChoiceStrategyContext<Worker, Data, Response>

    The worker choice strategy context.

    Type Parameters

    • Worker extends IWorker

      Type of worker.

    • Data = unknown

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

    • Response = unknown

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

      -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    retries retriesCount workerChoiceStrategies @@ -19,28 +19,28 @@

    Type Parameters

    • Worker extends IWorker

    • Data = unknown

    • Response = unknown

    Parameters

    • pool: IPool<Worker, Data, Response>

      The pool instance.

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

      The worker choice strategy.

    • Optional opts: WorkerChoiceStrategyOptions

      The worker choice strategy options.

      -

    Returns WorkerChoiceStrategyContext<Worker, Data, Response>

    Properties

    Private Readonly retries

    retries: number

    The maximum number of worker choice strategy execution retries.

    -

    retriesCount

    retriesCount: number

    The number of worker choice strategy 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 strategy instances registered in the context.

    -

    Private workerChoiceStrategy

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

    The worker choice strategy.

    -

    Methods

    execute

    • execute(): number

    • Executes the worker choice strategy in the context algorithm.

      +

    Returns WorkerChoiceStrategyContext<Worker, Data, Response>

    Properties

    Private Readonly retries

    retries: number

    The maximum number of worker choice strategy execution retries.

    +

    retriesCount

    retriesCount: number

    The number of worker choice strategy 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 strategy instances registered in the context.

    +

    Private workerChoiceStrategy

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

    The worker choice strategy.

    +

    Methods

    execute

    Private executeStrategy

    Private executeStrategy

    getStrategyPolicy

    getStrategyPolicy

    getTaskStatisticsRequirements

    getTaskStatisticsRequirements

    remove

    remove

    setOptions

    setOptions

    setWorkerChoiceStrategy

    • setWorkerChoiceStrategy(workerChoiceStrategy): void

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

      +

    Returns void

    setWorkerChoiceStrategy

    • setWorkerChoiceStrategy(workerChoiceStrategy): void

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

      Parameters

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

        The worker choice strategy to set.

        -

      Returns void

    update

    • update(workerNodeKey): boolean

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

      +

    Returns void

    update

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/availableParallelism.html b/docs/functions/availableParallelism.html index 8abadc38..2a69950f 100644 --- a/docs/functions/availableParallelism.html +++ b/docs/functions/availableParallelism.html @@ -1,4 +1,4 @@ -availableParallelism | poolifier - v3.1.20

    Function availableParallelism

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/hierarchy.html b/docs/hierarchy.html index c2e90a45..2abdd358 100644 --- a/docs/hierarchy.html +++ b/docs/hierarchy.html @@ -1 +1 @@ -poolifier - v3.1.20

    poolifier - v3.1.20

    Class Hierarchy

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +poolifier - v3.1.21

    poolifier - v3.1.21

    Class Hierarchy

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index c52e68d1..0a5579dc 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,4 +1,4 @@ -poolifier - v3.1.20

    poolifier - v3.1.20

    Index

    Classes

    AbstractPool +poolifier - v3.1.21

    poolifier - v3.1.21

    Index

    Classes

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

    Functions

    availableParallelism -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/EventLoopUtilizationMeasurementStatistics.html b/docs/interfaces/EventLoopUtilizationMeasurementStatistics.html index d60b8ca0..2a52fea2 100644 --- a/docs/interfaces/EventLoopUtilizationMeasurementStatistics.html +++ b/docs/interfaces/EventLoopUtilizationMeasurementStatistics.html @@ -1,5 +1,5 @@ -EventLoopUtilizationMeasurementStatistics | poolifier - v3.1.20

    Interface EventLoopUtilizationMeasurementStatisticsInternal

    Event loop utilization measurement statistics.

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

    Properties

    active +EventLoopUtilizationMeasurementStatistics | poolifier - v3.1.21

    Interface EventLoopUtilizationMeasurementStatisticsInternal

    Event loop utilization measurement statistics.

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

    Properties

    active idle utilization? -

    Properties

    Readonly active

    active: MeasurementStatistics

    Readonly idle

    idle: MeasurementStatistics

    Optional utilization

    utilization?: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Readonly active

    active: MeasurementStatistics

    Readonly idle

    idle: MeasurementStatistics

    Optional utilization

    utilization?: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/ILinkedListNode.html b/docs/interfaces/ILinkedListNode.html index 970cbd9f..c704b080 100644 --- a/docs/interfaces/ILinkedListNode.html +++ b/docs/interfaces/ILinkedListNode.html @@ -1,6 +1,6 @@ -ILinkedListNode | poolifier - v3.1.20

    Interface ILinkedListNode<T>Internal

    Linked list node interface.

    +ILinkedListNode | poolifier - v3.1.21

    Interface ILinkedListNode<T>Internal

    Linked list node interface.

    interface ILinkedListNode<T> {
        data: T;
        next?: ILinkedListNode<T>;
        prev?: ILinkedListNode<T>;
    }

    Type Parameters

    • T

      Type of linked list node data.

      -

    Properties

    data +

    Properties

    data next? prev? -

    Properties

    data

    data: T

    Optional next

    next?: ILinkedListNode<T>

    Optional prev

    prev?: ILinkedListNode<T>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    data

    data: T

    Optional next

    next?: ILinkedListNode<T>

    Optional prev

    prev?: ILinkedListNode<T>

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Interface IPool<Worker, Data, Response>

    Contract definition for a poolifier pool.

    +IPool | poolifier - v3.1.21

    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;
        listTaskFunctionNames: (() => string[]);
        removeTaskFunction: ((name) => Promise<boolean>);
        setDefaultTaskFunction: ((name) => Promise<boolean>);
        setTasksQueueOptions: ((tasksQueueOptions) => void);
        setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void);
        setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void);
        start: (() => void);
        workerNodes: IWorkerNode<Worker, Data>[];
    }

    Type Parameters

    • Worker extends IWorker

      Type of worker which manages this pool.

    • Data = unknown

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

    • Response = unknown

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

      -

    Implemented by

    Properties

    addTaskFunction +

    Implemented by

    Properties

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

    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.

    +

    Readonly destroy

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

    Terminates all workers in this pool.

    Type declaration

      • (): Promise<void>

      • Terminates all workers in this pool.

        -

        Returns Promise<void>

    Optional Readonly emitter

    emitter?: EventEmitterAsyncResource

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

    Returns Promise<void>

    Optional Readonly emitter

    emitter?: EventEmitterAsyncResource

    Event emitter integrated with async resource on which events can be listened to. The async tracking tooling identifier is poolifier:<PoolType>-<WorkerType>-pool.

    Events that can currently be listened to:

      @@ -46,13 +46,13 @@ 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

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

        Parameters

        • enable: boolean

          Whether to enable or disable the worker node tasks queue.

        • Optional tasksQueueOptions: TasksQueueOptions

          The worker node tasks queue options.

        Returns void

    Param: enable

    Whether to enable or disable the worker node tasks queue.

    Param: tasksQueueOptions

    The worker node tasks queue options.

    -

    Readonly execute

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

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

    +

    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>

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

        Parameters

        • Optional data: Data

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

        • Optional name: string

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

          @@ -62,44 +62,44 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo

          Param: name

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

          Param: transferList

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

      • Whether the specified task function exists in this pool.

        Parameters

        • name: string

          The name of the task function.

        Returns boolean

        true if the task function exists, false otherwise.

    Param: name

    The name of the task function.

    Returns

    true if the task function exists, false otherwise.

    -

    Readonly info

    info: PoolInfo

    Pool information.

    -

    Readonly listTaskFunctionNames

    listTaskFunctionNames: (() => string[])

    Lists the names of task function available in this pool.

    +

    Readonly info

    info: PoolInfo

    Pool information.

    +

    Readonly listTaskFunctionNames

    listTaskFunctionNames: (() => string[])

    Lists the names of task function available in this pool.

    Type declaration

      • (): string[]

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

        Returns string[]

        The names of task function available in this pool.

    Returns

    The names of task function 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>

      • Removes a task function from this pool.

        Parameters

        • name: string

          The name of the task function.

        Returns Promise<boolean>

        true if the task function was removed, false otherwise.

    Param: name

    The name of the task function.

    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>

      • Sets the default task function in this pool.

        Parameters

        • name: string

          The name of the task function.

        Returns Promise<boolean>

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

    Param: name

    The name of the task function.

    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

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

        Parameters

        Returns void

    Param: tasksQueueOptions

    The worker node tasks queue options.

    -

    Readonly setWorkerChoiceStrategy

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

    Sets the worker choice strategy in this pool.

    +

    Readonly setWorkerChoiceStrategy

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

    Sets the worker choice strategy in this pool.

    Type declaration

      • (workerChoiceStrategy, workerChoiceStrategyOptions?): void

      • Sets the worker choice strategy in this pool.

        Parameters

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

          The worker choice strategy.

        • Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptions

          The worker choice strategy options.

        Returns void

    Param: workerChoiceStrategy

    The worker choice strategy.

    Param: workerChoiceStrategyOptions

    The worker choice strategy options.

    -

    Readonly setWorkerChoiceStrategyOptions

    setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)

    Sets the worker choice strategy options in this pool.

    +

    Readonly setWorkerChoiceStrategyOptions

    setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)

    Sets the worker choice strategy options in this pool.

    Type declaration

      • (workerChoiceStrategyOptions): void

      • Sets the worker choice strategy options in this pool.

        Parameters

        Returns void

    Param: workerChoiceStrategyOptions

    The worker choice strategy options.

    -

    Readonly start

    start: (() => void)

    Starts the minimum number of workers in this pool.

    +

    Readonly start

    start: (() => void)

    Starts the minimum number of workers in this pool.

    Type declaration

      • (): void

      • Starts the minimum number of workers in this pool.

        -

        Returns void

    Readonly Internal workerNodes

    workerNodes: IWorkerNode<Worker, Data>[]

    Pool worker nodes.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Readonly Internal workerNodes

    workerNodes: IWorkerNode<Worker, Data>[]

    Pool worker nodes.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/IWorker.html b/docs/interfaces/IWorker.html index 1451cc91..3e1f4eb6 100644 --- a/docs/interfaces/IWorker.html +++ b/docs/interfaces/IWorker.html @@ -1,5 +1,5 @@ -IWorker | poolifier - v3.1.20

    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]?(error, event, ...args): void;
        addListener(eventName, listener): this;
        emit(eventName, ...args): boolean;
        eventNames(): (string | symbol)[];
        getMaxListeners(): number;
        listenerCount(eventName, listener?): number;
        listeners(eventName): Function[];
        off(eventName, listener): this;
        prependListener(eventName, listener): this;
        prependOnceListener(eventName, listener): this;
        rawListeners(eventName): Function[];
        removeAllListeners(event?): this;
        removeListener(eventName, listener): this;
        setMaxListeners(n): this;
    }

    Hierarchy

    • EventEmitter
      • IWorker

    Properties

    disconnect? +IWorker | poolifier - v3.1.21

    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]?(error, event, ...args): void;
        addListener(eventName, listener): this;
        emit(eventName, ...args): boolean;
        eventNames(): (string | symbol)[];
        getMaxListeners(): number;
        listenerCount(eventName, listener?): number;
        listeners(eventName): Function[];
        off(eventName, listener): this;
        prependListener(eventName, listener): this;
        prependOnceListener(eventName, listener): this;
        rawListeners(eventName): Function[];
        removeAllListeners(event?): this;
        removeListener(eventName, listener): this;
        setMaxListeners(n): this;
    }

    Hierarchy

    • EventEmitter
      • IWorker

    Properties

    disconnect? id? kill? on @@ -23,61 +23,61 @@ setMaxListeners

    Properties

    Optional Readonly disconnect

    disconnect?: (() => void)

    Cluster worker disconnect.

    Type declaration

      • (): void

      • Cluster worker disconnect.

        -

        Returns void

    Optional Readonly id

    id?: number

    Cluster worker id.

    -

    Optional Readonly kill

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

    Cluster worker kill.

    +

    Returns void

    Optional Readonly id

    id?: number

    Cluster worker id.

    +

    Optional Readonly kill

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

    Cluster worker kill.

    Type declaration

      • (signal?): void

      • Cluster worker kill.

        -

        Parameters

        • Optional signal: string

        Returns void

    Readonly on

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

    Registers an event handler.

    +

    Parameters

    • Optional signal: string

    Returns void

    Readonly on

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

    Registers an event handler.

    Type declaration

      • (event, handler): this

      • Registers an event handler.

        Parameters

        Returns this

    Param: event

    The event.

    Param: handler

    The event handler.

    -

    Readonly once

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

    Registers once an event handler.

    +

    Readonly once

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

    Registers once an event handler.

    Type declaration

      • (event, handler): this

      • Registers once an event handler.

        Parameters

        Returns this

    Param: event

    The event.

    Param: handler

    The event handler.

    -

    Optional Readonly terminate

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

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

    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>

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

        -

        Returns Promise<number>

    Optional Readonly threadId

    threadId?: number

    Worker thread worker id.

    -

    Optional Readonly unref

    unref?: (() => void)

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

    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

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

        Returns void

        Since

        v10.5.0

    Since

    v10.5.0

    -

    Methods

    Optional [captureRejectionSymbol]

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

    • Parameters

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

      Returns void

    addListener

    • addListener(eventName, listener): this

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

      +

    Methods

    Optional [captureRejectionSymbol]

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

    • Parameters

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

      Returns void

    addListener

    • addListener(eventName, listener): this

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

      Parameters

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

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns this

      Since

      v0.1.26

      -

    emit

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

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

    emit

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

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

      Returns true if the event had listeners, false otherwise.

      import { EventEmitter } from 'node:events';
      const myEmitter = new EventEmitter();

      // First listener
      myEmitter.on('event', function firstListener() {
        console.log('Helloooo! first listener');
      });
      // Second listener
      myEmitter.on('event', function secondListener(arg1, arg2) {
        console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
      });
      // Third listener
      myEmitter.on('event', function thirdListener(...args) {
        const parameters = args.join(', ');
        console.log(`event with parameters ${parameters} in third listener`);
      });

      console.log(myEmitter.listeners('event'));

      myEmitter.emit('event', 1, 2, 3, 4, 5);

      // Prints:
      // [
      //   [Function: firstListener],
      //   [Function: secondListener],
      //   [Function: thirdListener]
      // ]
      // Helloooo! first listener
      // event with parameters 1, 2 in second listener
      // event with parameters 1, 2, 3, 4, 5 in third listener

      Parameters

      • eventName: string | symbol
      • Rest ...args: any[]

      Returns boolean

      Since

      v0.1.26

      -

    eventNames

    • eventNames(): (string | symbol)[]

    • Returns an array listing the events for which the emitter has registered +

    eventNames

    • eventNames(): (string | symbol)[]

    • Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

      import { EventEmitter } from 'node:events';

      const myEE = new EventEmitter();
      myEE.on('foo', () => {});
      myEE.on('bar', () => {});

      const sym = Symbol('symbol');
      myEE.on(sym, () => {});

      console.log(myEE.eventNames());
      // Prints: [ 'foo', 'bar', Symbol(symbol) ]

      Returns (string | symbol)[]

      Since

      v6.0.0

      -

    getMaxListeners

    • getMaxListeners(): number

    • Returns the current max listener value for the EventEmitter which is either +

    getMaxListeners

    • getMaxListeners(): number

    • Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.

      Returns number

      Since

      v1.0.0

      -

    listenerCount

    • listenerCount(eventName, listener?): number

    • Returns the number of listeners listening for the event named eventName. +

    listenerCount

    • listenerCount(eventName, listener?): number

    • Returns the number of listeners listening for the event named eventName. If listener is provided, it will return how many times the listener is found in the list of the listeners of the event.

      Parameters

      • eventName: string | symbol

        The name of the event being listened for

      • Optional listener: Function

        The event handler function

      Returns number

      Since

      v3.2.0

      -

    listeners

    • listeners(eventName): Function[]

    • Returns a copy of the array of listeners for the event named eventName.

      +

    listeners

    • listeners(eventName): Function[]

    • Returns a copy of the array of listeners for the event named eventName.

      server.on('connection', (stream) => {
        console.log('someone connected!');
      });
      console.log(util.inspect(server.listeners('connection')));
      // Prints: [ [Function] ]

      Parameters

      • eventName: string | symbol

      Returns Function[]

      Since

      v0.1.26

      -

    off

    • off(eventName, listener): this

    • Alias for emitter.removeListener().

      +

    off

    • off(eventName, listener): this

    • Alias for emitter.removeListener().

      Parameters

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

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns this

      Since

      v10.0.0

      -

    prependListener

    • prependListener(eventName, listener): this

    • Adds the listener function to the beginning of the listeners array for the +

    prependListener

    • prependListener(eventName, listener): this

    • Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple times.

      @@ -87,7 +87,7 @@ times.

      Parameters

      • eventName: string | symbol

        The name of the event.

      • listener: ((...args) => void)

        The callback function

          • (...args): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns this

      Since

      v6.0.0

      -

    prependOnceListener

    • prependOnceListener(eventName, listener): this

    • Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this +

    prependOnceListener

    • prependOnceListener(eventName, listener): this

    • Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

      server.prependOnceListener('connection', (stream) => {
        console.log('Ah, we have our first user!');
      });
      @@ -95,18 +95,18 @@ listener is removed, and then invoked.

      Parameters

      • eventName: string | symbol

        The name of the event.

      • listener: ((...args) => void)

        The callback function

          • (...args): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns this

      Since

      v6.0.0

      -

    rawListeners

    • rawListeners(eventName): Function[]

    • Returns a copy of the array of listeners for the event named eventName, +

    rawListeners

    • rawListeners(eventName): Function[]

    • Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

      import { EventEmitter } from 'node:events';
      const emitter = new EventEmitter();
      emitter.once('log', () => console.log('log once'));

      // Returns a new Array with a function `onceWrapper` which has a property
      // `listener` which contains the original listener bound above
      const listeners = emitter.rawListeners('log');
      const logFnWrapper = listeners[0];

      // Logs "log once" to the console and does not unbind the `once` event
      logFnWrapper.listener();

      // Logs "log once" to the console and removes the listener
      logFnWrapper();

      emitter.on('log', () => console.log('log persistently'));
      // Will return a new Array with a single function bound by `.on()` above
      const newListeners = emitter.rawListeners('log');

      // Logs "log persistently" twice
      newListeners[0]();
      emitter.emit('log');

      Parameters

      • eventName: string | symbol

      Returns Function[]

      Since

      v9.4.0

      -

    removeAllListeners

    • removeAllListeners(event?): this

    • Removes all listeners, or those of the specified eventName.

      +

    removeAllListeners

    • removeAllListeners(event?): this

    • Removes all listeners, or those of the specified eventName.

      It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

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

      Parameters

      • Optional event: string | symbol

      Returns this

      Since

      v0.1.26

      -

    removeListener

    • removeListener(eventName, listener): this

    • Removes the specified listener from the listener array for the event namedeventName.

      +

    removeListener

    • removeListener(eventName, listener): this

    • Removes the specified listener from the listener array for the event namedeventName.

      const callback = (stream) => {
        console.log('someone connected!');
      };
      server.on('connection', callback);
      // ...
      server.removeListener('connection', callback);

      removeListener() will remove, at most, one instance of a listener from the @@ -130,10 +130,10 @@ recently added instance. In the example the once('ping')lis

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

      Parameters

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

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns this

      Since

      v0.1.26

      -

    setMaxListeners

    • setMaxListeners(n): this

    • By default EventEmitters will print a warning if more than 10 listeners are +

    setMaxListeners

    • setMaxListeners(n): this

    • By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.

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

      Parameters

      • n: number

      Returns this

      Since

      v0.3.5

      -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/IWorkerChoiceStrategy.html b/docs/interfaces/IWorkerChoiceStrategy.html index 0446726a..6bc84d0e 100644 --- a/docs/interfaces/IWorkerChoiceStrategy.html +++ b/docs/interfaces/IWorkerChoiceStrategy.html @@ -1,5 +1,5 @@ -IWorkerChoiceStrategy | poolifier - v3.1.20

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

    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 @@ -14,26 +14,26 @@ If no worker nodes are not eligible, undefined is returned. If undefined is returned, the caller retry.

    Returns undefined | number

    The worker node key or undefined.

    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

      • Removes the worker node key from strategy internals.

        Parameters

        • workerNodeKey: number

          The worker node key.

        Returns boolean

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

    Param: workerNodeKey

    The worker node key.

    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

      • Resets strategy internals.

        Returns boolean

        true if the reset is successful, false otherwise.

    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

      • (opts): void

      • Sets the worker choice strategy options.

        Parameters

        Returns void

    Param: opts

    The worker choice strategy options.

    -

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

    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

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

        Parameters

        • workerNodeKey: number

        Returns boolean

        true if the update is successful, false otherwise.

    Returns

    true if the update is successful, false otherwise.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/IWorkerNode.html b/docs/interfaces/IWorkerNode.html index ad1eeae1..04b816a5 100644 --- a/docs/interfaces/IWorkerNode.html +++ b/docs/interfaces/IWorkerNode.html @@ -1,7 +1,7 @@ -IWorkerNode | poolifier - v3.1.20

    Interface IWorkerNode<Worker, Data>Internal

    Worker node interface.

    +IWorkerNode | poolifier - v3.1.21

    Interface IWorkerNode<Worker, Data>Internal

    Worker node interface.

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

    Properties

    Readonly clearTasksQueue

    clearTasksQueue: (() => void)

    Clears tasks queue.

    Type declaration

      • (): void

      • Clears tasks queue.

        -

        Returns void

    Readonly deleteTaskFunctionWorkerUsage

    deleteTaskFunctionWorkerUsage: ((name) => boolean)

    Deletes task function worker usage statistics.

    +

    Returns void

    Readonly deleteTaskFunctionWorkerUsage

    deleteTaskFunctionWorkerUsage: ((name) => boolean)

    Deletes task function worker usage statistics.

    Type declaration

      • (name): boolean

      • Deletes task function worker usage statistics.

        Parameters

        • name: string

          The task function name.

        Returns boolean

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

    Param: name

    The task function name.

    Returns

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

    -

    Readonly dequeueTask

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

    Dequeue task.

    +

    Readonly dequeueTask

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

    Dequeue task.

    Type declaration

      • (): undefined | Task<Data>

      • Dequeue task.

        Returns undefined | Task<Data>

        The dequeued task.

    Returns

    The dequeued task.

    -

    Readonly enqueueTask

    enqueueTask: ((task) => number)

    Enqueue task.

    +

    Readonly enqueueTask

    enqueueTask: ((task) => number)

    Enqueue task.

    Type declaration

      • (task): number

      • Enqueue task.

        Parameters

        Returns number

        The tasks queue size.

    Param: task

    The task to queue.

    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

      • (name): undefined | WorkerUsage

      • Gets task function worker usage statistics.

        Parameters

        • name: string

          The task function name.

        Returns undefined | WorkerUsage

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

    Param: name

    The task function name.

    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

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

        Returns boolean

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

    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 popTask

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

    Pops a task from the tasks queue.

    +

    Readonly info

    info: WorkerInfo

    Worker info.

    +

    Optional Readonly messageChannel

    messageChannel?: MessageChannel

    Message channel (worker thread only).

    +

    Readonly popTask

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

    Pops a task from the tasks queue.

    Type declaration

      • (): undefined | Task<Data>

      • Pops a task from the tasks queue.

        Returns undefined | Task<Data>

        The popped task.

    Returns

    The popped task.

    -

    Readonly registerOnceWorkerEventHandler

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

    Registers once a worker event handler.

    +

    Readonly registerOnceWorkerEventHandler

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

    Registers once a worker event handler.

    Type declaration

      • (event, handler): void

      • Registers once a worker event handler.

        Parameters

        Returns void

    Param: event

    The event.

    Param: handler

    The event handler.

    -

    Readonly registerWorkerEventHandler

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

    Registers a worker event handler.

    +

    Readonly registerWorkerEventHandler

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

    Registers a worker event handler.

    Type declaration

      • (event, handler): void

      • Registers a worker event handler.

        Parameters

        Returns void

    Param: event

    The event.

    Param: handler

    The event handler.

    -

    Readonly resetUsage

    resetUsage: (() => void)

    Resets usage statistics.

    +

    Readonly resetUsage

    resetUsage: (() => void)

    Resets usage statistics.

    Type declaration

      • (): void

      • Resets usage statistics.

        -

        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

      • Tasks queue size.

        Returns number

        The tasks queue size.

    Returns

    The tasks queue size.

    -

    Readonly terminate

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

    Terminates the worker node.

    +

    Readonly terminate

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

    Terminates the worker node.

    Type declaration

      • (): Promise<void>

      • Terminates the worker node.

        -

        Returns Promise<void>

    Readonly unshiftTask

    unshiftTask: ((task) => number)

    Prepends a task to the tasks queue.

    +

    Returns Promise<void>

    Readonly unshiftTask

    unshiftTask: ((task) => number)

    Prepends a task to the tasks queue.

    Type declaration

      • (task): number

      • Prepends a task to the tasks queue.

        Parameters

        Returns number

        The tasks queue size.

    Param: task

    The task to prepend.

    Returns

    The tasks queue size.

    -

    Readonly usage

    usage: WorkerUsage

    Worker usage statistics.

    -

    Readonly worker

    worker: Worker

    Worker.

    -

    Methods

    Optional [captureRejectionSymbol]

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

    • Parameters

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

      Returns void

    addListener

    • addListener(eventName, listener): this

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

      +

    Readonly usage

    usage: WorkerUsage

    Worker usage statistics.

    +

    Readonly worker

    worker: Worker

    Worker.

    +

    Methods

    Optional [captureRejectionSymbol]

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

    • Parameters

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

      Returns void

    addListener

    • addListener(eventName, listener): this

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

      Parameters

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

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns this

      Since

      v0.1.26

      -

    emit

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

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

    emit

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

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

      Returns true if the event had listeners, false otherwise.

      import { EventEmitter } from 'node:events';
      const myEmitter = new EventEmitter();

      // First listener
      myEmitter.on('event', function firstListener() {
        console.log('Helloooo! first listener');
      });
      // Second listener
      myEmitter.on('event', function secondListener(arg1, arg2) {
        console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
      });
      // Third listener
      myEmitter.on('event', function thirdListener(...args) {
        const parameters = args.join(', ');
        console.log(`event with parameters ${parameters} in third listener`);
      });

      console.log(myEmitter.listeners('event'));

      myEmitter.emit('event', 1, 2, 3, 4, 5);

      // Prints:
      // [
      //   [Function: firstListener],
      //   [Function: secondListener],
      //   [Function: thirdListener]
      // ]
      // Helloooo! first listener
      // event with parameters 1, 2 in second listener
      // event with parameters 1, 2, 3, 4, 5 in third listener

      Parameters

      • eventName: string | symbol
      • Rest ...args: any[]

      Returns boolean

      Since

      v0.1.26

      -

    eventNames

    • eventNames(): (string | symbol)[]

    • Returns an array listing the events for which the emitter has registered +

    eventNames

    • eventNames(): (string | symbol)[]

    • Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

      import { EventEmitter } from 'node:events';

      const myEE = new EventEmitter();
      myEE.on('foo', () => {});
      myEE.on('bar', () => {});

      const sym = Symbol('symbol');
      myEE.on(sym, () => {});

      console.log(myEE.eventNames());
      // Prints: [ 'foo', 'bar', Symbol(symbol) ]

      Returns (string | symbol)[]

      Since

      v6.0.0

      -

    getMaxListeners

    • getMaxListeners(): number

    • Returns the current max listener value for the EventEmitter which is either +

    getMaxListeners

    • getMaxListeners(): number

    • Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.

      Returns number

      Since

      v1.0.0

      -

    listenerCount

    • listenerCount(eventName, listener?): number

    • Returns the number of listeners listening for the event named eventName. +

    listenerCount

    • listenerCount(eventName, listener?): number

    • Returns the number of listeners listening for the event named eventName. If listener is provided, it will return how many times the listener is found in the list of the listeners of the event.

      Parameters

      • eventName: string | symbol

        The name of the event being listened for

      • Optional listener: Function

        The event handler function

      Returns number

      Since

      v3.2.0

      -

    listeners

    • listeners(eventName): Function[]

    • Returns a copy of the array of listeners for the event named eventName.

      +

    listeners

    • listeners(eventName): Function[]

    • Returns a copy of the array of listeners for the event named eventName.

      server.on('connection', (stream) => {
        console.log('someone connected!');
      });
      console.log(util.inspect(server.listeners('connection')));
      // Prints: [ [Function] ]

      Parameters

      • eventName: string | symbol

      Returns Function[]

      Since

      v0.1.26

      -

    off

    • off(eventName, listener): this

    • Alias for emitter.removeListener().

      +

    off

    • off(eventName, listener): this

    • Alias for emitter.removeListener().

      Parameters

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

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns this

      Since

      v10.0.0

      -

    on

    • on(eventName, listener): this

    • Adds the listener function to the end of the listeners array for the +

    on

    • on(eventName, listener): this

    • Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple times.

      @@ -144,7 +144,7 @@ event listener to the beginning of the listeners array.

      Parameters

      • eventName: string | symbol

        The name of the event.

      • listener: ((...args) => void)

        The callback function

          • (...args): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns this

      Since

      v0.1.101

      -

    once

    • once(eventName, listener): this

    • Adds a one-timelistener function for the event named eventName. The +

    once

    • once(eventName, listener): this

    • Adds a one-timelistener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

      server.once('connection', (stream) => {
        console.log('Ah, we have our first user!');
      });
      @@ -156,7 +156,7 @@ event listener to the beginning of the listeners array.

      Parameters

      • eventName: string | symbol

        The name of the event.

      • listener: ((...args) => void)

        The callback function

          • (...args): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns this

      Since

      v0.3.0

      -

    prependListener

    • prependListener(eventName, listener): this

    • Adds the listener function to the beginning of the listeners array for the +

    prependListener

    • prependListener(eventName, listener): this

    • Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple times.

      @@ -166,7 +166,7 @@ times.

      Parameters

      • eventName: string | symbol

        The name of the event.

      • listener: ((...args) => void)

        The callback function

          • (...args): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns this

      Since

      v6.0.0

      -

    prependOnceListener

    • prependOnceListener(eventName, listener): this

    • Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this +

    prependOnceListener

    • prependOnceListener(eventName, listener): this

    • Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

      server.prependOnceListener('connection', (stream) => {
        console.log('Ah, we have our first user!');
      });
      @@ -174,18 +174,18 @@ listener is removed, and then invoked.

      Parameters

      • eventName: string | symbol

        The name of the event.

      • listener: ((...args) => void)

        The callback function

          • (...args): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns this

      Since

      v6.0.0

      -

    rawListeners

    • rawListeners(eventName): Function[]

    • Returns a copy of the array of listeners for the event named eventName, +

    rawListeners

    • rawListeners(eventName): Function[]

    • Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

      import { EventEmitter } from 'node:events';
      const emitter = new EventEmitter();
      emitter.once('log', () => console.log('log once'));

      // Returns a new Array with a function `onceWrapper` which has a property
      // `listener` which contains the original listener bound above
      const listeners = emitter.rawListeners('log');
      const logFnWrapper = listeners[0];

      // Logs "log once" to the console and does not unbind the `once` event
      logFnWrapper.listener();

      // Logs "log once" to the console and removes the listener
      logFnWrapper();

      emitter.on('log', () => console.log('log persistently'));
      // Will return a new Array with a single function bound by `.on()` above
      const newListeners = emitter.rawListeners('log');

      // Logs "log persistently" twice
      newListeners[0]();
      emitter.emit('log');

      Parameters

      • eventName: string | symbol

      Returns Function[]

      Since

      v9.4.0

      -

    removeAllListeners

    • removeAllListeners(event?): this

    • Removes all listeners, or those of the specified eventName.

      +

    removeAllListeners

    • removeAllListeners(event?): this

    • Removes all listeners, or those of the specified eventName.

      It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

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

      Parameters

      • Optional event: string | symbol

      Returns this

      Since

      v0.1.26

      -

    removeListener

    • removeListener(eventName, listener): this

    • Removes the specified listener from the listener array for the event namedeventName.

      +

    removeListener

    • removeListener(eventName, listener): this

    • Removes the specified listener from the listener array for the event namedeventName.

      const callback = (stream) => {
        console.log('someone connected!');
      };
      server.on('connection', callback);
      // ...
      server.removeListener('connection', callback);

      removeListener() will remove, at most, one instance of a listener from the @@ -209,10 +209,10 @@ recently added instance. In the example the once('ping')lis

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

      Parameters

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

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns this

      Since

      v0.1.26

      -

    setMaxListeners

    • setMaxListeners(n): this

    • By default EventEmitters will print a warning if more than 10 listeners are +

    setMaxListeners

    • setMaxListeners(n): this

    • By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.

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

      Parameters

      • n: number

      Returns this

      Since

      v0.3.5

      -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/MeasurementOptions.html b/docs/interfaces/MeasurementOptions.html index b5055a8f..0bb3a907 100644 --- a/docs/interfaces/MeasurementOptions.html +++ b/docs/interfaces/MeasurementOptions.html @@ -1,4 +1,4 @@ -MeasurementOptions | poolifier - v3.1.20

    Interface MeasurementOptions

    Measurement options.

    -
    interface MeasurementOptions {
        median: boolean;
    }

    Properties

    median +MeasurementOptions | poolifier - v3.1.21

    Interface MeasurementOptions

    Measurement options.

    +
    interface MeasurementOptions {
        median: boolean;
    }

    Properties

    median

    Properties

    Readonly median

    median: boolean

    Set measurement median.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/MeasurementStatistics.html b/docs/interfaces/MeasurementStatistics.html index fb3f9d4d..b1e9d5d2 100644 --- a/docs/interfaces/MeasurementStatistics.html +++ b/docs/interfaces/MeasurementStatistics.html @@ -1,14 +1,14 @@ -MeasurementStatistics | poolifier - v3.1.20

    Interface MeasurementStatisticsInternal

    Measurement statistics.

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

    Properties

    aggregate? +MeasurementStatistics | poolifier - v3.1.21

    Interface MeasurementStatisticsInternal

    Measurement statistics.

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

    Properties

    aggregate? average? history maximum? median? minimum?

    Properties

    Optional aggregate

    aggregate?: number

    Measurement aggregate.

    -

    Optional average

    average?: number

    Measurement average.

    -

    Readonly history

    history: CircularArray<number>

    Measurement history.

    -

    Optional maximum

    maximum?: number

    Measurement maximum.

    -

    Optional median

    median?: number

    Measurement median.

    -

    Optional minimum

    minimum?: number

    Measurement minimum.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Optional average

    average?: number

    Measurement average.

    +

    Readonly history

    history: CircularArray<number>

    Measurement history.

    +

    Optional maximum

    maximum?: number

    Measurement maximum.

    +

    Optional median

    median?: number

    Measurement median.

    +

    Optional minimum

    minimum?: number

    Measurement minimum.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/MeasurementStatisticsRequirements.html b/docs/interfaces/MeasurementStatisticsRequirements.html index 012594ab..566567be 100644 --- a/docs/interfaces/MeasurementStatisticsRequirements.html +++ b/docs/interfaces/MeasurementStatisticsRequirements.html @@ -1,8 +1,8 @@ -MeasurementStatisticsRequirements | poolifier - v3.1.20

    Interface MeasurementStatisticsRequirementsInternal

    Measurement statistics requirements.

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

    Properties

    aggregate +MeasurementStatisticsRequirements | poolifier - v3.1.21

    Interface MeasurementStatisticsRequirementsInternal

    Measurement statistics requirements.

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

    Properties

    aggregate average median

    Properties

    aggregate

    aggregate: boolean

    Requires measurement aggregate.

    -

    average

    average: boolean

    Requires measurement average.

    -

    median

    median: boolean

    Requires measurement median.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    average

    average: boolean

    Requires measurement average.

    +

    median

    median: boolean

    Requires measurement median.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/MessageValue.html b/docs/interfaces/MessageValue.html index 7ee400ff..81eafa67 100644 --- a/docs/interfaces/MessageValue.html +++ b/docs/interfaces/MessageValue.html @@ -1,7 +1,7 @@ -MessageValue | poolifier - v3.1.20

    Interface MessageValue<Data, ErrorData>Internal

    Message object that is passed between main worker and worker.

    +MessageValue | poolifier - v3.1.21

    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;
        ready?: boolean;
        statistics?: WorkerStatistics;
        taskFunction?: string;
        taskFunctionName?: string;
        taskFunctionNames?: string[];
        taskFunctionOperation?: "add" | "default" | "remove";
        taskFunctionOperationStatus?: boolean;
        taskId?: string;
        taskPerformance?: TaskPerformance;
        timestamp?: number;
        transferList?: TransferListItem[];
        workerError?: WorkerError<ErrorData>;
        workerId?: number;
    }

    Type Parameters

    • Data = unknown

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

    • ErrorData = unknown

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

      -

    Hierarchy (view full)

    Properties

    checkActive? +

    Hierarchy (view full)

    Properties

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

    Properties

    Optional Readonly checkActive

    checkActive?: boolean

    Whether the worker starts or stops its activity check.

    -

    Optional Readonly data

    data?: Data

    Task input data that will be passed to the worker.

    -

    Optional Readonly kill

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

    Kill code.

    -

    Optional Readonly name

    name?: string

    Task name.

    -

    Optional Readonly port

    port?: MessagePort

    Message port.

    -

    Optional Readonly ready

    ready?: boolean

    Whether the worker is ready or not.

    -

    Optional Readonly statistics

    statistics?: WorkerStatistics

    Whether the worker computes the given statistics or not.

    -

    Optional Readonly taskFunction

    taskFunction?: string

    Task function serialized to string.

    -

    Optional Readonly taskFunctionName

    taskFunctionName?: string

    Task function name.

    -

    Optional Readonly taskFunctionNames

    taskFunctionNames?: string[]

    Task function names.

    -

    Optional Readonly taskFunctionOperation

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

    Task function operation:

    +

    Optional Readonly data

    data?: Data

    Task input data that will be passed to the worker.

    +

    Optional Readonly kill

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

    Kill code.

    +

    Optional Readonly name

    name?: string

    Task name.

    +

    Optional Readonly port

    port?: MessagePort

    Message port.

    +

    Optional Readonly ready

    ready?: boolean

    Whether the worker is ready or not.

    +

    Optional Readonly statistics

    statistics?: WorkerStatistics

    Whether the worker computes the given statistics or not.

    +

    Optional Readonly taskFunction

    taskFunction?: string

    Task function serialized to string.

    +

    Optional Readonly taskFunctionName

    taskFunctionName?: string

    Task function name.

    +

    Optional Readonly taskFunctionNames

    taskFunctionNames?: string[]

    Task function names.

    +

    Optional Readonly taskFunctionOperation

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

    Task function operation:

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

    Optional Readonly taskFunctionOperationStatus

    taskFunctionOperationStatus?: boolean

    Whether the task function operation is successful or not.

    -

    Optional Readonly taskId

    taskId?: string

    Task UUID.

    -

    Optional Readonly taskPerformance

    taskPerformance?: TaskPerformance

    Task performance.

    -

    Optional Readonly timestamp

    timestamp?: number

    Timestamp.

    -

    Optional Readonly transferList

    transferList?: TransferListItem[]

    Array of transferable objects.

    -

    Optional Readonly workerError

    workerError?: WorkerError<ErrorData>

    Worker error.

    -

    Optional Readonly workerId

    workerId?: number

    Worker id.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Optional Readonly taskFunctionOperationStatus

    taskFunctionOperationStatus?: boolean

    Whether the task function operation is successful or not.

    +

    Optional Readonly taskId

    taskId?: string

    Task UUID.

    +

    Optional Readonly taskPerformance

    taskPerformance?: TaskPerformance

    Task performance.

    +

    Optional Readonly timestamp

    timestamp?: number

    Timestamp.

    +

    Optional Readonly transferList

    transferList?: TransferListItem[]

    Array of transferable objects.

    +

    Optional Readonly workerError

    workerError?: WorkerError<ErrorData>

    Worker error.

    +

    Optional Readonly workerId

    workerId?: number

    Worker id.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/PoolInfo.html b/docs/interfaces/PoolInfo.html index f7ea5cae..77713a1b 100644 --- a/docs/interfaces/PoolInfo.html +++ b/docs/interfaces/PoolInfo.html @@ -1,5 +1,5 @@ -PoolInfo | poolifier - v3.1.20

    Interface PoolInfo

    Pool information.

    -
    interface PoolInfo {
        backPressure?: boolean;
        busyWorkerNodes: number;
        executedTasks: number;
        executingTasks: number;
        failedTasks: number;
        idleWorkerNodes: number;
        maxQueuedTasks?: number;
        maxSize: number;
        minSize: number;
        queuedTasks?: number;
        ready: boolean;
        runTime?: {
            average?: number;
            maximum: number;
            median?: number;
            minimum: number;
        };
        started: boolean;
        stealingWorkerNodes?: number;
        stolenTasks?: number;
        strategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN";
        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 - v3.1.21

    Interface PoolInfo

    Pool information.

    +
    interface PoolInfo {
        backPressure?: boolean;
        busyWorkerNodes: number;
        executedTasks: number;
        executingTasks: number;
        failedTasks: number;
        idleWorkerNodes: number;
        maxQueuedTasks?: number;
        maxSize: number;
        minSize: number;
        queuedTasks?: number;
        ready: boolean;
        runTime?: {
            average?: number;
            maximum: number;
            median?: number;
            minimum: number;
        };
        started: boolean;
        stealingWorkerNodes?: number;
        stolenTasks?: number;
        strategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN";
        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 executedTasks executingTasks @@ -22,9 +22,9 @@ waitTime? worker workerNodes -

    Properties

    Optional Readonly backPressure

    backPressure?: boolean

    Readonly busyWorkerNodes

    busyWorkerNodes: number

    Pool busy worker nodes.

    -

    Readonly executedTasks

    executedTasks: number

    Readonly executingTasks

    executingTasks: number

    Readonly failedTasks

    failedTasks: number

    Readonly idleWorkerNodes

    idleWorkerNodes: number

    Pool idle worker nodes.

    -

    Optional Readonly maxQueuedTasks

    maxQueuedTasks?: number

    Readonly maxSize

    maxSize: number

    Readonly minSize

    minSize: number

    Optional Readonly queuedTasks

    queuedTasks?: number

    Readonly ready

    ready: boolean

    Optional Readonly runTime

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

    Type declaration

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

    Readonly started

    started: boolean

    Optional Readonly stealingWorkerNodes

    stealingWorkerNodes?: number

    Pool stealing worker nodes.

    -

    Optional Readonly stolenTasks

    stolenTasks?: number

    Readonly strategy

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

    Readonly 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

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional Readonly backPressure

    backPressure?: boolean

    Readonly busyWorkerNodes

    busyWorkerNodes: number

    Pool busy worker nodes.

    +

    Readonly executedTasks

    executedTasks: number

    Readonly executingTasks

    executingTasks: number

    Readonly failedTasks

    failedTasks: number

    Readonly idleWorkerNodes

    idleWorkerNodes: number

    Pool idle worker nodes.

    +

    Optional Readonly maxQueuedTasks

    maxQueuedTasks?: number

    Readonly maxSize

    maxSize: number

    Readonly minSize

    minSize: number

    Optional Readonly queuedTasks

    queuedTasks?: number

    Readonly ready

    ready: boolean

    Optional Readonly runTime

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

    Type declaration

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

    Readonly started

    started: boolean

    Optional Readonly stealingWorkerNodes

    stealingWorkerNodes?: number

    Pool stealing worker nodes.

    +

    Optional Readonly stolenTasks

    stolenTasks?: number

    Readonly strategy

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

    Readonly 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

    Generated using TypeDoc

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

    Interface PoolOptions<Worker>

    Options for a poolifier pool.

    +PoolOptions | poolifier - v3.1.21

    Interface PoolOptions<Worker>

    Options for a poolifier pool.

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

    Type Parameters

    • Worker extends IWorker

      Type of worker.

      -

    Properties

    enableEvents? +

    Properties

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

    Properties

    Optional enableEvents

    enableEvents?: boolean

    Pool events integrated with async resource emission.

    Default Value

    true
    -

    Optional enableTasksQueue

    enableTasksQueue?: boolean

    Pool worker node tasks queue.

    +

    Optional enableTasksQueue

    enableTasksQueue?: boolean

    Pool worker node tasks queue.

    Default Value

    false
    -

    Optional env

    env?: Record<string, unknown>

    Key/value pairs to add to worker process environment.

    +

    Optional env

    env?: Record<string, unknown>

    Key/value pairs to add to worker process environment.

    See

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

    -

    Optional errorHandler

    errorHandler?: ErrorHandler<Worker>

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

    +

    Optional errorHandler

    errorHandler?: ErrorHandler<Worker>

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

    Default Value

    () => {}

    -

    Optional exitHandler

    exitHandler?: ExitHandler<Worker>

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

    +

    Optional exitHandler

    exitHandler?: ExitHandler<Worker>

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

    Default Value

    () => {}

    -

    Optional messageHandler

    messageHandler?: MessageHandler<Worker>

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

    +

    Optional messageHandler

    messageHandler?: MessageHandler<Worker>

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

    Default Value

    () => {}

    -

    Optional onlineHandler

    onlineHandler?: OnlineHandler<Worker>

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

    +

    Optional onlineHandler

    onlineHandler?: OnlineHandler<Worker>

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

    Default Value

    () => {}

    -

    Optional restartWorkerOnError

    restartWorkerOnError?: boolean

    Restart worker on error.

    -

    Optional settings

    settings?: ClusterSettings

    Cluster settings.

    +

    Optional restartWorkerOnError

    restartWorkerOnError?: boolean

    Restart worker on error.

    +

    Optional settings

    settings?: ClusterSettings

    Cluster settings.

    See

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

    -

    Optional startWorkers

    startWorkers?: boolean

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

    +

    Optional startWorkers

    startWorkers?: boolean

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

    Default Value

    true
    -

    Optional tasksQueueOptions

    tasksQueueOptions?: TasksQueueOptions

    Pool worker node tasks queue options.

    -

    Optional workerChoiceStrategy

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

    The worker choice strategy to use in this pool.

    +

    Optional tasksQueueOptions

    tasksQueueOptions?: TasksQueueOptions

    Pool worker node tasks queue options.

    +

    Optional workerChoiceStrategy

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

    The worker choice strategy to use in this pool.

    Default Value

    WorkerChoiceStrategies.ROUND_ROBIN
    -

    Optional workerChoiceStrategyOptions

    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions

    The worker choice strategy options.

    -

    Optional workerOptions

    workerOptions?: WorkerOptions

    Worker options.

    +

    Optional workerChoiceStrategyOptions

    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions

    The worker choice strategy options.

    +

    Optional workerOptions

    workerOptions?: WorkerOptions

    Worker options.

    See

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

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/PromiseResponseWrapper.html b/docs/interfaces/PromiseResponseWrapper.html index 5f870c97..c78d21b7 100644 --- a/docs/interfaces/PromiseResponseWrapper.html +++ b/docs/interfaces/PromiseResponseWrapper.html @@ -1,13 +1,13 @@ -PromiseResponseWrapper | poolifier - v3.1.20

    Interface PromiseResponseWrapper<Response>Internal

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

    +PromiseResponseWrapper | poolifier - v3.1.21

    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.

    +

    Readonly reject

    reject: ((reason?) => void)

    Reject callback to reject the promise.

    Type declaration

      • (reason?): void

      • Reject callback to reject the promise.

        -

        Parameters

        • Optional reason: unknown

        Returns void

    Readonly resolve

    resolve: ((value) => void)

    Resolve callback to fulfill the promise.

    +

    Parameters

    • Optional reason: unknown

    Returns void

    Readonly resolve

    resolve: ((value) => void)

    Resolve callback to fulfill the promise.

    Type declaration

      • (value): void

      • Resolve callback to fulfill the promise.

        -

        Parameters

        Returns void

    Readonly workerNodeKey

    workerNodeKey: number

    The worker node key executing the task.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns void

    Readonly workerNodeKey

    workerNodeKey: number

    The worker node key executing the task.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/StrategyData.html b/docs/interfaces/StrategyData.html index afdd8570..e4bd13b4 100644 --- a/docs/interfaces/StrategyData.html +++ b/docs/interfaces/StrategyData.html @@ -1,3 +1,3 @@ -StrategyData | poolifier - v3.1.20

    Interface StrategyDataInternal

    Worker choice strategy data.

    -
    interface StrategyData {
        virtualTaskEndTimestamp?: number;
    }

    Properties

    virtualTaskEndTimestamp? -

    Properties

    Optional virtualTaskEndTimestamp

    virtualTaskEndTimestamp?: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Interface StrategyDataInternal

    Worker choice strategy data.

    +
    interface StrategyData {
        virtualTaskEndTimestamp?: number;
    }

    Properties

    virtualTaskEndTimestamp? +

    Properties

    Optional virtualTaskEndTimestamp

    virtualTaskEndTimestamp?: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/StrategyPolicy.html b/docs/interfaces/StrategyPolicy.html index 11fa7094..98f9fadf 100644 --- a/docs/interfaces/StrategyPolicy.html +++ b/docs/interfaces/StrategyPolicy.html @@ -1,6 +1,6 @@ -StrategyPolicy | poolifier - v3.1.20

    Interface StrategyPolicyInternal

    Strategy policy.

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

    Properties

    dynamicWorkerReady +StrategyPolicy | poolifier - v3.1.21

    Interface StrategyPolicyInternal

    Strategy policy.

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

    Properties

    dynamicWorkerReady dynamicWorkerUsage

    Properties

    Readonly dynamicWorkerReady

    dynamicWorkerReady: boolean

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

    -

    Readonly dynamicWorkerUsage

    dynamicWorkerUsage: boolean

    Expects tasks execution on the newly created dynamic worker.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Readonly dynamicWorkerUsage

    dynamicWorkerUsage: boolean

    Expects tasks execution on the newly created dynamic worker.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/Task.html b/docs/interfaces/Task.html index 472625ca..5da3b49a 100644 --- a/docs/interfaces/Task.html +++ b/docs/interfaces/Task.html @@ -1,13 +1,13 @@ -Task | poolifier - v3.1.20

    Interface Task<Data>Internal

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

    +Task | poolifier - v3.1.21

    Interface Task<Data>Internal

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

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

    Type Parameters

    • Data = unknown

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

      -

    Hierarchy (view full)

    Properties

    data? +

    Hierarchy (view full)

    Properties

    data? name? taskId? timestamp? transferList?

    Properties

    Optional Readonly data

    data?: Data

    Task input data that will be passed to the worker.

    -

    Optional Readonly name

    name?: string

    Task name.

    -

    Optional Readonly taskId

    taskId?: string

    Task UUID.

    -

    Optional Readonly timestamp

    timestamp?: number

    Timestamp.

    -

    Optional Readonly transferList

    transferList?: TransferListItem[]

    Array of transferable objects.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Optional Readonly name

    name?: string

    Task name.

    +

    Optional Readonly taskId

    taskId?: string

    Task UUID.

    +

    Optional Readonly timestamp

    timestamp?: number

    Timestamp.

    +

    Optional Readonly transferList

    transferList?: TransferListItem[]

    Array of transferable objects.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Interface TaskFunctionOperationResult

    Task function operation result.

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

    Properties

    error? +TaskFunctionOperationResult | poolifier - v3.1.21

    Interface TaskFunctionOperationResult

    Task function operation result.

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

    Properties

    error? status -

    Properties

    Optional error

    error?: Error

    status

    status: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional error

    error?: Error

    status

    status: boolean

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/TaskPerformance.html b/docs/interfaces/TaskPerformance.html index 66384cce..d6d208ac 100644 --- a/docs/interfaces/TaskPerformance.html +++ b/docs/interfaces/TaskPerformance.html @@ -1,10 +1,10 @@ -TaskPerformance | poolifier - v3.1.20

    Interface TaskPerformanceInternal

    Task performance.

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

    Properties

    elu? +TaskPerformance | poolifier - v3.1.21

    Interface TaskPerformanceInternal

    Task performance.

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

    Properties

    elu? name runTime? timestamp

    Properties

    Optional Readonly elu

    elu?: EventLoopUtilization

    Task event loop utilization.

    -

    Readonly name

    name: string

    Task name.

    -

    Optional Readonly runTime

    runTime?: number

    Task runtime.

    -

    Readonly timestamp

    timestamp: number

    Task performance timestamp.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Readonly name

    name: string

    Task name.

    +

    Optional Readonly runTime

    runTime?: number

    Task runtime.

    +

    Readonly timestamp

    timestamp: number

    Task performance timestamp.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/TaskStatistics.html b/docs/interfaces/TaskStatistics.html index c85c305e..23d7c4df 100644 --- a/docs/interfaces/TaskStatistics.html +++ b/docs/interfaces/TaskStatistics.html @@ -1,5 +1,5 @@ -TaskStatistics | poolifier - v3.1.20

    Interface TaskStatisticsInternal

    Task statistics.

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

    Properties

    executed +TaskStatistics | poolifier - v3.1.21

    Interface TaskStatisticsInternal

    Task statistics.

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

    Properties

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

    Properties

    executed

    executed: number

    Number of executed tasks.

    -

    executing

    executing: number

    Number of executing tasks.

    -

    failed

    failed: number

    Number of failed tasks.

    -

    Optional Readonly maxQueued

    maxQueued?: number

    Maximum number of queued tasks.

    -

    Readonly queued

    queued: number

    Number of queued tasks.

    -

    sequentiallyStolen

    sequentiallyStolen: number

    Number of sequentially stolen tasks.

    -

    stolen

    stolen: number

    Number of stolen tasks.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    executing

    executing: number

    Number of executing tasks.

    +

    failed

    failed: number

    Number of failed tasks.

    +

    Optional Readonly maxQueued

    maxQueued?: number

    Maximum number of queued tasks.

    +

    Readonly queued

    queued: number

    Number of queued tasks.

    +

    sequentiallyStolen

    sequentiallyStolen: number

    Number of sequentially stolen tasks.

    +

    stolen

    stolen: number

    Number of stolen tasks.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/TaskStatisticsRequirements.html b/docs/interfaces/TaskStatisticsRequirements.html index 048fcad4..fd5b409d 100644 --- a/docs/interfaces/TaskStatisticsRequirements.html +++ b/docs/interfaces/TaskStatisticsRequirements.html @@ -1,8 +1,8 @@ -TaskStatisticsRequirements | poolifier - v3.1.20

    Interface TaskStatisticsRequirementsInternal

    Pool worker node worker usage statistics requirements.

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

    Properties

    elu +TaskStatisticsRequirements | poolifier - v3.1.21

    Interface TaskStatisticsRequirementsInternal

    Pool worker node worker usage statistics requirements.

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

    Properties

    elu runTime waitTime

    Properties

    Readonly elu

    elu: MeasurementStatisticsRequirements

    Tasks event loop utilization requirements.

    -

    Readonly runTime

    runTime: MeasurementStatisticsRequirements

    Tasks runtime requirements.

    -

    Readonly waitTime

    waitTime: MeasurementStatisticsRequirements

    Tasks wait time requirements.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Readonly runTime

    runTime: MeasurementStatisticsRequirements

    Tasks runtime requirements.

    +

    Readonly waitTime

    waitTime: MeasurementStatisticsRequirements

    Tasks wait time requirements.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/TasksQueueOptions.html b/docs/interfaces/TasksQueueOptions.html index bd7bb5cc..277fa62d 100644 --- a/docs/interfaces/TasksQueueOptions.html +++ b/docs/interfaces/TasksQueueOptions.html @@ -1,5 +1,5 @@ -TasksQueueOptions | poolifier - v3.1.20

    Interface TasksQueueOptions

    Worker node tasks queue options.

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

    Properties

    concurrency? +TasksQueueOptions | poolifier - v3.1.21

    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

    true
    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/WorkerChoiceStrategyOptions.html b/docs/interfaces/WorkerChoiceStrategyOptions.html index 9bcaa7bb..d65c7acc 100644 --- a/docs/interfaces/WorkerChoiceStrategyOptions.html +++ b/docs/interfaces/WorkerChoiceStrategyOptions.html @@ -1,5 +1,5 @@ -WorkerChoiceStrategyOptions | poolifier - v3.1.20

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

    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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/WorkerError.html b/docs/interfaces/WorkerError.html index c6c14805..73c5ebe8 100644 --- a/docs/interfaces/WorkerError.html +++ b/docs/interfaces/WorkerError.html @@ -1,9 +1,9 @@ -WorkerError | poolifier - v3.1.20

    Interface WorkerError<Data>

    Worker error.

    +WorkerError | poolifier - v3.1.21

    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

    Generated using TypeDoc

    \ No newline at end of file +

    Readonly message

    message: string

    Error message.

    +

    Readonly name

    name: string

    Task function name triggering the error.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/WorkerInfo.html b/docs/interfaces/WorkerInfo.html index 8327f3d2..713922b7 100644 --- a/docs/interfaces/WorkerInfo.html +++ b/docs/interfaces/WorkerInfo.html @@ -1,15 +1,15 @@ -WorkerInfo | poolifier - v3.1.20

    Interface WorkerInfoInternal

    Worker information.

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

    Properties

    dynamic +WorkerInfo | poolifier - v3.1.21

    Interface WorkerInfoInternal

    Worker information.

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

    Properties

    dynamic id ready stealing taskFunctionNames? type

    Properties

    dynamic

    dynamic: boolean

    Dynamic flag.

    -

    Readonly id

    id: undefined | number

    Worker id.

    -

    ready

    ready: boolean

    Ready flag.

    -

    stealing

    stealing: boolean

    Stealing 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 taskFunctionNames

    taskFunctionNames?: string[]

    Task function names.

    -

    Readonly type

    type: "thread" | "cluster"

    Worker type.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Optional taskFunctionNames

    taskFunctionNames?: string[]

    Task function names.

    +

    Readonly type

    type: "thread" | "cluster"

    Worker type.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/WorkerNodeEventDetail.html b/docs/interfaces/WorkerNodeEventDetail.html index 2ce525f8..e5e861cf 100644 --- a/docs/interfaces/WorkerNodeEventDetail.html +++ b/docs/interfaces/WorkerNodeEventDetail.html @@ -1,4 +1,4 @@ -WorkerNodeEventDetail | poolifier - v3.1.20

    Interface WorkerNodeEventDetailInternal

    Worker node event detail.

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

    Properties

    workerId? +WorkerNodeEventDetail | poolifier - v3.1.21

    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

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional workerId

    workerId?: number

    Optional workerNodeKey

    workerNodeKey?: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/WorkerNodeOptions.html b/docs/interfaces/WorkerNodeOptions.html index 6723d90e..db51f2b5 100644 --- a/docs/interfaces/WorkerNodeOptions.html +++ b/docs/interfaces/WorkerNodeOptions.html @@ -1,5 +1,5 @@ -WorkerNodeOptions | poolifier - v3.1.20

    Interface WorkerNodeOptionsInternal

    Worker node options.

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

    Properties

    env? +WorkerNodeOptions | poolifier - v3.1.21

    Interface WorkerNodeOptionsInternal

    Worker node options.

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

    Properties

    env? tasksQueueBackPressureSize workerOptions? -

    Properties

    Optional env

    env?: Record<string, unknown>

    tasksQueueBackPressureSize

    tasksQueueBackPressureSize: undefined | number

    Optional workerOptions

    workerOptions?: WorkerOptions

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional env

    env?: Record<string, unknown>

    tasksQueueBackPressureSize

    tasksQueueBackPressureSize: undefined | number

    Optional workerOptions

    workerOptions?: WorkerOptions

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/WorkerOptions.html b/docs/interfaces/WorkerOptions.html index d76c5672..f991109f 100644 --- a/docs/interfaces/WorkerOptions.html +++ b/docs/interfaces/WorkerOptions.html @@ -1,5 +1,5 @@ -WorkerOptions | poolifier - v3.1.20

    Interface WorkerOptions

    Options for workers.

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

    Properties

    killBehavior? +WorkerOptions | poolifier - v3.1.21

    Interface WorkerOptions

    Options for workers.

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

    Properties

    killBehavior? killHandler? maxInactiveTime?

    Properties

    Optional killBehavior

    killBehavior?: "SOFT" | "HARD"

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

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

    This option only apply to the newly created workers.

    Default Value

    KillBehaviors.SOFT
    -

    Optional killHandler

    killHandler?: KillHandler

    The function to call when a worker is killed.

    +

    Optional killHandler

    killHandler?: KillHandler

    The function to call when a worker is killed.

    Default Value

    () => {}

    -

    Optional maxInactiveTime

    maxInactiveTime?: number

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

    +

    Optional maxInactiveTime

    maxInactiveTime?: number

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

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

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

    Default Value

    60000
    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/WorkerStatistics.html b/docs/interfaces/WorkerStatistics.html index 9c6d8811..c4086705 100644 --- a/docs/interfaces/WorkerStatistics.html +++ b/docs/interfaces/WorkerStatistics.html @@ -1,6 +1,6 @@ -WorkerStatistics | poolifier - v3.1.20

    Interface WorkerStatisticsInternal

    Worker task performance statistics computation settings.

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

    Properties

    elu +WorkerStatistics | poolifier - v3.1.21

    Interface WorkerStatisticsInternal

    Worker task performance statistics computation settings.

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

    Properties

    elu runTime

    Properties

    Readonly elu

    elu: boolean

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

    -

    Readonly runTime

    runTime: boolean

    Whether the worker computes the task runtime or not.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Readonly runTime

    runTime: boolean

    Whether the worker computes the task runtime or not.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/WorkerUsage.html b/docs/interfaces/WorkerUsage.html index 64b5a196..5c045a83 100644 --- a/docs/interfaces/WorkerUsage.html +++ b/docs/interfaces/WorkerUsage.html @@ -1,10 +1,10 @@ -WorkerUsage | poolifier - v3.1.20

    Interface WorkerUsageInternal

    Worker usage statistics.

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

    Properties

    elu +WorkerUsage | poolifier - v3.1.21

    Interface WorkerUsageInternal

    Worker usage statistics.

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

    Properties

    elu runTime tasks waitTime

    Properties

    Readonly elu

    elu: EventLoopUtilizationMeasurementStatistics

    Tasks event loop utilization statistics.

    -

    Readonly runTime

    runTime: MeasurementStatistics

    Tasks runtime statistics.

    -

    Readonly tasks

    tasks: TaskStatistics

    Tasks statistics.

    -

    Readonly waitTime

    waitTime: MeasurementStatistics

    Tasks wait time statistics.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Readonly runTime

    runTime: MeasurementStatistics

    Tasks runtime statistics.

    +

    Readonly tasks

    tasks: TaskStatistics

    Tasks statistics.

    +

    Readonly waitTime

    waitTime: MeasurementStatistics

    Tasks wait time statistics.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/ClusterPoolOptions.html b/docs/types/ClusterPoolOptions.html index 1d1b747d..034225a9 100644 --- a/docs/types/ClusterPoolOptions.html +++ b/docs/types/ClusterPoolOptions.html @@ -1,2 +1,2 @@ -ClusterPoolOptions | poolifier - v3.1.20

    Type alias ClusterPoolOptions

    ClusterPoolOptions: PoolOptions<Worker>

    Options for a poolifier cluster pool.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ClusterPoolOptions | poolifier - v3.1.21

    Type alias ClusterPoolOptions

    ClusterPoolOptions: PoolOptions<Worker>

    Options for a poolifier cluster pool.

    +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/ErrorHandler.html b/docs/types/ErrorHandler.html index e70aedbb..175a6302 100644 --- a/docs/types/ErrorHandler.html +++ b/docs/types/ErrorHandler.html @@ -1,3 +1,3 @@ -ErrorHandler | poolifier - v3.1.20

    Type alias ErrorHandler<Worker>

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

    Callback invoked if the worker raised an error.

    +ErrorHandler | poolifier - v3.1.21

    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

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

      • (this, error): void

      • Parameters

        Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/EventHandler.html b/docs/types/EventHandler.html index 4ddea941..63664a24 100644 --- a/docs/types/EventHandler.html +++ b/docs/types/EventHandler.html @@ -1,3 +1,3 @@ -EventHandler | poolifier - v3.1.20

    Type alias EventHandler<Worker>

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

    Worker event handler.

    +EventHandler | poolifier - v3.1.21

    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

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/ExitHandler.html b/docs/types/ExitHandler.html index ff30161b..4dc21b6e 100644 --- a/docs/types/ExitHandler.html +++ b/docs/types/ExitHandler.html @@ -1,3 +1,3 @@ -ExitHandler | poolifier - v3.1.20

    Type alias ExitHandler<Worker>

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

    Callback invoked when the worker exits successfully.

    +ExitHandler | poolifier - v3.1.21

    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

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

      • (this, exitCode): void

      • Parameters

        Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/KillBehavior.html b/docs/types/KillBehavior.html index a2a0c138..294d509f 100644 --- a/docs/types/KillBehavior.html +++ b/docs/types/KillBehavior.html @@ -1,2 +1,2 @@ -KillBehavior | poolifier - v3.1.20

    Type alias KillBehavior

    KillBehavior: keyof typeof KillBehaviors

    Kill behavior.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias KillBehavior

    KillBehavior: keyof typeof KillBehaviors

    Kill behavior.

    +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/KillHandler.html b/docs/types/KillHandler.html index d3080083..0f716990 100644 --- a/docs/types/KillHandler.html +++ b/docs/types/KillHandler.html @@ -1,2 +1,2 @@ -KillHandler | poolifier - v3.1.20

    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

    Generated using TypeDoc

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

    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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/Measurement.html b/docs/types/Measurement.html index 46b3fedd..bf3fcf5b 100644 --- a/docs/types/Measurement.html +++ b/docs/types/Measurement.html @@ -1,2 +1,2 @@ -Measurement | poolifier - v3.1.20

    Type alias Measurement

    Measurement: keyof typeof Measurements

    Measurement.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias Measurement

    Measurement: keyof typeof Measurements

    Measurement.

    +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/MessageHandler.html b/docs/types/MessageHandler.html index c9657a61..a7d8dee3 100644 --- a/docs/types/MessageHandler.html +++ b/docs/types/MessageHandler.html @@ -1,3 +1,3 @@ -MessageHandler | poolifier - v3.1.20

    Type alias MessageHandler<Worker>

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

    Callback invoked if the worker has received a message.

    +MessageHandler | poolifier - v3.1.21

    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

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

      • (this, message): void

      • Parameters

        Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/OnlineHandler.html b/docs/types/OnlineHandler.html index 00986f3f..9e1f73a0 100644 --- a/docs/types/OnlineHandler.html +++ b/docs/types/OnlineHandler.html @@ -1,3 +1,3 @@ -OnlineHandler | poolifier - v3.1.20

    Type alias OnlineHandler<Worker>

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

    Callback invoked when the worker has started successfully.

    +OnlineHandler | poolifier - v3.1.21

    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

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

      • (this): void

      • Parameters

        Returns void

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/PoolEvent.html b/docs/types/PoolEvent.html index 4e4658de..34f91a9e 100644 --- a/docs/types/PoolEvent.html +++ b/docs/types/PoolEvent.html @@ -1,2 +1,2 @@ -PoolEvent | poolifier - v3.1.20

    Type alias PoolEvent

    PoolEvent: keyof typeof PoolEvents

    Pool event.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias PoolEvent

    PoolEvent: keyof typeof PoolEvents

    Pool event.

    +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias PoolType

    PoolType: keyof typeof PoolTypes

    Pool type.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias PoolType

    PoolType: keyof typeof PoolTypes

    Pool type.

    +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/TaskAsyncFunction.html b/docs/types/TaskAsyncFunction.html index 1113515e..aa36d707 100644 --- a/docs/types/TaskAsyncFunction.html +++ b/docs/types/TaskAsyncFunction.html @@ -1,6 +1,6 @@ -TaskAsyncFunction | poolifier - v3.1.20

    Type alias TaskAsyncFunction<Data, Response>

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

    Task asynchronous function that can be executed. +TaskAsyncFunction | poolifier - v3.1.21

    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>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<Response>

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/TaskFunction.html b/docs/types/TaskFunction.html index 794cc6fd..fb14e913 100644 --- a/docs/types/TaskFunction.html +++ b/docs/types/TaskFunction.html @@ -1,5 +1,5 @@ -TaskFunction | poolifier - v3.1.20

    Type alias TaskFunction<Data, Response>

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

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

    Type alias TaskFunction<Data, Response>

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

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

    Type Parameters

    • Data = unknown

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

    • Response = unknown

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

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias TaskFunctions<Data, Response>

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

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

    Type alias TaskFunctions<Data, Response>

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

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

    Type Parameters

    • Data = unknown

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

    • Response = unknown

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

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/TaskSyncFunction.html b/docs/types/TaskSyncFunction.html index 4c6d66bc..00903d93 100644 --- a/docs/types/TaskSyncFunction.html +++ b/docs/types/TaskSyncFunction.html @@ -1,5 +1,5 @@ -TaskSyncFunction | poolifier - v3.1.20

    Type alias TaskSyncFunction<Data, Response>

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

    Task synchronous function that can be executed.

    +TaskSyncFunction | poolifier - v3.1.21

    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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Response

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/ThreadPoolOptions.html b/docs/types/ThreadPoolOptions.html index 506c9255..3c3abe75 100644 --- a/docs/types/ThreadPoolOptions.html +++ b/docs/types/ThreadPoolOptions.html @@ -1,2 +1,2 @@ -ThreadPoolOptions | poolifier - v3.1.20

    Type alias ThreadPoolOptions

    ThreadPoolOptions: PoolOptions<Worker>

    Options for a poolifier thread pool.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +ThreadPoolOptions | poolifier - v3.1.21

    Type alias ThreadPoolOptions

    ThreadPoolOptions: PoolOptions<Worker>

    Options for a poolifier thread pool.

    +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/WorkerChoiceStrategy.html b/docs/types/WorkerChoiceStrategy.html index a1042742..8956dc6f 100644 --- a/docs/types/WorkerChoiceStrategy.html +++ b/docs/types/WorkerChoiceStrategy.html @@ -1,2 +1,2 @@ -WorkerChoiceStrategy | poolifier - v3.1.20

    Type alias WorkerChoiceStrategy

    WorkerChoiceStrategy: keyof typeof WorkerChoiceStrategies

    Worker choice strategy.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias WorkerChoiceStrategy

    WorkerChoiceStrategy: keyof typeof WorkerChoiceStrategies

    Worker choice strategy.

    +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/WorkerType.html b/docs/types/WorkerType.html index ca14f5d1..477b1a92 100644 --- a/docs/types/WorkerType.html +++ b/docs/types/WorkerType.html @@ -1,2 +1,2 @@ -WorkerType | poolifier - v3.1.20

    Type alias WorkerType

    WorkerType: keyof typeof WorkerTypes

    Worker type.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias WorkerType

    WorkerType: keyof typeof WorkerTypes

    Worker type.

    +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/Writable.html b/docs/types/Writable.html index f8309a4e..d378e3a6 100644 --- a/docs/types/Writable.html +++ b/docs/types/Writable.html @@ -1 +1 @@ -Writable | poolifier - v3.1.20

    Type alias Writable<T>

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

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias Writable<T>

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

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/KillBehaviors.html b/docs/variables/KillBehaviors.html index 6b7b7aa5..7bf7a9f7 100644 --- a/docs/variables/KillBehaviors.html +++ b/docs/variables/KillBehaviors.html @@ -1,4 +1,4 @@ -KillBehaviors | poolifier - v3.1.20

    Variable KillBehaviorsConst

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

    Enumeration of kill behaviors.

    +KillBehaviors | poolifier - v3.1.21

    Variable KillBehaviorsConst

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

    Enumeration of kill behaviors.

    Type declaration

    • Readonly HARD: "HARD"

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

    • Readonly SOFT: "SOFT"

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

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/Measurements.html b/docs/variables/Measurements.html index 597a8df1..c0c656df 100644 --- a/docs/variables/Measurements.html +++ b/docs/variables/Measurements.html @@ -1,2 +1,2 @@ -Measurements | poolifier - v3.1.20

    Variable MeasurementsConst

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

    Enumeration of measurements.

    -

    Type declaration

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Variable MeasurementsConst

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

    Enumeration of measurements.

    +

    Type declaration

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/PoolEvents.html b/docs/variables/PoolEvents.html index 21abff88..9b1381fb 100644 --- a/docs/variables/PoolEvents.html +++ b/docs/variables/PoolEvents.html @@ -1,2 +1,2 @@ -PoolEvents | poolifier - v3.1.20

    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

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    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

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/PoolTypes.html b/docs/variables/PoolTypes.html index 82ea1a6b..32bc69a7 100644 --- a/docs/variables/PoolTypes.html +++ b/docs/variables/PoolTypes.html @@ -1,4 +1,4 @@ -PoolTypes | poolifier - v3.1.20

    Variable PoolTypesConst

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

    Enumeration of pool types.

    +PoolTypes | poolifier - v3.1.21

    Variable PoolTypesConst

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

    Enumeration of pool types.

    Type declaration

    • Readonly dynamic: "dynamic"

      Dynamic pool type.

    • Readonly fixed: "fixed"

      Fixed pool type.

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/WorkerChoiceStrategies.html b/docs/variables/WorkerChoiceStrategies.html index f07b290a..9c975148 100644 --- a/docs/variables/WorkerChoiceStrategies.html +++ b/docs/variables/WorkerChoiceStrategies.html @@ -1,4 +1,4 @@ -WorkerChoiceStrategies | poolifier - v3.1.20

    Variable WorkerChoiceStrategiesConst

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

    Enumeration of worker choice strategies.

    +WorkerChoiceStrategies | poolifier - v3.1.21

    Variable WorkerChoiceStrategiesConst

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

    Enumeration of worker choice strategies.

    Type declaration

    • Readonly FAIR_SHARE: "FAIR_SHARE"

      Fair share worker selection strategy.

    • Readonly Experimental INTERLEAVED_WEIGHTED_ROUND_ROBIN: "INTERLEAVED_WEIGHTED_ROUND_ROBIN"

      Interleaved weighted round robin worker selection strategy.

    • Readonly LEAST_BUSY: "LEAST_BUSY"

      Least busy worker selection strategy.

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

      Least used worker selection strategy.

    • Readonly ROUND_ROBIN: "ROUND_ROBIN"

      Round robin worker selection strategy.

    • Readonly WEIGHTED_ROUND_ROBIN: "WEIGHTED_ROUND_ROBIN"

      Weighted round robin worker selection strategy.

      -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Variable WorkerTypesConst

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

    Enumeration of worker types.

    -

    Type declaration

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Variable WorkerTypesConst

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

    Enumeration of worker types.

    +

    Type declaration

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file -- 2.34.1