From 904ddac9d4d1484aa4364ee8c042c62871ec2e39 Mon Sep 17 00:00:00 2001 From: Documentation Bot Date: Wed, 13 Dec 2023 10:05:11 +0000 Subject: [PATCH] docs: generate documentation --- docs/classes/AbstractPool.html | 130 +++++++++--------- docs/classes/AbstractWorker.html | 60 ++++---- docs/classes/CircularArray.html | 20 +-- docs/classes/ClusterWorker.html | 48 +++---- docs/classes/Deque.html | 26 ++-- docs/classes/DynamicClusterPool.html | 98 ++++++------- docs/classes/DynamicThreadPool.html | 98 ++++++------- docs/classes/FixedClusterPool.html | 98 ++++++------- docs/classes/FixedThreadPool.html | 98 ++++++------- docs/classes/Node.html | 4 +- docs/classes/ThreadWorker.html | 50 +++---- docs/classes/WorkerChoiceStrategyContext.html | 24 ++-- docs/functions/availableParallelism.html | 2 +- docs/interfaces/ClusterPoolOptions.html | 28 ++-- ...tLoopUtilizationMeasurementStatistics.html | 4 +- docs/interfaces/IPool.html | 34 ++--- docs/interfaces/IWorker.html | 8 +- docs/interfaces/IWorkerChoiceStrategy.html | 18 +-- docs/interfaces/IWorkerNode.html | 36 ++--- docs/interfaces/MeasurementOptions.html | 4 +- docs/interfaces/MeasurementStatistics.html | 14 +- .../MeasurementStatisticsRequirements.html | 8 +- docs/interfaces/MessageValue.html | 38 ++--- docs/interfaces/PoolInfo.html | 12 +- docs/interfaces/PoolOptions.html | 24 ++-- docs/interfaces/PromiseResponseWrapper.html | 10 +- docs/interfaces/StrategyData.html | 4 +- docs/interfaces/StrategyPolicy.html | 6 +- docs/interfaces/Task.html | 12 +- .../TaskFunctionOperationResult.html | 4 +- docs/interfaces/TaskPerformance.html | 10 +- docs/interfaces/TaskStatistics.html | 16 +-- .../TaskStatisticsRequirements.html | 8 +- docs/interfaces/TasksQueueOptions.html | 10 +- docs/interfaces/ThreadPoolOptions.html | 26 ++-- .../WorkerChoiceStrategyOptions.html | 14 +- docs/interfaces/WorkerError.html | 8 +- docs/interfaces/WorkerInfo.html | 12 +- docs/interfaces/WorkerNodeEventDetail.html | 4 +- docs/interfaces/WorkerOptions.html | 8 +- docs/interfaces/WorkerStatistics.html | 6 +- docs/interfaces/WorkerUsage.html | 10 +- docs/types/ErrorHandler.html | 2 +- docs/types/ExitHandler.html | 2 +- docs/types/KillBehavior.html | 2 +- docs/types/KillHandler.html | 2 +- docs/types/Measurement.html | 2 +- docs/types/MessageHandler.html | 2 +- docs/types/OnlineHandler.html | 2 +- docs/types/PoolEvent.html | 2 +- docs/types/PoolType.html | 2 +- docs/types/TaskAsyncFunction.html | 2 +- docs/types/TaskFunction.html | 2 +- docs/types/TaskFunctions.html | 2 +- docs/types/TaskSyncFunction.html | 2 +- docs/types/WorkerChoiceStrategy.html | 2 +- docs/types/WorkerType.html | 2 +- docs/types/Writable.html | 2 +- docs/variables/KillBehaviors.html | 2 +- docs/variables/Measurements.html | 2 +- docs/variables/PoolEvents.html | 2 +- docs/variables/PoolTypes.html | 2 +- docs/variables/WorkerChoiceStrategies.html | 2 +- docs/variables/WorkerTypes.html | 2 +- 64 files changed, 598 insertions(+), 598 deletions(-) diff --git a/docs/classes/AbstractPool.html b/docs/classes/AbstractPool.html index 260674ba..b11a37a9 100644 --- a/docs/classes/AbstractPool.html +++ b/docs/classes/AbstractPool.html @@ -2,7 +2,7 @@

Type Parameters

Hierarchy

Implements

Constructors

Hierarchy

Implements

  • IPool<Worker, Data, Response>

Constructors

Properties

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

Type Parameters

  • Worker extends IWorker

  • Data = unknown

  • Response = unknown

Parameters

  • numberOfWorkers: number

    Number of workers that this pool should manage.

  • filePath: string

    Path to the worker file.

  • opts: PoolOptions<Worker>

    Options for the pool.

    -

Returns AbstractPool<Worker, Data, Response>

Properties

destroying: boolean

Whether the pool is destroying or not.

-
emitter?: EventEmitterAsyncResource

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

Returns AbstractPool<Worker, Data, Response>

Properties

destroying: boolean

Whether the pool is destroying or not.

+
emitter?: EventEmitterAsyncResource

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

Events that can currently be listened to:

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

Path to the worker file.

-
max?: number

Dynamic pool maximum size property placeholder.

-
numberOfWorkers: number

Number of workers that this pool should manage.

-
opts: PoolOptions<Worker>

Options for the pool.

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

The task execution response promise map:

+
filePath: string

Path to the worker file.

+
max?: number

Dynamic pool maximum size property placeholder.

+
numberOfWorkers: number

Number of workers that this pool should manage.

+
opts: PoolOptions<Worker>

Options for the pool.

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

The task execution response promise map:

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

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

-
readyEventEmitted: boolean

Whether the pool ready event has been emitted or not.

-
startTimestamp: number

The start timestamp of the pool.

-
started: boolean

Whether the pool is started or not.

-
starting: boolean

Whether the pool is starting or not.

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

The task functions added at runtime map:

+
readyEventEmitted: boolean

Whether the pool ready event has been emitted or not.

+
startTimestamp: number

The start timestamp of the pool.

+
started: boolean

Whether the pool is started or not.

+
starting: boolean

Whether the pool is starting or not.

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

The task functions added at runtime map:

  • key: The task function name.
  • value: The task function itself.
-
workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>

Worker choice strategy context referencing a worker choice algorithm implementation.

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

Pool worker nodes.

-

Accessors

workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>

Worker choice strategy context referencing a worker choice algorithm implementation.

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

Pool worker nodes.

+

Accessors

  • get type(): "fixed" | "dynamic"
  • The pool type.

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

    -

    Returns "fixed" | "dynamic"

Methods

Methods

  • 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

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

Returns 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

  • Hook executed before the worker task execution. +

Returns 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

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

    +

Returns void

  • Chooses a worker node for the next task.

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

    Returns number

    The chosen worker node key

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

    Returns number

    New, completely set up dynamic worker node key.

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

    Returns number

    New, completely set up worker node key.

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

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

    Type Parameters

    • Message

    Parameters

    • workerNodeKey: number

      The worker node key.

    • listener: ((message) => void)

      The message listener callback.

      -
        • (message): void
        • Parameters

          Returns void

    Returns void

  • Terminates the worker node given its worker node key.

    +
      • (message): void
      • Parameters

        Returns void

Returns void

  • Terminates the worker node given its worker node key.

    Parameters

    • workerNodeKey: number

      The worker node key.

      -

    Returns Promise<void>

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

    +

Returns Promise<void>

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

    Parameters

    • enable: boolean

      Whether to enable or disable the worker node tasks queue.

    • Optional tasksQueueOptions: TasksQueueOptions

      The worker node tasks queue options.

      -

    Returns void

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

    +

Returns void

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

    Parameters

    • Optional data: Data

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

    • Optional name: string

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

    • Optional transferList: TransferListItem[]

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

    Returns Promise<Response>

    Promise that will be fulfilled when the task is completed.

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

    Parameters

    • workerNodeKey: number

      The worker node key.

    • task: Task<Data>

      The task to execute.

      -

    Returns void

  • Gets the worker information given its worker node key.

    +

Returns void

  • Gets the given worker its worker node key.

    Parameters

    • worker: Worker

      The worker.

    Returns number

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

    -
  • Gets the worker node key given its worker id.

    Parameters

    • workerId: undefined | number

      The worker id.

    Returns number

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

    -
  • Whether the specified task function exists in this pool.

    Parameters

    • name: string

      The name of the task function.

    Returns boolean

    true if the task function exists, false otherwise.

    -
  • Internal

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

    Parameters

    • workerNodeKey: number

      The worker node key.

    Returns boolean

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

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

    Returns boolean

    Worker nodes busyness boolean status.

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

    Type Parameters

    • Message

    Parameters

    • workerNodeKey: number

      The worker node key.

    • listener: ((message) => void)

      The message listener callback.

      -
        • (message): void
        • Parameters

          Returns void

    Returns void

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

    +
      • (message): void
      • Parameters

        Returns void

Returns void

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

    Type Parameters

    • Message

    Parameters

    • workerNodeKey: number

      The worker node key.

    • listener: ((message) => void)

      The message listener callback.

      -
        • (message): void
        • Parameters

          Returns void

    Returns void

  • Removes a task function from this pool.

    +
      • (message): void
      • Parameters

        Returns void

Returns void

  • Removes a task function from this pool.

    Parameters

    • name: string

      The name of the task function.

    Returns Promise<boolean>

    true if the task function was removed, false otherwise.

    -
  • Removes the given worker from the pool worker nodes.

    Parameters

    • worker: Worker

      The worker.

      -

    Returns void

  • Parameters

    • workerNodeKey: number
    • taskName: string

    Returns void

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

    +

Returns void

  • Parameters

    • workerNodeKey: number
    • taskName: string

    Returns void

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

    Parameters

    • workerNodeKey: number

      The worker node key.

      -

    Returns void

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

    +

Returns void

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

    Parameters

    • workerNodeKey: number

      The worker node key.

      -

    Returns void

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

    +

Returns void

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

    Parameters

    • workerNodeKey: number

      The worker node key.

    • message: MessageValue<Data, unknown>

      The message.

    • Optional transferList: TransferListItem[]

      The optional array of transferable objects.

      -

    Returns void

  • Sets the default task function in this pool.

    +

Returns void

  • Sets the default task function in this pool.

    Parameters

    • name: string

      The name of the task function.

    Returns Promise<boolean>

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

    -
  • Sets the worker choice strategy in this pool.

    +

Returns void

  • Sets the worker choice strategy in this pool.

    Parameters

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

      The worker choice strategy.

    • Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptions

      The worker choice strategy options.

      -

    Returns void

  • Sets the worker choice strategy options in this pool.

    +

Returns void

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

Returns void

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

    -

    Returns void

  • Conditions for dynamic worker creation.

    Returns boolean

    Whether to create a dynamic worker or not.

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

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

    Parameters

    • workerNodeKey: number

      The worker node key.

    Returns boolean

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

    -
  • Parameters

    • workerNodeKey: number
    • taskName: string

    Returns void

  • Parameters

    • workerNodeKey: number

    Returns void

  • Parameters

    • workerNodeKey: number
    • taskName: string

    Returns void

Generated using TypeDoc

\ No newline at end of file +
  • Parameters

    • workerNodeKey: number
    • taskName: string

    Returns void

  • Parameters

    • workerNodeKey: number

    Returns void

  • Parameters

    • workerNodeKey: number
    • taskName: string

    Returns void

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/AbstractWorker.html b/docs/classes/AbstractWorker.html index 000982f4..f29da7f4 100644 --- a/docs/classes/AbstractWorker.html +++ b/docs/classes/AbstractWorker.html @@ -2,7 +2,7 @@

