From 7da803598cda0e6935733c84fb4a6afa8a8fe4bd Mon Sep 17 00:00:00 2001 From: Documentation Bot Date: Sat, 26 Oct 2024 20:12:55 +0000 Subject: [PATCH] docs: publish documentation --- docs/classes/AbstractPool.html | 88 +++++++++---------- docs/classes/AbstractWorker.html | 50 +++++------ docs/classes/CircularBuffer.html | 16 ++-- docs/classes/ClusterWorker.html | 50 +++++------ docs/classes/DynamicClusterPool.html | 88 +++++++++---------- docs/classes/DynamicThreadPool.html | 88 +++++++++---------- docs/classes/FixedClusterPool.html | 88 +++++++++---------- docs/classes/FixedThreadPool.html | 88 +++++++++---------- docs/classes/PriorityQueue.html | 24 ++--- docs/classes/ThreadWorker.html | 50 +++++------ .../WorkerChoiceStrategiesContext.html | 24 ++--- docs/functions/availableParallelism.html | 4 +- docs/hierarchy.html | 2 +- docs/index.html | 4 +- ...tLoopUtilizationMeasurementStatistics.html | 6 +- docs/interfaces/FixedQueueNode.html | 6 +- docs/interfaces/IFixedQueue.html | 24 ++--- docs/interfaces/IPool.html | 36 ++++---- docs/interfaces/IWorker.html | 22 ++--- docs/interfaces/IWorkerChoiceStrategy.html | 18 ++-- docs/interfaces/IWorkerNode.html | 40 ++++----- docs/interfaces/MeasurementOptions.html | 6 +- docs/interfaces/MeasurementStatistics.html | 16 ++-- .../MeasurementStatisticsRequirements.html | 10 +-- docs/interfaces/MessageValue.html | 44 +++++----- docs/interfaces/PoolInfo.html | 20 ++--- docs/interfaces/PoolOptions.html | 32 +++---- docs/interfaces/PromiseResponseWrapper.html | 12 +-- docs/interfaces/StrategyData.html | 6 +- docs/interfaces/StrategyPolicy.html | 8 +- docs/interfaces/Task.html | 18 ++-- docs/interfaces/TaskFunctionObject.html | 10 +-- .../TaskFunctionOperationResult.html | 6 +- docs/interfaces/TaskFunctionProperties.html | 10 +-- docs/interfaces/TaskPerformance.html | 12 +-- docs/interfaces/TaskStatistics.html | 18 ++-- .../TaskStatisticsRequirements.html | 10 +-- docs/interfaces/TasksQueueOptions.html | 16 ++-- .../WorkerChoiceStrategyOptions.html | 14 +-- docs/interfaces/WorkerError.html | 14 +-- docs/interfaces/WorkerInfo.html | 24 ++--- 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 | 4 +- 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 +- 71 files changed, 632 insertions(+), 632 deletions(-) diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index 03bba446..0c37fa62 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -1,8 +1,8 @@ -AbstractPool | poolifier - v4.4.3

Class AbstractPool<Worker, Data, Response>Abstract

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

+AbstractPool | poolifier - v4.4.4

Class AbstractPool<Worker, Data, Response>Abstract

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

Type Parameters

  • Worker extends IWorker

    Type of worker which manages this pool.

  • Data = unknown

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

  • Response = unknown

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

    -

Hierarchy (view full)

Implements

Constructors

constructor +

Hierarchy (view full)

Implements

Constructors

constructor

Properties