Type Parameters

  • MainWorker extends Worker | MessagePort

    Type of main worker.

  • Data = unknown

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

  • Response = unknown

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

    -

Hierarchy

Constructors

Hierarchy

Constructors

Properties

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

    Reference to main worker.

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

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

  • opts: WorkerOptions = DEFAULT_WORKER_OPTIONS

    Options for the worker.

    -
  • Returns AbstractWorker<MainWorker, Data, Response>

    Properties

    activeInterval?: Timeout

    Handler id of the activeInterval worker activity check.

    -
    id: number

    Worker id.

    -
    isMain: boolean

    Whether this is the main worker or not.

    -
    lastTaskTimestamp: number

    Timestamp of the last task processed by this worker.

    -
    mainWorker: MainWorker

    Reference to main worker.

    -
    opts: WorkerOptions = DEFAULT_WORKER_OPTIONS

    Options for the worker.

    -
    statistics: WorkerStatistics

    Performance statistics computation requirements.

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

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

    -

    Methods

    Returns AbstractWorker<MainWorker, Data, Response>

    Properties

    activeInterval?: Timeout

    Handler id of the activeInterval worker activity check.

    +
    id: number

    Worker id.

    +
    isMain: boolean

    Whether this is the main worker or not.

    +
    lastTaskTimestamp: number

    Timestamp of the last task processed by this worker.

    +
    mainWorker: MainWorker

    Reference to main worker.

    +
    opts: WorkerOptions = DEFAULT_WORKER_OPTIONS

    Options for the worker.

    +
    statistics: WorkerStatistics

    Performance statistics computation requirements.

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

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

    +

    Methods

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

      Parameters

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

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

        -

      Returns void

    • Returns the main worker.

      +

    Returns void

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

      Parameters

      • error: string | Error

        The error raised by the worker.

      Returns string

      The error message.

      -

    Returns void

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

      Returns string[]

      The names of the worker's task functions.

      -

    Returns void

    • Runs the given task function asynchronously.

      +

    Returns void

    • Runs the given task function synchronously.

      +

    Returns void

    • Sends a message to main worker.

      +

    Returns void

    Returns void

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/CircularArray.html b/docs/classes/CircularArray.html index 673fd9e5..bf2462a2 100644 --- a/docs/classes/CircularArray.html +++ b/docs/classes/CircularArray.html @@ -1,5 +1,5 @@ CircularArray | poolifier - v3.0.13

    Class CircularArray<T>Internal

    Array with a maximum length and shifting items when full.

    -

    Type Parameters

    • T

    Hierarchy

    • Array<T>
      • CircularArray

    Constructors

    Type Parameters

    • T

    Hierarchy

    • Array<T>
      • CircularArray

    Constructors

    Properties

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

    Constructors

    Properties

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

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

    Constructors

    Properties

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

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

    Type declaration

    • Optional Readonly [unscopables]?: boolean

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

    • Optional length?: boolean

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

    length: number

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

    -
    size: number
    [species]: ArrayConstructor

    Methods

    • Iterator

      +
    size: number
    [species]: ArrayConstructor

    Methods

    • Iterator

      Returns IterableIterator<T>

    • Returns the item located at the specified index.

      Parameters

      • index: number

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

        -

      Returns undefined | T

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

    Returns undefined | T

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

      Parameters

      • target: number

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

      • start: number

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

      • Optional end: number

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

        -

      Returns CircularArray<T>

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

      +

    Returns CircularArray<T>

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

      Returns IterableIterator<[number, T]>

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

      Type Parameters

      • S

      Parameters

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

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

      Returns U[]

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

      Parameters

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

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

          • (value, index, array): void
          • Parameters

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

            Returns void

      • Optional thisArg: any

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

        -

      Returns void

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

      +

    Returns void

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

      Parameters

      • searchElement: T

        The element to search for.

      • Optional fromIndex: number

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

      Returns boolean

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

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

        • (value, index, array): U
        • Parameters

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

          Returns U

    • Optional thisArg: any

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

    Returns U[]

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

      -

      Returns undefined | T

    • Parameters

      • Rest ...items: T[]

      Returns number

      Inherit Doc

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

      +

      Returns undefined | T

    • Parameters

      • Rest ...items: T[]

      Returns number

      Inherit Doc

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

      Parameters

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

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

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

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

            Returns T

      Returns T

    • Parameters

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

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

            Returns T

      • initialValue: T

      Returns T

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

      Type Parameters

      • U

      Parameters

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

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

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

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

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

            Returns T

      Returns T

    • Parameters

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

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

            Returns T

      • initialValue: T

      Returns T

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

      Type Parameters

      • U

      Parameters

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

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

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

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

            Returns U

      • initialValue: U

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

        -

      Returns U

    • Reverses the elements in an array in place. +

    Returns U

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

      Returns T[]

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

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

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

          • a: T
          • b: T

          Returns number

    Returns CircularArray<T>

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

      +
        • (a, b): number
        • Parameters

          • a: T
          • b: T

          Returns number

    Returns CircularArray<T>

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

      Returns string

    • Returns a string representation of an array.

      -

      Returns string

    • Parameters

      • Rest ...items: T[]

      Returns number

      Inherit Doc

    • Returns an iterable of values in the array

      +

      Returns string

    • Parameters

      • Rest ...items: T[]

      Returns number

      Inherit Doc

    • Returns an iterable of values in the array

      Returns IterableIterator<T>

    • Creates an array from an array-like object.

      Type Parameters

      • T

      Parameters

      • arrayLike: ArrayLike<T>

        An array-like object to convert to an array.

      Returns T[]

    • Creates an array from an iterable object.

      diff --git a/docs/classes/ClusterWorker.html b/docs/classes/ClusterWorker.html index 0936445f..d5e75718 100644 --- a/docs/classes/ClusterWorker.html +++ b/docs/classes/ClusterWorker.html @@ -7,7 +7,7 @@ but the minimum number of workers will be guaranteed.

      Since

      2.0.0

    Type Parameters

    • Data = unknown

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

    • Response = unknown

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

      -

    Hierarchy

    Constructors

    Hierarchy

    Constructors

    Properties

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

    Constructors

    Properties

    activeInterval?: Timeout

    Handler id of the activeInterval worker activity check.

    -
    isMain: boolean

    Whether this is the main worker or not.

    -
    lastTaskTimestamp: number

    Timestamp of the last task processed by this worker.

    -
    opts: WorkerOptions = DEFAULT_WORKER_OPTIONS

    Options for the worker.

    -
    statistics: WorkerStatistics

    Performance statistics computation requirements.

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

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

    -

    Accessors

    Methods

    Returns ClusterWorker<Data, Response>

    Properties

    activeInterval?: Timeout

    Handler id of the activeInterval worker activity check.

    +
    isMain: boolean

    Whether this is the main worker or not.

    +
    lastTaskTimestamp: number

    Timestamp of the last task processed by this worker.

    +
    opts: WorkerOptions = DEFAULT_WORKER_OPTIONS

    Options for the worker.

    +
    statistics: WorkerStatistics

    Performance statistics computation requirements.

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

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

    +

    Accessors

    Methods

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

      Parameters

      • error: string | Error

        The error raised by the worker.

      Returns string

      The error message.

      -

    Returns void

    Returns void

    • Runs the given task function asynchronously.

      +

    Returns void

    • Runs the given task function synchronously.

      +

    Returns void

    • Sends a message to main worker.

      +

    Returns void

    Returns void

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

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

    Class Deque<T>Internal

    Deque. Implemented with a doubly linked list.

    Type Parameters

    • T

      Type of deque data.

      -

    Constructors

    Constructors

    Properties

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

    push shift unshift -

    Constructors

    Properties

    head?: Node<T>
    maxSize: number

    The maximum size of the deque.

    -
    size: number

    The size of the deque.

    -
    tail?: Node<T>

    Methods

    • Returns an iterator for the deque.

      +

    Constructors

    Properties

    head?: Node<T>
    maxSize: number

    The maximum size of the deque.

    +
    size: number

    The size of the deque.

    +
    tail?: Node<T>

    Methods

    • Returns an backward iterator for the deque.

      +
    • Peeks at the first data.

      Returns undefined | T

      The first data or undefined if the deque is empty.

      -
    • Peeks at the last data.

      Returns undefined | T

      The last data or undefined if the deque is empty.

      -
    • Pops data from the deque.

      Returns undefined | T

      The popped data or undefined if the deque is empty.

      -
    • Appends data to the deque.

      Parameters

      • data: T

        Data to append.

      Returns number

      The new size of the queue.

      -
    • Shifts data from the deque.

      +
    • Shifts data from the deque.

      Returns undefined | T

      The shifted data or undefined if the deque is empty.

      -
    • Prepends data to the deque.

      +
    • Prepends data to the deque.

      Parameters

      • data: T

        Data to prepend.

      Returns number

      The new size of the queue.

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/DynamicClusterPool.html b/docs/classes/DynamicClusterPool.html index 2932c231..6aee4137 100644 --- a/docs/classes/DynamicClusterPool.html +++ b/docs/classes/DynamicClusterPool.html @@ -5,7 +5,7 @@ When the maximum number of workers is reached and workers are busy, an event is

    Since

    2.0.0

    Type Parameters

    • Data = unknown

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

    • Response = unknown

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

      -

    Hierarchy

    Constructors

    Hierarchy

    Constructors

    Properties

    emitter? filePath max @@ -61,7 +61,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

    emitter?: EventEmitterAsyncResource

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

    Returns DynamicClusterPool<Data, Response>

    Properties

    emitter?: EventEmitterAsyncResource

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

    Events that can currently be listened to:

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

    Path to the worker file.

    -
    max: number

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

    -
    numberOfWorkers: number

    Number of workers that this pool should manage.

    -

    Options for this fixed cluster pool.

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

    The task execution response promise map:

    +
    filePath: string

    Path to the worker file.

    +
    max: number

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

    +
    numberOfWorkers: number

    Number of workers that this pool should manage.

    +

    Options for this fixed cluster pool.

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

    The task execution response promise map:

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

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

    -
    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>

    Worker choice strategy context referencing a worker choice algorithm implementation.

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

    Pool worker nodes.

    -

    Accessors

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>

    Worker choice strategy context referencing a worker choice algorithm implementation.

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

    Pool worker nodes.

    +

    Accessors

    • get busy(): boolean
    • Whether the pool is busy or not.

      The pool busyness boolean status.

      -

      Returns boolean

    • get full(): boolean
    • Whether the pool is full or not.

      The pool filling boolean status.

      -

      Returns boolean

    • get type(): "fixed" | "dynamic"
    • The pool type.

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

      -

      Returns "fixed" | "dynamic"

    • get utilization(): number
    • The approximate pool utilization.

      +

      Returns "fixed" | "dynamic"

    • get utilization(): number
    • The approximate pool utilization.

      Returns number

      The pool utilization.

      -
    • get worker(): "thread" | "cluster"
    • The worker type.

      -

      Returns "thread" | "cluster"

    Methods

    • Adds a task function to this pool. +

    • get worker(): "thread" | "cluster"
    • The worker type.

      +

      Returns "thread" | "cluster"

    Methods

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

    Returns void

    • Hook executed before the worker task execution. +

    Returns void

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

      +

    Returns void

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

      Type Parameters

      • Message

      Parameters

      • workerNodeKey: number

        The worker node key.

      • listener: ((message) => void)

        The message listener callback.

        -
          • (message): void
          • Parameters

            Returns void

      Returns void

    • Terminates the worker node given its worker node key.

      +
        • (message): void
        • Parameters

          Returns void

    Returns void

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

      +

    Returns Promise<void>

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

      +

    Returns void

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

      Parameters

      • Optional data: Data

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

      • Optional name: string

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

      • Optional transferList: TransferListItem[]

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

      Returns Promise<Response>

      Promise that will be fulfilled when the task is completed.

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

      Type Parameters

      • Message

      Parameters

      • workerNodeKey: number

        The worker node key.

      • listener: ((message) => void)

        The message listener callback.

        -
          • (message): void
          • Parameters

            Returns void

      Returns void

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

      +
        • (message): void
        • Parameters

          Returns void

    Returns void

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

      Type Parameters

      • Message

      Parameters

      • workerNodeKey: number

        The worker node key.

      • listener: ((message) => void)

        The message listener callback.

        -
          • (message): void
          • Parameters

            Returns void

      Returns void

    • Removes a task function from this pool.

      +
        • (message): void
        • Parameters

          Returns void

    Returns void

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

      +

    Returns void

    • Sets the default task function in this pool.

      +

    Returns void

    • Sets the worker choice strategy in this pool.

      +

    Returns void

    • Sets the worker choice strategy in this pool.

      Parameters

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

        The worker choice strategy.

      • Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptions

        The worker choice strategy options.

        -

      Returns void

    • Sets the worker choice strategy options in this pool.

      +

    Returns void

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

    Returns void

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/DynamicThreadPool.html b/docs/classes/DynamicThreadPool.html index 7ba0aa3a..a579620c 100644 --- a/docs/classes/DynamicThreadPool.html +++ b/docs/classes/DynamicThreadPool.html @@ -5,7 +5,7 @@ When the maximum number of threads is reached and workers are busy, an event is

    Since

    0.0.1

    Type Parameters

    • Data = unknown

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

    • Response = unknown

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

      -

    Hierarchy

    Constructors

    Hierarchy

    Constructors

    Properties

    emitter? filePath max @@ -61,7 +61,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

    emitter?: EventEmitterAsyncResource

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

    Returns DynamicThreadPool<Data, Response>

    Properties

    emitter?: EventEmitterAsyncResource

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

    Events that can currently be listened to:

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

    Path to the worker file.

    -
    max: number

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

    -
    numberOfWorkers: number

    Number of workers that this pool should manage.

    -

    Options for this fixed thread pool.

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

    The task execution response promise map:

    +
    filePath: string

    Path to the worker file.

    +
    max: number

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

    +
    numberOfWorkers: number

    Number of workers that this pool should manage.

    +

    Options for this fixed thread pool.

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

    The task execution response promise map:

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

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

    -
    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>

    Worker choice strategy context referencing a worker choice algorithm implementation.

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

    Pool worker nodes.

    -

    Accessors

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>

    Worker choice strategy context referencing a worker choice algorithm implementation.

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

    Pool worker nodes.

    +

    Accessors

    • get busy(): boolean
    • Whether the pool is busy or not.

      The pool busyness boolean status.

      -

      Returns boolean

    • get full(): boolean
    • Whether the pool is full or not.

      The pool filling boolean status.

      -

      Returns boolean

    • get type(): "fixed" | "dynamic"
    • The pool type.

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

      -

      Returns "fixed" | "dynamic"

    • get utilization(): number
    • The approximate pool utilization.

      +

      Returns "fixed" | "dynamic"

    • get utilization(): number
    • The approximate pool utilization.

      Returns number

      The pool utilization.

      -
    • get worker(): "thread" | "cluster"
    • The worker type.

      -

      Returns "thread" | "cluster"

    Methods

    • Adds a task function to this pool. +

    • get worker(): "thread" | "cluster"
    • The worker type.

      +

      Returns "thread" | "cluster"

    Methods

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

    Returns void

    • Hook executed before the worker task execution. +

    Returns void

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

      +

    Returns void

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

      Type Parameters

      • Message

      Parameters

      • workerNodeKey: number

        The worker node key.

      • listener: ((message) => void)

        The message listener callback.

        -
          • (message): void
          • Parameters

            Returns void

      Returns void

    • Terminates the worker node given its worker node key.

      +
        • (message): void
        • Parameters

          Returns void

    Returns void

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

      +

    Returns Promise<void>

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

      +

    Returns void

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

      Parameters

      • Optional data: Data

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

      • Optional name: string

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

      • Optional transferList: TransferListItem[]

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

      Returns Promise<Response>

      Promise that will be fulfilled when the task is completed.

      -
    • Internal

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

      Parameters

      • workerNodeKey: number

        The worker node key.

      Returns boolean

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

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

      Type Parameters

      • Message

      Parameters

      • workerNodeKey: number

        The worker node key.

      • listener: ((message) => void)

        The message listener callback.

        -
          • (message): void
          • Parameters

            Returns void

      Returns void

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

      +
        • (message): void
        • Parameters

          Returns void

    Returns void

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

      Type Parameters

      • Message

      Parameters

      • workerNodeKey: number

        The worker node key.

      • listener: ((message) => void)

        The message listener callback.

        -
          • (message): void
          • Parameters

            Returns void

      Returns void

    • Removes a task function from this pool.

      +
        • (message): void
        • Parameters

          Returns void

    Returns void

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

      +

    Returns void

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

      Parameters

      • workerNodeKey: number

        The worker node key.

      • message: MessageValue<Data, unknown>

        The message.

      • Optional transferList: TransferListItem[]

        The optional array of transferable objects.

        -

      Returns void

    • Sets the default task function in this pool.

      +

    Returns void

    • Sets the worker choice strategy in this pool.

      +

    Returns void

    • Sets the worker choice strategy in this pool.

      Parameters

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

        The worker choice strategy.

      • Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptions

        The worker choice strategy options.

        -

      Returns void

    • Sets the worker choice strategy options in this pool.

      +

    Returns void

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

    Returns void

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/FixedClusterPool.html b/docs/classes/FixedClusterPool.html index 551866f2..8d127a5a 100644 --- a/docs/classes/FixedClusterPool.html +++ b/docs/classes/FixedClusterPool.html @@ -3,7 +3,7 @@

    Since

    2.0.0

    Type Parameters

    • Data = unknown

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

    • Response = unknown

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

      -

    Hierarchy

    Constructors

    Hierarchy

    Constructors

    Properties

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

    Type Parameters

    • Data = unknown

    • Response = unknown

    Parameters

    • numberOfWorkers: number

      Number of workers for this pool.

    • filePath: string

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

    • opts: ClusterPoolOptions = {}

      Options for this fixed cluster pool.

      -

    Returns FixedClusterPool<Data, Response>

    Properties

    emitter?: EventEmitterAsyncResource

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

    Returns FixedClusterPool<Data, Response>

    Properties

    emitter?: EventEmitterAsyncResource

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

    Events that can currently be listened to:

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

    Path to the worker file.

    -
    max?: number

    Dynamic pool maximum size property placeholder.

    -
    numberOfWorkers: number

    Number of workers that this pool should manage.

    -

    Options for this fixed cluster pool.

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

    The task execution response promise map:

    +
    filePath: string

    Path to the worker file.

    +
    max?: number

    Dynamic pool maximum size property placeholder.

    +
    numberOfWorkers: number

    Number of workers that this pool should manage.

    +

    Options for this fixed cluster pool.

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

    The task execution response promise map:

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

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

    -
    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>

    Worker choice strategy context referencing a worker choice algorithm implementation.

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

    Pool worker nodes.

    -

    Accessors

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>

    Worker choice strategy context referencing a worker choice algorithm implementation.

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

    Pool worker nodes.

    +

    Accessors

    • get busy(): boolean
    • Whether the pool is busy or not.

      The pool busyness boolean status.

      -

      Returns boolean

    • get full(): boolean
    • Whether the pool is full or not.

      The pool filling boolean status.

      -

      Returns boolean

    • get type(): "fixed" | "dynamic"
    • The pool type.

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

      -

      Returns "fixed" | "dynamic"

    • get utilization(): number
    • The approximate pool utilization.

      +

      Returns "fixed" | "dynamic"

    • get utilization(): number
    • The approximate pool utilization.

      Returns number

      The pool utilization.

      -
    • get worker(): "thread" | "cluster"
    • The worker type.

      -

      Returns "thread" | "cluster"

    Methods

    • Adds a task function to this pool. +

    • get worker(): "thread" | "cluster"
    • The worker type.

      +

      Returns "thread" | "cluster"

    Methods

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

    Returns void

    • Hook executed before the worker task execution. +

    Returns void

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

      +

    Returns void

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

      Type Parameters

      • Message

      Parameters

      • workerNodeKey: number

        The worker node key.

      • listener: ((message) => void)

        The message listener callback.

        -
          • (message): void
          • Parameters

            Returns void

      Returns void

    • Terminates the worker node given its worker node key.

      +
        • (message): void
        • Parameters

          Returns void

    Returns void

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

      +

    Returns Promise<void>

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

      +

    Returns void

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

      Parameters

      • Optional data: Data

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

      • Optional name: string

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

      • Optional transferList: TransferListItem[]

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

      Returns Promise<Response>

      Promise that will be fulfilled when the task is completed.

      -
    • Whether the specified task function exists in this pool.

      Parameters

      • name: string

        The name of the task function.

      Returns boolean

      true if the task function exists, false otherwise.

      -
    • Internal

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

      Parameters

      • workerNodeKey: number

        The worker node key.

      Returns boolean

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

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

      Type Parameters

      • Message

      Parameters

      • workerNodeKey: number

        The worker node key.

      • listener: ((message) => void)

        The message listener callback.

        -
          • (message): void
          • Parameters

            Returns void

      Returns void

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

      +
        • (message): void
        • Parameters

          Returns void

    Returns void

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

      Type Parameters

      • Message

      Parameters

      • workerNodeKey: number

        The worker node key.

      • listener: ((message) => void)

        The message listener callback.

        -
          • (message): void
          • Parameters

            Returns void

      Returns void

    • Removes a task function from this pool.

      +
        • (message): void
        • Parameters

          Returns void

    Returns void

    • Removes a task function from this pool.

      Parameters

      • name: string

        The name of the task function.

      Returns Promise<boolean>

      true if the task function was removed, false otherwise.

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

      +

    Returns void

    • Sets the default task function in this pool.

      +

    Returns void

    • Sets the default task function in this pool.

      Parameters

      • name: string

        The name of the task function.

      Returns Promise<boolean>

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

      -
    • Sets the worker choice strategy in this pool.

      +

    Returns void

    • Sets the worker choice strategy in this pool.

      Parameters

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

        The worker choice strategy.

      • Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptions

        The worker choice strategy options.

        -

      Returns void

    • Sets the worker choice strategy options in this pool.

      +

    Returns void

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

    Returns void

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/FixedThreadPool.html b/docs/classes/FixedThreadPool.html index db411369..a5f6c47b 100644 --- a/docs/classes/FixedThreadPool.html +++ b/docs/classes/FixedThreadPool.html @@ -3,7 +3,7 @@

    Since

    0.0.1

    Type Parameters

    • Data = unknown

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

    • Response = unknown

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

      -

    Hierarchy

    Constructors

    Hierarchy

    Constructors

    Properties

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

    Type Parameters

    • Data = unknown

    • Response = unknown

    Parameters

    • numberOfThreads: number

      Number of threads for this pool.

    • filePath: string

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

    • opts: ThreadPoolOptions = {}

      Options for this fixed thread pool.

      -

    Returns FixedThreadPool<Data, Response>

    Properties

    emitter?: EventEmitterAsyncResource

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

    Returns FixedThreadPool<Data, Response>

    Properties

    emitter?: EventEmitterAsyncResource

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

    Events that can currently be listened to:

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

    Path to the worker file.

    -
    max?: number

    Dynamic pool maximum size property placeholder.

    -
    numberOfWorkers: number

    Number of workers that this pool should manage.

    -

    Options for this fixed thread pool.

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

    The task execution response promise map:

    +
    filePath: string

    Path to the worker file.

    +
    max?: number

    Dynamic pool maximum size property placeholder.

    +
    numberOfWorkers: number

    Number of workers that this pool should manage.

    +

    Options for this fixed thread pool.

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

    The task execution response promise map:

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

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

    -
    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>

    Worker choice strategy context referencing a worker choice algorithm implementation.

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

    Pool worker nodes.

    -

    Accessors

    workerChoiceStrategyContext: WorkerChoiceStrategyContext<Worker, Data, Response>

    Worker choice strategy context referencing a worker choice algorithm implementation.

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

    Pool worker nodes.

    +

    Accessors

    • get busy(): boolean
    • Whether the pool is busy or not.

      The pool busyness boolean status.

      -

      Returns boolean

    • get full(): boolean
    • Whether the pool is full or not.

      The pool filling boolean status.

      -

      Returns boolean

    • get type(): "fixed" | "dynamic"
    • The pool type.

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

      -

      Returns "fixed" | "dynamic"

    • get utilization(): number
    • The approximate pool utilization.

      +

      Returns "fixed" | "dynamic"

    • get utilization(): number
    • The approximate pool utilization.

      Returns number

      The pool utilization.

      -
    • get worker(): "thread" | "cluster"
    • The worker type.

      -

      Returns "thread" | "cluster"

    Methods

    • Adds a task function to this pool. +

    • get worker(): "thread" | "cluster"
    • The worker type.

      +

      Returns "thread" | "cluster"

    Methods

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

    Returns void

    • Hook executed before the worker task execution. +

    Returns void

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

      +

    Returns void

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

      Type Parameters

      • Message

      Parameters

      • workerNodeKey: number

        The worker node key.

      • listener: ((message) => void)

        The message listener callback.

        -
          • (message): void
          • Parameters

            Returns void

      Returns void

    • Terminates the worker node given its worker node key.

      +
        • (message): void
        • Parameters

          Returns void

    Returns void

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

      +

    Returns Promise<void>

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

      +

    Returns void

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

      Parameters

      • Optional data: Data

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

      • Optional name: string

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

      • Optional transferList: TransferListItem[]

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

      Returns Promise<Response>

      Promise that will be fulfilled when the task is completed.

      -
    • Whether the specified task function exists in this pool.

      Parameters

      • name: string

        The name of the task function.

      Returns boolean

      true if the task function exists, false otherwise.

      -
    • Internal

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

      Parameters

      • workerNodeKey: number

        The worker node key.

      Returns boolean

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

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

      Type Parameters

      • Message

      Parameters

      • workerNodeKey: number

        The worker node key.

      • listener: ((message) => void)

        The message listener callback.

        -
          • (message): void
          • Parameters

            Returns void

      Returns void

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

      +
        • (message): void
        • Parameters

          Returns void

    Returns void

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

      Type Parameters

      • Message

      Parameters

      • workerNodeKey: number

        The worker node key.

      • listener: ((message) => void)

        The message listener callback.

        -
          • (message): void
          • Parameters

            Returns void

      Returns void

    • Removes a task function from this pool.

      +
        • (message): void
        • Parameters

          Returns void

    Returns void

    • Removes a task function from this pool.

      Parameters

      • name: string

        The name of the task function.

      Returns Promise<boolean>

      true if the task function was removed, false otherwise.

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

      +

    Returns void

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

      Parameters

      • workerNodeKey: number

        The worker node key.

      • message: MessageValue<Data, unknown>

        The message.

      • Optional transferList: TransferListItem[]

        The optional array of transferable objects.

        -

      Returns void

    • Sets the default task function in this pool.

      +

    Returns void

    • Sets the default task function in this pool.

      Parameters

      • name: string

        The name of the task function.

      Returns Promise<boolean>

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

      -
    • Sets the worker choice strategy in this pool.

      +

    Returns void

    • Sets the worker choice strategy in this pool.

      Parameters

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

        The worker choice strategy.

      • Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptions

        The worker choice strategy options.

        -

      Returns void

    • Sets the worker choice strategy options in this pool.

      +

    Returns void

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

    Returns void

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Generated using TypeDoc

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

    Class Node<T>Internal

    Node.

    Type Parameters

    • T

      Type of node data.

      -

    Constructors

    Constructors

    Properties

    Constructors

    Properties

    data: T
    next?: Node<T>
    prev?: Node<T>

    Generated using TypeDoc

    \ No newline at end of file +

    Constructors

    Properties

    data: T
    next?: Node<T>
    prev?: Node<T>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/ThreadWorker.html b/docs/classes/ThreadWorker.html index 316159fc..d21f1245 100644 --- a/docs/classes/ThreadWorker.html +++ b/docs/classes/ThreadWorker.html @@ -7,7 +7,7 @@ but the minimum number of workers will be guaranteed.

    Since

    0.0.1

    Type Parameters

    • Data = unknown

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

    • Response = unknown

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

      -

    Hierarchy

    Constructors

    Hierarchy

    Constructors

    Properties

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

    Constructors

    Properties

    activeInterval?: Timeout

    Handler id of the activeInterval worker activity check.

    -
    isMain: boolean

    Whether this is the main worker or not.

    -
    lastTaskTimestamp: number

    Timestamp of the last task processed by this worker.

    -
    opts: WorkerOptions = DEFAULT_WORKER_OPTIONS

    Options for the worker.

    -
    port?: MessagePort

    Message port used to communicate with the main worker.

    -
    statistics: WorkerStatistics

    Performance statistics computation requirements.

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

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

    -

    Accessors

    Methods

    Returns ThreadWorker<Data, Response>

    Properties

    activeInterval?: Timeout

    Handler id of the activeInterval worker activity check.

    +
    isMain: boolean

    Whether this is the main worker or not.

    +
    lastTaskTimestamp: number

    Timestamp of the last task processed by this worker.

    +
    opts: WorkerOptions = DEFAULT_WORKER_OPTIONS

    Options for the worker.

    +
    port?: MessagePort

    Message port used to communicate with the main worker.

    +
    statistics: WorkerStatistics

    Performance statistics computation requirements.

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

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

    +

    Accessors

    Methods

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

      Parameters

      • error: string | Error

        The error raised by the worker.

      Returns string

      The error message.

      -

    Returns void

    Returns void

    • Runs the given task function asynchronously.

      +

    Returns void

    • Runs the given task function synchronously.

      +

    Returns void

    • Sends a message to main worker.

      +

    Returns void

    Returns void

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/classes/WorkerChoiceStrategyContext.html b/docs/classes/WorkerChoiceStrategyContext.html index 78ca4d65..ec4b2061 100644 --- a/docs/classes/WorkerChoiceStrategyContext.html +++ b/docs/classes/WorkerChoiceStrategyContext.html @@ -2,7 +2,7 @@

    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

    Constructors

    Properties

    Type Parameters

    • Worker extends IWorker

    • Data = unknown

    • Response = unknown

    Parameters

    • pool: IPool<Worker, Data, Response>

      The pool instance.

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

      The worker choice strategy.

    • opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS

      The worker choice strategy options.

      -

    Returns WorkerChoiceStrategyContext<Worker, Data, Response>

    Properties

    opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS

    The worker choice strategy options.

    -
    workerChoiceStrategies: Map<"ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN", IWorkerChoiceStrategy>
    workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN" = WorkerChoiceStrategies.ROUND_ROBIN

    The worker choice strategy.

    -

    Methods

    • Executes the worker choice strategy in the context algorithm.

      +

    Returns WorkerChoiceStrategyContext<Worker, Data, Response>

    Properties

    opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS

    The worker choice strategy options.

    +
    workerChoiceStrategies: Map<"ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN", IWorkerChoiceStrategy>
    workerChoiceStrategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN" = WorkerChoiceStrategies.ROUND_ROBIN

    The worker choice strategy.

    +

    Methods

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

      +

    Returns void

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

      Parameters

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

        The worker choice strategy to set.

        -

      Returns void

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

      +

    Returns void

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/availableParallelism.html b/docs/functions/availableParallelism.html index 79dd6c56..312efb54 100644 --- a/docs/functions/availableParallelism.html +++ b/docs/functions/availableParallelism.html @@ -1,4 +1,4 @@ availableParallelism | poolifier - v3.0.13

    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.

      Returns number

      The host OS optimized maximum pool size.

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/ClusterPoolOptions.html b/docs/interfaces/ClusterPoolOptions.html index abd4906c..15b585cd 100644 --- a/docs/interfaces/ClusterPoolOptions.html +++ b/docs/interfaces/ClusterPoolOptions.html @@ -1,5 +1,5 @@ ClusterPoolOptions | poolifier - v3.0.13

    Interface ClusterPoolOptions

    Options for a poolifier cluster pool.

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

    Hierarchy

    Properties

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

    Hierarchy

    Properties

    Properties

    enableEvents?: boolean

    Pool events integrated with async resource emission.

    Default Value

    true
     
    -
    enableTasksQueue?: boolean

    Pool worker node tasks queue.

    +
    enableTasksQueue?: boolean

    Pool worker node tasks queue.

    Default Value

    false
     
    -
    env?: Record<string, unknown>

    Key/value pairs to add to worker process environment.

    +
    env?: Record<string, unknown>

    Key/value pairs to add to worker process environment.

    errorHandler?: ErrorHandler<Worker>

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

    +
    errorHandler?: ErrorHandler<Worker>

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

    Default Value

    () => {}

    -
    exitHandler?: ExitHandler<Worker>

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

    +
    exitHandler?: ExitHandler<Worker>

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

    Default Value

    () => {}

    -
    messageHandler?: MessageHandler<Worker>

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

    +
    messageHandler?: MessageHandler<Worker>

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

    Default Value

    () => {}

    -
    onlineHandler?: OnlineHandler<Worker>

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

    +
    onlineHandler?: OnlineHandler<Worker>

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

    Default Value

    () => {}

    -
    restartWorkerOnError?: boolean

    Restart worker on error.

    -
    settings?: ClusterSettings

    Cluster settings.

    +
    restartWorkerOnError?: boolean

    Restart worker on error.

    +
    settings?: ClusterSettings

    Cluster settings.

    startWorkers?: boolean

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

    +
    startWorkers?: boolean

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

    Default Value

    true
     
    -
    tasksQueueOptions?: TasksQueueOptions

    Pool worker node tasks queue options.

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

    The worker choice strategy to use in this pool.

    +
    tasksQueueOptions?: TasksQueueOptions

    Pool worker node tasks queue options.

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

    The worker choice strategy to use in this pool.

    Default Value

    WorkerChoiceStrategies.ROUND_ROBIN
     
    -
    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions

    The worker choice strategy options.

    -

    Generated using TypeDoc

    \ No newline at end of file +
    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions

    The worker choice strategy options.

    +

    Generated using TypeDoc

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

    Interface EventLoopUtilizationMeasurementStatisticsInternal

    Event loop utilization measurement statistics.

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

    Properties

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

    Properties

    utilization?: number

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    utilization?: number

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/IPool.html b/docs/interfaces/IPool.html index f662f574..b1419f8b 100644 --- a/docs/interfaces/IPool.html +++ b/docs/interfaces/IPool.html @@ -2,7 +2,7 @@
    interface IPool {
        addTaskFunction: ((name, fn) => Promise<boolean>);
        destroy: (() => Promise<void>);
        emitter?: EventEmitterAsyncResource;
        enableTasksQueue: ((enable, tasksQueueOptions?) => void);
        execute: ((data?, name?, transferList?) => Promise<Response>);
        hasTaskFunction: ((name) => boolean);
        hasWorkerNodeBackPressure: ((workerNodeKey) => boolean);
        info: PoolInfo;
        listTaskFunctionNames: (() => string[]);
        removeTaskFunction: ((name) => Promise<boolean>);
        setDefaultTaskFunction: ((name) => Promise<boolean>);
        setTasksQueueOptions: ((tasksQueueOptions) => void);
        setWorkerChoiceStrategy: ((workerChoiceStrategy, workerChoiceStrategyOptions?) => void);
        setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void);
        start: (() => void);
        workerNodes: IWorkerNode<Worker, Data>[];
    }

    Type Parameters

    • Worker extends IWorker

      Type of worker which manages this pool.

    • Data = unknown

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

    • Response = unknown

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

      -

    Implemented by

    Properties

    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.

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

    Type declaration

      • (): Promise<void>
      • Terminates all workers in this pool.

        -

        Returns Promise<void>

    emitter?: EventEmitterAsyncResource

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

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

    Type declaration

      • (): Promise<void>
      • Terminates all workers in this pool.

        +

        Returns Promise<void>

    emitter?: EventEmitterAsyncResource

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

    Events that can currently be listened to:

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

    Type declaration

      • (enable, tasksQueueOptions?): void
      • Enables/disables the worker node tasks queue in this pool.

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

    Type declaration

      • (enable, tasksQueueOptions?): void
      • Enables/disables the worker node tasks queue in this pool.

        Parameters

        • enable: boolean

          Whether to enable or disable the worker node tasks queue.

        • Optional tasksQueueOptions: TasksQueueOptions

          The worker node tasks queue options.

          -

        Returns void

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

    Type declaration

      • (data?, name?, transferList?): Promise<Response>
      • Executes the specified function in the worker constructor with the task data input parameter.

        +

    Returns void

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

    Type declaration

      • (data?, name?, transferList?): Promise<Response>
      • Executes the specified function in the worker constructor with the task data input parameter.

        Parameters

        • Optional data: Data

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

        • Optional name: string

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

        • Optional transferList: TransferListItem[]

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

        Returns Promise<Response>

        Promise that will be fulfilled when the task is completed.

        -
    hasTaskFunction: ((name) => boolean)

    Type declaration

      • (name): boolean
      • Whether the specified task function exists in this pool.

        +
    hasTaskFunction: ((name) => boolean)

    Type declaration

      • (name): boolean
      • Whether the specified task function exists in this pool.

        Parameters

        • name: string

          The name of the task function.

        Returns boolean

        true if the task function exists, false otherwise.

        -
    hasWorkerNodeBackPressure: ((workerNodeKey) => boolean)

    Type declaration

      • (workerNodeKey): boolean
      • Internal

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

        +
    hasWorkerNodeBackPressure: ((workerNodeKey) => boolean)

    Type declaration

      • (workerNodeKey): boolean
      • Internal

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

        Parameters

        • workerNodeKey: number

          The worker node key.

        Returns boolean

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

        -
    info: PoolInfo

    Pool information.

    -
    listTaskFunctionNames: (() => string[])

    Type declaration

      • (): string[]
      • Lists the names of task function available in this pool.

        +
    info: PoolInfo

    Pool information.

    +
    listTaskFunctionNames: (() => string[])

    Type declaration

      • (): string[]
      • Lists the names of task function available in this pool.

        Returns string[]

        The names of task function available in this pool.

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

    Type declaration

      • (name): Promise<boolean>
      • Removes a task function from this pool.

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

    Type declaration

      • (name): Promise<boolean>
      • Removes a task function from this pool.

        Parameters

        • name: string

          The name of the task function.

        Returns Promise<boolean>

        true if the task function was removed, false otherwise.

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

    Type declaration

      • (name): Promise<boolean>
      • Sets the default task function in this pool.

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

    Type declaration

      • (name): Promise<boolean>
      • Sets the default task function in this pool.

        Parameters

        • name: string

          The name of the task function.

        Returns Promise<boolean>

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

        -
    setTasksQueueOptions: ((tasksQueueOptions) => void)

    Type declaration

      • (tasksQueueOptions): void
      • Sets the worker node tasks queue options in this pool.

        +
    setTasksQueueOptions: ((tasksQueueOptions) => void)

    Type declaration

      • (tasksQueueOptions): void
      • Sets the worker node tasks queue options in this pool.

        Parameters

        Returns void

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

    Type declaration

      • (workerChoiceStrategy, workerChoiceStrategyOptions?): void
      • Sets the worker choice strategy in this pool.

        +

    Returns void

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

    Type declaration

      • (workerChoiceStrategy, workerChoiceStrategyOptions?): void
      • Sets the worker choice strategy in this pool.

        Parameters

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

          The worker choice strategy.

        • Optional workerChoiceStrategyOptions: WorkerChoiceStrategyOptions

          The worker choice strategy options.

          -

        Returns void

    setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)

    Type declaration

      • (workerChoiceStrategyOptions): void
      • Sets the worker choice strategy options in this pool.

        +

    Returns void

    setWorkerChoiceStrategyOptions: ((workerChoiceStrategyOptions) => void)

    Type declaration

      • (workerChoiceStrategyOptions): void
      • Sets the worker choice strategy options in this pool.

        Parameters

        Returns void

    start: (() => void)

    Type declaration

      • (): void
      • Starts the minimum number of workers in this pool.

        -

        Returns void

    workerNodes: IWorkerNode<Worker, Data>[]

    Pool worker nodes.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    start: (() => void)

    Type declaration

      • (): void
      • Starts the minimum number of workers in this pool.

        +

        Returns void

    workerNodes: IWorkerNode<Worker, Data>[]

    Pool worker nodes.

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/IWorker.html b/docs/interfaces/IWorker.html index 9a3aa83b..17fbca2e 100644 --- a/docs/interfaces/IWorker.html +++ b/docs/interfaces/IWorker.html @@ -1,13 +1,13 @@ IWorker | poolifier - v3.0.13

    Interface IWorker

    Worker interface.

    -
    interface IWorker {
        id?: number;
        on: ((event, handler) => void) & ((event, handler) => void) & ((event, handler) => void) & ((event, handler) => void);
        once: ((event, handler) => void);
        threadId?: number;
    }

    Properties

    id? +
    interface IWorker {
        id?: number;
        on: ((event, handler) => void) & ((event, handler) => void) & ((event, handler) => void) & ((event, handler) => void);
        once: ((event, handler) => void);
        threadId?: number;
    }

    Properties

    Properties

    id?: number

    Worker id.

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

    Registers an event listener.

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

    Registers an event listener.

    Type declaration

    Type declaration

    Type declaration

    Type declaration

    Param: event

    The event.

    Param: handler

    The event handler.

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

    Type declaration

      • (event, handler): void
      • Registers a listener to the exit event that will only be performed once.

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

    Type declaration

      • (event, handler): void
      • Registers a listener to the exit event that will only be performed once.

        Parameters

        Returns void

    threadId?: number

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    threadId?: number

    Generated using TypeDoc

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

    Interface IWorkerChoiceStrategyInternal

    Worker choice strategy interface.

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

    Properties

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

    Properties

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

    Returns undefined | number

    The worker node key or undefined.

    -
    hasPoolWorkerNodesReady: (() => boolean)

    Type declaration

      • (): boolean
      • Whether the pool has worker nodes ready or not.

        +
    hasPoolWorkerNodesReady: (() => boolean)

    Type declaration

      • (): boolean
      • Whether the pool has worker nodes ready or not.

        Returns boolean

        Whether the pool has worker nodes ready or not.

        -
    remove: ((workerNodeKey) => boolean)

    Type declaration

      • (workerNodeKey): boolean
      • Removes the worker node key from strategy internals.

        +
    remove: ((workerNodeKey) => boolean)

    Type declaration

      • (workerNodeKey): boolean
      • Removes the worker node key from strategy internals.

        Parameters

        • workerNodeKey: number

          The worker node key.

        Returns boolean

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

        -
    reset: (() => boolean)

    Type declaration

      • (): boolean
      • Resets strategy internals.

        +
    reset: (() => boolean)

    Type declaration

      • (): boolean
      • Resets strategy internals.

        Returns boolean

        true if the reset is successful, false otherwise.

        -
    setOptions: ((opts) => void)

    Type declaration

      • (opts): void
      • Sets the worker choice strategy options.

        +
    setOptions: ((opts) => void)

    Type declaration

      • (opts): void
      • Sets the worker choice strategy options.

        Parameters

        Returns void

    strategyPolicy: StrategyPolicy

    Strategy policy.

    -
    taskStatisticsRequirements: TaskStatisticsRequirements

    Tasks statistics requirements.

    -
    update: ((workerNodeKey) => boolean)

    Type declaration

      • (workerNodeKey): boolean
      • Updates the worker node key strategy internals. +

    Returns void

    strategyPolicy: StrategyPolicy

    Strategy policy.

    +
    taskStatisticsRequirements: TaskStatisticsRequirements

    Tasks statistics requirements.

    +
    update: ((workerNodeKey) => boolean)

    Type declaration

      • (workerNodeKey): boolean
      • Updates the worker node key strategy internals. This is called after a task has been executed on a worker node.

        Parameters

        • workerNodeKey: number

        Returns boolean

        true if the update is successful, false otherwise.

        -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

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

    Interface IWorkerNode<Worker, Data>Internal

    Worker node interface.

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

    Type Parameters

    • Worker extends IWorker

      Type of worker.

    • Data = unknown

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

      -

    Hierarchy

    • EventEmitter
      • IWorkerNode

    Properties

    Hierarchy

    • EventEmitter
      • IWorkerNode

    Properties

    clearTasksQueue: (() => void)

    Type declaration

      • (): void
      • Clears tasks queue.

        -

        Returns void

    closeChannel: (() => void)

    Type declaration

      • (): void
      • Closes communication channel.

        -

        Returns void

    deleteTaskFunctionWorkerUsage: ((name) => boolean)

    Type declaration

      • (name): boolean
      • Deletes task function worker usage statistics.

        +

        Returns void

    closeChannel: (() => void)

    Type declaration

      • (): void
      • Closes communication channel.

        +

        Returns void

    deleteTaskFunctionWorkerUsage: ((name) => boolean)

    Type declaration

      • (name): boolean
      • Deletes task function worker usage statistics.

        Parameters

        • name: string

          The task function name.

        Returns boolean

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

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

    Type declaration

      • (): undefined | Task<Data>
      • Dequeue task.

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

    Type declaration

      • (): undefined | Task<Data>
      • Dequeue task.

        Returns undefined | Task<Data>

        The dequeued task.

        -
    enqueueTask: ((task) => number)

    Type declaration

      • (task): number
      • Enqueue task.

        +
    enqueueTask: ((task) => number)

    Type declaration

      • (task): number
      • Enqueue task.

        Parameters

        • task: Task<Data>

          The task to queue.

        Returns number

        The tasks queue size.

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

    Type declaration

      • (name): undefined | WorkerUsage
      • Gets task function worker usage statistics.

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

    Type declaration

      • (name): undefined | WorkerUsage
      • Gets task function worker usage statistics.

        Parameters

        • name: string

          The task function name.

        Returns undefined | WorkerUsage

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

        -
    hasBackPressure: (() => boolean)

    Type declaration

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

        +
    hasBackPressure: (() => boolean)

    Type declaration

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

        Returns boolean

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

        -

    Worker info.

    -
    messageChannel?: MessageChannel

    Message channel (worker_threads only).

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

    Type declaration

      • (): undefined | Task<Data>
      • Pops a task from the tasks queue.

        +

    Worker info.

    +
    messageChannel?: MessageChannel

    Message channel (worker_threads only).

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

    Type declaration

      • (): undefined | Task<Data>
      • Pops a task from the tasks queue.

        Returns undefined | Task<Data>

        The popped task.

        -
    resetUsage: (() => void)

    Type declaration

      • (): void
      • Resets usage statistics.

        -

        Returns void

    strategyData?: StrategyData

    Worker choice strategy data. +

    resetUsage: (() => void)

    Type declaration

      • (): void
      • Resets usage statistics.

        +

        Returns void

    strategyData?: StrategyData

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

    -
    tasksQueueBackPressureSize: number

    Tasks queue back pressure size. +

    tasksQueueBackPressureSize: number

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

    -
    tasksQueueSize: (() => number)

    Type declaration

    tasksQueueSize: (() => number)

    Type declaration

      • (): number
      • Tasks queue size.

        Returns number

        The tasks queue size.

        -
    unshiftTask: ((task) => number)

    Type declaration

      • (task): number
      • Prepends a task to the tasks queue.

        +
    unshiftTask: ((task) => number)

    Type declaration

      • (task): number
      • Prepends a task to the tasks queue.

        Parameters

        • task: Task<Data>

          The task to prepend.

        Returns number

        The tasks queue size.

        -

    Worker usage statistics.

    -
    worker: Worker

    Worker.

    -

    Methods

    • Parameters

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

      Returns void

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

      +

    Worker usage statistics.

    +
    worker: Worker

    Worker.

    +

    Methods

    • Parameters

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

      Returns void

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

      Parameters

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

            • Rest ...args: any[]

            Returns void

      Returns IWorkerNode<Worker, Data>

      Since

      v0.1.26

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/MeasurementStatistics.html b/docs/interfaces/MeasurementStatistics.html index 0a143dec..6e0b4240 100644 --- a/docs/interfaces/MeasurementStatistics.html +++ b/docs/interfaces/MeasurementStatistics.html @@ -1,14 +1,14 @@ MeasurementStatistics | poolifier - v3.0.13

    Interface MeasurementStatisticsInternal

    Measurement statistics.

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

    Properties

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

    Properties

    aggregate?: number

    Measurement aggregate.

    -
    average?: number

    Measurement average.

    -
    history: CircularArray<number>

    Measurement history.

    -
    maximum?: number

    Measurement maximum.

    -
    median?: number

    Measurement median.

    -
    minimum?: number

    Measurement minimum.

    -

    Generated using TypeDoc

    \ No newline at end of file +
    average?: number

    Measurement average.

    +
    history: CircularArray<number>

    Measurement history.

    +
    maximum?: number

    Measurement maximum.

    +
    median?: number

    Measurement median.

    +
    minimum?: number

    Measurement minimum.

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/MeasurementStatisticsRequirements.html b/docs/interfaces/MeasurementStatisticsRequirements.html index 9b70f109..3f95a61a 100644 --- a/docs/interfaces/MeasurementStatisticsRequirements.html +++ b/docs/interfaces/MeasurementStatisticsRequirements.html @@ -1,8 +1,8 @@ MeasurementStatisticsRequirements | poolifier - v3.0.13

    Interface MeasurementStatisticsRequirementsInternal

    Measurement statistics requirements.

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

    Properties

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

    Properties

    aggregate: boolean

    Requires measurement aggregate.

    -
    average: boolean

    Requires measurement average.

    -
    median: boolean

    Requires measurement median.

    -

    Generated using TypeDoc

    \ No newline at end of file +
    average: boolean

    Requires measurement average.

    +
    median: boolean

    Requires measurement median.

    +

    Generated using TypeDoc

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

    Interface MessageValue<Data, ErrorData>Internal

    Message object that is passed between main worker and worker.

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

    Type Parameters

    • Data = unknown

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

    • ErrorData = unknown

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

      -

    Hierarchy

    • Task<Data>
      • MessageValue

    Properties

    Hierarchy

    • Task<Data>
      • MessageValue

    Properties

    Properties

    checkActive?: boolean

    Whether the worker starts or stops its activity check.

    -
    data?: Data

    Task input data that will be passed to the worker.

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

    Kill code.

    -
    name?: string

    Task name.

    -
    port?: MessagePort

    Message port.

    -
    ready?: boolean

    Whether the worker is ready or not.

    -
    statistics?: WorkerStatistics

    Whether the worker computes the given statistics or not.

    -
    taskFunction?: string

    Task function serialized to string.

    -
    taskFunctionName?: string

    Task function name.

    -
    taskFunctionNames?: string[]

    Task function names.

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

    Task function operation:

    +
    data?: Data

    Task input data that will be passed to the worker.

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

    Kill code.

    +
    name?: string

    Task name.

    +
    port?: MessagePort

    Message port.

    +
    ready?: boolean

    Whether the worker is ready or not.

    +
    statistics?: WorkerStatistics

    Whether the worker computes the given statistics or not.

    +
    taskFunction?: string

    Task function serialized to string.

    +
    taskFunctionName?: string

    Task function name.

    +
    taskFunctionNames?: string[]

    Task function names.

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

    Task function operation:

    • 'add' - Add a task function.
    • 'remove' - Remove a task function.
    • 'default' - Set a task function as default.
    -
    taskFunctionOperationStatus?: boolean

    Whether the task function operation is successful or not.

    -
    taskId?: string

    Task UUID.

    -
    taskPerformance?: TaskPerformance

    Task performance.

    -
    timestamp?: number

    Timestamp.

    -
    transferList?: TransferListItem[]

    Array of transferable objects.

    -
    workerError?: WorkerError<ErrorData>

    Worker error.

    -
    workerId?: number

    Worker id.

    -

    Generated using TypeDoc

    \ No newline at end of file +
    taskFunctionOperationStatus?: boolean

    Whether the task function operation is successful or not.

    +
    taskId?: string

    Task UUID.

    +
    taskPerformance?: TaskPerformance

    Task performance.

    +
    timestamp?: number

    Timestamp.

    +
    transferList?: TransferListItem[]

    Array of transferable objects.

    +
    workerError?: WorkerError<ErrorData>

    Worker error.

    +
    workerId?: number

    Worker id.

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/PoolInfo.html b/docs/interfaces/PoolInfo.html index 564362d6..c4bb1201 100644 --- a/docs/interfaces/PoolInfo.html +++ b/docs/interfaces/PoolInfo.html @@ -1,5 +1,5 @@ PoolInfo | poolifier - v3.0.13

    Interface PoolInfo

    Pool information.

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

    Properties

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

    Properties

    backPressure?: boolean
    busyWorkerNodes: number

    Pool busy worker nodes.

    -
    executedTasks: number
    executingTasks: number
    failedTasks: number
    idleWorkerNodes: number

    Pool idle worker nodes.

    -
    maxQueuedTasks?: number
    maxSize: number
    minSize: number
    queuedTasks?: number
    ready: boolean
    runTime?: {
        average?: number;
        maximum: number;
        median?: number;
        minimum: number;
    }

    Type declaration

    • Optional Readonly average?: number
    • Readonly maximum: number
    • Optional Readonly median?: number
    • Readonly minimum: number
    started: boolean
    stolenTasks?: number
    strategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
    type: "fixed" | "dynamic"
    utilization?: number

    Pool utilization.

    -
    version: string
    waitTime?: {
        average?: number;
        maximum: number;
        median?: number;
        minimum: number;
    }

    Type declaration

    • Optional Readonly average?: number
    • Readonly maximum: number
    • Optional Readonly median?: number
    • Readonly minimum: number
    worker: "thread" | "cluster"
    workerNodes: number

    Pool total worker nodes.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    backPressure?: boolean
    busyWorkerNodes: number

    Pool busy worker nodes.

    +
    executedTasks: number
    executingTasks: number
    failedTasks: number
    idleWorkerNodes: number

    Pool idle worker nodes.

    +
    maxQueuedTasks?: number
    maxSize: number
    minSize: number
    queuedTasks?: number
    ready: boolean
    runTime?: {
        average?: number;
        maximum: number;
        median?: number;
        minimum: number;
    }

    Type declaration

    • Optional Readonly average?: number
    • Readonly maximum: number
    • Optional Readonly median?: number
    • Readonly minimum: number
    started: boolean
    stolenTasks?: number
    strategy: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
    type: "fixed" | "dynamic"
    utilization?: number

    Pool utilization.

    +
    version: string
    waitTime?: {
        average?: number;
        maximum: number;
        median?: number;
        minimum: number;
    }

    Type declaration

    • Optional Readonly average?: number
    • Readonly maximum: number
    • Optional Readonly median?: number
    • Readonly minimum: number
    worker: "thread" | "cluster"
    workerNodes: number

    Pool total worker nodes.

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/PoolOptions.html b/docs/interfaces/PoolOptions.html index 5d1f070d..6060dcf9 100644 --- a/docs/interfaces/PoolOptions.html +++ b/docs/interfaces/PoolOptions.html @@ -1,6 +1,6 @@ PoolOptions | poolifier - v3.0.13

    Interface PoolOptions<Worker>

    Options for a poolifier pool.

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

    Type Parameters

    • Worker extends IWorker

      Type of worker.

      -

    Hierarchy

    Properties

    Hierarchy

    Properties

    enableEvents?: boolean

    Pool events integrated with async resource emission.

    Default Value

    true
     
    -
    enableTasksQueue?: boolean

    Pool worker node tasks queue.

    +
    enableTasksQueue?: boolean

    Pool worker node tasks queue.

    Default Value

    false
     
    -
    errorHandler?: ErrorHandler<Worker>

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

    +
    errorHandler?: ErrorHandler<Worker>

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

    Default Value

    () => {}

    -
    exitHandler?: ExitHandler<Worker>

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

    +
    exitHandler?: ExitHandler<Worker>

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

    Default Value

    () => {}

    -
    messageHandler?: MessageHandler<Worker>

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

    +
    messageHandler?: MessageHandler<Worker>

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

    Default Value

    () => {}

    -
    onlineHandler?: OnlineHandler<Worker>

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

    +
    onlineHandler?: OnlineHandler<Worker>

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

    Default Value

    () => {}

    -
    restartWorkerOnError?: boolean

    Restart worker on error.

    -
    startWorkers?: boolean

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

    +
    restartWorkerOnError?: boolean

    Restart worker on error.

    +
    startWorkers?: boolean

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

    Default Value

    true
     
    -
    tasksQueueOptions?: TasksQueueOptions

    Pool worker node tasks queue options.

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

    The worker choice strategy to use in this pool.

    +
    tasksQueueOptions?: TasksQueueOptions

    Pool worker node tasks queue options.

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

    The worker choice strategy to use in this pool.

    Default Value

    WorkerChoiceStrategies.ROUND_ROBIN
     
    -
    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions

    The worker choice strategy options.

    -

    Generated using TypeDoc

    \ No newline at end of file +
    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions

    The worker choice strategy options.

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/PromiseResponseWrapper.html b/docs/interfaces/PromiseResponseWrapper.html index b9f94e5a..76c1fb93 100644 --- a/docs/interfaces/PromiseResponseWrapper.html +++ b/docs/interfaces/PromiseResponseWrapper.html @@ -1,11 +1,11 @@ PromiseResponseWrapper | poolifier - v3.0.13

    Interface PromiseResponseWrapper<Response>Internal

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

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

    Type Parameters

    • Response = unknown

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

      -

    Properties

    Properties

    asyncResource?: AsyncResource

    The asynchronous resource used to track the task execution.

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

    Type declaration

      • (reason?): void
      • Reject callback to reject the promise.

        -

        Parameters

        • Optional reason: unknown

        Returns void

    resolve: ((value) => void)

    Type declaration

      • (value): void
      • Resolve callback to fulfill the promise.

        -

        Parameters

        • value: Response | PromiseLike<Response>

        Returns void

    workerNodeKey: number

    The worker node key executing the task.

    -

    Generated using TypeDoc

    \ No newline at end of file +
    reject: ((reason?) => void)

    Type declaration

      • (reason?): void
      • Reject callback to reject the promise.

        +

        Parameters

        • Optional reason: unknown

        Returns void

    resolve: ((value) => void)

    Type declaration

      • (value): void
      • Resolve callback to fulfill the promise.

        +

        Parameters

        • value: Response | PromiseLike<Response>

        Returns void

    workerNodeKey: number

    The worker node key executing the task.

    +

    Generated using TypeDoc

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

    Generated using TypeDoc

    \ No newline at end of file +
    interface StrategyData {
        virtualTaskEndTimestamp?: number;
    }

    Properties

    virtualTaskEndTimestamp?: number

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/StrategyPolicy.html b/docs/interfaces/StrategyPolicy.html index 8605a186..a32d3195 100644 --- a/docs/interfaces/StrategyPolicy.html +++ b/docs/interfaces/StrategyPolicy.html @@ -1,6 +1,6 @@ StrategyPolicy | poolifier - v3.0.13

    Interface StrategyPolicyInternal

    Strategy policy.

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

    Properties

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

    Properties

    dynamicWorkerReady: boolean

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

    -
    dynamicWorkerUsage: boolean

    Expects tasks execution on the newly created dynamic worker.

    -

    Generated using TypeDoc

    \ No newline at end of file +
    dynamicWorkerUsage: boolean

    Expects tasks execution on the newly created dynamic worker.

    +

    Generated using TypeDoc

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

    Interface Task<Data>Internal

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

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

    Type Parameters

    • Data = unknown

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

      -

    Hierarchy

    Properties

    Hierarchy

    Properties

    data?: Data

    Task input data that will be passed to the worker.

    -
    name?: string

    Task name.

    -
    taskId?: string

    Task UUID.

    -
    timestamp?: number

    Timestamp.

    -
    transferList?: TransferListItem[]

    Array of transferable objects.

    -

    Generated using TypeDoc

    \ No newline at end of file +
    name?: string

    Task name.

    +
    taskId?: string

    Task UUID.

    +
    timestamp?: number

    Timestamp.

    +
    transferList?: TransferListItem[]

    Array of transferable objects.

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/TaskFunctionOperationResult.html b/docs/interfaces/TaskFunctionOperationResult.html index 02a2318f..543349e1 100644 --- a/docs/interfaces/TaskFunctionOperationResult.html +++ b/docs/interfaces/TaskFunctionOperationResult.html @@ -1,4 +1,4 @@ TaskFunctionOperationResult | poolifier - v3.0.13

    Interface TaskFunctionOperationResult

    Task function operation result.

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

    Properties

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

    Properties

    Properties

    error?: Error
    status: boolean

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    error?: Error
    status: boolean

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/TaskPerformance.html b/docs/interfaces/TaskPerformance.html index c94af285..8b7c2c09 100644 --- a/docs/interfaces/TaskPerformance.html +++ b/docs/interfaces/TaskPerformance.html @@ -1,10 +1,10 @@ TaskPerformance | poolifier - v3.0.13

    Interface TaskPerformanceInternal

    Task performance.

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

    Properties

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

    Properties

    elu?: EventLoopUtilization

    Task event loop utilization.

    -
    name: string

    Task name.

    -
    runTime?: number

    Task runtime.

    -
    timestamp: number

    Task performance timestamp.

    -

    Generated using TypeDoc

    \ No newline at end of file +
    name: string

    Task name.

    +
    runTime?: number

    Task runtime.

    +
    timestamp: number

    Task performance timestamp.

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/TaskStatistics.html b/docs/interfaces/TaskStatistics.html index b5af4677..2ee44223 100644 --- a/docs/interfaces/TaskStatistics.html +++ b/docs/interfaces/TaskStatistics.html @@ -1,5 +1,5 @@ TaskStatistics | poolifier - v3.0.13

    Interface TaskStatisticsInternal

    Task statistics.

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

    Properties

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

    Properties

    executed: number

    Number of executed tasks.

    -
    executing: number

    Number of executing tasks.

    -
    failed: number

    Number of failed tasks.

    -
    maxQueued?: number

    Maximum number of queued tasks.

    -
    queued: number

    Number of queued tasks.

    -
    sequentiallyStolen: number

    Number of sequentially stolen tasks.

    -
    stolen: number

    Number of stolen tasks.

    -

    Generated using TypeDoc

    \ No newline at end of file +
    executing: number

    Number of executing tasks.

    +
    failed: number

    Number of failed tasks.

    +
    maxQueued?: number

    Maximum number of queued tasks.

    +
    queued: number

    Number of queued tasks.

    +
    sequentiallyStolen: number

    Number of sequentially stolen tasks.

    +
    stolen: number

    Number of stolen tasks.

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/TaskStatisticsRequirements.html b/docs/interfaces/TaskStatisticsRequirements.html index e6c3ea7d..990a8adb 100644 --- a/docs/interfaces/TaskStatisticsRequirements.html +++ b/docs/interfaces/TaskStatisticsRequirements.html @@ -1,8 +1,8 @@ TaskStatisticsRequirements | poolifier - v3.0.13

    Interface TaskStatisticsRequirementsInternal

    Pool worker node worker usage statistics requirements.

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

    Properties

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

    Properties

    Properties

    Tasks event loop utilization requirements.

    -

    Tasks runtime requirements.

    -

    Tasks wait time requirements.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Tasks runtime requirements.

    +

    Tasks wait time requirements.

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/TasksQueueOptions.html b/docs/interfaces/TasksQueueOptions.html index 32b2d31b..fb170381 100644 --- a/docs/interfaces/TasksQueueOptions.html +++ b/docs/interfaces/TasksQueueOptions.html @@ -1,18 +1,18 @@ TasksQueueOptions | poolifier - v3.0.13

    Interface TasksQueueOptions

    Worker node tasks queue options.

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

    Properties

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

    Properties

    concurrency?: number

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

    Default Value

    1
     
    -
    size?: number

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

    +
    size?: number

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

    Default Value

    (pool maximum size)^2
     
    -
    taskStealing?: boolean

    Whether to enable task stealing on idle.

    +
    taskStealing?: boolean

    Whether to enable task stealing on idle.

    Default Value

    true
     
    -
    tasksStealingOnBackPressure?: boolean

    Whether to enable tasks stealing under back pressure.

    +
    tasksStealingOnBackPressure?: boolean

    Whether to enable tasks stealing under back pressure.

    Default Value

    true
     
    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/ThreadPoolOptions.html b/docs/interfaces/ThreadPoolOptions.html index bdc076ea..60c8b917 100644 --- a/docs/interfaces/ThreadPoolOptions.html +++ b/docs/interfaces/ThreadPoolOptions.html @@ -1,5 +1,5 @@ ThreadPoolOptions | poolifier - v3.0.13

    Interface ThreadPoolOptions

    Options for a poolifier thread pool.

    -
    interface ThreadPoolOptions {
        enableEvents?: boolean;
        enableTasksQueue?: boolean;
        errorHandler?: ErrorHandler<Worker>;
        exitHandler?: ExitHandler<Worker>;
        messageHandler?: MessageHandler<Worker>;
        onlineHandler?: OnlineHandler<Worker>;
        restartWorkerOnError?: boolean;
        startWorkers?: boolean;
        tasksQueueOptions?: TasksQueueOptions;
        workerChoiceStrategy?: "ROUND_ROBIN" | "LEAST_USED" | "LEAST_BUSY" | "LEAST_ELU" | "FAIR_SHARE" | "WEIGHTED_ROUND_ROBIN" | "INTERLEAVED_WEIGHTED_ROUND_ROBIN";
        workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions;
        workerOptions?: WorkerOptions;
    }

    Hierarchy

    Properties

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

    Hierarchy

    Properties

    enableEvents?: boolean

    Pool events integrated with async resource emission.

    Default Value

    true
     
    -
    enableTasksQueue?: boolean

    Pool worker node tasks queue.

    +
    enableTasksQueue?: boolean

    Pool worker node tasks queue.

    Default Value

    false
     
    -
    errorHandler?: ErrorHandler<Worker>

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

    +
    errorHandler?: ErrorHandler<Worker>

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

    Default Value

    () => {}

    -
    exitHandler?: ExitHandler<Worker>

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

    +
    exitHandler?: ExitHandler<Worker>

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

    Default Value

    () => {}

    -
    messageHandler?: MessageHandler<Worker>

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

    +
    messageHandler?: MessageHandler<Worker>

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

    Default Value

    () => {}

    -
    onlineHandler?: OnlineHandler<Worker>

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

    +
    onlineHandler?: OnlineHandler<Worker>

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

    Default Value

    () => {}

    -
    restartWorkerOnError?: boolean

    Restart worker on error.

    -
    startWorkers?: boolean

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

    +
    restartWorkerOnError?: boolean

    Restart worker on error.

    +
    startWorkers?: boolean

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

    Default Value

    true
     
    -
    tasksQueueOptions?: TasksQueueOptions

    Pool worker node tasks queue options.

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

    The worker choice strategy to use in this pool.

    +
    tasksQueueOptions?: TasksQueueOptions

    Pool worker node tasks queue options.

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

    The worker choice strategy to use in this pool.

    Default Value

    WorkerChoiceStrategies.ROUND_ROBIN
     
    -
    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions

    The worker choice strategy options.

    -
    workerOptions?: WorkerOptions

    Worker options.

    +
    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions

    The worker choice strategy options.

    +
    workerOptions?: WorkerOptions

    Worker options.

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

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

    Interface WorkerChoiceStrategyOptions

    Worker choice strategy options.

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

    Properties

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

    Properties

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

    Properties

    Event loop utilization options.

    Default Value

    { median: false }
     
    -
    measurement?: "runTime" | "waitTime" | "elu"

    Measurement to use in worker choice strategy supporting it.

    -
    retries?: number

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

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

    Measurement to use in worker choice strategy supporting it.

    +
    retries?: number

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

    Default Value

    6
     
    -

    Runtime options.

    +

    Runtime options.

    Default Value

    { median: false }
     
    -

    Wait time options.

    +

    Wait time options.

    Default Value

    { median: false }
     
    -
    weights?: Record<number, number>

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

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

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/WorkerError.html b/docs/interfaces/WorkerError.html index aac45277..381acdf4 100644 --- a/docs/interfaces/WorkerError.html +++ b/docs/interfaces/WorkerError.html @@ -1,9 +1,9 @@ WorkerError | poolifier - v3.0.13

    Interface WorkerError<Data>

    Worker error.

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

    Type Parameters

    • Data = unknown

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

      -

    Properties

    Properties

    Properties

    data?: Data

    Data triggering the error.

    -
    message: string

    Error message.

    -
    name: string

    Task function name triggering the error.

    -

    Generated using TypeDoc

    \ No newline at end of file +
    message: string

    Error message.

    +
    name: string

    Task function name triggering the error.

    +

    Generated using TypeDoc

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

    Interface WorkerInfoInternal

    Worker information.

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

    Properties

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

    Properties

    dynamic: boolean

    Dynamic flag.

    -
    id: undefined | number

    Worker id.

    -
    ready: boolean

    Ready flag.

    -
    taskFunctionNames?: string[]

    Task function names.

    -
    type: "thread" | "cluster"

    Worker type.

    -

    Generated using TypeDoc

    \ No newline at end of file +
    id: undefined | number

    Worker id.

    +
    ready: boolean

    Ready flag.

    +
    taskFunctionNames?: string[]

    Task function names.

    +
    type: "thread" | "cluster"

    Worker type.

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/WorkerNodeEventDetail.html b/docs/interfaces/WorkerNodeEventDetail.html index b9455882..5a0a1921 100644 --- a/docs/interfaces/WorkerNodeEventDetail.html +++ b/docs/interfaces/WorkerNodeEventDetail.html @@ -1,4 +1,4 @@ WorkerNodeEventDetail | poolifier - v3.0.13

    Interface WorkerNodeEventDetailInternal

    Worker node event detail.

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

    Properties

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

    Properties

    workerId: number
    workerNodeKey?: number

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    workerId: number
    workerNodeKey?: number

    Generated using TypeDoc

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

    Interface WorkerOptions

    Options for workers.

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

    Properties

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

    Properties

    killBehavior?: "SOFT" | "HARD"

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

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

    This option only apply to the newly created workers.

    Default Value

    KillBehaviors.SOFT
     
    -
    killHandler?: KillHandler

    The function to call when a worker is killed.

    +
    killHandler?: KillHandler

    The function to call when a worker is killed.

    Default Value

    () => {}

    -
    maxInactiveTime?: number

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

    +
    maxInactiveTime?: number

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

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

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

    Default Value

    60000
     
    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/WorkerStatistics.html b/docs/interfaces/WorkerStatistics.html index 547f96c0..b38cca3c 100644 --- a/docs/interfaces/WorkerStatistics.html +++ b/docs/interfaces/WorkerStatistics.html @@ -1,6 +1,6 @@ WorkerStatistics | poolifier - v3.0.13

    Interface WorkerStatisticsInternal

    Worker task performance statistics computation settings.

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

    Properties

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

    Properties

    Properties

    elu: boolean

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

    -
    runTime: boolean

    Whether the worker computes the task runtime or not.

    -

    Generated using TypeDoc

    \ No newline at end of file +
    runTime: boolean

    Whether the worker computes the task runtime or not.

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/WorkerUsage.html b/docs/interfaces/WorkerUsage.html index 5c292257..56dfa7ec 100644 --- a/docs/interfaces/WorkerUsage.html +++ b/docs/interfaces/WorkerUsage.html @@ -1,10 +1,10 @@ WorkerUsage | poolifier - v3.0.13

    Interface WorkerUsageInternal

    Worker usage statistics.

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

    Properties

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

    Properties

    Tasks event loop utilization statistics.

    -

    Tasks runtime statistics.

    -

    Tasks statistics.

    -

    Tasks wait time statistics.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Tasks runtime statistics.

    +

    Tasks statistics.

    +

    Tasks wait time statistics.

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/ErrorHandler.html b/docs/types/ErrorHandler.html index 3081ebc2..256cbf8f 100644 --- a/docs/types/ErrorHandler.html +++ b/docs/types/ErrorHandler.html @@ -1,3 +1,3 @@ ErrorHandler | poolifier - v3.0.13

    Type alias ErrorHandler<Worker>

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

    Type Parameters

    • Worker extends IWorker

      Type of worker.

    Type declaration

      • (this, error): void
      • Callback invoked if the worker raised an error.

        -

        Parameters

        • this: Worker
        • error: Error

        Returns void

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • this: Worker
    • error: Error

    Returns void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/ExitHandler.html b/docs/types/ExitHandler.html index 48b075b7..719829c0 100644 --- a/docs/types/ExitHandler.html +++ b/docs/types/ExitHandler.html @@ -1,3 +1,3 @@ ExitHandler | poolifier - v3.0.13

    Type alias ExitHandler<Worker>

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

    Type Parameters

    • Worker extends IWorker

      Type of worker.

    Type declaration

      • (this, exitCode): void
      • Callback invoked when the worker exits successfully.

        -

        Parameters

        • this: Worker
        • exitCode: number

        Returns void

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • this: Worker
    • exitCode: number

    Returns void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/KillBehavior.html b/docs/types/KillBehavior.html index d73a2394..12fa1d25 100644 --- a/docs/types/KillBehavior.html +++ b/docs/types/KillBehavior.html @@ -1,2 +1,2 @@ KillBehavior | poolifier - v3.0.13

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/KillHandler.html b/docs/types/KillHandler.html index 538d37ab..b722d5e0 100644 --- a/docs/types/KillHandler.html +++ b/docs/types/KillHandler.html @@ -1,2 +1,2 @@ KillHandler | poolifier - v3.0.13

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void | Promise<void>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/Measurement.html b/docs/types/Measurement.html index c083c948..0b6288b2 100644 --- a/docs/types/Measurement.html +++ b/docs/types/Measurement.html @@ -1,2 +1,2 @@ Measurement | poolifier - v3.0.13

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/MessageHandler.html b/docs/types/MessageHandler.html index 548cd2fe..0e40efd6 100644 --- a/docs/types/MessageHandler.html +++ b/docs/types/MessageHandler.html @@ -1,3 +1,3 @@ MessageHandler | poolifier - v3.0.13

    Type alias MessageHandler<Worker>

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

    Type Parameters

    • Worker extends IWorker

      Type of worker.

    Type declaration

      • (this, message): void
      • Callback invoked if the worker has received a message.

        -

        Parameters

        • this: Worker
        • message: unknown

        Returns void

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • this: Worker
    • message: unknown

    Returns void

    Generated using TypeDoc

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

    Type alias OnlineHandler<Worker>

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

    Type Parameters

    • Worker extends IWorker

      Type of worker.

    Type declaration

      • (this): void
      • Callback invoked when the worker has started successfully.

        -

        Parameters

        • this: Worker

        Returns void

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    • this: Worker

    Returns void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/PoolEvent.html b/docs/types/PoolEvent.html index 30b3fb07..dea289d5 100644 --- a/docs/types/PoolEvent.html +++ b/docs/types/PoolEvent.html @@ -1,2 +1,2 @@ PoolEvent | poolifier - v3.0.13

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

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

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/TaskAsyncFunction.html b/docs/types/TaskAsyncFunction.html index b379fcbf..de773722 100644 --- a/docs/types/TaskAsyncFunction.html +++ b/docs/types/TaskAsyncFunction.html @@ -3,4 +3,4 @@

    Type declaration

      • (data?): Promise<Response>
      • Task asynchronous function that can be executed. This function must return a promise.

        Parameters

        • Optional data: Data

          Data sent to the worker.

          -

        Returns Promise<Response>

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Promise<Response>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/TaskFunction.html b/docs/types/TaskFunction.html index 16cc9afd..4dec2b58 100644 --- a/docs/types/TaskFunction.html +++ b/docs/types/TaskFunction.html @@ -2,4 +2,4 @@ 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.

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/TaskFunctions.html b/docs/types/TaskFunctions.html index 1eb73764..3a7f1bdc 100644 --- a/docs/types/TaskFunctions.html +++ b/docs/types/TaskFunctions.html @@ -4,4 +4,4 @@ The key is the name of the function. The value is the function itself.

    Type Parameters

    • Data = unknown

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

    • Response = unknown

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

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/TaskSyncFunction.html b/docs/types/TaskSyncFunction.html index b45eb284..10a99fc3 100644 --- a/docs/types/TaskSyncFunction.html +++ b/docs/types/TaskSyncFunction.html @@ -2,4 +2,4 @@
  • Response = unknown

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

  • Type declaration

      • (data?): Response
      • Task synchronous function that can be executed.

        Parameters

        • Optional data: Data

          Data sent to the worker.

          -

        Returns Response

    Generated using TypeDoc

    \ No newline at end of file +

    Returns Response

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/WorkerChoiceStrategy.html b/docs/types/WorkerChoiceStrategy.html index 419b3bea..9da4c2d6 100644 --- a/docs/types/WorkerChoiceStrategy.html +++ b/docs/types/WorkerChoiceStrategy.html @@ -1,2 +1,2 @@ WorkerChoiceStrategy | poolifier - v3.0.13

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/WorkerType.html b/docs/types/WorkerType.html index 8c7d9340..b0feaa98 100644 --- a/docs/types/WorkerType.html +++ b/docs/types/WorkerType.html @@ -1,2 +1,2 @@ WorkerType | poolifier - v3.0.13

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

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

    Generated using TypeDoc

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

    Generated using TypeDoc

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

    Variable KillBehaviorsConst

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

    Enumeration of kill behaviors.

    Type declaration

    • Readonly HARD: "HARD"

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

    • Readonly SOFT: "SOFT"

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

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/Measurements.html b/docs/variables/Measurements.html index d3db688b..82cfb584 100644 --- a/docs/variables/Measurements.html +++ b/docs/variables/Measurements.html @@ -1,2 +1,2 @@ Measurements | poolifier - v3.0.13

    Variable MeasurementsConst

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

    Enumeration of measurements.

    -

    Type declaration

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

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/PoolEvents.html b/docs/variables/PoolEvents.html index 151e3de6..4a762347 100644 --- a/docs/variables/PoolEvents.html +++ b/docs/variables/PoolEvents.html @@ -1,2 +1,2 @@ PoolEvents | poolifier - v3.0.13

    Variable PoolEventsConst

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

    Enumeration of pool events.

    -

    Type declaration

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

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

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

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/PoolTypes.html b/docs/variables/PoolTypes.html index 23ad20db..42bae3e8 100644 --- a/docs/variables/PoolTypes.html +++ b/docs/variables/PoolTypes.html @@ -1,4 +1,4 @@ PoolTypes | poolifier - v3.0.13

    Variable PoolTypesConst

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

    Enumeration of pool types.

    Type declaration

    • Readonly dynamic: "dynamic"

      Dynamic pool type.

    • Readonly fixed: "fixed"

      Fixed pool type.

      -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/WorkerChoiceStrategies.html b/docs/variables/WorkerChoiceStrategies.html index 102e829d..b8d5a1b9 100644 --- a/docs/variables/WorkerChoiceStrategies.html +++ b/docs/variables/WorkerChoiceStrategies.html @@ -6,4 +6,4 @@
  • Readonly LEAST_USED: "LEAST_USED"

    Least used worker selection strategy.

  • Readonly ROUND_ROBIN: "ROUND_ROBIN"

    Round robin worker selection strategy.

  • Readonly WEIGHTED_ROUND_ROBIN: "WEIGHTED_ROUND_ROBIN"

    Weighted round robin worker selection strategy.

    -
  • Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/WorkerTypes.html b/docs/variables/WorkerTypes.html index 3d4bc6a8..64be0eb5 100644 --- a/docs/variables/WorkerTypes.html +++ b/docs/variables/WorkerTypes.html @@ -1,2 +1,2 @@ WorkerTypes | poolifier - v3.0.13

    Variable WorkerTypesConst

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

    Enumeration of worker types.

    -

    Type declaration

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

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

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

    Generated using TypeDoc

    \ No newline at end of file -- 2.34.1