emitter? filePath maximumNumberOfWorkers? @@ -56,7 +56,7 @@
  • filePath: string

    Path to the worker file.

  • opts: PoolOptions<Worker>

    Options for the pool.

  • OptionalmaximumNumberOfWorkers: number

    Maximum number of workers that this pool manages.

    -

    • Returns AbstractPool<Worker, Data, Response>

    Properties

    Optionalemitter

    emitter?: EventEmitterAsyncResource

    Pool event emitter integrated with async resource. +

    Returns AbstractPool<Worker, Data, Response>

    Properties

    Optionalemitter

    emitter?: EventEmitterAsyncResource

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

    Events that can currently be listened to:

      @@ -72,93 +72,93 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    • 'backPressure': Emitted when the number of workers created in the pool has reached the maximum size expected and are back pressured (i.e. their tasks queue is full: queue size >= maximum queue size).
    • 'backPressureEnd': Emitted when the number of workers created in the pool has reached the maximum size expected and are no longer back pressured (i.e. their tasks queue is no longer full: queue size < maximum queue size).
    -

    Protected ReadonlyfilePath

    filePath: string

    Path to the worker file.

    -

    Protected Optional ReadonlymaximumNumberOfWorkers

    maximumNumberOfWorkers?: number

    Maximum number of workers that this pool manages.

    -

    Protected ReadonlyminimumNumberOfWorkers

    minimumNumberOfWorkers: number

    Minimum number of workers that this pool manages.

    -

    Protected Readonlyopts

    opts: PoolOptions<Worker>

    Options for the pool.

    -

    ProtectedpromiseResponseMap

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

    The task execution response promise map:

    +

    Protected ReadonlyfilePath

    filePath: string

    Path to the worker file.

    +

    Protected Optional ReadonlymaximumNumberOfWorkers

    maximumNumberOfWorkers?: number

    Maximum number of workers that this pool manages.

    +

    Protected ReadonlyminimumNumberOfWorkers

    minimumNumberOfWorkers: number

    Minimum number of workers that this pool manages.

    +

    Protected Readonlyopts

    opts: PoolOptions<Worker>

    Options for the pool.

    +

    ProtectedpromiseResponseMap

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

    The task execution response promise map:

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

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

    -

    Protected OptionalworkerChoiceStrategiesContext

    workerChoiceStrategiesContext?: WorkerChoiceStrategiesContext<Worker, Data, Response>

    Worker choice strategies context referencing worker choice algorithms implementation.

    -

    Readonly InternalworkerNodes

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

    Pool worker nodes.

    -

    Accessors

    Protected AbstractbackPressure

    Protected OptionalworkerChoiceStrategiesContext

    workerChoiceStrategiesContext?: WorkerChoiceStrategiesContext<Worker, Data, Response>

    Worker choice strategies context referencing worker choice algorithms implementation.

    +

    Readonly InternalworkerNodes

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

    Pool worker nodes.

    +

    Accessors

    Protected AbstractbackPressure

    • get backPressure(): boolean

    • Whether the pool is back pressured or not.

      Returns boolean

      The pool back pressure boolean status.

      -

    Protected Abstractbusy

    Protected Abstractbusy

    info

    Protected Abstracttype

    info

    Protected Abstracttype

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

    • The pool type.

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

      -

      Returns "fixed" | "dynamic"

    Protected Abstractworker

    Methods

    addTaskFunction

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

    • Parameters

    Protected Abstractworker

    Methods

    addTaskFunction

    ProtectedafterTaskExecutionHook

    ProtectedafterTaskExecutionHook

    • 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

    ProtectedafterWorkerNodeSetup

    • afterWorkerNodeSetup(workerNodeKey): void

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

    Returns void

    ProtectedafterWorkerNodeSetup

    • 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

    ProtectedbeforeTaskExecutionHook

    • beforeTaskExecutionHook(workerNodeKey, task): void

    • Hook executed before the worker task execution. +

    Returns void

    ProtectedbeforeTaskExecutionHook

    • 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

    Protected AbstractcheckAndEmitDynamicWorkerCreationEvents

    Protected AbstractcheckAndEmitDynamicWorkerDestructionEvents

    ProtectedcreateAndSetupDynamicWorkerNode

    • createAndSetupDynamicWorkerNode(): number

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

      +

    Returns void

    Protected AbstractcheckAndEmitDynamicWorkerCreationEvents

    Protected AbstractcheckAndEmitDynamicWorkerDestructionEvents

    ProtectedcreateAndSetupDynamicWorkerNode

    • createAndSetupDynamicWorkerNode(): number

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

      Returns number

      New, completely set up dynamic worker node key.

      -

    ProtectedcreateAndSetupWorkerNode

    ProtectedcreateAndSetupWorkerNode

    • createAndSetupWorkerNode(): number

    • Creates a new, completely set up worker node.

      Returns number

      New, completely set up worker node key.

      -

    Protected AbstractderegisterWorkerMessageListener

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

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

      +

    Protected AbstractderegisterWorkerMessageListener

    • 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: MessageValue<Message, unknown>) => void)

        The message listener callback.

        -

      Returns void

    destroy

    ProtecteddestroyWorkerNode

    • destroyWorkerNode(workerNodeKey): Promise<void>

    • Terminates the worker node given its worker node key.

      +

    Returns void

    destroy

    ProtecteddestroyWorkerNode

    • destroyWorkerNode(workerNodeKey): Promise<void>

    • Terminates the worker node given its worker node key.

      Parameters

      • workerNodeKey: number

        The worker node key.

        -

      Returns Promise<void>

    enableTasksQueue

    execute

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

    • Parameters

      • Optionaldata: Data

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

        +

      Returns Promise<void>

    enableTasksQueue

    execute

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

    • Parameters

      • Optionaldata: Data

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

      • Optionalname: string

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

      • OptionaltransferList: readonly TransferListItem[]

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

      Returns Promise<Response>

      Promise with a task function response that will be fulfilled when the task is completed.

      -

    ProtectedflagWorkerNodeAsNotReady

    ProtectedflushTasksQueue

    ProtectedgetWorkerInfo

    ProtectedflagWorkerNodeAsNotReady

    ProtectedflushTasksQueue

    ProtectedgetWorkerInfo

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

      -

    hasTaskFunction

    hasTaskFunction

    ProtectedinternalBackPressure

    ProtectedinternalBackPressure

    • internalBackPressure(): boolean

    • Whether the worker nodes are back pressured or not.

      Returns boolean

      Worker nodes back pressure boolean status.

      -

    ProtectedinternalBusy

    ProtectedinternalBusy

    • internalBusy(): boolean

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

      Returns boolean

      Worker nodes busyness boolean status.

      -

    Protected AbstractisMain

    Protected AbstractisMain

    • isMain(): boolean

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

      Returns boolean

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

      -

    listTaskFunctionsProperties

    mapExecute

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

    • Parameters

      • data: Iterable<Data, any, any>

        The tasks iterable input data for the specified task function. This can only be an iterable of structured-cloneable data.

        +

    listTaskFunctionsProperties

    mapExecute

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

    • Parameters

      • data: Iterable<Data, any, any>

        The tasks iterable input data for the specified task function. This can only be an iterable of structured-cloneable data.

      • Optionalname: string

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

      • OptionaltransferList: readonly TransferListItem[]

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

      Returns Promise<Response[]>

      Promise with an array of task function responses that will be fulfilled when the tasks are completed.

      -

    Protected AbstractregisterOnceWorkerMessageListener

    Protected AbstractregisterOnceWorkerMessageListener

    • 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: MessageValue<Message, unknown>) => void)

        The message listener callback.

        -

      Returns void

    Protected AbstractregisterWorkerMessageListener

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

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

      +

    Returns void

    Protected AbstractregisterWorkerMessageListener

    • 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: MessageValue<Message, unknown>) => void)

        The message listener callback.

        -

      Returns void

    removeTaskFunction

    removeTaskFunction

    Protected AbstractsendStartupMessageToWorker

    Protected AbstractsendStartupMessageToWorker

    • sendStartupMessageToWorker(workerNodeKey): void

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

      Parameters

      • workerNodeKey: number

        The worker node key.

        -

      Returns void

    Protected AbstractsendToWorker

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

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

      +

    Returns void

    Protected AbstractsendToWorker

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

      • OptionaltransferList: readonly TransferListItem[]

        The optional array of transferable objects.

        -

      Returns void

    setDefaultTaskFunction

    • setDefaultTaskFunction(name): Promise<boolean>

    • Parameters

      • name: string

        The name of the task function.

        +

      Returns void

    setDefaultTaskFunction

    setTasksQueueOptions

    ProtectedsetupHook

    setTasksQueueOptions

    ProtectedsetupHook

    • setupHook(): void

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

      -

      Returns void

    setWorkerChoiceStrategy

    • setWorkerChoiceStrategy(workerChoiceStrategy, workerChoiceStrategyOptions?): void

    • Parameters

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

      Returns void

      Inherit Doc

    setWorkerChoiceStrategyOptions

    setWorkerChoiceStrategy

    • setWorkerChoiceStrategy(workerChoiceStrategy, workerChoiceStrategyOptions?): void

    • Parameters

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

      Returns void

      Inherit Doc

    setWorkerChoiceStrategyOptions

    Protected AbstractshallCreateDynamicWorker

    Protected AbstractshallCreateDynamicWorker

    • shallCreateDynamicWorker(): boolean

    • Conditions for dynamic worker creation.

      Returns boolean

      Whether to create a dynamic worker or not.

      -

    start

    Protected ReadonlyworkerMessageListener

    start

    Protected ReadonlyworkerMessageListener

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index c9fbc6b1..7aaf0570 100644 --- a/docs/classes/AbstractWorker.html +++ b/docs/classes/AbstractWorker.html @@ -1,8 +1,8 @@ -AbstractWorker | poolifier - v4.4.3

    Class AbstractWorker<MainWorker, Data, Response>Abstract

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

    +AbstractWorker | poolifier - v4.4.4

    Class AbstractWorker<MainWorker, Data, Response>Abstract

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

    Type Parameters

    • MainWorker extends MessagePort | Worker

      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 @@ -31,50 +31,50 @@
  • 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 execute method 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 OptionalactiveInterval

    activeInterval?: Timeout

    Handler id of the activeInterval worker activity check.

    -

    Protected Abstractid

    id: number

    Worker id.

    -

    Protected ReadonlyisMain

    isMain: undefined | boolean

    Whether this is the main worker or not.

    -

    ProtectedlastTaskTimestamp

    lastTaskTimestamp: number

    Timestamp of the last task processed by this worker.

    -

    Protectedopts

    opts: WorkerOptions = DEFAULT_WORKER_OPTIONS

    Options for the worker.

    -

    Protected Optionalstatistics

    statistics?: WorkerStatistics

    Performance statistics computation requirements.

    -

    ProtectedtaskFunctions

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

    Task function object(s) processed by the worker when the pool's execute method is invoked.

    -

    Methods

    addTaskFunction

    Returns AbstractWorker<MainWorker, Data, Response>

    Properties

    Protected OptionalactiveInterval

    activeInterval?: Timeout

    Handler id of the activeInterval worker activity check.

    +

    Protected Abstractid

    id: number

    Worker id.

    +

    Protected ReadonlyisMain

    isMain: undefined | boolean

    Whether this is the main worker or not.

    +

    ProtectedlastTaskTimestamp

    lastTaskTimestamp: number

    Timestamp of the last task processed by this worker.

    +

    Protectedopts

    opts: WorkerOptions = DEFAULT_WORKER_OPTIONS

    Options for the worker.

    +

    Protected Optionalstatistics

    statistics?: WorkerStatistics

    Performance statistics computation requirements.

    +

    ProtectedtaskFunctions

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

    Task function object(s) processed by the worker when the pool's execute method is invoked.

    +

    Methods

    addTaskFunction

    ProtectedgetMainWorker

    ProtectedgetMainWorker

    Protected AbstracthandleError

    • handleError(error): {
          error?: Error;
          message: string;
          stack?: string;
      }

    • Handles a worker error.

      +

    Protected AbstracthandleError

    • handleError(error): {
          error?: Error;
          message: string;
          stack?: string;
      }

    • Handles a worker error.

      Parameters

      • error: Error

        The error raised by the worker.

      Returns {
          error?: Error;
          message: string;
          stack?: string;
      }

      The worker error object.

      -
      • Optionalerror?: Error
      • message: string
      • Optionalstack?: string

    ProtectedhandleKillMessage

    • handleKillMessage(message): void

    • Handles a kill message sent by the main worker.

      +
      • Optionalerror?: Error
      • message: string
      • Optionalstack?: string

    ProtectedhandleKillMessage

    Protected AbstracthandleReadyMessage

    • handleReadyMessage(message): void

    • Handles the ready message sent by the main worker.

      +

    Returns void

    Protected AbstracthandleReadyMessage

    ProtectedhandleTaskFunctionOperationMessage

    hasTaskFunction

    Returns void

    ProtectedhandleTaskFunctionOperationMessage

    hasTaskFunction

    listTaskFunctionsProperties

    listTaskFunctionsProperties

    ProtectedmessageListener

    ProtectedmessageListener

    removeTaskFunction

    Returns void

    removeTaskFunction

    Protected Readonlyrun

    Protected Readonlyrun

    Protected ReadonlyrunAsync

    • runAsync(fn, task): void

    • Runs the given task function asynchronously.

      +

    Returns void

    Protected ReadonlyrunAsync

    Protected ReadonlyrunSync

    • runSync(fn, task): void

    • Runs the given task function synchronously.

      +

    Returns void

    Protected ReadonlyrunSync

    ProtectedsendTaskFunctionsPropertiesToMainWorker

    Protected AbstractsendToMainWorker

    • sendToMainWorker(message): void

    • Sends a message to main worker.

      +

    Returns void

    ProtectedsendTaskFunctionsPropertiesToMainWorker

    Protected AbstractsendToMainWorker

    setDefaultTaskFunction

    Returns void

    setDefaultTaskFunction

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/docs/classes/CircularBuffer.html b/docs/classes/CircularBuffer.html index 85d3edfd..c71b3ae4 100644 --- a/docs/classes/CircularBuffer.html +++ b/docs/classes/CircularBuffer.html @@ -1,5 +1,5 @@ -CircularBuffer | poolifier - v4.4.3

    Class CircularBufferInternal

    Circular buffer designed for positive numbers.

    -

    Constructors

    constructor +CircularBuffer | poolifier - v4.4.4

    Class CircularBufferInternal

    Circular buffer designed for positive numbers.

    +

    Constructors

    constructor

    Properties

    size

    Methods

    empty full @@ -11,14 +11,14 @@

    Default Value

    defaultBufferSize
    -

    Properties

    size

    size: number

    Methods

    empty

    • empty(): boolean

    • Checks whether the buffer is empty.

      +

    Properties

    size

    size: number

    Methods

    empty

    • empty(): boolean

    • Checks whether the buffer is empty.

      Returns boolean

      Whether the buffer is empty.

      -

    full

    full

    • full(): boolean

    • Checks whether the buffer is full.

      Returns boolean

      Whether the buffer is full.

      -

    get

    get

    • get(): undefined | number

    • Gets number from buffer.

      Returns undefined | number

      Number from buffer.

      -

    put

    put

    • put(number): void

    • Puts number into buffer.

      Parameters

      • number: number

        Number to put into buffer.

        -

      Returns void

    toArray

    • toArray(): number[]

    • Returns buffer as numbers' array.

      +

    Returns void

    toArray

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/docs/classes/ClusterWorker.html b/docs/classes/ClusterWorker.html index 5a6544b3..16467638 100644 --- a/docs/classes/ClusterWorker.html +++ b/docs/classes/ClusterWorker.html @@ -1,4 +1,4 @@ -ClusterWorker | poolifier - v4.4.3

    Class ClusterWorker<Data, Response>

    A cluster worker used by a poolifier ClusterPool.

    +ClusterWorker | poolifier - v4.4.4

    Class ClusterWorker<Data, Response>

    A cluster worker used by a poolifier ClusterPool.

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

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

    Since

    2.0.0

    Type Parameters

    • Data = unknown

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

    • Response = unknown

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

      -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

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

    Constructors

    constructor

    Properties

    Protected OptionalactiveInterval

    activeInterval?: Timeout

    Handler id of the activeInterval worker activity check.

    -

    Protected ReadonlyisMain

    isMain: undefined | boolean

    Whether this is the main worker or not.

    -

    ProtectedlastTaskTimestamp

    lastTaskTimestamp: number

    Timestamp of the last task processed by this worker.

    -

    Protectedopts

    opts: WorkerOptions = DEFAULT_WORKER_OPTIONS

    Options for the worker.

    -

    Protected Optionalstatistics

    statistics?: WorkerStatistics

    Performance statistics computation requirements.

    -

    ProtectedtaskFunctions

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

    Task function object(s) processed by the worker when the pool's execute method is invoked.

    -

    Accessors

    Protectedid

    Methods

    addTaskFunction

    Returns ClusterWorker<Data, Response>

    Properties

    Protected OptionalactiveInterval

    activeInterval?: Timeout

    Handler id of the activeInterval worker activity check.

    +

    Protected ReadonlyisMain

    isMain: undefined | boolean

    Whether this is the main worker or not.

    +

    ProtectedlastTaskTimestamp

    lastTaskTimestamp: number

    Timestamp of the last task processed by this worker.

    +

    Protectedopts

    opts: WorkerOptions = DEFAULT_WORKER_OPTIONS

    Options for the worker.

    +

    Protected Optionalstatistics

    statistics?: WorkerStatistics

    Performance statistics computation requirements.

    +

    ProtectedtaskFunctions

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

    Task function object(s) processed by the worker when the pool's execute method is invoked.

    +

    Accessors

    Protectedid

    Methods

    addTaskFunction

    ProtectedgetMainWorker

    ProtectedgetMainWorker

    ProtectedhandleError

    • handleError(error): {
          message: string;
          stack?: string;
      }

    • Handles a worker error.

      +

    ProtectedhandleError

    • handleError(error): {
          message: string;
          stack?: string;
      }

    • Handles a worker error.

      Parameters

      • error: Error

        The error raised by the worker.

      Returns {
          message: string;
          stack?: string;
      }

      The worker error object.

      -
      • message: string
      • Optionalstack?: string

    ProtectedhandleKillMessage

    ProtectedhandleKillMessage

    ProtectedhandleReadyMessage

    • handleReadyMessage(message): void

    • Handles the ready message sent by the main worker.

      +

    Returns void

    ProtectedhandleReadyMessage

    ProtectedhandleTaskFunctionOperationMessage

    hasTaskFunction

    Returns void

    ProtectedhandleTaskFunctionOperationMessage

    hasTaskFunction

    listTaskFunctionsProperties

    listTaskFunctionsProperties

    ProtectedmessageListener

    ProtectedmessageListener

    removeTaskFunction

    Returns void

    removeTaskFunction

    Protected Readonlyrun

    Protected Readonlyrun

    Protected ReadonlyrunAsync

    • runAsync(fn, task): void

    • Runs the given task function asynchronously.

      +

    Returns void

    Protected ReadonlyrunAsync

    Protected ReadonlyrunSync

    • runSync(fn, task): void

    • Runs the given task function synchronously.

      +

    Returns void

    Protected ReadonlyrunSync

    ProtectedsendTaskFunctionsPropertiesToMainWorker

    Protected ReadonlysendToMainWorker

    • sendToMainWorker(message): void

    • Sends a message to main worker.

      +

    Returns void

    ProtectedsendTaskFunctionsPropertiesToMainWorker

    Protected ReadonlysendToMainWorker

    setDefaultTaskFunction

    Returns void

    setDefaultTaskFunction

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index 8fd927c8..c14f93b6 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -1,11 +1,11 @@ -DynamicClusterPool | poolifier - v4.4.3

    Class DynamicClusterPool<Data, Response>

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

    +DynamicClusterPool | poolifier - v4.4.4

    Class DynamicClusterPool<Data, Response>

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

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

    Author

    Christopher Quadflieg

    Since

    2.0.0

    Type Parameters

    • Data = unknown

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

    • Response = unknown

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

      -

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

    Optionalemitter

    emitter?: EventEmitterAsyncResource

    Pool event emitter integrated with async resource. +

    Returns DynamicClusterPool<Data, Response>

    Properties

    Optionalemitter

    emitter?: EventEmitterAsyncResource

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

    Events that can currently be listened to:

      @@ -75,92 +75,92 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    • 'backPressure': Emitted when the number of workers created in the pool has reached the maximum size expected and are back pressured (i.e. their tasks queue is full: queue size >= maximum queue size).
    • 'backPressureEnd': Emitted when the number of workers created in the pool has reached the maximum size expected and are no longer back pressured (i.e. their tasks queue is no longer full: queue size < maximum queue size).
    -

    Protected ReadonlyfilePath

    filePath: string

    Path to the worker file.

    -

    Protected Optional ReadonlymaximumNumberOfWorkers

    maximumNumberOfWorkers?: number

    Maximum number of workers that this pool manages.

    -

    Protected ReadonlyminimumNumberOfWorkers

    minimumNumberOfWorkers: number

    Minimum number of workers that this pool manages.

    -

    Protected Readonlyopts

    opts: PoolOptions<Worker>

    Options for the pool.

    -

    ProtectedpromiseResponseMap

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

    The task execution response promise map:

    +

    Protected ReadonlyfilePath

    filePath: string

    Path to the worker file.

    +

    Protected Optional ReadonlymaximumNumberOfWorkers

    maximumNumberOfWorkers?: number

    Maximum number of workers that this pool manages.

    +

    Protected ReadonlyminimumNumberOfWorkers

    minimumNumberOfWorkers: number

    Minimum number of workers that this pool manages.

    +

    Protected Readonlyopts

    opts: PoolOptions<Worker>

    Options for the pool.

    +

    ProtectedpromiseResponseMap

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

    The task execution response promise map:

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

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

    -

    Protected OptionalworkerChoiceStrategiesContext

    workerChoiceStrategiesContext?: WorkerChoiceStrategiesContext<Worker, Data, Response>

    Worker choice strategies context referencing worker choice algorithms implementation.

    -

    Readonly InternalworkerNodes

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

    Pool worker nodes.

    -

    Accessors

    ProtectedbackPressure

    Protected OptionalworkerChoiceStrategiesContext

    workerChoiceStrategiesContext?: WorkerChoiceStrategiesContext<Worker, Data, Response>

    Worker choice strategies context referencing worker choice algorithms implementation.

    +

    Readonly InternalworkerNodes

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

    Pool worker nodes.

    +

    Accessors

    ProtectedbackPressure

    • get backPressure(): boolean

    • Whether the pool is back pressured or not.

      Returns boolean

      The pool back pressure boolean status.

      -

    Protectedbusy

    Protectedbusy

    • get busy(): boolean

    • Whether the pool is busy or not.

      Returns boolean

      The pool busyness boolean status.

      -

    info

    Protectedtype

    info

    Protectedtype

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

    • The pool type.

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

      -

      Returns "fixed" | "dynamic"

    Protectedworker

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

    • The worker type.

      -

      Returns "cluster" | "thread"

    Methods

    addTaskFunction

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

    • Parameters

    Protectedworker

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

    • The worker type.

      +

      Returns "cluster" | "thread"

    Methods

    addTaskFunction

    ProtectedafterTaskExecutionHook

    ProtectedafterTaskExecutionHook

    ProtectedafterWorkerNodeSetup

    • afterWorkerNodeSetup(workerNodeKey): void

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

    Returns void

    ProtectedafterWorkerNodeSetup

    ProtectedbeforeTaskExecutionHook

    • beforeTaskExecutionHook(workerNodeKey, task): void

    • Hook executed before the worker task execution. +

    Returns void

    ProtectedbeforeTaskExecutionHook

    ProtectedcheckAndEmitDynamicWorkerCreationEvents

    ProtectedcheckAndEmitDynamicWorkerDestructionEvents

    ProtectedcreateAndSetupDynamicWorkerNode

    • createAndSetupDynamicWorkerNode(): number

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

      +

    Returns void

    ProtectedcheckAndEmitDynamicWorkerCreationEvents

    ProtectedcheckAndEmitDynamicWorkerDestructionEvents

    ProtectedcreateAndSetupDynamicWorkerNode

    ProtectedcreateAndSetupWorkerNode

    ProtectedcreateAndSetupWorkerNode

    ProtectedderegisterWorkerMessageListener

    ProtectedderegisterWorkerMessageListener

    destroy

    ProtecteddestroyWorkerNode

    • destroyWorkerNode(workerNodeKey): Promise<void>

    • Terminates the worker node given its worker node key.

      +

    Returns void

    destroy

    ProtecteddestroyWorkerNode

    enableTasksQueue

    execute

    enableTasksQueue

    execute

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

    • Parameters

      • Optionaldata: Data

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

      • Optionalname: string

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

      • OptionaltransferList: readonly TransferListItem[]

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

      Returns Promise<Response>

      Promise with a task function response that will be fulfilled when the task is completed.

      -

    ProtectedflagWorkerNodeAsNotReady

    ProtectedflushTasksQueue

    ProtectedgetWorkerInfo

    ProtectedflagWorkerNodeAsNotReady

    ProtectedflushTasksQueue

    ProtectedgetWorkerInfo

    hasTaskFunction

    hasTaskFunction

    ProtectedinternalBackPressure

    ProtectedinternalBackPressure

    ProtectedinternalBusy

    ProtectedinternalBusy

    ProtectedisMain

    ProtectedisMain

    listTaskFunctionsProperties

    mapExecute

    listTaskFunctionsProperties

    mapExecute

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

    • Parameters

      • data: Iterable<Data, any, any>

        The tasks iterable input data for the specified task function. This can only be an iterable of structured-cloneable data.

      • Optionalname: string

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

      • OptionaltransferList: readonly TransferListItem[]

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

      Returns Promise<Response[]>

      Promise with an array of task function responses that will be fulfilled when the tasks are completed.

      -

    ProtectedregisterOnceWorkerMessageListener

    ProtectedregisterOnceWorkerMessageListener

    ProtectedregisterWorkerMessageListener

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

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

      +

    Returns void

    ProtectedregisterWorkerMessageListener

    removeTaskFunction

    removeTaskFunction

    ProtectedsendStartupMessageToWorker

    ProtectedsendStartupMessageToWorker

    ProtectedsendToWorker

    • sendToWorker(workerNodeKey, message): void

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

      +

    Returns void

    ProtectedsendToWorker

    setDefaultTaskFunction

    setDefaultTaskFunction

    setTasksQueueOptions

    ProtectedsetupHook

    setTasksQueueOptions

    ProtectedsetupHook

    setWorkerChoiceStrategy

    • setWorkerChoiceStrategy(workerChoiceStrategy, workerChoiceStrategyOptions?): void

    • Parameters

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

      Returns void

      Inherit Doc

    setWorkerChoiceStrategyOptions

    setWorkerChoiceStrategy

    • setWorkerChoiceStrategy(workerChoiceStrategy, workerChoiceStrategyOptions?): void

    • Parameters

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

      Returns void

      Inherit Doc

    setWorkerChoiceStrategyOptions

    ProtectedshallCreateDynamicWorker

    ProtectedshallCreateDynamicWorker

    start

    Protected ReadonlyworkerMessageListener

    start

    Protected ReadonlyworkerMessageListener

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index 93934b6f..f002d599 100644 --- a/docs/classes/DynamicThreadPool.html +++ b/docs/classes/DynamicThreadPool.html @@ -1,11 +1,11 @@ -DynamicThreadPool | poolifier - v4.4.3

    Class DynamicThreadPool<Data, Response>

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

    +DynamicThreadPool | poolifier - v4.4.4

    Class DynamicThreadPool<Data, Response>

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

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

    Author

    Alessandro Pio Ardizio

    Since

    0.0.1

    Type Parameters

    • Data = unknown

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

    • Response = unknown

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

      -

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

    Optionalemitter

    emitter?: EventEmitterAsyncResource

    Pool event emitter integrated with async resource. +

    Returns DynamicThreadPool<Data, Response>

    Properties

    Optionalemitter

    emitter?: EventEmitterAsyncResource

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

    Events that can currently be listened to:

      @@ -75,93 +75,93 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    • 'backPressure': Emitted when the number of workers created in the pool has reached the maximum size expected and are back pressured (i.e. their tasks queue is full: queue size >= maximum queue size).
    • 'backPressureEnd': Emitted when the number of workers created in the pool has reached the maximum size expected and are no longer back pressured (i.e. their tasks queue is no longer full: queue size < maximum queue size).
    -

    Protected ReadonlyfilePath

    filePath: string

    Path to the worker file.

    -

    Protected Optional ReadonlymaximumNumberOfWorkers

    maximumNumberOfWorkers?: number

    Maximum number of workers that this pool manages.

    -

    Protected ReadonlyminimumNumberOfWorkers

    minimumNumberOfWorkers: number

    Minimum number of workers that this pool manages.

    -

    Protected Readonlyopts

    opts: PoolOptions<Worker>

    Options for the pool.

    -

    ProtectedpromiseResponseMap

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

    The task execution response promise map:

    +

    Protected ReadonlyfilePath

    filePath: string

    Path to the worker file.

    +

    Protected Optional ReadonlymaximumNumberOfWorkers

    maximumNumberOfWorkers?: number

    Maximum number of workers that this pool manages.

    +

    Protected ReadonlyminimumNumberOfWorkers

    minimumNumberOfWorkers: number

    Minimum number of workers that this pool manages.

    +

    Protected Readonlyopts

    opts: PoolOptions<Worker>

    Options for the pool.

    +

    ProtectedpromiseResponseMap

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

    The task execution response promise map:

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

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

    -

    Protected OptionalworkerChoiceStrategiesContext

    workerChoiceStrategiesContext?: WorkerChoiceStrategiesContext<Worker, Data, Response>

    Worker choice strategies context referencing worker choice algorithms implementation.

    -

    Readonly InternalworkerNodes

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

    Pool worker nodes.

    -

    Accessors

    ProtectedbackPressure

    Protected OptionalworkerChoiceStrategiesContext

    workerChoiceStrategiesContext?: WorkerChoiceStrategiesContext<Worker, Data, Response>

    Worker choice strategies context referencing worker choice algorithms implementation.

    +

    Readonly InternalworkerNodes

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

    Pool worker nodes.

    +

    Accessors

    ProtectedbackPressure

    • get backPressure(): boolean

    • Whether the pool is back pressured or not.

      Returns boolean

      The pool back pressure boolean status.

      -

    Protectedbusy

    Protectedbusy

    • get busy(): boolean

    • Whether the pool is busy or not.

      Returns boolean

      The pool busyness boolean status.

      -

    info

    Protectedtype

    info

    Protectedtype

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

    • The pool type.

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

      -

      Returns "fixed" | "dynamic"

    Protectedworker

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

    • The worker type.

      -

      Returns "cluster" | "thread"

    Methods

    addTaskFunction

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

    • Parameters

    Protectedworker

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

    • The worker type.

      +

      Returns "cluster" | "thread"

    Methods

    addTaskFunction

    ProtectedafterTaskExecutionHook

    ProtectedafterTaskExecutionHook

    ProtectedafterWorkerNodeSetup

    • afterWorkerNodeSetup(workerNodeKey): void

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

    Returns void

    ProtectedafterWorkerNodeSetup

    ProtectedbeforeTaskExecutionHook

    • beforeTaskExecutionHook(workerNodeKey, task): void

    • Hook executed before the worker task execution. +

    Returns void

    ProtectedbeforeTaskExecutionHook

    ProtectedcheckAndEmitDynamicWorkerCreationEvents

    ProtectedcheckAndEmitDynamicWorkerDestructionEvents

    ProtectedcreateAndSetupDynamicWorkerNode

    • createAndSetupDynamicWorkerNode(): number

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

      +

    Returns void

    ProtectedcheckAndEmitDynamicWorkerCreationEvents

    ProtectedcheckAndEmitDynamicWorkerDestructionEvents

    ProtectedcreateAndSetupDynamicWorkerNode

    ProtectedcreateAndSetupWorkerNode

    ProtectedcreateAndSetupWorkerNode

    ProtectedderegisterWorkerMessageListener

    ProtectedderegisterWorkerMessageListener

    destroy

    ProtecteddestroyWorkerNode

    • destroyWorkerNode(workerNodeKey): Promise<void>

    • Terminates the worker node given its worker node key.

      +

    Returns void

    destroy

    ProtecteddestroyWorkerNode

    enableTasksQueue

    execute

    enableTasksQueue

    execute

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

    • Parameters

      • Optionaldata: Data

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

      • Optionalname: string

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

      • OptionaltransferList: readonly TransferListItem[]

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

      Returns Promise<Response>

      Promise with a task function response that will be fulfilled when the task is completed.

      -

    ProtectedflagWorkerNodeAsNotReady

    ProtectedflushTasksQueue

    ProtectedgetWorkerInfo

    ProtectedflagWorkerNodeAsNotReady

    ProtectedflushTasksQueue

    ProtectedgetWorkerInfo

    hasTaskFunction

    hasTaskFunction

    ProtectedinternalBackPressure

    ProtectedinternalBackPressure

    ProtectedinternalBusy

    ProtectedinternalBusy

    ProtectedisMain

    ProtectedisMain

    listTaskFunctionsProperties

    mapExecute

    listTaskFunctionsProperties

    mapExecute

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

    • Parameters

      • data: Iterable<Data, any, any>

        The tasks iterable input data for the specified task function. This can only be an iterable of structured-cloneable data.

      • Optionalname: string

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

      • OptionaltransferList: readonly TransferListItem[]

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

      Returns Promise<Response[]>

      Promise with an array of task function responses that will be fulfilled when the tasks are completed.

      -

    ProtectedregisterOnceWorkerMessageListener

    ProtectedregisterOnceWorkerMessageListener

    ProtectedregisterWorkerMessageListener

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

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

      +

    Returns void

    ProtectedregisterWorkerMessageListener

    removeTaskFunction

    removeTaskFunction

    ProtectedsendStartupMessageToWorker

    ProtectedsendStartupMessageToWorker

    ProtectedsendToWorker

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

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

      +

    Returns void

    ProtectedsendToWorker

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

      • OptionaltransferList: readonly TransferListItem[]

        The optional array of transferable objects.

        -

      Returns void

    setDefaultTaskFunction

    setDefaultTaskFunction

    setTasksQueueOptions

    ProtectedsetupHook

    setTasksQueueOptions

    ProtectedsetupHook

    setWorkerChoiceStrategy

    • setWorkerChoiceStrategy(workerChoiceStrategy, workerChoiceStrategyOptions?): void

    • Parameters

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

      Returns void

      Inherit Doc

    setWorkerChoiceStrategyOptions

    setWorkerChoiceStrategy

    • setWorkerChoiceStrategy(workerChoiceStrategy, workerChoiceStrategyOptions?): void

    • Parameters

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

      Returns void

      Inherit Doc

    setWorkerChoiceStrategyOptions

    ProtectedshallCreateDynamicWorker

    ProtectedshallCreateDynamicWorker

    start

    Protected ReadonlyworkerMessageListener

    start

    Protected ReadonlyworkerMessageListener

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index b5c58d44..6e2b2a54 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -1,9 +1,9 @@ -FixedClusterPool | poolifier - v4.4.3

    Class FixedClusterPool<Data, Response>

    A cluster pool with a fixed number of workers.

    +FixedClusterPool | poolifier - v4.4.4

    Class FixedClusterPool<Data, Response>

    A cluster pool with a fixed number of workers.

    Author

    Christopher Quadflieg

    Since

    2.0.0

    Type Parameters

    • Data = unknown

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

    • Response = unknown

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

      -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    emitter? filePath maximumNumberOfWorkers? @@ -57,7 +57,7 @@
  • filePath: string

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

  • opts: ClusterPoolOptions = {}

    Options for this fixed cluster pool.

  • OptionalmaximumNumberOfWorkers: number

    The maximum number of workers for this pool.

    -

    • Returns FixedClusterPool<Data, Response>

    Properties

    Optionalemitter

    emitter?: EventEmitterAsyncResource

    Pool event emitter integrated with async resource. +

    Returns FixedClusterPool<Data, Response>

    Properties

    Optionalemitter

    emitter?: EventEmitterAsyncResource

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

    Events that can currently be listened to:

      @@ -73,92 +73,92 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    • 'backPressure': Emitted when the number of workers created in the pool has reached the maximum size expected and are back pressured (i.e. their tasks queue is full: queue size >= maximum queue size).
    • 'backPressureEnd': Emitted when the number of workers created in the pool has reached the maximum size expected and are no longer back pressured (i.e. their tasks queue is no longer full: queue size < maximum queue size).
    -

    Protected ReadonlyfilePath

    filePath: string

    Path to the worker file.

    -

    Protected Optional ReadonlymaximumNumberOfWorkers

    maximumNumberOfWorkers?: number

    Maximum number of workers that this pool manages.

    -

    Protected ReadonlyminimumNumberOfWorkers

    minimumNumberOfWorkers: number

    Minimum number of workers that this pool manages.

    -

    Protected Readonlyopts

    opts: PoolOptions<Worker>

    Options for the pool.

    -

    ProtectedpromiseResponseMap

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

    The task execution response promise map:

    +

    Protected ReadonlyfilePath

    filePath: string

    Path to the worker file.

    +

    Protected Optional ReadonlymaximumNumberOfWorkers

    maximumNumberOfWorkers?: number

    Maximum number of workers that this pool manages.

    +

    Protected ReadonlyminimumNumberOfWorkers

    minimumNumberOfWorkers: number

    Minimum number of workers that this pool manages.

    +

    Protected Readonlyopts

    opts: PoolOptions<Worker>

    Options for the pool.

    +

    ProtectedpromiseResponseMap

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

    The task execution response promise map:

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

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

    -

    Protected OptionalworkerChoiceStrategiesContext

    workerChoiceStrategiesContext?: WorkerChoiceStrategiesContext<Worker, Data, Response>

    Worker choice strategies context referencing worker choice algorithms implementation.

    -

    Readonly InternalworkerNodes

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

    Pool worker nodes.

    -

    Accessors

    ProtectedbackPressure

    Protected OptionalworkerChoiceStrategiesContext

    workerChoiceStrategiesContext?: WorkerChoiceStrategiesContext<Worker, Data, Response>

    Worker choice strategies context referencing worker choice algorithms implementation.

    +

    Readonly InternalworkerNodes

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

    Pool worker nodes.

    +

    Accessors

    ProtectedbackPressure

    • get backPressure(): boolean

    • Whether the pool is back pressured or not.

      Returns boolean

      The pool back pressure boolean status.

      -

    Protectedbusy

    Protectedbusy

    • get busy(): boolean

    • Whether the pool is busy or not.

      Returns boolean

      The pool busyness boolean status.

      -

    info

    Protectedtype

    info

    Protectedtype

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

    • The pool type.

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

      -

      Returns "fixed" | "dynamic"

    Protectedworker

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

    • The worker type.

      -

      Returns "cluster" | "thread"

    Methods

    addTaskFunction

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

    • Parameters

    Protectedworker

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

    • The worker type.

      +

      Returns "cluster" | "thread"

    Methods

    addTaskFunction

    ProtectedafterTaskExecutionHook

    ProtectedafterTaskExecutionHook

    ProtectedafterWorkerNodeSetup

    • afterWorkerNodeSetup(workerNodeKey): void

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

    Returns void

    ProtectedafterWorkerNodeSetup

    ProtectedbeforeTaskExecutionHook

    • beforeTaskExecutionHook(workerNodeKey, task): void

    • Hook executed before the worker task execution. +

    Returns void

    ProtectedbeforeTaskExecutionHook

    ProtectedcheckAndEmitDynamicWorkerCreationEvents

    ProtectedcheckAndEmitDynamicWorkerDestructionEvents

    ProtectedcreateAndSetupDynamicWorkerNode

    • createAndSetupDynamicWorkerNode(): number

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

      +

    Returns void

    ProtectedcheckAndEmitDynamicWorkerCreationEvents

    ProtectedcheckAndEmitDynamicWorkerDestructionEvents

    ProtectedcreateAndSetupDynamicWorkerNode

    ProtectedcreateAndSetupWorkerNode

    ProtectedcreateAndSetupWorkerNode

    ProtectedderegisterWorkerMessageListener

    ProtectedderegisterWorkerMessageListener

    destroy

    ProtecteddestroyWorkerNode

    • destroyWorkerNode(workerNodeKey): Promise<void>

    • Terminates the worker node given its worker node key.

      +

    Returns void

    destroy

    ProtecteddestroyWorkerNode

    enableTasksQueue

    execute

    enableTasksQueue

    execute

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

    • Parameters

      • Optionaldata: Data

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

      • Optionalname: string

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

      • OptionaltransferList: readonly TransferListItem[]

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

      Returns Promise<Response>

      Promise with a task function response that will be fulfilled when the task is completed.

      -

    ProtectedflagWorkerNodeAsNotReady

    ProtectedflushTasksQueue

    ProtectedgetWorkerInfo

    ProtectedflagWorkerNodeAsNotReady

    ProtectedflushTasksQueue

    ProtectedgetWorkerInfo

    hasTaskFunction

    hasTaskFunction

    ProtectedinternalBackPressure

    ProtectedinternalBackPressure

    ProtectedinternalBusy

    ProtectedinternalBusy

    ProtectedisMain

    ProtectedisMain

    listTaskFunctionsProperties

    mapExecute

    listTaskFunctionsProperties

    mapExecute

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

    • Parameters

      • data: Iterable<Data, any, any>

        The tasks iterable input data for the specified task function. This can only be an iterable of structured-cloneable data.

      • Optionalname: string

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

      • OptionaltransferList: readonly TransferListItem[]

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

      Returns Promise<Response[]>

      Promise with an array of task function responses that will be fulfilled when the tasks are completed.

      -

    ProtectedregisterOnceWorkerMessageListener

    ProtectedregisterOnceWorkerMessageListener

    ProtectedregisterWorkerMessageListener

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

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

      +

    Returns void

    ProtectedregisterWorkerMessageListener

    removeTaskFunction

    removeTaskFunction

    ProtectedsendStartupMessageToWorker

    ProtectedsendStartupMessageToWorker

    ProtectedsendToWorker

    • sendToWorker(workerNodeKey, message): void

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

      +

    Returns void

    ProtectedsendToWorker

    setDefaultTaskFunction

    setDefaultTaskFunction

    setTasksQueueOptions

    ProtectedsetupHook

    setTasksQueueOptions

    ProtectedsetupHook

    setWorkerChoiceStrategy

    • setWorkerChoiceStrategy(workerChoiceStrategy, workerChoiceStrategyOptions?): void

    • Parameters

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

      Returns void

      Inherit Doc

    setWorkerChoiceStrategyOptions

    setWorkerChoiceStrategy

    • setWorkerChoiceStrategy(workerChoiceStrategy, workerChoiceStrategyOptions?): void

    • Parameters

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

      Returns void

      Inherit Doc

    setWorkerChoiceStrategyOptions

    ProtectedshallCreateDynamicWorker

    ProtectedshallCreateDynamicWorker

    start

    Protected ReadonlyworkerMessageListener

    start

    Protected ReadonlyworkerMessageListener

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index c0135bb8..33d95d86 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.html @@ -1,9 +1,9 @@ -FixedThreadPool | poolifier - v4.4.3

    Class FixedThreadPool<Data, Response>

    A thread pool with a fixed number of threads.

    +FixedThreadPool | poolifier - v4.4.4

    Class FixedThreadPool<Data, Response>

    A thread pool with a fixed number of threads.

    Author

    Alessandro Pio Ardizio

    Since

    0.0.1

    Type Parameters

    • Data = unknown

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

    • Response = unknown

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

      -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    emitter? filePath maximumNumberOfWorkers? @@ -57,7 +57,7 @@
  • filePath: string

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

  • opts: ThreadPoolOptions = {}

    Options for this fixed thread pool.

  • OptionalmaximumNumberOfThreads: number

    The maximum number of threads for this pool.

    -

    • Returns FixedThreadPool<Data, Response>

    Properties

    Optionalemitter

    emitter?: EventEmitterAsyncResource

    Pool event emitter integrated with async resource. +

    Returns FixedThreadPool<Data, Response>

    Properties

    Optionalemitter

    emitter?: EventEmitterAsyncResource

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

    Events that can currently be listened to:

      @@ -73,93 +73,93 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    • 'backPressure': Emitted when the number of workers created in the pool has reached the maximum size expected and are back pressured (i.e. their tasks queue is full: queue size >= maximum queue size).
    • 'backPressureEnd': Emitted when the number of workers created in the pool has reached the maximum size expected and are no longer back pressured (i.e. their tasks queue is no longer full: queue size < maximum queue size).
    -

    Protected ReadonlyfilePath

    filePath: string

    Path to the worker file.

    -

    Protected Optional ReadonlymaximumNumberOfWorkers

    maximumNumberOfWorkers?: number

    Maximum number of workers that this pool manages.

    -

    Protected ReadonlyminimumNumberOfWorkers

    minimumNumberOfWorkers: number

    Minimum number of workers that this pool manages.

    -

    Protected Readonlyopts

    opts: PoolOptions<Worker>

    Options for the pool.

    -

    ProtectedpromiseResponseMap

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

    The task execution response promise map:

    +

    Protected ReadonlyfilePath

    filePath: string

    Path to the worker file.

    +

    Protected Optional ReadonlymaximumNumberOfWorkers

    maximumNumberOfWorkers?: number

    Maximum number of workers that this pool manages.

    +

    Protected ReadonlyminimumNumberOfWorkers

    minimumNumberOfWorkers: number

    Minimum number of workers that this pool manages.

    +

    Protected Readonlyopts

    opts: PoolOptions<Worker>

    Options for the pool.

    +

    ProtectedpromiseResponseMap

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

    The task execution response promise map:

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

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

    -

    Protected OptionalworkerChoiceStrategiesContext

    workerChoiceStrategiesContext?: WorkerChoiceStrategiesContext<Worker, Data, Response>

    Worker choice strategies context referencing worker choice algorithms implementation.

    -

    Readonly InternalworkerNodes

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

    Pool worker nodes.

    -

    Accessors

    ProtectedbackPressure

    Protected OptionalworkerChoiceStrategiesContext

    workerChoiceStrategiesContext?: WorkerChoiceStrategiesContext<Worker, Data, Response>

    Worker choice strategies context referencing worker choice algorithms implementation.

    +

    Readonly InternalworkerNodes

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

    Pool worker nodes.

    +

    Accessors

    ProtectedbackPressure

    • get backPressure(): boolean

    • Whether the pool is back pressured or not.

      Returns boolean

      The pool back pressure boolean status.

      -

    Protectedbusy

    Protectedbusy

    • get busy(): boolean

    • Whether the pool is busy or not.

      Returns boolean

      The pool busyness boolean status.

      -

    info

    Protectedtype

    info

    Protectedtype

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

    • The pool type.

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

      -

      Returns "fixed" | "dynamic"

    Protectedworker

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

    • The worker type.

      -

      Returns "cluster" | "thread"

    Methods

    addTaskFunction

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

    • Parameters

    Protectedworker

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

    • The worker type.

      +

      Returns "cluster" | "thread"

    Methods

    addTaskFunction

    ProtectedafterTaskExecutionHook

    ProtectedafterTaskExecutionHook

    ProtectedafterWorkerNodeSetup

    • afterWorkerNodeSetup(workerNodeKey): void

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

    Returns void

    ProtectedafterWorkerNodeSetup

    ProtectedbeforeTaskExecutionHook

    • beforeTaskExecutionHook(workerNodeKey, task): void

    • Hook executed before the worker task execution. +

    Returns void

    ProtectedbeforeTaskExecutionHook

    ProtectedcheckAndEmitDynamicWorkerCreationEvents

    ProtectedcheckAndEmitDynamicWorkerDestructionEvents

    ProtectedcreateAndSetupDynamicWorkerNode

    • createAndSetupDynamicWorkerNode(): number

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

      +

    Returns void

    ProtectedcheckAndEmitDynamicWorkerCreationEvents

    ProtectedcheckAndEmitDynamicWorkerDestructionEvents

    ProtectedcreateAndSetupDynamicWorkerNode

    ProtectedcreateAndSetupWorkerNode

    ProtectedcreateAndSetupWorkerNode

    ProtectedderegisterWorkerMessageListener

    ProtectedderegisterWorkerMessageListener

    destroy

    ProtecteddestroyWorkerNode

    • destroyWorkerNode(workerNodeKey): Promise<void>

    • Terminates the worker node given its worker node key.

      +

    Returns void

    destroy

    ProtecteddestroyWorkerNode

    enableTasksQueue

    execute

    enableTasksQueue

    execute

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

    • Parameters

      • Optionaldata: Data

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

      • Optionalname: string

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

      • OptionaltransferList: readonly TransferListItem[]

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

      Returns Promise<Response>

      Promise with a task function response that will be fulfilled when the task is completed.

      -

    ProtectedflagWorkerNodeAsNotReady

    ProtectedflushTasksQueue

    ProtectedgetWorkerInfo

    ProtectedflagWorkerNodeAsNotReady

    ProtectedflushTasksQueue

    ProtectedgetWorkerInfo

    hasTaskFunction

    hasTaskFunction

    ProtectedinternalBackPressure

    ProtectedinternalBackPressure

    ProtectedinternalBusy

    ProtectedinternalBusy

    ProtectedisMain

    ProtectedisMain

    listTaskFunctionsProperties

    mapExecute

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

    • Parameters

    listTaskFunctionsProperties

    mapExecute

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

    • Parameters

      • data: Iterable<Data, any, any>

        The tasks iterable input data for the specified task function. This can only be an iterable of structured-cloneable data.

      • Optionalname: string

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

      • OptionaltransferList: readonly TransferListItem[]

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

      Returns Promise<Response[]>

      Promise with an array of task function responses that will be fulfilled when the tasks are completed.

      -

    ProtectedregisterOnceWorkerMessageListener

    ProtectedregisterOnceWorkerMessageListener

    ProtectedregisterWorkerMessageListener

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

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

      +

    Returns void

    ProtectedregisterWorkerMessageListener

    removeTaskFunction

    removeTaskFunction

    ProtectedsendStartupMessageToWorker

    ProtectedsendStartupMessageToWorker

    ProtectedsendToWorker

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

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

      +

    Returns void

    ProtectedsendToWorker

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

      • OptionaltransferList: readonly TransferListItem[]

        The optional array of transferable objects.

        -

      Returns void

    setDefaultTaskFunction

    setDefaultTaskFunction

    setTasksQueueOptions

    ProtectedsetupHook

    setTasksQueueOptions

    ProtectedsetupHook

    setWorkerChoiceStrategy

    • setWorkerChoiceStrategy(workerChoiceStrategy, workerChoiceStrategyOptions?): void

    • Parameters

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

      Returns void

      Inherit Doc

    setWorkerChoiceStrategyOptions

    setWorkerChoiceStrategy

    • setWorkerChoiceStrategy(workerChoiceStrategy, workerChoiceStrategyOptions?): void

    • Parameters

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

      Returns void

      Inherit Doc

    setWorkerChoiceStrategyOptions

    ProtectedshallCreateDynamicWorker

    ProtectedshallCreateDynamicWorker

    start

    Protected ReadonlyworkerMessageListener

    start

    Protected ReadonlyworkerMessageListener

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/classes/PriorityQueue.html b/docs/classes/PriorityQueue.html index 93fcc3c2..4cb74512 100644 --- a/docs/classes/PriorityQueue.html +++ b/docs/classes/PriorityQueue.html @@ -1,6 +1,6 @@ -PriorityQueue | poolifier - v4.4.3

    Class PriorityQueue<T>Internal

    Priority queue.

    +PriorityQueue | poolifier - v4.4.4

    Class PriorityQueue<T>Internal

    Priority queue.

    Type Parameters

    • T

      Type of priority queue data.

      -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    maxSize

    Accessors

    buckets enablePriority @@ -19,24 +19,24 @@

    Default Value

    false
    -

    Properties

    maxSize

    maxSize: number

    The priority queue maximum size.

    -

    Accessors

    buckets

    • get buckets(): number

    • The number of filled prioritized buckets.

      +

    Properties

    maxSize

    maxSize: number

    The priority queue maximum size.

    +

    Accessors

    buckets

    • get buckets(): number

    • The number of filled prioritized buckets.

      Returns number

      The number of filled prioritized buckets.

      -

    enablePriority

    enablePriority

    size

    • get size(): number

    • The priority queue size.

      +

    Returns void

    size

    Methods

    [iterator]

    Methods

    [iterator]

    clear

    dequeue

    • dequeue(bucket?): undefined | T

    • Dequeue data from the priority queue.

      +

    clear

    dequeue

    • dequeue(bucket?): undefined | T

    • Dequeue data from the priority queue.

      Parameters

      • Optionalbucket: number

        The prioritized bucket to dequeue from.

      Returns undefined | T

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

      -

    enqueue

    enqueue

    • enqueue(data, priority?): number

    • Enqueue data into the priority queue.

      Parameters

      • data: T

        Data to enqueue.

      • Optionalpriority: number

        Priority of the data. Lower values have higher priority.

      Returns number

      The new size of the priority queue.

      -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/classes/ThreadWorker.html b/docs/classes/ThreadWorker.html index 8ecfe479..9ede79ee 100644 --- a/docs/classes/ThreadWorker.html +++ b/docs/classes/ThreadWorker.html @@ -1,4 +1,4 @@ -ThreadWorker | poolifier - v4.4.3

    Class ThreadWorker<Data, Response>

    A thread worker used by a poolifier ThreadPool.

    +ThreadWorker | poolifier - v4.4.4

    Class ThreadWorker<Data, Response>

    A thread worker used by a poolifier ThreadPool.

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

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

    Since

    0.0.1

    Type Parameters

    • Data = unknown

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

    • Response = unknown

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

      -

    Hierarchy (view full)

    Constructors

    constructor +

    Hierarchy (view full)

    Constructors

    constructor

    Properties

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

    Constructors

    constructor

    Properties

    Protected OptionalactiveInterval

    activeInterval?: Timeout

    Handler id of the activeInterval worker activity check.

    -

    Protected ReadonlyisMain

    isMain: undefined | boolean

    Whether this is the main worker or not.

    -

    ProtectedlastTaskTimestamp

    lastTaskTimestamp: number

    Timestamp of the last task processed by this worker.

    -

    Protectedopts

    opts: WorkerOptions = DEFAULT_WORKER_OPTIONS

    Options for the worker.

    -

    Protected Optionalstatistics

    statistics?: WorkerStatistics

    Performance statistics computation requirements.

    -

    ProtectedtaskFunctions

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

    Task function object(s) processed by the worker when the pool's execute method is invoked.

    -

    Accessors

    Protectedid

    Methods

    addTaskFunction

    Returns ThreadWorker<Data, Response>

    Properties

    Protected OptionalactiveInterval

    activeInterval?: Timeout

    Handler id of the activeInterval worker activity check.

    +

    Protected ReadonlyisMain

    isMain: undefined | boolean

    Whether this is the main worker or not.

    +

    ProtectedlastTaskTimestamp

    lastTaskTimestamp: number

    Timestamp of the last task processed by this worker.

    +

    Protectedopts

    opts: WorkerOptions = DEFAULT_WORKER_OPTIONS

    Options for the worker.

    +

    Protected Optionalstatistics

    statistics?: WorkerStatistics

    Performance statistics computation requirements.

    +

    ProtectedtaskFunctions

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

    Task function object(s) processed by the worker when the pool's execute method is invoked.

    +

    Accessors

    Protectedid

    Methods

    addTaskFunction

    ProtectedgetMainWorker

    ProtectedgetMainWorker

    ProtectedhandleError

    • handleError(error): {
          error: Error;
          message: string;
          stack?: string;
      }

    • Handles a worker error.

      +

    ProtectedhandleError

    • handleError(error): {
          error: Error;
          message: string;
          stack?: string;
      }

    • Handles a worker error.

      Parameters

      • error: Error

        The error raised by the worker.

      Returns {
          error: Error;
          message: string;
          stack?: string;
      }

      The worker error object.

      -
      • error: Error
      • message: string
      • Optionalstack?: string

    ProtectedhandleKillMessage

    ProtectedhandleKillMessage

    ProtectedhandleReadyMessage

    • handleReadyMessage(message): void

    • Handles the ready message sent by the main worker.

      +

    Returns void

    ProtectedhandleReadyMessage

    ProtectedhandleTaskFunctionOperationMessage

    hasTaskFunction

    Returns void

    ProtectedhandleTaskFunctionOperationMessage

    hasTaskFunction

    listTaskFunctionsProperties

    listTaskFunctionsProperties

    ProtectedmessageListener

    ProtectedmessageListener

    removeTaskFunction

    Returns void

    removeTaskFunction

    Protected Readonlyrun

    Protected Readonlyrun

    Protected ReadonlyrunAsync

    • runAsync(fn, task): void

    • Runs the given task function asynchronously.

      +

    Returns void

    Protected ReadonlyrunAsync

    Protected ReadonlyrunSync

    • runSync(fn, task): void

    • Runs the given task function synchronously.

      +

    Returns void

    Protected ReadonlyrunSync

    ProtectedsendTaskFunctionsPropertiesToMainWorker

    Protected ReadonlysendToMainWorker

    • sendToMainWorker(message): void

    • Sends a message to main worker.

      +

    Returns void

    ProtectedsendTaskFunctionsPropertiesToMainWorker

    Protected ReadonlysendToMainWorker

    setDefaultTaskFunction

    Returns void

    setDefaultTaskFunction

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/classes/WorkerChoiceStrategiesContext.html b/docs/classes/WorkerChoiceStrategiesContext.html index e3119c92..5cb81ff1 100644 --- a/docs/classes/WorkerChoiceStrategiesContext.html +++ b/docs/classes/WorkerChoiceStrategiesContext.html @@ -1,8 +1,8 @@ -WorkerChoiceStrategiesContext | poolifier - v4.4.3

    Class WorkerChoiceStrategiesContext<Worker, Data, Response>Internal

    The worker choice strategies context.

    +WorkerChoiceStrategiesContext | poolifier - v4.4.4

    Class WorkerChoiceStrategiesContext<Worker, Data, Response>Internal

    The worker choice strategies context.

    Type Parameters

    • Worker extends IWorker

      Type of worker.

    • Data = unknown

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

    • Response = unknown

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

      -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    retriesCount

    Methods

    execute getPolicy @@ -19,30 +19,30 @@

    Returns WorkerChoiceStrategiesContext<Worker, Data, Response>

    Default Value

    [WorkerChoiceStrategies.ROUND_ROBIN]
    -

    Properties

    retriesCount

    retriesCount: number

    The number of worker choice strategies execution retries.

    -

    Methods

    execute

    • execute(workerChoiceStrategy?): number

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

      +

    Properties

    retriesCount

    retriesCount: number

    The number of worker choice strategies execution retries.

    +

    Methods

    execute

    • execute(workerChoiceStrategy?): number

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

      Parameters

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

        The worker choice strategy algorithm to execute.

      Returns number

      The key of the worker node.

      Default Value

      this.defaultWorkerChoiceStrategy

      Throws

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

      -

    getPolicy

    • getPolicy(): StrategyPolicy

    • Gets the active worker choice strategies in the context policy.

      +

    getPolicy

    getTaskStatisticsRequirements

    getTaskStatisticsRequirements

    remove

    remove

    setDefaultWorkerChoiceStrategy

    setDefaultWorkerChoiceStrategy

    • setDefaultWorkerChoiceStrategy(workerChoiceStrategy, opts?): void

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

      Parameters

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

        The default worker choice strategy to set.

      • Optionalopts: WorkerChoiceStrategyOptions

        The worker choice strategy options.

        -

      Returns void

    setOptions

    • setOptions(opts): void

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

      +

    Returns void

    setOptions

    syncWorkerChoiceStrategies

    • syncWorkerChoiceStrategies(workerChoiceStrategies, opts?): void

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

      +

    Returns void

    syncWorkerChoiceStrategies

    • syncWorkerChoiceStrategies(workerChoiceStrategies, opts?): void

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

      Parameters

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

        The worker choice strategies to synchronize.

      • Optionalopts: WorkerChoiceStrategyOptions

        The worker choice strategy options.

        -

      Returns void

    update

    • update(workerNodeKey): boolean

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

      +

    Returns void

    update

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/docs/functions/availableParallelism.html b/docs/functions/availableParallelism.html index 9aeb9bf9..e202a7b1 100644 --- a/docs/functions/availableParallelism.html +++ b/docs/functions/availableParallelism.html @@ -1,4 +1,4 @@ -availableParallelism | poolifier - v4.4.3

    Function availableParallelism

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

    Function availableParallelism

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

    • availableParallelism(): number

    • Returns number

      The host OS optimized maximum pool size.

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/docs/hierarchy.html b/docs/hierarchy.html index 688c1fca..45d0fa1d 100644 --- a/docs/hierarchy.html +++ b/docs/hierarchy.html @@ -1 +1 @@ -poolifier - v4.4.3

    poolifier - v4.4.3

    Class Hierarchy

    Settings

    Member Visibility
    +poolifier - v4.4.4

    poolifier - v4.4.4

    Class Hierarchy

    Settings

    Member Visibility
    diff --git a/docs/index.html b/docs/index.html index 0f20cca2..aeab71b2 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,4 +1,4 @@ -poolifier - v4.4.3

    poolifier - v4.4.3

    Index

    Classes

    AbstractPool +poolifier - v4.4.4

    poolifier - v4.4.4

    Index

    Classes

    AbstractPool AbstractWorker CircularBuffer ClusterWorker @@ -67,4 +67,4 @@ WorkerChoiceStrategies WorkerTypes

    Functions

    availableParallelism -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/docs/interfaces/EventLoopUtilizationMeasurementStatistics.html b/docs/interfaces/EventLoopUtilizationMeasurementStatistics.html index 141fdb3b..c1b43016 100644 --- a/docs/interfaces/EventLoopUtilizationMeasurementStatistics.html +++ b/docs/interfaces/EventLoopUtilizationMeasurementStatistics.html @@ -1,5 +1,5 @@ -EventLoopUtilizationMeasurementStatistics | poolifier - v4.4.3

    Interface EventLoopUtilizationMeasurementStatisticsInternal

    Event loop utilization measurement statistics.

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

    Properties

    active +EventLoopUtilizationMeasurementStatistics | poolifier - v4.4.4

    Interface EventLoopUtilizationMeasurementStatisticsInternal

    Event loop utilization measurement statistics.

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

    Properties

    active idle utilization? -

    Properties

    Readonlyactive

    active: MeasurementStatistics

    Readonlyidle

    idle: MeasurementStatistics

    Optionalutilization

    utilization?: number

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Readonlyactive

    active: MeasurementStatistics

    Readonlyidle

    idle: MeasurementStatistics

    Optionalutilization

    utilization?: number

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/FixedQueueNode.html b/docs/interfaces/FixedQueueNode.html index bbc77592..fa5e246e 100644 --- a/docs/interfaces/FixedQueueNode.html +++ b/docs/interfaces/FixedQueueNode.html @@ -1,5 +1,5 @@ -FixedQueueNode | poolifier - v4.4.3

    Interface FixedQueueNode<T>Internal

    Fixed queue node.

    +FixedQueueNode | poolifier - v4.4.4

    Interface FixedQueueNode<T>Internal

    Fixed queue node.

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

    Type Parameters

    • T

      Type of fixed queue node data.

      -

    Properties

    data +

    Properties

    data priority -

    Properties

    data

    data: T

    priority

    priority: number

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    data

    data: T

    priority

    priority: number

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/IFixedQueue.html b/docs/interfaces/IFixedQueue.html index e9853fb7..7602a95b 100644 --- a/docs/interfaces/IFixedQueue.html +++ b/docs/interfaces/IFixedQueue.html @@ -1,6 +1,6 @@ -IFixedQueue | poolifier - v4.4.3

    Interface IFixedQueue<T>Internal

    Fixed queue.

    +IFixedQueue | poolifier - v4.4.4

    Interface IFixedQueue<T>Internal

    Fixed queue.

    interface IFixedQueue<T> {
        [iterator]: (() => Iterator<T, any, any>);
        capacity: number;
        clear: (() => void);
        dequeue: (() => undefined | T);
        empty: (() => boolean);
        enqueue: ((data: T, priority?: number) => number);
        full: (() => boolean);
        get: ((index: number) => undefined | T);
        nodeArray: FixedQueueNode<T>[];
        size: number;
    }

    Type Parameters

    • T

      Type of fixed queue data.

      -

    Properties

    [iterator] +

    Properties

    [iterator] capacity clear dequeue @@ -13,22 +13,22 @@

    Properties

    [iterator]

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

    Returns an iterator for the fixed queue.

    Type declaration

      • (): Iterator<T, any, any>

      • Returns Iterator<T, any, any>

        An iterator for the fixed queue.

    See

    https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols

    -

    Readonlycapacity

    capacity: number

    The fixed queue capacity.

    -

    clear

    clear: (() => void)

    Clears the fixed queue.

    -

    dequeue

    dequeue: (() => undefined | T)

    Dequeue data from the fixed queue.

    +

    Readonlycapacity

    capacity: number

    The fixed queue capacity.

    +

    clear

    clear: (() => void)

    Clears the fixed queue.

    +

    dequeue

    dequeue: (() => undefined | T)

    Dequeue data from the fixed queue.

    Type declaration

      • (): undefined | T

      • Returns undefined | T

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

        -

    empty

    empty: (() => boolean)

    Checks if the fixed queue is empty.

    +

    empty

    empty: (() => boolean)

    Checks if the fixed queue is empty.

    Type declaration

      • (): boolean

      • Returns boolean

        true if the fixed queue is empty, false otherwise.

        -

    enqueue

    enqueue: ((data: T, priority?: number) => number)

    Enqueue data into the fixed queue.

    +

    enqueue

    enqueue: ((data: T, priority?: number) => number)

    Enqueue data into the fixed queue.

    Type declaration

      • (data, priority?): number

      • Parameters

        • data: T

          Data to enqueue.

        • Optionalpriority: number

          Priority of the data. Lower values have higher priority.

        Returns number

        The new size of the fixed queue.

    Throws

    If the fixed queue is full.

    -

    full

    full: (() => boolean)

    Checks if the fixed queue is full.

    +

    full

    full: (() => boolean)

    Checks if the fixed queue is full.

    Type declaration

      • (): boolean

      • Returns boolean

        true if the fixed queue is full, false otherwise.

        -

    get

    get: ((index: number) => undefined | T)

    Gets data from the fixed queue.

    +

    get

    get: ((index: number) => undefined | T)

    Gets data from the fixed queue.

    Type declaration

      • (index): undefined | T

      • Parameters

        • index: number

          The index of the data to get.

        Returns undefined | T

        The data at the index or undefined if the fixed queue is empty or the index is out of bounds.

        -

    nodeArray

    nodeArray: FixedQueueNode<T>[]

    The fixed queue node array.

    -

    Readonlysize

    size: number

    The fixed queue size.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    nodeArray

    nodeArray: FixedQueueNode<T>[]

    The fixed queue node array.

    +

    Readonlysize

    size: number

    The fixed queue size.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index a5ae1b47..35e773f1 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -1,8 +1,8 @@ -IPool | poolifier - v4.4.3

    Interface IPool<Worker, Data, Response>

    Contract definition for a poolifier pool.

    +IPool | poolifier - v4.4.4

    Interface IPool<Worker, Data, Response>

    Contract definition for a poolifier pool.

    interface IPool<Worker, Data, Response> {
        addTaskFunction: ((name: string, fn: TaskFunction<Data, Response> | TaskFunctionObject<Data, Response>) => Promise<boolean>);
        destroy: (() => Promise<void>);
        emitter?: EventEmitterAsyncResource;
        enableTasksQueue: ((enable: boolean, tasksQueueOptions?: TasksQueueOptions) => void);
        execute: ((data?: Data, name?: string, transferList?: readonly TransferListItem[]) => Promise<Response>);
        hasTaskFunction: ((name: string) => boolean);
        info: PoolInfo;
        listTaskFunctionsProperties: (() => TaskFunctionProperties[]);
        mapExecute: ((data: Iterable<Data, any, any>, name?: string, transferList?: readonly TransferListItem[]) => Promise<Response[]>);
        removeTaskFunction: ((name: string) => Promise<boolean>);
        setDefaultTaskFunction: ((name: string) => Promise<boolean>);
        setTasksQueueOptions: ((tasksQueueOptions: TasksQueueOptions) => void);
        setWorkerChoiceStrategy: ((workerChoiceStrategy:
            | "FAIR_SHARE"
            | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
            | "LEAST_BUSY"
            | "LEAST_ELU"
            | "LEAST_USED"
            | "ROUND_ROBIN"
            | "WEIGHTED_ROUND_ROBIN", workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions) => void);
        setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions: WorkerChoiceStrategyOptions) => boolean);
        start: (() => void);
        workerNodes: IWorkerNode<Worker, Data>[];
    }

    Type Parameters

    • Worker extends IWorker

      Type of worker which manages this pool.

    • Data = unknown

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

    • Response = unknown

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

      -

    Implemented by

    Properties

    addTaskFunction +

    Implemented by

    Properties

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

    Returns Promise<boolean>

    true if the task function was added, false otherwise.

    Throws

    https://nodejs.org/api/errors.html#class-typeerror If the name parameter is not a string or an empty string.

    Throws

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

    -

    Readonlydestroy

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

    Terminates all workers in this pool.

    -

    Optional Readonlyemitter

    emitter?: EventEmitterAsyncResource

    Pool event emitter integrated with async resource. +

    Readonlydestroy

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

    Terminates all workers in this pool.

    +

    Optional Readonlyemitter

    emitter?: EventEmitterAsyncResource

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

    Events that can currently be listened to:

      @@ -42,39 +42,39 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
    • 'backPressure': Emitted when the number of workers created in the pool has reached the maximum size expected and are back pressured (i.e. their tasks queue is full: queue size >= maximum queue size).
    • 'backPressureEnd': Emitted when the number of workers created in the pool has reached the maximum size expected and are no longer back pressured (i.e. their tasks queue is no longer full: queue size < maximum queue size).
    -

    ReadonlyenableTasksQueue

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

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

    +

    ReadonlyenableTasksQueue

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

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

    Type declaration

      • (enable, tasksQueueOptions?): void

      • Parameters

        • enable: boolean

          Whether to enable or disable the worker node tasks queue.

        • OptionaltasksQueueOptions: TasksQueueOptions

          The worker node tasks queue options.

          -

        Returns void

    Readonlyexecute

    execute: ((data?: Data, name?: string, transferList?: readonly TransferListItem[]) => Promise<Response>)

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

    +

    Returns void

    Readonlyexecute

    execute: ((data?: Data, name?: string, transferList?: readonly TransferListItem[]) => Promise<Response>)

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

    Type declaration

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

      • Parameters

        • Optionaldata: Data

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

        • Optionalname: string

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

        • OptionaltransferList: readonly TransferListItem[]

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

        Returns Promise<Response>

        Promise with a task function response that will be fulfilled when the task is completed.

        -

    ReadonlyhasTaskFunction

    hasTaskFunction: ((name: string) => boolean)

    Whether the specified task function exists in this pool.

    +

    ReadonlyhasTaskFunction

    hasTaskFunction: ((name: string) => boolean)

    Whether the specified task function exists in this pool.

    Type declaration

      • (name): boolean

      • Parameters

        • name: string

          The name of the task function.

        Returns boolean

        true if the task function exists, false otherwise.

        -

    Readonlyinfo

    info: PoolInfo

    Pool information.

    -

    ReadonlylistTaskFunctionsProperties

    listTaskFunctionsProperties: (() => TaskFunctionProperties[])

    Lists the properties of task functions available in this pool.

    +

    Readonlyinfo

    info: PoolInfo

    Pool information.

    +

    ReadonlylistTaskFunctionsProperties

    listTaskFunctionsProperties: (() => TaskFunctionProperties[])

    Lists the properties of task functions available in this pool.

    Type declaration

    ReadonlymapExecute

    mapExecute: ((data: Iterable<Data, any, any>, name?: string, transferList?: readonly TransferListItem[]) => Promise<Response[]>)

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

    +

    ReadonlymapExecute

    mapExecute: ((data: Iterable<Data, any, any>, name?: string, transferList?: readonly TransferListItem[]) => Promise<Response[]>)

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

    Type declaration

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

      • Parameters

        • data: Iterable<Data, any, any>

          The tasks iterable input data for the specified task function. This can only be an iterable of structured-cloneable data.

        • Optionalname: string

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

        • OptionaltransferList: readonly TransferListItem[]

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

        Returns Promise<Response[]>

        Promise with an array of task function responses that will be fulfilled when the tasks are completed.

        -

    ReadonlyremoveTaskFunction

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

    Removes a task function from this pool.

    +

    ReadonlyremoveTaskFunction

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

    Removes a task function from this pool.

    Type declaration

      • (name): Promise<boolean>

      • Parameters

        • name: string

          The name of the task function.

        Returns Promise<boolean>

        true if the task function was removed, false otherwise.

        -

    ReadonlysetDefaultTaskFunction

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

    Sets the default task function in this pool.

    +

    ReadonlysetDefaultTaskFunction

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

    Sets the default task function in this pool.

    Type declaration

      • (name): Promise<boolean>

      • Parameters

        • name: string

          The name of the task function.

        Returns Promise<boolean>

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

        -

    ReadonlysetTasksQueueOptions

    setTasksQueueOptions: ((tasksQueueOptions: TasksQueueOptions) => void)

    Sets the worker node tasks queue options in this pool.

    +

    ReadonlysetTasksQueueOptions

    setTasksQueueOptions: ((tasksQueueOptions: TasksQueueOptions) => void)

    Sets the worker node tasks queue options in this pool.

    Type declaration

      • (tasksQueueOptions): void

      • Parameters

        Returns void

    ReadonlysetWorkerChoiceStrategy

    setWorkerChoiceStrategy: ((workerChoiceStrategy:
        | "FAIR_SHARE"
        | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
        | "LEAST_BUSY"
        | "LEAST_ELU"
        | "LEAST_USED"
        | "ROUND_ROBIN"
        | "WEIGHTED_ROUND_ROBIN", workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions) => void)

    Sets the default worker choice strategy in this pool.

    +

    Returns void

    ReadonlysetWorkerChoiceStrategy

    setWorkerChoiceStrategy: ((workerChoiceStrategy:
        | "FAIR_SHARE"
        | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
        | "LEAST_BUSY"
        | "LEAST_ELU"
        | "LEAST_USED"
        | "ROUND_ROBIN"
        | "WEIGHTED_ROUND_ROBIN", workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions) => void)

    Sets the default worker choice strategy in this pool.

    Type declaration

      • (workerChoiceStrategy, workerChoiceStrategyOptions?): void

      • Parameters

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

          The default worker choice strategy.

        • OptionalworkerChoiceStrategyOptions: WorkerChoiceStrategyOptions

          The worker choice strategy options.

          -

        Returns void

    ReadonlysetWorkerChoiceStrategyOptions

    setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions: WorkerChoiceStrategyOptions) => boolean)

    Sets the worker choice strategy options in this pool.

    +

    Returns void

    ReadonlysetWorkerChoiceStrategyOptions

    setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions: WorkerChoiceStrategyOptions) => boolean)

    Sets the worker choice strategy options in this pool.

    Type declaration

      • (workerChoiceStrategyOptions): boolean

      • Parameters

        Returns boolean

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

        -

    Readonlystart

    start: (() => void)

    Starts the minimum number of workers in this pool.

    -

    Readonly InternalworkerNodes

    workerNodes: IWorkerNode<Worker, Data>[]

    Pool worker nodes.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Readonlystart

    start: (() => void)

    Starts the minimum number of workers in this pool.

    +

    Readonly InternalworkerNodes

    workerNodes: IWorkerNode<Worker, Data>[]

    Pool worker nodes.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/IWorker.html b/docs/interfaces/IWorker.html index 516ad607..41432fc9 100644 --- a/docs/interfaces/IWorker.html +++ b/docs/interfaces/IWorker.html @@ -1,5 +1,5 @@ -IWorker | poolifier - v4.4.3

    Interface IWorker

    Worker interface.

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

    Hierarchy

    • EventEmitter
      • IWorker

    Properties

    disconnect? +IWorker | poolifier - v4.4.4

    Interface IWorker

    Worker interface.

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

    Hierarchy

    • EventEmitter
      • IWorker

    Properties

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

    Properties

    Optional Readonlydisconnect

    disconnect?: (() => void)

    Cluster worker disconnect.

    -

    Optional Readonlyid

    id?: number

    Cluster worker id.

    -

    Optional Readonlykill

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

    Cluster worker kill.

    -

    Readonlyon

    on: ((event: string, handler: EventHandler<IWorker>) => this)

    Registers an event handler.

    +

    Optional Readonlyid

    id?: number

    Cluster worker id.

    +

    Optional Readonlykill

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

    Cluster worker kill.

    +

    Readonlyon

    on: ((event: string, handler: EventHandler<IWorker>) => this)

    Registers an event handler.

    Type declaration

      • (event, handler): this

      • Parameters

        Returns this

    Readonlyonce

    once: ((event: string, handler: EventHandler<IWorker>) => this)

    Registers once an event handler.

    +

    Returns this

    Readonlyonce

    once: ((event: string, handler: EventHandler<IWorker>) => this)

    Registers once an event handler.

    Type declaration

      • (event, handler): this

      • Parameters

        Returns this

    Optional Readonlyterminate

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

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

    Returns this

    Optional Readonlyterminate

    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.

    -

    Optional ReadonlythreadId

    threadId?: number

    Worker thread worker id.

    -

    Optional Readonlyunref

    unref?: (() => void)

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

    Optional ReadonlythreadId

    threadId?: number

    Worker thread worker id.

    +

    Optional Readonlyunref

    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.

    Since

    v10.5.0

    -

    Methods

    Optional[captureRejectionSymbol]

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

    • Type Parameters

      • K

      Parameters

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

      Returns void

    addListener

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

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

      +

    Methods

    Optional[captureRejectionSymbol]

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

    • Type Parameters

      • K

      Parameters

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

      Returns void

    addListener

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

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

      Type Parameters

      • K

      Parameters

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

          • Parameters

            • Rest...args: any[]

            Returns void

      Returns this

      Since

      v0.1.26

    emit

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

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

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

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

      Parameters

      • n: number

      Returns this

      Since

      v0.3.5

      -

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    diff --git a/docs/interfaces/IWorkerChoiceStrategy.html b/docs/interfaces/IWorkerChoiceStrategy.html index 47e64c85..7c12d98a 100644 --- a/docs/interfaces/IWorkerChoiceStrategy.html +++ b/docs/interfaces/IWorkerChoiceStrategy.html @@ -1,5 +1,5 @@ -IWorkerChoiceStrategy | poolifier - v4.4.3

    Interface IWorkerChoiceStrategyInternal

    Worker choice strategy interface.

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

    Properties

    choose +IWorkerChoiceStrategy | poolifier - v4.4.4

    Interface IWorkerChoiceStrategyInternal

    Worker choice strategy interface.

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

    Properties

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

    Type declaration

      • (): undefined | number

      • Returns undefined | number

        The worker node key or undefined.

        -

    Readonlyremove

    remove: ((workerNodeKey: number) => boolean)

    Removes the worker node key from strategy internals.

    +

    Readonlyremove

    remove: ((workerNodeKey: number) => boolean)

    Removes the worker node key from strategy internals.

    Type declaration

      • (workerNodeKey): boolean

      • Parameters

        • workerNodeKey: number

          The worker node key.

        Returns boolean

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

        -

    Readonlyreset

    reset: (() => boolean)

    Resets strategy internals.

    +

    Readonlyreset

    reset: (() => boolean)

    Resets strategy internals.

    Type declaration

      • (): boolean

      • Returns boolean

        true if the reset is successful, false otherwise.

        -

    ReadonlysetOptions

    setOptions: ((opts: undefined | WorkerChoiceStrategyOptions) => void)

    Sets the worker choice strategy options.

    +

    ReadonlysetOptions

    setOptions: ((opts: undefined | WorkerChoiceStrategyOptions) => void)

    Sets the worker choice strategy options.

    Type declaration

    ReadonlystrategyPolicy

    strategyPolicy: StrategyPolicy

    Strategy policy.

    -

    ReadonlytaskStatisticsRequirements

    taskStatisticsRequirements: TaskStatisticsRequirements

    Tasks statistics requirements.

    -

    Readonlyupdate

    update: ((workerNodeKey: number) => boolean)

    Updates the worker node key strategy internals. +

    Returns void

    ReadonlystrategyPolicy

    strategyPolicy: StrategyPolicy

    Strategy policy.

    +

    ReadonlytaskStatisticsRequirements

    taskStatisticsRequirements: TaskStatisticsRequirements

    Tasks statistics requirements.

    +

    Readonlyupdate

    update: ((workerNodeKey: number) => boolean)

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

    Type declaration

      • (workerNodeKey): boolean

      • Parameters

        • workerNodeKey: number

        Returns boolean

        true if the update is successful, false otherwise.

        -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/IWorkerNode.html b/docs/interfaces/IWorkerNode.html index 26ac5280..80dfe187 100644 --- a/docs/interfaces/IWorkerNode.html +++ b/docs/interfaces/IWorkerNode.html @@ -1,7 +1,7 @@ -IWorkerNode | poolifier - v4.4.3

    Interface IWorkerNode<Worker, Data>Internal

    Worker node interface.

    +IWorkerNode | poolifier - v4.4.4

    Interface IWorkerNode<Worker, Data>Internal

    Worker node interface.

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

    Type Parameters

    • Worker extends IWorker

      Type of worker.

    • Data = unknown

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

      -

    Hierarchy

    • EventEmitter
      • IWorkerNode

    Properties

    clearTasksQueue +

    Hierarchy

    • EventEmitter
      • IWorkerNode

    Properties

    clearTasksQueue deleteTaskFunctionWorkerUsage dequeueLastPrioritizedTask dequeueTask @@ -35,43 +35,43 @@ removeListener setMaxListeners

    Properties

    ReadonlyclearTasksQueue

    clearTasksQueue: (() => void)

    Clears tasks queue.

    -

    ReadonlydeleteTaskFunctionWorkerUsage

    deleteTaskFunctionWorkerUsage: ((name: string) => boolean)

    Deletes task function worker usage statistics.

    +

    ReadonlydeleteTaskFunctionWorkerUsage

    deleteTaskFunctionWorkerUsage: ((name: string) => boolean)

    Deletes task function worker usage statistics.

    Type declaration

      • (name): boolean

      • Parameters

        • name: string

          The task function name.

        Returns boolean

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

        -

    ReadonlydequeueLastPrioritizedTask

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

    Dequeue last prioritized task.

    +

    ReadonlydequeueLastPrioritizedTask

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

    Dequeue last prioritized task.

    Type declaration

    ReadonlydequeueTask

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

    Dequeue task.

    +

    ReadonlydequeueTask

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

    Dequeue task.

    Type declaration

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

      • Parameters

        • Optionalbucket: number

          The prioritized bucket to dequeue from.

        Returns undefined | Task<Data>

        The dequeued task.

    Default Value

    0
    -

    ReadonlyenqueueTask

    enqueueTask: ((task: Task<Data>) => number)

    Enqueue task.

    +

    ReadonlyenqueueTask

    enqueueTask: ((task: Task<Data>) => number)

    Enqueue task.

    Type declaration

      • (task): number

      • Parameters

        Returns number

        The tasks queue size.

        -

    ReadonlygetTaskFunctionWorkerUsage

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

    Gets task function worker usage statistics.

    +

    ReadonlygetTaskFunctionWorkerUsage

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

    Gets task function worker usage statistics.

    Type declaration

      • (name): undefined | WorkerUsage

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

        -

    Readonlyinfo

    info: WorkerInfo

    Worker info.

    -

    Optional ReadonlymessageChannel

    messageChannel?: MessageChannel

    Message channel (worker thread only).

    -

    ReadonlyregisterOnceWorkerEventHandler

    registerOnceWorkerEventHandler: ((event: string, handler: EventHandler<Worker>) => void)

    Registers once a worker event handler.

    +

    Readonlyinfo

    info: WorkerInfo

    Worker info.

    +

    Optional ReadonlymessageChannel

    messageChannel?: MessageChannel

    Message channel (worker thread only).

    +

    ReadonlyregisterOnceWorkerEventHandler

    registerOnceWorkerEventHandler: ((event: string, handler: EventHandler<Worker>) => void)

    Registers once a worker event handler.

    Type declaration

      • (event, handler): void

      • Parameters

        Returns void

    ReadonlyregisterWorkerEventHandler

    registerWorkerEventHandler: ((event: string, handler: EventHandler<Worker>) => void)

    Registers a worker event handler.

    +

    Returns void

    ReadonlyregisterWorkerEventHandler

    registerWorkerEventHandler: ((event: string, handler: EventHandler<Worker>) => void)

    Registers a worker event handler.

    Type declaration

      • (event, handler): void

      • Parameters

        Returns void

    ReadonlysetTasksQueuePriority

    setTasksQueuePriority: ((enablePriority: boolean) => void)

    Sets tasks queue priority.

    +

    Returns void

    ReadonlysetTasksQueuePriority

    setTasksQueuePriority: ((enablePriority: boolean) => void)

    Sets tasks queue priority.

    Type declaration

      • (enablePriority): void

      • Parameters

        • enablePriority: boolean

          Whether to enable tasks queue priority.

          -

        Returns void

    OptionalstrategyData

    strategyData?: StrategyData

    Worker choice strategy data. +

    Returns void

    OptionalstrategyData

    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.

    -

    ReadonlytasksQueueSize

    tasksQueueSize: (() => number)

    Tasks queue size.

    +

    ReadonlytasksQueueSize

    tasksQueueSize: (() => number)

    Tasks queue size.

    Type declaration

      • (): number

      • Returns number

        The tasks queue size.

        -

    Readonlyterminate

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

    Terminates the worker node.

    -

    Readonlyusage

    usage: WorkerUsage

    Worker usage statistics.

    -

    Readonlyworker

    worker: Worker

    Worker.

    -

    Methods

    Optional[captureRejectionSymbol]

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

    • Type Parameters

      • K

      Parameters

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

      Returns void

    addListener

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

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

      +

    Readonlyterminate

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

    Terminates the worker node.

    +

    Readonlyusage

    usage: WorkerUsage

    Worker usage statistics.

    +

    Readonlyworker

    worker: Worker

    Worker.

    +

    Methods

    Optional[captureRejectionSymbol]

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

    • Type Parameters

      • K

      Parameters

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

      Returns void

    addListener

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

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

      Type Parameters

      • K

      Parameters

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

          • Parameters

            • Rest...args: any[]

            Returns void

      Returns this

      Since

      v0.1.26

    emit

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

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

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

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

      Parameters

      • n: number

      Returns this

      Since

      v0.3.5

      -

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    diff --git a/docs/interfaces/MeasurementOptions.html b/docs/interfaces/MeasurementOptions.html index e49ab06f..d0d8104c 100644 --- a/docs/interfaces/MeasurementOptions.html +++ b/docs/interfaces/MeasurementOptions.html @@ -1,4 +1,4 @@ -MeasurementOptions | poolifier - v4.4.3

    Interface MeasurementOptions

    Measurement options.

    -
    interface MeasurementOptions {
        median: boolean;
    }

    Properties

    median +MeasurementOptions | poolifier - v4.4.4

    Interface MeasurementOptions

    Measurement options.

    +
    interface MeasurementOptions {
        median: boolean;
    }

    Properties

    median

    Properties

    Readonlymedian

    median: boolean

    Set measurement median.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/MeasurementStatistics.html b/docs/interfaces/MeasurementStatistics.html index bd34e934..af065ef6 100644 --- a/docs/interfaces/MeasurementStatistics.html +++ b/docs/interfaces/MeasurementStatistics.html @@ -1,14 +1,14 @@ -MeasurementStatistics | poolifier - v4.4.3

    Interface MeasurementStatisticsInternal

    Measurement statistics.

    -
    interface MeasurementStatistics {
        aggregate?: number;
        average?: number;
        history: CircularBuffer;
        maximum?: number;
        median?: number;
        minimum?: number;
    }

    Properties

    aggregate? +MeasurementStatistics | poolifier - v4.4.4

    Interface MeasurementStatisticsInternal

    Measurement statistics.

    +
    interface MeasurementStatistics {
        aggregate?: number;
        average?: number;
        history: CircularBuffer;
        maximum?: number;
        median?: number;
        minimum?: number;
    }

    Properties

    aggregate? average? history maximum? median? minimum?

    Properties

    Optionalaggregate

    aggregate?: number

    Measurement aggregate.

    -

    Optionalaverage

    average?: number

    Measurement average.

    -

    Readonlyhistory

    history: CircularBuffer

    Measurement history.

    -

    Optionalmaximum

    maximum?: number

    Measurement maximum.

    -

    Optionalmedian

    median?: number

    Measurement median.

    -

    Optionalminimum

    minimum?: number

    Measurement minimum.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Optionalaverage

    average?: number

    Measurement average.

    +

    Readonlyhistory

    history: CircularBuffer

    Measurement history.

    +

    Optionalmaximum

    maximum?: number

    Measurement maximum.

    +

    Optionalmedian

    median?: number

    Measurement median.

    +

    Optionalminimum

    minimum?: number

    Measurement minimum.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/MeasurementStatisticsRequirements.html b/docs/interfaces/MeasurementStatisticsRequirements.html index d5502a5c..05547bdf 100644 --- a/docs/interfaces/MeasurementStatisticsRequirements.html +++ b/docs/interfaces/MeasurementStatisticsRequirements.html @@ -1,8 +1,8 @@ -MeasurementStatisticsRequirements | poolifier - v4.4.3

    Interface MeasurementStatisticsRequirementsInternal

    Measurement statistics requirements.

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

    Properties

    aggregate +MeasurementStatisticsRequirements | poolifier - v4.4.4

    Interface MeasurementStatisticsRequirementsInternal

    Measurement statistics requirements.

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

    Properties

    aggregate average median

    Properties

    aggregate

    aggregate: boolean

    Requires measurement aggregate.

    -

    average

    average: boolean

    Requires measurement average.

    -

    median

    median: boolean

    Requires measurement median.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    average

    average: boolean

    Requires measurement average.

    +

    median

    median: boolean

    Requires measurement median.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/MessageValue.html b/docs/interfaces/MessageValue.html index 3ac9be9f..7707667d 100644 --- a/docs/interfaces/MessageValue.html +++ b/docs/interfaces/MessageValue.html @@ -1,7 +1,7 @@ -MessageValue | poolifier - v4.4.3

    Interface MessageValue<Data, ErrorData>Internal

    Message object that is passed between main worker and worker.

    +MessageValue | poolifier - v4.4.4

    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"
            | "HARD"
            | "SOFT"
            | "failure";
        name?: string;
        port?: MessagePort;
        priority?: number;
        ready?: boolean;
        statistics?: WorkerStatistics;
        strategy?:
            | "FAIR_SHARE"
            | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
            | "LEAST_BUSY"
            | "LEAST_ELU"
            | "LEAST_USED"
            | "ROUND_ROBIN"
            | "WEIGHTED_ROUND_ROBIN";
        taskFunction?: string;
        taskFunctionOperation?: "add" | "default" | "remove";
        taskFunctionOperationStatus?: boolean;
        taskFunctionProperties?: TaskFunctionProperties;
        taskFunctionsProperties?: TaskFunctionProperties[];
        taskId?: `${string}-${string}-${string}-${string}-${string}`;
        taskPerformance?: TaskPerformance;
        timestamp?: number;
        transferList?: readonly TransferListItem[];
        workerError?: WorkerError<ErrorData>;
        workerId?: number;
    }

    Type Parameters

    • Data = unknown

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

    • ErrorData = unknown

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

      -

    Hierarchy (view full)

    Properties

    checkActive? +

    Hierarchy (view full)

    Properties

    checkActive? data? kill? name? @@ -22,31 +22,31 @@ workerError? workerId?

    Properties

    Optional ReadonlycheckActive

    checkActive?: boolean

    Whether the worker starts or stops its activity check.

    -

    Optional Readonlydata

    data?: Data

    Task input data that will be passed to the worker.

    -

    Optional Readonlykill

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

    Kill code.

    -

    Optional Readonlyname

    name?: string

    Task name.

    -

    Optional Readonlyport

    port?: MessagePort

    Message port.

    -

    Optional Readonlypriority

    priority?: number

    Task priority. Lower values have higher priority.

    +

    Optional Readonlydata

    data?: Data

    Task input data that will be passed to the worker.

    +

    Optional Readonlykill

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

    Kill code.

    +

    Optional Readonlyname

    name?: string

    Task name.

    +

    Optional Readonlyport

    port?: MessagePort

    Message port.

    +

    Optional Readonlypriority

    priority?: number

    Task priority. Lower values have higher priority.

    Default Value

    0
    -

    Optional Readonlyready

    ready?: boolean

    Whether the worker is ready or not.

    -

    Optional Readonlystatistics

    statistics?: WorkerStatistics

    Whether the worker computes the given statistics or not.

    -

    Optional Readonlystrategy

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

    Task worker choice strategy.

    -

    Optional ReadonlytaskFunction

    taskFunction?: string

    Task function serialized to string.

    -

    Optional ReadonlytaskFunctionOperation

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

    Task function operation:

    +

    Optional Readonlyready

    ready?: boolean

    Whether the worker is ready or not.

    +

    Optional Readonlystatistics

    statistics?: WorkerStatistics

    Whether the worker computes the given statistics or not.

    +

    Optional Readonlystrategy

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

    Task worker choice strategy.

    +

    Optional ReadonlytaskFunction

    taskFunction?: string

    Task function serialized to string.

    +

    Optional ReadonlytaskFunctionOperation

    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 ReadonlytaskFunctionOperationStatus

    taskFunctionOperationStatus?: boolean

    Whether the task function operation is successful or not.

    -

    Optional ReadonlytaskFunctionProperties

    taskFunctionProperties?: TaskFunctionProperties

    Task function properties.

    -

    Optional ReadonlytaskFunctionsProperties

    taskFunctionsProperties?: TaskFunctionProperties[]

    Task functions properties.

    -

    Optional ReadonlytaskId

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

    Task UUID.

    -

    Optional ReadonlytaskPerformance

    taskPerformance?: TaskPerformance

    Task performance.

    -

    Optional Readonlytimestamp

    timestamp?: number

    Timestamp.

    -

    Optional ReadonlytransferList

    transferList?: readonly TransferListItem[]

    Array of transferable objects.

    -

    Optional ReadonlyworkerError

    workerError?: WorkerError<ErrorData>

    Worker error.

    -

    Optional ReadonlyworkerId

    workerId?: number

    Worker id.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Optional ReadonlytaskFunctionOperationStatus

    taskFunctionOperationStatus?: boolean

    Whether the task function operation is successful or not.

    +

    Optional ReadonlytaskFunctionProperties

    taskFunctionProperties?: TaskFunctionProperties

    Task function properties.

    +

    Optional ReadonlytaskFunctionsProperties

    taskFunctionsProperties?: TaskFunctionProperties[]

    Task functions properties.

    +

    Optional ReadonlytaskId

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

    Task UUID.

    +

    Optional ReadonlytaskPerformance

    taskPerformance?: TaskPerformance

    Task performance.

    +

    Optional Readonlytimestamp

    timestamp?: number

    Timestamp.

    +

    Optional ReadonlytransferList

    transferList?: readonly TransferListItem[]

    Array of transferable objects.

    +

    Optional ReadonlyworkerError

    workerError?: WorkerError<ErrorData>

    Worker error.

    +

    Optional ReadonlyworkerId

    workerId?: number

    Worker id.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/PoolInfo.html b/docs/interfaces/PoolInfo.html index 9ead6d2e..23db13c0 100644 --- a/docs/interfaces/PoolInfo.html +++ b/docs/interfaces/PoolInfo.html @@ -1,5 +1,5 @@ -PoolInfo | poolifier - v4.4.3

    Interface PoolInfo

    Pool information.

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

    Properties

    backPressure? +PoolInfo | poolifier - v4.4.4

    Interface PoolInfo

    Pool information.

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

    Properties

    backPressure? backPressureWorkerNodes? busyWorkerNodes defaultStrategy @@ -25,11 +25,11 @@ waitTime? worker workerNodes -

    Properties

    Optional ReadonlybackPressure

    backPressure?: boolean

    Optional ReadonlybackPressureWorkerNodes

    backPressureWorkerNodes?: number

    Pool tasks back pressure worker nodes.

    -

    ReadonlybusyWorkerNodes

    busyWorkerNodes: number

    Pool busy worker nodes.

    -

    ReadonlydefaultStrategy

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

    Optional ReadonlydynamicWorkerNodes

    dynamicWorkerNodes?: number

    Pool dynamic worker nodes.

    -

    Optional Readonlyelu

    elu?: {
        active: {
            average?: number;
            maximum: number;
            median?: number;
            minimum: number;
        };
        idle: {
            average?: number;
            maximum: number;
            median?: number;
            minimum: number;
        };
        utilization: {
            average?: number;
            median?: number;
        };
    }

    ReadonlyexecutedTasks

    executedTasks: number

    ReadonlyexecutingTasks

    executingTasks: number

    ReadonlyfailedTasks

    failedTasks: number

    ReadonlyidleWorkerNodes

    idleWorkerNodes: number

    Pool idle worker nodes.

    -

    Optional ReadonlymaxQueuedTasks

    maxQueuedTasks?: number

    ReadonlymaxSize

    maxSize: number

    ReadonlyminSize

    minSize: number

    Optional ReadonlyqueuedTasks

    queuedTasks?: number

    Readonlyready

    ready: boolean

    Optional ReadonlyrunTime

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

    Readonlystarted

    started: boolean

    Optional ReadonlystealingWorkerNodes

    stealingWorkerNodes?: number

    Pool tasks stealing worker nodes.

    -

    Optional ReadonlystolenTasks

    stolenTasks?: number

    ReadonlystrategyRetries

    strategyRetries: number

    Readonlytype

    type: "fixed" | "dynamic"

    Optional Readonlyutilization

    utilization?: number

    Pool utilization.

    -

    Readonlyversion

    version: string

    Optional ReadonlywaitTime

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

    Readonlyworker

    worker: "cluster" | "thread"

    ReadonlyworkerNodes

    workerNodes: number

    Pool total worker nodes.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optional ReadonlybackPressure

    backPressure?: boolean

    Optional ReadonlybackPressureWorkerNodes

    backPressureWorkerNodes?: number

    Pool tasks back pressure worker nodes.

    +

    ReadonlybusyWorkerNodes

    busyWorkerNodes: number

    Pool busy worker nodes.

    +

    ReadonlydefaultStrategy

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

    Optional ReadonlydynamicWorkerNodes

    dynamicWorkerNodes?: number

    Pool dynamic worker nodes.

    +

    Optional Readonlyelu

    elu?: {
        active: {
            average?: number;
            maximum: number;
            median?: number;
            minimum: number;
        };
        idle: {
            average?: number;
            maximum: number;
            median?: number;
            minimum: number;
        };
        utilization: {
            average?: number;
            median?: number;
        };
    }

    ReadonlyexecutedTasks

    executedTasks: number

    ReadonlyexecutingTasks

    executingTasks: number

    ReadonlyfailedTasks

    failedTasks: number

    ReadonlyidleWorkerNodes

    idleWorkerNodes: number

    Pool idle worker nodes.

    +

    Optional ReadonlymaxQueuedTasks

    maxQueuedTasks?: number

    ReadonlymaxSize

    maxSize: number

    ReadonlyminSize

    minSize: number

    Optional ReadonlyqueuedTasks

    queuedTasks?: number

    Readonlyready

    ready: boolean

    Optional ReadonlyrunTime

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

    Readonlystarted

    started: boolean

    Optional ReadonlystealingWorkerNodes

    stealingWorkerNodes?: number

    Pool tasks stealing worker nodes.

    +

    Optional ReadonlystolenTasks

    stolenTasks?: number

    ReadonlystrategyRetries

    strategyRetries: number

    Readonlytype

    type: "fixed" | "dynamic"

    Optional Readonlyutilization

    utilization?: number

    Pool utilization.

    +

    Readonlyversion

    version: string

    Optional ReadonlywaitTime

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

    Readonlyworker

    worker: "cluster" | "thread"

    ReadonlyworkerNodes

    workerNodes: number

    Pool total worker nodes.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/PoolOptions.html b/docs/interfaces/PoolOptions.html index eef9b1f7..b212c1e1 100644 --- a/docs/interfaces/PoolOptions.html +++ b/docs/interfaces/PoolOptions.html @@ -1,6 +1,6 @@ -PoolOptions | poolifier - v4.4.3

    Interface PoolOptions<Worker>

    Options for a poolifier pool.

    +PoolOptions | poolifier - v4.4.4

    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?:
            | "FAIR_SHARE"
            | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
            | "LEAST_BUSY"
            | "LEAST_ELU"
            | "LEAST_USED"
            | "ROUND_ROBIN"
            | "WEIGHTED_ROUND_ROBIN";
        workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions;
        workerOptions?: WorkerOptions;
    }

    Type Parameters

    • Worker extends IWorker

      Type of worker.

      -

    Properties

    enableEvents? +

    Properties

    enableEvents? enableTasksQueue? env? errorHandler? @@ -18,33 +18,33 @@

    Default Value

    true
    -

    OptionalenableTasksQueue

    enableTasksQueue?: boolean

    Pool worker node tasks queue.

    +

    OptionalenableTasksQueue

    enableTasksQueue?: boolean

    Pool worker node tasks queue.

    Default Value

    false
    -

    Optionalenv

    env?: Record<string, unknown>

    Key/value pairs to add to worker process environment.

    +

    Optionalenv

    env?: Record<string, unknown>

    Key/value pairs to add to worker process environment.

    See

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

    -

    OptionalerrorHandler

    errorHandler?: ErrorHandler<Worker>

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

    +

    OptionalerrorHandler

    errorHandler?: ErrorHandler<Worker>

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

    Default Value

    () => {}

    -

    OptionalexitHandler

    exitHandler?: ExitHandler<Worker>

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

    +

    OptionalexitHandler

    exitHandler?: ExitHandler<Worker>

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

    Default Value

    () => {}

    -

    OptionalmessageHandler

    messageHandler?: MessageHandler<Worker>

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

    +

    OptionalmessageHandler

    messageHandler?: MessageHandler<Worker>

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

    Default Value

    () => {}

    -

    OptionalonlineHandler

    onlineHandler?: OnlineHandler<Worker>

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

    +

    OptionalonlineHandler

    onlineHandler?: OnlineHandler<Worker>

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

    Default Value

    () => {}

    -

    OptionalrestartWorkerOnError

    restartWorkerOnError?: boolean

    Restart worker on error.

    -

    Optionalsettings

    settings?: ClusterSettings

    Cluster settings.

    +

    OptionalrestartWorkerOnError

    restartWorkerOnError?: boolean

    Restart worker on error.

    +

    Optionalsettings

    settings?: ClusterSettings

    Cluster settings.

    See

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

    -

    OptionalstartWorkers

    startWorkers?: boolean

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

    +

    OptionalstartWorkers

    startWorkers?: boolean

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

    Default Value

    true
    -

    OptionaltasksQueueOptions

    tasksQueueOptions?: TasksQueueOptions

    Pool worker node tasks queue options.

    -

    OptionalworkerChoiceStrategy

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

    The default worker choice strategy to use in this pool.

    +

    OptionaltasksQueueOptions

    tasksQueueOptions?: TasksQueueOptions

    Pool worker node tasks queue options.

    +

    OptionalworkerChoiceStrategy

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

    The default worker choice strategy to use in this pool.

    Default Value

    WorkerChoiceStrategies.ROUND_ROBIN
    -

    OptionalworkerChoiceStrategyOptions

    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions

    The worker choice strategy options.

    -

    OptionalworkerOptions

    workerOptions?: WorkerOptions

    Worker options.

    +

    OptionalworkerChoiceStrategyOptions

    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions

    The worker choice strategy options.

    +

    OptionalworkerOptions

    workerOptions?: WorkerOptions

    Worker options.

    See

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

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/PromiseResponseWrapper.html b/docs/interfaces/PromiseResponseWrapper.html index 7afde73a..90e4bfa7 100644 --- a/docs/interfaces/PromiseResponseWrapper.html +++ b/docs/interfaces/PromiseResponseWrapper.html @@ -1,11 +1,11 @@ -PromiseResponseWrapper | poolifier - v4.4.3

    Interface PromiseResponseWrapper<Response>Internal

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

    +PromiseResponseWrapper | poolifier - v4.4.4

    Interface PromiseResponseWrapper<Response>Internal

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

    interface PromiseResponseWrapper<Response> {
        asyncResource?: AsyncResource;
        reject: ((reason?: unknown) => void);
        resolve: ((value: Response | PromiseLike<Response>) => 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 ReadonlyasyncResource

    asyncResource?: AsyncResource

    The asynchronous resource used to track the task execution.

    -

    Readonlyreject

    reject: ((reason?: unknown) => void)

    Reject callback to reject the promise.

    -

    Readonlyresolve

    resolve: ((value: Response | PromiseLike<Response>) => void)

    Resolve callback to fulfill the promise.

    -

    ReadonlyworkerNodeKey

    workerNodeKey: number

    The worker node key executing the task.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Readonlyreject

    reject: ((reason?: unknown) => void)

    Reject callback to reject the promise.

    +

    Readonlyresolve

    resolve: ((value: Response | PromiseLike<Response>) => void)

    Resolve callback to fulfill the promise.

    +

    ReadonlyworkerNodeKey

    workerNodeKey: number

    The worker node key executing the task.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/StrategyData.html b/docs/interfaces/StrategyData.html index e4aa7dce..4c852496 100644 --- a/docs/interfaces/StrategyData.html +++ b/docs/interfaces/StrategyData.html @@ -1,3 +1,3 @@ -StrategyData | poolifier - v4.4.3

    Interface StrategyDataInternal

    Worker choice strategy data.

    -
    interface StrategyData {
        virtualTaskEndTimestamp?: number;
    }

    Properties

    virtualTaskEndTimestamp? -

    Properties

    OptionalvirtualTaskEndTimestamp

    virtualTaskEndTimestamp?: number

    Settings

    Member Visibility

    On This Page

    Properties
    +StrategyData | poolifier - v4.4.4

    Interface StrategyDataInternal

    Worker choice strategy data.

    +
    interface StrategyData {
        virtualTaskEndTimestamp?: number;
    }

    Properties

    virtualTaskEndTimestamp? +

    Properties

    OptionalvirtualTaskEndTimestamp

    virtualTaskEndTimestamp?: number

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/StrategyPolicy.html b/docs/interfaces/StrategyPolicy.html index 2290344e..d48a889b 100644 --- a/docs/interfaces/StrategyPolicy.html +++ b/docs/interfaces/StrategyPolicy.html @@ -1,6 +1,6 @@ -StrategyPolicy | poolifier - v4.4.3

    Interface StrategyPolicyInternal

    Strategy policy.

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

    Properties

    dynamicWorkerReady +StrategyPolicy | poolifier - v4.4.4

    Interface StrategyPolicyInternal

    Strategy policy.

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

    Properties

    dynamicWorkerReady dynamicWorkerUsage

    Properties

    ReadonlydynamicWorkerReady

    dynamicWorkerReady: boolean

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

    -

    ReadonlydynamicWorkerUsage

    dynamicWorkerUsage: boolean

    Expects tasks execution on the newly created dynamic worker.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    ReadonlydynamicWorkerUsage

    dynamicWorkerUsage: boolean

    Expects tasks execution on the newly created dynamic worker.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/Task.html b/docs/interfaces/Task.html index 5c8430b3..208f6225 100644 --- a/docs/interfaces/Task.html +++ b/docs/interfaces/Task.html @@ -1,6 +1,6 @@ -Task | poolifier - v4.4.3

    Interface Task<Data>Internal

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

    +Task | poolifier - v4.4.4

    Interface Task<Data>Internal

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

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

    Type Parameters

    • Data = unknown

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

      -

    Hierarchy (view full)

    Properties

    data? +

    Hierarchy (view full)

    Properties

    data? name? priority? strategy? @@ -8,13 +8,13 @@ timestamp? transferList?

    Properties

    Optional Readonlydata

    data?: Data

    Task input data that will be passed to the worker.

    -

    Optional Readonlyname

    name?: string

    Task name.

    -

    Optional Readonlypriority

    priority?: number

    Task priority. Lower values have higher priority.

    +

    Optional Readonlyname

    name?: string

    Task name.

    +

    Optional Readonlypriority

    priority?: number

    Task priority. Lower values have higher priority.

    Default Value

    0
    -

    Optional Readonlystrategy

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

    Task worker choice strategy.

    -

    Optional ReadonlytaskId

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

    Task UUID.

    -

    Optional Readonlytimestamp

    timestamp?: number

    Timestamp.

    -

    Optional ReadonlytransferList

    transferList?: readonly TransferListItem[]

    Array of transferable objects.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Optional Readonlystrategy

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

    Task worker choice strategy.

    +

    Optional ReadonlytaskId

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

    Task UUID.

    +

    Optional Readonlytimestamp

    timestamp?: number

    Timestamp.

    +

    Optional ReadonlytransferList

    transferList?: readonly TransferListItem[]

    Array of transferable objects.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/TaskFunctionObject.html b/docs/interfaces/TaskFunctionObject.html index 759dfc4f..ed109501 100644 --- a/docs/interfaces/TaskFunctionObject.html +++ b/docs/interfaces/TaskFunctionObject.html @@ -1,10 +1,10 @@ -TaskFunctionObject | poolifier - v4.4.3

    Interface TaskFunctionObject<Data, Response>

    Task function object.

    +TaskFunctionObject | poolifier - v4.4.4

    Interface TaskFunctionObject<Data, Response>

    Task function object.

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

    Type Parameters

    • Data = unknown

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

    • Response = unknown

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

      -

    Properties

    priority? +

    Properties

    priority? strategy? taskFunction

    Properties

    Optionalpriority

    priority?: number

    Task function priority. Lower values have higher priority.

    -

    Optionalstrategy

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

    Task function worker choice strategy.

    -

    taskFunction

    taskFunction: TaskFunction<Data, Response>

    Task function.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Optionalstrategy

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

    Task function worker choice strategy.

    +

    taskFunction

    taskFunction: TaskFunction<Data, Response>

    Task function.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/TaskFunctionOperationResult.html b/docs/interfaces/TaskFunctionOperationResult.html index c4498e16..182a5c81 100644 --- a/docs/interfaces/TaskFunctionOperationResult.html +++ b/docs/interfaces/TaskFunctionOperationResult.html @@ -1,4 +1,4 @@ -TaskFunctionOperationResult | poolifier - v4.4.3

    Interface TaskFunctionOperationResult

    Task function operation result.

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

    Properties

    error? +TaskFunctionOperationResult | poolifier - v4.4.4

    Interface TaskFunctionOperationResult

    Task function operation result.

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

    Properties

    error? status -

    Properties

    Optionalerror

    error?: Error

    status

    status: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalerror

    error?: Error

    status

    status: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/TaskFunctionProperties.html b/docs/interfaces/TaskFunctionProperties.html index 44932bbb..77000a93 100644 --- a/docs/interfaces/TaskFunctionProperties.html +++ b/docs/interfaces/TaskFunctionProperties.html @@ -1,8 +1,8 @@ -TaskFunctionProperties | poolifier - v4.4.3

    Interface TaskFunctionProperties

    Task function properties.

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

    Properties

    name +TaskFunctionProperties | poolifier - v4.4.4

    Interface TaskFunctionProperties

    Task function properties.

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

    Properties

    name priority? strategy?

    Properties

    Readonlyname

    name: string

    Task function name.

    -

    Optional Readonlypriority

    priority?: number

    Task function priority. Lower values have higher priority.

    -

    Optional Readonlystrategy

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

    Task function worker choice strategy.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Optional Readonlypriority

    priority?: number

    Task function priority. Lower values have higher priority.

    +

    Optional Readonlystrategy

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

    Task function worker choice strategy.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/TaskPerformance.html b/docs/interfaces/TaskPerformance.html index 06f10df4..fb636fb6 100644 --- a/docs/interfaces/TaskPerformance.html +++ b/docs/interfaces/TaskPerformance.html @@ -1,10 +1,10 @@ -TaskPerformance | poolifier - v4.4.3

    Interface TaskPerformanceInternal

    Task performance.

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

    Properties

    elu? +TaskPerformance | poolifier - v4.4.4

    Interface TaskPerformanceInternal

    Task performance.

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

    Properties

    elu? name runTime? timestamp

    Properties

    Optional Readonlyelu

    elu?: EventLoopUtilization

    Task event loop utilization.

    -

    Readonlyname

    name: string

    Task name.

    -

    Optional ReadonlyrunTime

    runTime?: number

    Task runtime.

    -

    Readonlytimestamp

    timestamp: number

    Task performance timestamp.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Readonlyname

    name: string

    Task name.

    +

    Optional ReadonlyrunTime

    runTime?: number

    Task runtime.

    +

    Readonlytimestamp

    timestamp: number

    Task performance timestamp.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/TaskStatistics.html b/docs/interfaces/TaskStatistics.html index 327cdd09..3c11323f 100644 --- a/docs/interfaces/TaskStatistics.html +++ b/docs/interfaces/TaskStatistics.html @@ -1,5 +1,5 @@ -TaskStatistics | poolifier - v4.4.3

    Interface TaskStatisticsInternal

    Task statistics.

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

    Properties

    executed +TaskStatistics | poolifier - v4.4.4

    Interface TaskStatisticsInternal

    Task statistics.

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

    Properties

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

    Properties

    executed

    executed: number

    Number of executed tasks.

    -

    executing

    executing: number

    Number of executing tasks.

    -

    failed

    failed: number

    Number of failed tasks.

    -

    Optional ReadonlymaxQueued

    maxQueued?: number

    Maximum number of queued tasks.

    -

    Readonlyqueued

    queued: number

    Number of queued tasks.

    -

    sequentiallyStolen

    sequentiallyStolen: number

    Number of sequentially stolen tasks.

    -

    stolen

    stolen: number

    Number of stolen tasks.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    executing

    executing: number

    Number of executing tasks.

    +

    failed

    failed: number

    Number of failed tasks.

    +

    Optional ReadonlymaxQueued

    maxQueued?: number

    Maximum number of queued tasks.

    +

    Readonlyqueued

    queued: number

    Number of queued tasks.

    +

    sequentiallyStolen

    sequentiallyStolen: number

    Number of sequentially stolen tasks.

    +

    stolen

    stolen: number

    Number of stolen tasks.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/TaskStatisticsRequirements.html b/docs/interfaces/TaskStatisticsRequirements.html index db59dac0..538920c4 100644 --- a/docs/interfaces/TaskStatisticsRequirements.html +++ b/docs/interfaces/TaskStatisticsRequirements.html @@ -1,8 +1,8 @@ -TaskStatisticsRequirements | poolifier - v4.4.3

    Interface TaskStatisticsRequirementsInternal

    Pool worker node worker usage statistics requirements.

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

    Properties

    elu +TaskStatisticsRequirements | poolifier - v4.4.4

    Interface TaskStatisticsRequirementsInternal

    Pool worker node worker usage statistics requirements.

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

    Properties

    elu runTime waitTime

    Properties

    Readonlyelu

    elu: MeasurementStatisticsRequirements

    Tasks event loop utilization requirements.

    -

    ReadonlyrunTime

    runTime: MeasurementStatisticsRequirements

    Tasks runtime requirements.

    -

    ReadonlywaitTime

    waitTime: MeasurementStatisticsRequirements

    Tasks wait time requirements.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    ReadonlyrunTime

    runTime: MeasurementStatisticsRequirements

    Tasks runtime requirements.

    +

    ReadonlywaitTime

    waitTime: MeasurementStatisticsRequirements

    Tasks wait time requirements.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/TasksQueueOptions.html b/docs/interfaces/TasksQueueOptions.html index 6f90dcd2..8837ea14 100644 --- a/docs/interfaces/TasksQueueOptions.html +++ b/docs/interfaces/TasksQueueOptions.html @@ -1,5 +1,5 @@ -TasksQueueOptions | poolifier - v4.4.3

    Interface TasksQueueOptions

    Worker node tasks queue options.

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

    Properties

    concurrency? +TasksQueueOptions | poolifier - v4.4.4

    Interface TasksQueueOptions

    Worker node tasks queue options.

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

    Properties

    concurrency? size? tasksFinishedTimeout? tasksStealingOnBackPressure? @@ -9,24 +9,24 @@

    Default Value

    1
    -

    Optional Readonlysize

    size?: number

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

    +

    Optional Readonlysize

    size?: number

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

    Default Value

    (pool maximum size)^2
    -

    Optional ReadonlytasksFinishedTimeout

    tasksFinishedTimeout?: number

    Queued tasks finished timeout in milliseconds at worker node termination.

    +

    Optional ReadonlytasksFinishedTimeout

    tasksFinishedTimeout?: number

    Queued tasks finished timeout in milliseconds at worker node termination.

    Default Value

    2000
    -

    Optional ReadonlytasksStealingOnBackPressure

    tasksStealingOnBackPressure?: boolean

    Whether to enable tasks stealing under back pressure.

    +

    Optional ReadonlytasksStealingOnBackPressure

    tasksStealingOnBackPressure?: boolean

    Whether to enable tasks stealing under back pressure.

    Default Value

    true
    -

    Optional ReadonlytasksStealingRatio

    tasksStealingRatio?: number

    Ratio of worker nodes that can steal tasks from another worker node.

    +

    Optional ReadonlytasksStealingRatio

    tasksStealingRatio?: number

    Ratio of worker nodes that can steal tasks from another worker node.

    Default Value

    0.6
    -

    Optional ReadonlytaskStealing

    taskStealing?: boolean

    Whether to enable task stealing on idle.

    +

    Optional ReadonlytaskStealing

    taskStealing?: boolean

    Whether to enable task stealing on idle.

    Default Value

    true
    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/WorkerChoiceStrategyOptions.html b/docs/interfaces/WorkerChoiceStrategyOptions.html index 1aca262c..96d6310f 100644 --- a/docs/interfaces/WorkerChoiceStrategyOptions.html +++ b/docs/interfaces/WorkerChoiceStrategyOptions.html @@ -1,5 +1,5 @@ -WorkerChoiceStrategyOptions | poolifier - v4.4.3

    Interface WorkerChoiceStrategyOptions

    Worker choice strategy options.

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

    Properties

    elu? +WorkerChoiceStrategyOptions | poolifier - v4.4.4

    Interface WorkerChoiceStrategyOptions

    Worker choice strategy options.

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

    Properties

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

    Default Value

    { median: false }
    -

    Optional Readonlymeasurement

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

    Measurement to use in worker choice strategy supporting it.

    -

    Optional ReadonlyrunTime

    runTime?: MeasurementOptions

    Runtime options.

    +

    Optional Readonlymeasurement

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

    Measurement to use in worker choice strategy supporting it.

    +

    Optional ReadonlyrunTime

    runTime?: MeasurementOptions

    Runtime options.

    Default Value

    { median: false }
    -

    Optional ReadonlywaitTime

    waitTime?: MeasurementOptions

    Wait time options.

    +

    Optional ReadonlywaitTime

    waitTime?: MeasurementOptions

    Wait time options.

    Default Value

    { median: false }
    -

    Optionalweights

    weights?: Record<number, number>

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

    Optionalweights

    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

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/WorkerError.html b/docs/interfaces/WorkerError.html index 9c29e456..721b0edb 100644 --- a/docs/interfaces/WorkerError.html +++ b/docs/interfaces/WorkerError.html @@ -1,13 +1,13 @@ -WorkerError | poolifier - v4.4.3

    Interface WorkerError<Data>

    Worker error.

    +WorkerError | poolifier - v4.4.4

    Interface WorkerError<Data>

    Worker error.

    interface WorkerError<Data> {
        data?: Data;
        error?: Error;
        message: string;
        name?: string;
        stack?: 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? error? message name? stack?

    Properties

    Optional Readonlydata

    data?: Data

    Data triggering the error.

    -

    Optional Readonlyerror

    error?: Error

    Error object.

    -

    Readonlymessage

    message: string

    Error message.

    -

    Optional Readonlyname

    name?: string

    Task function name triggering the error.

    -

    Optional Readonlystack

    stack?: string

    Error stack trace.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Optional Readonlyerror

    error?: Error

    Error object.

    +

    Readonlymessage

    message: string

    Error message.

    +

    Optional Readonlyname

    name?: string

    Task function name triggering the error.

    +

    Optional Readonlystack

    stack?: string

    Error stack trace.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/WorkerInfo.html b/docs/interfaces/WorkerInfo.html index c0ff8cb3..859c3de3 100644 --- a/docs/interfaces/WorkerInfo.html +++ b/docs/interfaces/WorkerInfo.html @@ -1,5 +1,5 @@ -WorkerInfo | poolifier - v4.4.3

    Interface WorkerInfoInternal

    Worker information.

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

    Properties

    backPressure +WorkerInfo | poolifier - v4.4.4

    Interface WorkerInfoInternal

    Worker information.

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

    Properties

    backPressure backPressureStealing continuousStealing dynamic @@ -11,17 +11,17 @@ type

    Properties

    backPressure

    backPressure: boolean

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

    -

    backPressureStealing

    backPressureStealing: boolean

    Back pressure stealing flag. +

    backPressureStealing

    backPressureStealing: boolean

    Back pressure stealing flag. This flag is set to true when worker node is stealing one task from another back pressured worker node.

    -

    continuousStealing

    continuousStealing: boolean

    Continuous stealing flag. +

    continuousStealing

    continuousStealing: boolean

    Continuous stealing flag. This flag is set to true when worker node is continuously stealing tasks from other worker nodes.

    -

    dynamic

    dynamic: boolean

    Dynamic flag.

    -

    Readonlyid

    id: undefined | number

    Worker id.

    -

    ready

    ready: boolean

    Ready flag.

    -

    stealing

    stealing: boolean

    Stealing flag. +

    dynamic

    dynamic: boolean

    Dynamic flag.

    +

    Readonlyid

    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 one task from another worker node.

    -

    stolen

    stolen: boolean

    Stolen flag. +

    stolen

    stolen: boolean

    Stolen flag. This flag is set to true when worker node has one task stolen from another worker node.

    -

    OptionaltaskFunctionsProperties

    taskFunctionsProperties?: TaskFunctionProperties[]

    Task functions properties.

    -

    Readonlytype

    type: "cluster" | "thread"

    Worker type.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    OptionaltaskFunctionsProperties

    taskFunctionsProperties?: TaskFunctionProperties[]

    Task functions properties.

    +

    Readonlytype

    type: "cluster" | "thread"

    Worker type.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/WorkerNodeEventDetail.html b/docs/interfaces/WorkerNodeEventDetail.html index 8d012e7c..2cc36959 100644 --- a/docs/interfaces/WorkerNodeEventDetail.html +++ b/docs/interfaces/WorkerNodeEventDetail.html @@ -1,4 +1,4 @@ -WorkerNodeEventDetail | poolifier - v4.4.3

    Interface WorkerNodeEventDetailInternal

    Worker node event detail.

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

    Properties

    workerId? +WorkerNodeEventDetail | poolifier - v4.4.4

    Interface WorkerNodeEventDetailInternal

    Worker node event detail.

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

    Properties

    workerId? workerNodeKey? -

    Properties

    OptionalworkerId

    workerId?: number

    OptionalworkerNodeKey

    workerNodeKey?: number

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    OptionalworkerId

    workerId?: number

    OptionalworkerNodeKey

    workerNodeKey?: number

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/WorkerNodeOptions.html b/docs/interfaces/WorkerNodeOptions.html index 7f39c4b7..4ccb6b11 100644 --- a/docs/interfaces/WorkerNodeOptions.html +++ b/docs/interfaces/WorkerNodeOptions.html @@ -1,7 +1,7 @@ -WorkerNodeOptions | poolifier - v4.4.3

    Interface WorkerNodeOptionsInternal

    Worker node options.

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

    Properties

    env? +WorkerNodeOptions | poolifier - v4.4.4

    Interface WorkerNodeOptionsInternal

    Worker node options.

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

    Properties

    env? tasksQueueBackPressureSize tasksQueueBucketSize tasksQueuePriority workerOptions? -

    Properties

    Optionalenv

    env?: Record<string, unknown>

    tasksQueueBackPressureSize

    tasksQueueBackPressureSize: undefined | number

    tasksQueueBucketSize

    tasksQueueBucketSize: undefined | number

    tasksQueuePriority

    tasksQueuePriority: undefined | boolean

    OptionalworkerOptions

    workerOptions?: WorkerOptions

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalenv

    env?: Record<string, unknown>

    tasksQueueBackPressureSize

    tasksQueueBackPressureSize: undefined | number

    tasksQueueBucketSize

    tasksQueueBucketSize: undefined | number

    tasksQueuePriority

    tasksQueuePriority: undefined | boolean

    OptionalworkerOptions

    workerOptions?: WorkerOptions

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/WorkerOptions.html b/docs/interfaces/WorkerOptions.html index 78033aa4..96b08097 100644 --- a/docs/interfaces/WorkerOptions.html +++ b/docs/interfaces/WorkerOptions.html @@ -1,5 +1,5 @@ -WorkerOptions | poolifier - v4.4.3

    Interface WorkerOptions

    Options for workers.

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

    Properties

    killBehavior? +WorkerOptions | poolifier - v4.4.4

    Interface WorkerOptions

    Options for workers.

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

    Properties

    killBehavior? killHandler? maxInactiveTime?

    Properties

    OptionalkillBehavior

    killBehavior?: "HARD" | "SOFT"

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

    @@ -11,9 +11,9 @@

    Default Value

    KillBehaviors.SOFT
    -

    OptionalkillHandler

    killHandler?: KillHandler

    The function to call when a worker is killed.

    +

    OptionalkillHandler

    killHandler?: KillHandler

    The function to call when a worker is killed.

    Default Value

    () => {}

    -

    OptionalmaxInactiveTime

    maxInactiveTime?: number

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

    +

    OptionalmaxInactiveTime

    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.

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

    Default Value

    60000
    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/WorkerStatistics.html b/docs/interfaces/WorkerStatistics.html index 260996a1..f3d1f511 100644 --- a/docs/interfaces/WorkerStatistics.html +++ b/docs/interfaces/WorkerStatistics.html @@ -1,6 +1,6 @@ -WorkerStatistics | poolifier - v4.4.3

    Interface WorkerStatisticsInternal

    Worker task performance statistics computation settings.

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

    Properties

    elu +WorkerStatistics | poolifier - v4.4.4

    Interface WorkerStatisticsInternal

    Worker task performance statistics computation settings.

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

    Properties

    elu runTime

    Properties

    Readonlyelu

    elu: boolean

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

    -

    ReadonlyrunTime

    runTime: boolean

    Whether the worker computes the task runtime or not.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    ReadonlyrunTime

    runTime: boolean

    Whether the worker computes the task runtime or not.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/WorkerUsage.html b/docs/interfaces/WorkerUsage.html index 9f38aac4..d2df42cf 100644 --- a/docs/interfaces/WorkerUsage.html +++ b/docs/interfaces/WorkerUsage.html @@ -1,10 +1,10 @@ -WorkerUsage | poolifier - v4.4.3

    Interface WorkerUsageInternal

    Worker usage statistics.

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

    Properties

    elu +WorkerUsage | poolifier - v4.4.4

    Interface WorkerUsageInternal

    Worker usage statistics.

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

    Properties

    elu runTime tasks waitTime

    Properties

    Readonlyelu

    elu: EventLoopUtilizationMeasurementStatistics

    Tasks event loop utilization statistics.

    -

    ReadonlyrunTime

    runTime: MeasurementStatistics

    Tasks runtime statistics.

    -

    Readonlytasks

    tasks: TaskStatistics

    Tasks statistics.

    -

    ReadonlywaitTime

    waitTime: MeasurementStatistics

    Tasks wait time statistics.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    ReadonlyrunTime

    runTime: MeasurementStatistics

    Tasks runtime statistics.

    +

    Readonlytasks

    tasks: TaskStatistics

    Tasks statistics.

    +

    ReadonlywaitTime

    waitTime: MeasurementStatistics

    Tasks wait time statistics.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/types/ClusterPoolOptions.html b/docs/types/ClusterPoolOptions.html index e0234437..b0823350 100644 --- a/docs/types/ClusterPoolOptions.html +++ b/docs/types/ClusterPoolOptions.html @@ -1,2 +1,2 @@ -ClusterPoolOptions | poolifier - v4.4.3

    Type Alias ClusterPoolOptions

    ClusterPoolOptions: PoolOptions<Worker>

    Options for a poolifier cluster pool.

    -

    Settings

    Member Visibility
    +ClusterPoolOptions | poolifier - v4.4.4

    Type Alias ClusterPoolOptions

    ClusterPoolOptions: PoolOptions<Worker>

    Options for a poolifier cluster pool.

    +

    Settings

    Member Visibility
    diff --git a/docs/types/ErrorHandler.html b/docs/types/ErrorHandler.html index f27820dd..6ed91f79 100644 --- a/docs/types/ErrorHandler.html +++ b/docs/types/ErrorHandler.html @@ -1,3 +1,3 @@ -ErrorHandler | poolifier - v4.4.3

    Type Alias ErrorHandler<Worker>

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

    Callback invoked if the worker raised an error.

    +ErrorHandler | poolifier - v4.4.4

    Type Alias ErrorHandler<Worker>

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

    Callback invoked if the worker raised an error.

    Type Parameters

    • Worker extends IWorker

      Type of worker.

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/docs/types/EventHandler.html b/docs/types/EventHandler.html index 6ba3f40a..7c329898 100644 --- a/docs/types/EventHandler.html +++ b/docs/types/EventHandler.html @@ -1,3 +1,3 @@ -EventHandler | poolifier - v4.4.3

    Type Alias EventHandler<Worker>

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

    Worker event handler.

    +EventHandler | poolifier - v4.4.4

    Type Alias EventHandler<Worker>

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

    Worker event handler.

    Type Parameters

    • Worker extends IWorker

      Type of worker.

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/docs/types/ExitHandler.html b/docs/types/ExitHandler.html index 5ff092cc..4e1ad54c 100644 --- a/docs/types/ExitHandler.html +++ b/docs/types/ExitHandler.html @@ -1,3 +1,3 @@ -ExitHandler | poolifier - v4.4.3

    Type Alias ExitHandler<Worker>

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

    Callback invoked when the worker exits successfully.

    +ExitHandler | poolifier - v4.4.4

    Type Alias ExitHandler<Worker>

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

    Callback invoked when the worker exits successfully.

    Type Parameters

    • Worker extends IWorker

      Type of worker.

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/docs/types/KillBehavior.html b/docs/types/KillBehavior.html index 6e6ef244..09f6bff4 100644 --- a/docs/types/KillBehavior.html +++ b/docs/types/KillBehavior.html @@ -1,2 +1,2 @@ -KillBehavior | poolifier - v4.4.3

    Type Alias KillBehavior

    KillBehavior: keyof typeof KillBehaviors

    Kill behavior.

    -

    Settings

    Member Visibility
    +KillBehavior | poolifier - v4.4.4

    Type Alias KillBehavior

    KillBehavior: keyof typeof KillBehaviors

    Kill behavior.

    +

    Settings

    Member Visibility
    diff --git a/docs/types/KillHandler.html b/docs/types/KillHandler.html index 467b8981..dcb82566 100644 --- a/docs/types/KillHandler.html +++ b/docs/types/KillHandler.html @@ -1,2 +1,2 @@ -KillHandler | poolifier - v4.4.3

    Type Alias KillHandler

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

    Handler called when a worker is killed.

    -

    Settings

    Member Visibility
    +KillHandler | poolifier - v4.4.4

    Type Alias KillHandler

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

    Handler called when a worker is killed.

    +

    Settings

    Member Visibility
    diff --git a/docs/types/Measurement.html b/docs/types/Measurement.html index 5c50142b..db2a42fd 100644 --- a/docs/types/Measurement.html +++ b/docs/types/Measurement.html @@ -1,2 +1,2 @@ -Measurement | poolifier - v4.4.3

    Type Alias Measurement

    Measurement: keyof typeof Measurements

    Measurement.

    -

    Settings

    Member Visibility
    +Measurement | poolifier - v4.4.4

    Type Alias Measurement

    Measurement: keyof typeof Measurements

    Measurement.

    +

    Settings

    Member Visibility
    diff --git a/docs/types/MessageHandler.html b/docs/types/MessageHandler.html index 0d0ba9ff..d4baffd6 100644 --- a/docs/types/MessageHandler.html +++ b/docs/types/MessageHandler.html @@ -1,3 +1,3 @@ -MessageHandler | poolifier - v4.4.3

    Type Alias MessageHandler<Worker>

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

    Callback invoked if the worker has received a message.

    +MessageHandler | poolifier - v4.4.4

    Type Alias MessageHandler<Worker>

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

    Callback invoked if the worker has received a message.

    Type Parameters

    • Worker extends IWorker

      Type of worker.

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/docs/types/OnlineHandler.html b/docs/types/OnlineHandler.html index 0b6da7f9..33344c43 100644 --- a/docs/types/OnlineHandler.html +++ b/docs/types/OnlineHandler.html @@ -1,3 +1,3 @@ -OnlineHandler | poolifier - v4.4.3

    Type Alias OnlineHandler<Worker>

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

    Callback invoked when the worker has started successfully.

    +OnlineHandler | poolifier - v4.4.4

    Type Alias OnlineHandler<Worker>

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

    Callback invoked when the worker has started successfully.

    Type Parameters

    • Worker extends IWorker

      Type of worker.

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/docs/types/PoolEvent.html b/docs/types/PoolEvent.html index b574998b..dc1334fb 100644 --- a/docs/types/PoolEvent.html +++ b/docs/types/PoolEvent.html @@ -1,2 +1,2 @@ -PoolEvent | poolifier - v4.4.3

    Type Alias PoolEvent

    PoolEvent: keyof typeof PoolEvents

    Pool event.

    -

    Settings

    Member Visibility
    +PoolEvent | poolifier - v4.4.4

    Type Alias PoolEvent

    PoolEvent: keyof typeof PoolEvents

    Pool event.

    +

    Settings

    Member Visibility
    diff --git a/docs/types/PoolType.html b/docs/types/PoolType.html index de111677..e3c2375f 100644 --- a/docs/types/PoolType.html +++ b/docs/types/PoolType.html @@ -1,2 +1,2 @@ -PoolType | poolifier - v4.4.3

    Type Alias PoolType

    PoolType: keyof typeof PoolTypes

    Pool type.

    -

    Settings

    Member Visibility
    +PoolType | poolifier - v4.4.4

    Type Alias PoolType

    PoolType: keyof typeof PoolTypes

    Pool type.

    +

    Settings

    Member Visibility
    diff --git a/docs/types/TaskAsyncFunction.html b/docs/types/TaskAsyncFunction.html index a8682da5..ec0ae233 100644 --- a/docs/types/TaskAsyncFunction.html +++ b/docs/types/TaskAsyncFunction.html @@ -1,7 +1,7 @@ -TaskAsyncFunction | poolifier - v4.4.3

    Type Alias TaskAsyncFunction<Data, Response>

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

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

    Type Alias TaskAsyncFunction<Data, Response>

    TaskAsyncFunction<Data, Response>: ((data?: 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

        • Optionaldata: Data

          Data sent to the worker.

        Returns Promise<Response>

        Execution response promise.

        -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/docs/types/TaskFunction.html b/docs/types/TaskFunction.html index 81ff583a..d5029756 100644 --- a/docs/types/TaskFunction.html +++ b/docs/types/TaskFunction.html @@ -1,5 +1,5 @@ -TaskFunction | poolifier - v4.4.3

    Type Alias TaskFunction<Data, Response>

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

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

    Type Alias TaskFunction<Data, Response>

    TaskFunction<Data, Response>: TaskAsyncFunction<Data, Response> | TaskSyncFunction<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
    +

    Settings

    Member Visibility
    diff --git a/docs/types/TaskFunctions.html b/docs/types/TaskFunctions.html index 67d1bcee..8235e8ed 100644 --- a/docs/types/TaskFunctions.html +++ b/docs/types/TaskFunctions.html @@ -1,6 +1,6 @@ -TaskFunctions | poolifier - v4.4.3

    Type Alias TaskFunctions<Data, Response>

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

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

    Type Alias TaskFunctions<Data, Response>

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

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

    Type Parameters

    • Data = unknown

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

    • Response = unknown

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

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/docs/types/TaskSyncFunction.html b/docs/types/TaskSyncFunction.html index 1737bba5..e58e488b 100644 --- a/docs/types/TaskSyncFunction.html +++ b/docs/types/TaskSyncFunction.html @@ -1,6 +1,6 @@ -TaskSyncFunction | poolifier - v4.4.3

    Type Alias TaskSyncFunction<Data, Response>

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

    Task synchronous function that can be executed.

    +TaskSyncFunction | poolifier - v4.4.4

    Type Alias TaskSyncFunction<Data, Response>

    TaskSyncFunction<Data, Response>: ((data?: 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

      • (data?): Response

      • Parameters

        • Optionaldata: Data

          Data sent to the worker.

        Returns Response

        Execution response.

        -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/docs/types/ThreadPoolOptions.html b/docs/types/ThreadPoolOptions.html index 9980944e..2b9d74c6 100644 --- a/docs/types/ThreadPoolOptions.html +++ b/docs/types/ThreadPoolOptions.html @@ -1,2 +1,2 @@ -ThreadPoolOptions | poolifier - v4.4.3

    Type Alias ThreadPoolOptions

    ThreadPoolOptions: PoolOptions<Worker>

    Options for a poolifier thread pool.

    -

    Settings

    Member Visibility
    +ThreadPoolOptions | poolifier - v4.4.4

    Type Alias ThreadPoolOptions

    ThreadPoolOptions: PoolOptions<Worker>

    Options for a poolifier thread pool.

    +

    Settings

    Member Visibility
    diff --git a/docs/types/WorkerChoiceStrategy.html b/docs/types/WorkerChoiceStrategy.html index 5171f5c3..6d2c8d7a 100644 --- a/docs/types/WorkerChoiceStrategy.html +++ b/docs/types/WorkerChoiceStrategy.html @@ -1,2 +1,2 @@ -WorkerChoiceStrategy | poolifier - v4.4.3

    Type Alias WorkerChoiceStrategy

    WorkerChoiceStrategy: keyof typeof WorkerChoiceStrategies

    Worker choice strategy.

    -

    Settings

    Member Visibility
    +WorkerChoiceStrategy | poolifier - v4.4.4

    Type Alias WorkerChoiceStrategy

    WorkerChoiceStrategy: keyof typeof WorkerChoiceStrategies

    Worker choice strategy.

    +

    Settings

    Member Visibility
    diff --git a/docs/types/WorkerType.html b/docs/types/WorkerType.html index 18e59dd6..886c7d8d 100644 --- a/docs/types/WorkerType.html +++ b/docs/types/WorkerType.html @@ -1,2 +1,2 @@ -WorkerType | poolifier - v4.4.3

    Type Alias WorkerType

    WorkerType: keyof typeof WorkerTypes

    Worker type.

    -

    Settings

    Member Visibility
    +WorkerType | poolifier - v4.4.4

    Type Alias WorkerType

    WorkerType: keyof typeof WorkerTypes

    Worker type.

    +

    Settings

    Member Visibility
    diff --git a/docs/types/Writable.html b/docs/types/Writable.html index 51bebdc8..68679ef8 100644 --- a/docs/types/Writable.html +++ b/docs/types/Writable.html @@ -1,3 +1,3 @@ -Writable | poolifier - v4.4.3

    Type Alias Writable<T>Internal

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

    Remove readonly modifier from all properties of T.

    +Writable | poolifier - v4.4.4

    Type Alias Writable<T>Internal

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

    Remove readonly modifier from all properties of T.

    Type Parameters

    • T

      Type to remove readonly modifier.

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/docs/variables/KillBehaviors.html b/docs/variables/KillBehaviors.html index 17f3c608..0273779d 100644 --- a/docs/variables/KillBehaviors.html +++ b/docs/variables/KillBehaviors.html @@ -1,2 +1,2 @@ -KillBehaviors | poolifier - v4.4.3

    Variable KillBehaviorsConst

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

    Enumeration of kill behaviors.

    -

    Settings

    Member Visibility
    +KillBehaviors | poolifier - v4.4.4

    Variable KillBehaviorsConst

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

    Enumeration of kill behaviors.

    +

    Settings

    Member Visibility
    diff --git a/docs/variables/Measurements.html b/docs/variables/Measurements.html index 28ac197a..24f3cfaf 100644 --- a/docs/variables/Measurements.html +++ b/docs/variables/Measurements.html @@ -1,2 +1,2 @@ -Measurements | poolifier - v4.4.3

    Variable MeasurementsConst

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

    Enumeration of measurements.

    -

    Settings

    Member Visibility
    +Measurements | poolifier - v4.4.4

    Variable MeasurementsConst

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

    Enumeration of measurements.

    +

    Settings

    Member Visibility
    diff --git a/docs/variables/PoolEvents.html b/docs/variables/PoolEvents.html index 6b3fab5c..a6b9f968 100644 --- a/docs/variables/PoolEvents.html +++ b/docs/variables/PoolEvents.html @@ -1,2 +1,2 @@ -PoolEvents | poolifier - v4.4.3

    Variable PoolEventsConst

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

    Enumeration of pool events.

    -

    Settings

    Member Visibility
    +PoolEvents | poolifier - v4.4.4

    Variable PoolEventsConst

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

    Enumeration of pool events.

    +

    Settings

    Member Visibility
    diff --git a/docs/variables/PoolTypes.html b/docs/variables/PoolTypes.html index 69dc511e..af13a528 100644 --- a/docs/variables/PoolTypes.html +++ b/docs/variables/PoolTypes.html @@ -1,2 +1,2 @@ -PoolTypes | poolifier - v4.4.3

    Variable PoolTypesConst

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

    Enumeration of pool types.

    -

    Settings

    Member Visibility
    +PoolTypes | poolifier - v4.4.4

    Variable PoolTypesConst

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

    Enumeration of pool types.

    +

    Settings

    Member Visibility
    diff --git a/docs/variables/WorkerChoiceStrategies.html b/docs/variables/WorkerChoiceStrategies.html index f6e477ee..0d02ae9a 100644 --- a/docs/variables/WorkerChoiceStrategies.html +++ b/docs/variables/WorkerChoiceStrategies.html @@ -1,2 +1,2 @@ -WorkerChoiceStrategies | poolifier - v4.4.3

    Variable WorkerChoiceStrategiesConst

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

    Enumeration of worker choice strategies.

    -

    Settings

    Member Visibility
    +WorkerChoiceStrategies | poolifier - v4.4.4

    Variable WorkerChoiceStrategiesConst

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

    Enumeration of worker choice strategies.

    +

    Settings

    Member Visibility
    diff --git a/docs/variables/WorkerTypes.html b/docs/variables/WorkerTypes.html index 53597bf0..02f1c945 100644 --- a/docs/variables/WorkerTypes.html +++ b/docs/variables/WorkerTypes.html @@ -1,2 +1,2 @@ -WorkerTypes | poolifier - v4.4.3

    Variable WorkerTypesConst

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

    Enumeration of worker types.

    -

    Settings

    Member Visibility
    +WorkerTypes | poolifier - v4.4.4

    Variable WorkerTypesConst

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

    Enumeration of worker types.

    +

    Settings

    Member Visibility
    -- 2.34.1