From 4a473fcd22b6e02b12aaeda1fc6723c80ff742b9 Mon Sep 17 00:00:00 2001 From: Documentation Bot Date: Tue, 20 Oct 2026 21:28:02 +0000 Subject: [PATCH] docs: publish documentation --- docs/assets/hierarchy.js | 2 +- docs/classes/src.ClusterWorker.html | 64 +++++----- docs/classes/src.DynamicClusterPool.html | 114 +++++++++--------- docs/classes/src.DynamicThreadPool.html | 114 +++++++++--------- docs/classes/src.FixedClusterPool.html | 114 +++++++++--------- docs/classes/src.FixedThreadPool.html | 114 +++++++++--------- docs/classes/src.ThreadWorker.html | 64 +++++----- docs/documents/api.html | 14 ++- docs/documents/general-guidelines.html | 6 +- docs/documents/worker-choice-strategies.html | 6 +- docs/functions/src.availableParallelism.html | 8 +- docs/hierarchy.html | 24 ++-- docs/index.html | 8 +- docs/interfaces/src.AbstractPool.html | 110 ++++++++--------- docs/interfaces/src.AbstractWorker.html | 62 +++++----- docs/interfaces/src.IPool.html | 38 +++--- docs/interfaces/src.IWorker.html | 30 ++--- docs/interfaces/src.MeasurementOptions.html | 10 +- docs/interfaces/src.PoolInfo.html | 60 ++++----- docs/interfaces/src.PoolOptions.html | 36 +++--- docs/interfaces/src.TaskFunctionObject.html | 16 +-- .../src.TaskFunctionOperationResult.html | 12 +- .../src.TaskFunctionProperties.html | 16 +-- docs/interfaces/src.TasksQueueOptions.html | 24 ++-- .../src.WorkerChoiceStrategyOptions.html | 18 +-- docs/interfaces/src.WorkerError.html | 20 +-- docs/interfaces/src.WorkerOptions.html | 14 +-- docs/modules/src.html | 6 +- docs/types/src.ClusterPoolOptions.html | 8 +- docs/types/src.ErrorHandler.html | 8 +- docs/types/src.EventHandler.html | 8 +- docs/types/src.ExitHandler.html | 8 +- docs/types/src.KillBehavior.html | 8 +- docs/types/src.KillHandler.html | 8 +- docs/types/src.Measurement.html | 8 +- docs/types/src.MessageHandler.html | 8 +- docs/types/src.OnlineHandler.html | 8 +- docs/types/src.PoolEvent.html | 8 +- docs/types/src.PoolType.html | 8 +- docs/types/src.TaskAsyncFunction.html | 8 +- docs/types/src.TaskFunction.html | 8 +- docs/types/src.TaskFunctions.html | 8 +- docs/types/src.TaskSyncFunction.html | 8 +- docs/types/src.ThreadPoolOptions.html | 8 +- docs/types/src.WorkerChoiceStrategy.html | 8 +- docs/types/src.WorkerType.html | 8 +- docs/variables/src.KillBehaviors.html | 8 +- docs/variables/src.Measurements.html | 8 +- docs/variables/src.PoolEvents.html | 8 +- docs/variables/src.PoolTypes.html | 8 +- .../variables/src.WorkerChoiceStrategies.html | 8 +- docs/variables/src.WorkerTypes.html | 8 +- 52 files changed, 659 insertions(+), 657 deletions(-) diff --git a/docs/assets/hierarchy.js b/docs/assets/hierarchy.js index cd6b26e5d..f9293c7e5 100644 --- a/docs/assets/hierarchy.js +++ b/docs/assets/hierarchy.js @@ -1 +1 @@ -window.hierarchyData = "eJydkrFugzAURf/lzU4KJhjbW9WqUrYOlTpEGSg4AsXYku1IrSL+vTKkraGJgCwM8K7OfYd3BqO1s8B3MSUMZSzdIzDiIEXhaq0s8DPgzD9V3gjg8PhhnckL96q1BATHWpXAcUoQnIwEDrVywhzyQtgHa4p1OL6uXOMzhcytBQ7OliufX/1m/MeqlqURCviOJAzFOIn2LYJNRoISz18qb+riSZ6sE2ZQJcb0p0rHufT4n7jZpn/RIiAJC5gv9acoFxDH8xO8weabjPilM5YGBbYzlW/vcY0zD4wjckXzW2VEXi6w/BeYlux/8NjyfOBofIljv2u3MyXsyn2/a3MUZsGF94Gl3mNGKcIRS7sqjNKgyuV4Rk1umBgMT2v3yADVK5xHCmenQG37DYhwcbs=" \ No newline at end of file +window.hierarchyData = "eJydksFrwyAYxf+X72w7k5nEeBsbg952GOxQesiMJVKjoBY2Sv73YdJtJmtJs4sQfY/3vl++E1hjvAO2TWhRIorJDoEVeyW4l0Y7YCdIi3DqqhXA4OHdeVtx/2KMAgQHqWtgaZYjOFoFDKT2wu4rLtyds3wdy9eNb4OHq8o5YOBdvQr+1Y8nPDZS1VZoYNucUJSk9+WuQ0BoFpV4+tRVK/mjOjov7KhKktLvKn3Oucdfx9U2w0WHICc0ynyWH6JekDjVz+SNJic0C0NTTKICmxuRb/7DOi1CYIKLC5hfGyuqegHlX8M85PCDp5RvD5zIlzAOs/Yz06K8sN9vxh6EXbDhg2Exd4wxShPc4w8fUZXz8kyaXCExEs9jD5FR1IDwtqRYOxfUdV9QzXGB" \ No newline at end of file diff --git a/docs/classes/src.ClusterWorker.html b/docs/classes/src.ClusterWorker.html index a931b5876..775368e94 100644 --- a/docs/classes/src.ClusterWorker.html +++ b/docs/classes/src.ClusterWorker.html @@ -1,5 +1,5 @@ -ClusterWorker | poolifier - v6.0.1
-
poolifier - v6.0.1 +ClusterWorker | poolifier - v6.0.2
+
poolifier - v6.0.2
    @@ -34,14 +34,14 @@ but the minimum number of workers will be guaranteed.

  • Response = unknown

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

    • -
    +

    Hierarchy (View Summary)

    +
  • Defined in src/worker/cluster-worker.ts:23
    • @@ -118,7 +118,7 @@ but the minimum number of workers will be guaranteed.

    Returns ClusterWorker<Data, Response>

    +
  • Defined in src/worker/cluster-worker.ts:37
    • @@ -129,7 +129,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/abstract-worker.ts:71
    • isMain: boolean | undefined
    @@ -137,7 +137,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/abstract-worker.ts:122
    • lastTaskTimestamp: number
    @@ -145,7 +145,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/abstract-worker.ts:79
    • opts: WorkerOptions = DEFAULT_WORKER_OPTIONS
    @@ -153,7 +153,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/abstract-worker.ts:125
    • statistics?: WorkerStatistics
    @@ -161,7 +161,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/abstract-worker.ts:84
    • taskAbortFunctions: Map<
        `${string}-${string}-${string}-${string}-${string}`,
        () => void,
    >
    @@ -169,7 +169,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/abstract-worker.ts:89
    • taskFunctionOperationContext: AsyncLocalStorage<
        `${string}-${string}-${string}-${string}-${string}`
        | undefined,
    > = ...
    @@ -177,7 +177,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/abstract-worker.ts:94
    • taskFunctions: Map<string, TaskFunctionObject<Data, Response>>
    @@ -185,7 +185,7 @@ but the minimum number of workers will be guaranteed.

    +
  • Defined in src/worker/abstract-worker.ts:101
    • @@ -200,7 +200,7 @@ but the minimum number of workers will be guaranteed.

    Returns number

    +
  • Defined in src/worker/cluster-worker.ts:28
    • @@ -226,7 +226,7 @@ If a task function with the same name already exists, it is replaced.

    +
  • Defined in src/worker/abstract-worker.ts:145
    • +
  • Defined in src/worker/abstract-worker.ts:290
    • +
  • Defined in src/worker/abstract-worker.ts:302
    • +
  • Defined in src/worker/cluster-worker.ts:47
    • +
  • Defined in src/worker/abstract-worker.ts:330
    • +
  • Defined in src/worker/cluster-worker.ts:60
    • +
  • Defined in src/worker/abstract-worker.ts:374
    • +
  • Defined in src/worker/abstract-worker.ts:180
    • +
  • Defined in src/worker/abstract-worker.ts:193
    • +
  • Defined in src/worker/abstract-worker.ts:459
    • +
  • Defined in src/worker/abstract-worker.ts:229
    • +
  • Defined in src/worker/abstract-worker.ts:511
    • +
  • Defined in src/worker/abstract-worker.ts:541
    • +
  • Defined in src/worker/abstract-worker.ts:567
    • +
  • Defined in src/worker/abstract-worker.ts:598
    • +
  • Defined in src/worker/cluster-worker.ts:78
    • +
  • Defined in src/worker/abstract-worker.ts:263
    • @@ -541,7 +541,7 @@ An acknowledgement without a recoverable UUID rejects the pool operation.

    Methods
    -
    diff --git a/docs/classes/src.DynamicClusterPool.html b/docs/classes/src.DynamicClusterPool.html index 610a99c0e..b1af8ee86 100644 --- a/docs/classes/src.DynamicClusterPool.html +++ b/docs/classes/src.DynamicClusterPool.html @@ -1,5 +1,5 @@ -DynamicClusterPool | poolifier - v6.0.1
    -
    poolifier - v6.0.1 +DynamicClusterPool | poolifier - v6.0.2
    +
    poolifier - v6.0.2
      @@ -32,14 +32,14 @@ When the maximum number of workers is reached and workers are busy, an event is
    • Response = unknown

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

      • -
      +

      Hierarchy (View Summary)

      +
    • Defined in src/pools/cluster/dynamic.ts:15
      • @@ -147,7 +147,7 @@ When the maximum number of workers is reached and workers are busy, an event is

      Returns DynamicClusterPool<Data, Response>

      +
    • Defined in src/pools/cluster/dynamic.ts:73
      • @@ -158,7 +158,7 @@ When the maximum number of workers is reached and workers are busy, an event is
      +
    • Defined in src/pools/abstract-pool.ts:379
      • emitter?: EventEmitterAsyncResource
      @@ -167,7 +167,7 @@ When the maximum number of workers is reached and workers are busy, an event is
      +
    • Defined in src/pools/abstract-pool.ts:89
      • filePath: string
      @@ -175,7 +175,7 @@ When the maximum number of workers is reached and workers are busy, an event is
      +
    • Defined in src/pools/abstract-pool.ts:568
      • maximumNumberOfWorkers?: number
      @@ -183,7 +183,7 @@ When the maximum number of workers is reached and workers are busy, an event is
      +
    • Defined in src/pools/abstract-pool.ts:570
      • minimumNumberOfWorkers: number
      @@ -191,7 +191,7 @@ When the maximum number of workers is reached and workers are busy, an event is
      +
    • Defined in src/pools/abstract-pool.ts:567
      • opts: PoolOptions<Worker>
      @@ -199,7 +199,7 @@ When the maximum number of workers is reached and workers are busy, an event is
      +
    • Defined in src/pools/abstract-pool.ts:569
      • promiseResponseMap: Map<
          `${string}-${string}-${string}-${string}-${string}`,
          PromiseResponseWrapper<Response>,
      > = ...
      @@ -212,7 +212,7 @@ When the maximum number of workers is reached and workers are busy, an event is
      +
    • Defined in src/pools/abstract-pool.ts:388
      • started: boolean
      @@ -220,7 +220,7 @@ When the maximum number of workers is reached and workers are busy, an event is
      +
    • Defined in src/pools/abstract-pool.ts:394
      • starting: boolean
      @@ -228,7 +228,7 @@ When the maximum number of workers is reached and workers are busy, an event is
      +
    • Defined in src/pools/abstract-pool.ts:399
      • workerChoiceStrategiesContext?: WorkerChoiceStrategiesContext<
          Worker,
          Data,
          Response,
      >
      @@ -236,7 +236,7 @@ When the maximum number of workers is reached and workers are busy, an event is
      +
    • Defined in src/pools/abstract-pool.ts:404
      • workerNodes: IWorkerNode<Worker, Data>[] = []
      @@ -245,7 +245,7 @@ When the maximum number of workers is reached and workers are busy, an event is
      +
    • Defined in src/pools/abstract-pool.ts:92
      • @@ -261,7 +261,7 @@ When the maximum number of workers is reached and workers are busy, an event is
      +
    • Defined in src/pools/cluster/dynamic.ts:20
        • @@ -274,7 +274,7 @@ When the maximum number of workers is reached and workers are busy, an event is
      +
    • Defined in src/pools/cluster/dynamic.ts:25
        • @@ -287,7 +287,7 @@ When the maximum number of workers is reached and workers are busy, an event is
      +
    • Defined in src/pools/abstract-pool.ts:95
        • @@ -300,7 +300,7 @@ When the maximum number of workers is reached and workers are busy, an event is

        Returns "fixed" | "dynamic"

      +
    • Defined in src/pools/cluster/dynamic.ts:30
        • @@ -312,7 +312,7 @@ When the maximum number of workers is reached and workers are busy, an event is

        Returns "cluster" | "thread"

      +
    • Defined in src/pools/cluster/fixed.ts:42
      • @@ -333,7 +333,7 @@ When the maximum number of workers is reached and workers are busy, an event is
      +
    • Defined in src/pools/abstract-pool.ts:617
      • +
    • Defined in src/pools/abstract-pool.ts:1011
      • +
    • Defined in src/pools/abstract-pool.ts:1068
      • +
    • Defined in src/pools/abstract-pool.ts:1101
      • +
    • Defined in src/pools/cluster/dynamic.ts:89
      • +
    • Defined in src/pools/cluster/dynamic.ts:103
      • +
    • Defined in src/pools/abstract-pool.ts:1151
      • +
    • Defined in src/pools/abstract-pool.ts:1199
      • +
    • Defined in src/pools/cluster/fixed.ts:73
      • +
    • Defined in src/pools/abstract-pool.ts:675
      • +
    • Defined in src/pools/abstract-pool.ts:1346
      • +
    • Defined in src/pools/abstract-pool.ts:710
      • +
    • Defined in src/pools/abstract-pool.ts:724
      • +
    • Defined in src/pools/abstract-pool.ts:1371
      • +
    • Defined in src/pools/abstract-pool.ts:1378
      • +
    • Defined in src/pools/abstract-pool.ts:1395
      • +
    • Defined in src/pools/abstract-pool.ts:756
      • +
    • Defined in src/pools/abstract-pool.ts:1403
      • +
    • Defined in src/pools/abstract-pool.ts:1420
      • +
    • Defined in src/pools/cluster/fixed.ts:81
      • +
    • Defined in src/pools/abstract-pool.ts:763
      • +
    • Defined in src/pools/abstract-pool.ts:771
      • +
    • Defined in src/pools/cluster/fixed.ts:86
      • +
    • Defined in src/pools/cluster/fixed.ts:94
      • +
    • Defined in src/pools/abstract-pool.ts:841
      • +
    • Defined in src/pools/cluster/fixed.ts:102
      • +
    • Defined in src/pools/cluster/fixed.ts:109
      • +
    • Defined in src/pools/abstract-pool.ts:879
      • +
    • Defined in src/pools/abstract-pool.ts:901
      • +
    • Defined in src/pools/cluster/fixed.ts:120
      • +
    • Defined in src/pools/abstract-pool.ts:928
      • +
    • Defined in src/pools/abstract-pool.ts:959
      • +
    • Defined in src/pools/cluster/dynamic.ts:119
      • +
    • Defined in src/pools/abstract-pool.ts:984
      • +
    • Defined in src/pools/abstract-pool.ts:1497
      • @@ -934,7 +934,7 @@ Can be overridden.

      Methods
      -
      diff --git a/docs/classes/src.DynamicThreadPool.html b/docs/classes/src.DynamicThreadPool.html index f167dc8d2..c0a9fda08 100644 --- a/docs/classes/src.DynamicThreadPool.html +++ b/docs/classes/src.DynamicThreadPool.html @@ -1,5 +1,5 @@ -DynamicThreadPool | poolifier - v6.0.1
      -
      poolifier - v6.0.1 +DynamicThreadPool | poolifier - v6.0.2
      +
      poolifier - v6.0.2
        @@ -32,14 +32,14 @@ When the maximum number of threads is reached and workers are busy, an event is
      • Response = unknown

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

        • -
        +

        Hierarchy (View Summary)

        +
      • Defined in src/pools/thread/dynamic.ts:15
        • @@ -147,7 +147,7 @@ When the maximum number of threads is reached and workers are busy, an event is

        Returns DynamicThreadPool<Data, Response>

        +
      • Defined in src/pools/thread/dynamic.ts:73
        • @@ -158,7 +158,7 @@ When the maximum number of threads is reached and workers are busy, an event is
        +
      • Defined in src/pools/abstract-pool.ts:379
        • emitter?: EventEmitterAsyncResource
        @@ -167,7 +167,7 @@ When the maximum number of threads is reached and workers are busy, an event is
        +
      • Defined in src/pools/abstract-pool.ts:89
        • filePath: string
        @@ -175,7 +175,7 @@ When the maximum number of threads is reached and workers are busy, an event is
        +
      • Defined in src/pools/abstract-pool.ts:568
        • maximumNumberOfWorkers?: number
        @@ -183,7 +183,7 @@ When the maximum number of threads is reached and workers are busy, an event is
        +
      • Defined in src/pools/abstract-pool.ts:570
        • minimumNumberOfWorkers: number
        @@ -191,7 +191,7 @@ When the maximum number of threads is reached and workers are busy, an event is
        +
      • Defined in src/pools/abstract-pool.ts:567
        • opts: PoolOptions<Worker>
        @@ -199,7 +199,7 @@ When the maximum number of threads is reached and workers are busy, an event is
        +
      • Defined in src/pools/abstract-pool.ts:569
        • promiseResponseMap: Map<
            `${string}-${string}-${string}-${string}-${string}`,
            PromiseResponseWrapper<Response>,
        > = ...
        @@ -212,7 +212,7 @@ When the maximum number of threads is reached and workers are busy, an event is
        +
      • Defined in src/pools/abstract-pool.ts:388
        • started: boolean
        @@ -220,7 +220,7 @@ When the maximum number of threads is reached and workers are busy, an event is
        +
      • Defined in src/pools/abstract-pool.ts:394
        • starting: boolean
        @@ -228,7 +228,7 @@ When the maximum number of threads is reached and workers are busy, an event is
        +
      • Defined in src/pools/abstract-pool.ts:399
        • workerChoiceStrategiesContext?: WorkerChoiceStrategiesContext<
            Worker,
            Data,
            Response,
        >
        @@ -236,7 +236,7 @@ When the maximum number of threads is reached and workers are busy, an event is
        +
      • Defined in src/pools/abstract-pool.ts:404
        • workerNodes: IWorkerNode<Worker, Data>[] = []
        @@ -245,7 +245,7 @@ When the maximum number of threads is reached and workers are busy, an event is
        +
      • Defined in src/pools/abstract-pool.ts:92
        • @@ -261,7 +261,7 @@ When the maximum number of threads is reached and workers are busy, an event is
        +
      • Defined in src/pools/thread/dynamic.ts:20
          • @@ -274,7 +274,7 @@ When the maximum number of threads is reached and workers are busy, an event is
        +
      • Defined in src/pools/thread/dynamic.ts:25
          • @@ -287,7 +287,7 @@ When the maximum number of threads is reached and workers are busy, an event is
        +
      • Defined in src/pools/abstract-pool.ts:95
          • @@ -300,7 +300,7 @@ When the maximum number of threads is reached and workers are busy, an event is

          Returns "fixed" | "dynamic"

        +
      • Defined in src/pools/thread/dynamic.ts:30
          • @@ -312,7 +312,7 @@ When the maximum number of threads is reached and workers are busy, an event is

          Returns "cluster" | "thread"

        +
      • Defined in src/pools/thread/fixed.ts:45
        • @@ -333,7 +333,7 @@ When the maximum number of threads is reached and workers are busy, an event is
        +
      • Defined in src/pools/abstract-pool.ts:617
        • +
      • Defined in src/pools/abstract-pool.ts:1011
        • +
      • Defined in src/pools/abstract-pool.ts:1068
        • +
      • Defined in src/pools/abstract-pool.ts:1101
        • +
      • Defined in src/pools/thread/dynamic.ts:89
        • +
      • Defined in src/pools/thread/dynamic.ts:103
        • +
      • Defined in src/pools/abstract-pool.ts:1151
        • +
      • Defined in src/pools/abstract-pool.ts:1199
        • +
      • Defined in src/pools/thread/fixed.ts:76
        • +
      • Defined in src/pools/abstract-pool.ts:675
        • +
      • Defined in src/pools/abstract-pool.ts:1346
        • +
      • Defined in src/pools/abstract-pool.ts:710
        • +
      • Defined in src/pools/abstract-pool.ts:724
        • +
      • Defined in src/pools/abstract-pool.ts:1371
        • +
      • Defined in src/pools/abstract-pool.ts:1378
        • +
      • Defined in src/pools/abstract-pool.ts:1395
        • +
      • Defined in src/pools/abstract-pool.ts:756
        • +
      • Defined in src/pools/abstract-pool.ts:1403
        • +
      • Defined in src/pools/abstract-pool.ts:1420
        • +
      • Defined in src/pools/thread/fixed.ts:87
        • +
      • Defined in src/pools/abstract-pool.ts:763
        • +
      • Defined in src/pools/abstract-pool.ts:771
        • +
      • Defined in src/pools/thread/fixed.ts:92
        • +
      • Defined in src/pools/thread/fixed.ts:103
        • +
      • Defined in src/pools/abstract-pool.ts:841
        • +
      • Defined in src/pools/thread/fixed.ts:114
        • +
      • Defined in src/pools/thread/fixed.ts:129
        • +
      • Defined in src/pools/abstract-pool.ts:879
        • +
      • Defined in src/pools/abstract-pool.ts:901
        • +
      • Defined in src/pools/abstract-pool.ts:1483
        • +
      • Defined in src/pools/abstract-pool.ts:928
        • +
      • Defined in src/pools/abstract-pool.ts:959
        • +
      • Defined in src/pools/thread/dynamic.ts:119
        • +
      • Defined in src/pools/abstract-pool.ts:984
        • +
      • Defined in src/pools/abstract-pool.ts:1497
        • @@ -937,7 +937,7 @@ Can be overridden.

        Methods
        -
        diff --git a/docs/classes/src.FixedClusterPool.html b/docs/classes/src.FixedClusterPool.html index 6d6ad3a6f..62f6154cc 100644 --- a/docs/classes/src.FixedClusterPool.html +++ b/docs/classes/src.FixedClusterPool.html @@ -1,5 +1,5 @@ -FixedClusterPool | poolifier - v6.0.1
        -
        poolifier - v6.0.1 +FixedClusterPool | poolifier - v6.0.2
        +
        poolifier - v6.0.2
          @@ -30,7 +30,7 @@
        • Response = unknown

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

          • -
          +

          Hierarchy (View Summary)

          +
        • Defined in src/pools/cluster/fixed.ts:22
          • @@ -147,7 +147,7 @@

          Returns FixedClusterPool<Data, Response>

          +
        • Defined in src/pools/cluster/fixed.ts:53
          • @@ -158,7 +158,7 @@
          +
        • Defined in src/pools/abstract-pool.ts:379
          • emitter?: EventEmitterAsyncResource
          @@ -167,7 +167,7 @@
          +
        • Defined in src/pools/abstract-pool.ts:89
          • filePath: string
          @@ -175,7 +175,7 @@
          +
        • Defined in src/pools/abstract-pool.ts:568
          • maximumNumberOfWorkers?: number
          @@ -183,7 +183,7 @@
          +
        • Defined in src/pools/abstract-pool.ts:570
          • minimumNumberOfWorkers: number
          @@ -191,7 +191,7 @@
          +
        • Defined in src/pools/abstract-pool.ts:567
          • opts: PoolOptions<Worker>
          @@ -199,7 +199,7 @@
          +
        • Defined in src/pools/abstract-pool.ts:569
          • promiseResponseMap: Map<
              `${string}-${string}-${string}-${string}-${string}`,
              PromiseResponseWrapper<Response>,
          > = ...
          @@ -212,7 +212,7 @@
          +
        • Defined in src/pools/abstract-pool.ts:388
          • started: boolean
          @@ -220,7 +220,7 @@
          +
        • Defined in src/pools/abstract-pool.ts:394
          • starting: boolean
          @@ -228,7 +228,7 @@
          +
        • Defined in src/pools/abstract-pool.ts:399
          • workerChoiceStrategiesContext?: WorkerChoiceStrategiesContext<
              Worker,
              Data,
              Response,
          >
          @@ -236,7 +236,7 @@
          +
        • Defined in src/pools/abstract-pool.ts:404
          • workerNodes: IWorkerNode<Worker, Data>[] = []
          @@ -245,7 +245,7 @@
          +
        • Defined in src/pools/abstract-pool.ts:92
          • @@ -261,7 +261,7 @@
          +
        • Defined in src/pools/cluster/fixed.ts:27
          • +
        • Defined in src/pools/cluster/fixed.ts:32
          • +
        • Defined in src/pools/abstract-pool.ts:95
          • +
        • Defined in src/pools/cluster/fixed.ts:37
          • +
        • Defined in src/pools/cluster/fixed.ts:42
          • @@ -333,7 +333,7 @@
          +
        • Defined in src/pools/abstract-pool.ts:617
          • +
        • Defined in src/pools/abstract-pool.ts:1011
          • +
        • Defined in src/pools/abstract-pool.ts:1068
          • +
        • Defined in src/pools/abstract-pool.ts:1101
          • +
        • Defined in src/pools/cluster/fixed.ts:63
          • +
        • Defined in src/pools/cluster/fixed.ts:68
          • +
        • Defined in src/pools/abstract-pool.ts:1151
          • +
        • Defined in src/pools/abstract-pool.ts:1199
          • +
        • Defined in src/pools/cluster/fixed.ts:73
          • +
        • Defined in src/pools/abstract-pool.ts:675
          • +
        • Defined in src/pools/abstract-pool.ts:1346
          • +
        • Defined in src/pools/abstract-pool.ts:710
          • +
        • Defined in src/pools/abstract-pool.ts:724
          • +
        • Defined in src/pools/abstract-pool.ts:1371
          • +
        • Defined in src/pools/abstract-pool.ts:1378
          • +
        • Defined in src/pools/abstract-pool.ts:1395
          • +
        • Defined in src/pools/abstract-pool.ts:756
          • +
        • Defined in src/pools/abstract-pool.ts:1403
          • +
        • Defined in src/pools/abstract-pool.ts:1420
          • +
        • Defined in src/pools/cluster/fixed.ts:81
          • +
        • Defined in src/pools/abstract-pool.ts:763
          • +
        • Defined in src/pools/abstract-pool.ts:771
          • +
        • Defined in src/pools/cluster/fixed.ts:86
          • +
        • Defined in src/pools/cluster/fixed.ts:94
          • +
        • Defined in src/pools/abstract-pool.ts:841
          • +
        • Defined in src/pools/cluster/fixed.ts:102
          • +
        • Defined in src/pools/cluster/fixed.ts:109
          • +
        • Defined in src/pools/abstract-pool.ts:879
          • +
        • Defined in src/pools/abstract-pool.ts:901
          • +
        • Defined in src/pools/cluster/fixed.ts:120
          • +
        • Defined in src/pools/abstract-pool.ts:928
          • +
        • Defined in src/pools/abstract-pool.ts:959
          • +
        • Defined in src/pools/cluster/fixed.ts:131
          • +
        • Defined in src/pools/abstract-pool.ts:984
          • +
        • Defined in src/pools/abstract-pool.ts:1497
          • @@ -934,7 +934,7 @@ Can be overridden.

          Methods
          -
          diff --git a/docs/classes/src.FixedThreadPool.html b/docs/classes/src.FixedThreadPool.html index 2c3db77c4..71b9ee52b 100644 --- a/docs/classes/src.FixedThreadPool.html +++ b/docs/classes/src.FixedThreadPool.html @@ -1,5 +1,5 @@ -FixedThreadPool | poolifier - v6.0.1
          -
          poolifier - v6.0.1 +FixedThreadPool | poolifier - v6.0.2
          +
          poolifier - v6.0.2
            @@ -30,7 +30,7 @@
          • Response = unknown

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

            • -
            +

            Hierarchy (View Summary)

            +
          • Defined in src/pools/thread/fixed.ts:25
            • @@ -147,7 +147,7 @@

            Returns FixedThreadPool<Data, Response>

            +
          • Defined in src/pools/thread/fixed.ts:56
            • @@ -158,7 +158,7 @@
            +
          • Defined in src/pools/abstract-pool.ts:379
            • emitter?: EventEmitterAsyncResource
            @@ -167,7 +167,7 @@
            +
          • Defined in src/pools/abstract-pool.ts:89
            • filePath: string
            @@ -175,7 +175,7 @@
            +
          • Defined in src/pools/abstract-pool.ts:568
            • maximumNumberOfWorkers?: number
            @@ -183,7 +183,7 @@
            +
          • Defined in src/pools/abstract-pool.ts:570
            • minimumNumberOfWorkers: number
            @@ -191,7 +191,7 @@
            +
          • Defined in src/pools/abstract-pool.ts:567
            • opts: PoolOptions<Worker>
            @@ -199,7 +199,7 @@
            +
          • Defined in src/pools/abstract-pool.ts:569
            • promiseResponseMap: Map<
                `${string}-${string}-${string}-${string}-${string}`,
                PromiseResponseWrapper<Response>,
            > = ...
            @@ -212,7 +212,7 @@
            +
          • Defined in src/pools/abstract-pool.ts:388
            • started: boolean
            @@ -220,7 +220,7 @@
            +
          • Defined in src/pools/abstract-pool.ts:394
            • starting: boolean
            @@ -228,7 +228,7 @@
            +
          • Defined in src/pools/abstract-pool.ts:399
            • workerChoiceStrategiesContext?: WorkerChoiceStrategiesContext<
                Worker,
                Data,
                Response,
            >
            @@ -236,7 +236,7 @@
            +
          • Defined in src/pools/abstract-pool.ts:404
            • workerNodes: IWorkerNode<Worker, Data>[] = []
            @@ -245,7 +245,7 @@
            +
          • Defined in src/pools/abstract-pool.ts:92
            • @@ -261,7 +261,7 @@
            +
          • Defined in src/pools/thread/fixed.ts:30
            • +
          • Defined in src/pools/thread/fixed.ts:35
            • +
          • Defined in src/pools/abstract-pool.ts:95
            • +
          • Defined in src/pools/thread/fixed.ts:40
            • +
          • Defined in src/pools/thread/fixed.ts:45
            • @@ -333,7 +333,7 @@
            +
          • Defined in src/pools/abstract-pool.ts:617
            • +
          • Defined in src/pools/abstract-pool.ts:1011
            • +
          • Defined in src/pools/abstract-pool.ts:1068
            • +
          • Defined in src/pools/abstract-pool.ts:1101
            • +
          • Defined in src/pools/thread/fixed.ts:66
            • +
          • Defined in src/pools/thread/fixed.ts:71
            • +
          • Defined in src/pools/abstract-pool.ts:1151
            • +
          • Defined in src/pools/abstract-pool.ts:1199
            • +
          • Defined in src/pools/thread/fixed.ts:76
            • +
          • Defined in src/pools/abstract-pool.ts:675
            • +
          • Defined in src/pools/abstract-pool.ts:1346
            • +
          • Defined in src/pools/abstract-pool.ts:710
            • +
          • Defined in src/pools/abstract-pool.ts:724
            • +
          • Defined in src/pools/abstract-pool.ts:1371
            • +
          • Defined in src/pools/abstract-pool.ts:1378
            • +
          • Defined in src/pools/abstract-pool.ts:1395
            • +
          • Defined in src/pools/abstract-pool.ts:756
            • +
          • Defined in src/pools/abstract-pool.ts:1403
            • +
          • Defined in src/pools/abstract-pool.ts:1420
            • +
          • Defined in src/pools/thread/fixed.ts:87
            • +
          • Defined in src/pools/abstract-pool.ts:763
            • +
          • Defined in src/pools/abstract-pool.ts:771
            • +
          • Defined in src/pools/thread/fixed.ts:92
            • +
          • Defined in src/pools/thread/fixed.ts:103
            • +
          • Defined in src/pools/abstract-pool.ts:841
            • +
          • Defined in src/pools/thread/fixed.ts:114
            • +
          • Defined in src/pools/thread/fixed.ts:129
            • +
          • Defined in src/pools/abstract-pool.ts:879
            • +
          • Defined in src/pools/abstract-pool.ts:901
            • +
          • Defined in src/pools/abstract-pool.ts:1483
            • +
          • Defined in src/pools/abstract-pool.ts:928
            • +
          • Defined in src/pools/abstract-pool.ts:959
            • +
          • Defined in src/pools/thread/fixed.ts:144
            • +
          • Defined in src/pools/abstract-pool.ts:984
            • +
          • Defined in src/pools/abstract-pool.ts:1497
            • @@ -937,7 +937,7 @@ Can be overridden.

            Methods
            -
            diff --git a/docs/classes/src.ThreadWorker.html b/docs/classes/src.ThreadWorker.html index 6b6fa195f..533ea0a0a 100644 --- a/docs/classes/src.ThreadWorker.html +++ b/docs/classes/src.ThreadWorker.html @@ -1,5 +1,5 @@ -ThreadWorker | poolifier - v6.0.1
            -
            poolifier - v6.0.1 +ThreadWorker | poolifier - v6.0.2
            +
            poolifier - v6.0.2
              @@ -34,14 +34,14 @@ but the minimum number of workers will be guaranteed.

            • Response = unknown

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

              • -
              +

              Hierarchy (View Summary)

              +
            • Defined in src/worker/thread-worker.ts:28
              • @@ -118,7 +118,7 @@ but the minimum number of workers will be guaranteed.

              Returns ThreadWorker<Data, Response>

              +
            • Defined in src/worker/thread-worker.ts:47
              • @@ -129,7 +129,7 @@ but the minimum number of workers will be guaranteed.

              +
            • Defined in src/worker/abstract-worker.ts:71
              • isMain: boolean | undefined
              @@ -137,7 +137,7 @@ but the minimum number of workers will be guaranteed.

              +
            • Defined in src/worker/abstract-worker.ts:122
              • lastTaskTimestamp: number
              @@ -145,7 +145,7 @@ but the minimum number of workers will be guaranteed.

              +
            • Defined in src/worker/abstract-worker.ts:79
              • opts: WorkerOptions = DEFAULT_WORKER_OPTIONS
              @@ -153,7 +153,7 @@ but the minimum number of workers will be guaranteed.

              +
            • Defined in src/worker/abstract-worker.ts:125
              • statistics?: WorkerStatistics
              @@ -161,7 +161,7 @@ but the minimum number of workers will be guaranteed.

              +
            • Defined in src/worker/abstract-worker.ts:84
              • taskAbortFunctions: Map<
                  `${string}-${string}-${string}-${string}-${string}`,
                  () => void,
              >
              @@ -169,7 +169,7 @@ but the minimum number of workers will be guaranteed.

              +
            • Defined in src/worker/abstract-worker.ts:89
              • taskFunctionOperationContext: AsyncLocalStorage<
                  `${string}-${string}-${string}-${string}-${string}`
                  | undefined,
              > = ...
              @@ -177,7 +177,7 @@ but the minimum number of workers will be guaranteed.

              +
            • Defined in src/worker/abstract-worker.ts:94
              • taskFunctions: Map<string, TaskFunctionObject<Data, Response>>
              @@ -185,7 +185,7 @@ but the minimum number of workers will be guaranteed.

              +
            • Defined in src/worker/abstract-worker.ts:101
              • @@ -200,7 +200,7 @@ but the minimum number of workers will be guaranteed.

              Returns number

              +
            • Defined in src/worker/thread-worker.ts:33
              • @@ -226,7 +226,7 @@ If a task function with the same name already exists, it is replaced.

              +
            • Defined in src/worker/abstract-worker.ts:145
              • +
            • Defined in src/worker/abstract-worker.ts:290
              • +
            • Defined in src/worker/abstract-worker.ts:302
              • +
            • Defined in src/worker/thread-worker.ts:57
              • +
            • Defined in src/worker/abstract-worker.ts:330
              • +
            • Defined in src/worker/thread-worker.ts:72
              • +
            • Defined in src/worker/abstract-worker.ts:374
              • +
            • Defined in src/worker/abstract-worker.ts:180
              • +
            • Defined in src/worker/abstract-worker.ts:193
              • +
            • Defined in src/worker/abstract-worker.ts:459
              • +
            • Defined in src/worker/abstract-worker.ts:229
              • +
            • Defined in src/worker/abstract-worker.ts:511
              • +
            • Defined in src/worker/abstract-worker.ts:541
              • +
            • Defined in src/worker/abstract-worker.ts:567
              • +
            • Defined in src/worker/abstract-worker.ts:598
              • +
            • Defined in src/worker/thread-worker.ts:95
              • +
            • Defined in src/worker/abstract-worker.ts:263
              • @@ -541,7 +541,7 @@ An acknowledgement without a recoverable UUID rejects the pool operation.

              Methods
              -
              diff --git a/docs/documents/api.html b/docs/documents/api.html index e117374fb..a3cbd3700 100644 --- a/docs/documents/api.html +++ b/docs/documents/api.html @@ -1,5 +1,5 @@ -api | poolifier - v6.0.1
              -
              poolifier - v6.0.1 +api | poolifier - v6.0.2
              +
              poolifier - v6.0.2
                @@ -105,6 +105,7 @@

                pool.removeTaskFunction(name)

                name (mandatory) The task function name.

                This method is available on both pool implementations and returns a boolean promise. See Runtime task function changes.

                +

                For workers whose initialization failed, confirmed absence of the requested function also counts as successful removal. Other removal errors still reject the call.

                pool.listTaskFunctionsProperties()

                This method is available on both pool implementations and returns an array of the task function properties.

                pool.setDefaultTaskFunction(name)

                @@ -112,10 +113,11 @@

                This method is available on both pool implementations and returns a boolean promise. See Runtime task function changes.

                With no workers, this method resolves to true without changing the default selection.

                -

                Pool-wide calls to addTaskFunction(), removeTaskFunction() and setDefaultTaskFunction() run in call order. A failed call does not block later calls or undo changes already applied to workers.

                -

                If workers are present when a change starts, each must respond or exit before the call settles. At least one successful result is required; any reported failure rejects the change. Thread pools preserve operation results sent before an unexpected worker exit.

                +

                Pool-wide calls to addTaskFunction(), removeTaskFunction() and setDefaultTaskFunction() run in call order. A rejected call does not prevent later calls or undo changes already applied to workers.

                +

                Workers contacted by a change must respond or exit before the call settles, including when a later send fails. Send failures preserve the original error; otherwise, at least one accepted response is required and any other failed response rejects the change. Thread pools preserve operation results sent before an unexpected worker exit.

                New and replacement workers wait for ongoing task function changes. They accept tasks only after restoring successfully registered task functions, the selected default and scheduling options. Workers being terminated remain unavailable.

                -

                Custom worker subclasses that defer task function operations must echo the request's taskFunctionOperationId in their acknowledgement, or retain the original taskFunctionProperties object when using the standard transport. An acknowledgement without a recoverable UUID rejects the operation. Pool-wide changes still wait for all original targets to respond or exit. Status-only overrides that discard this correlation must be updated.

                +

                Successful calls resolve only after a restoration attempt completes for workers whose initialization failed. If restoration fails again, the change still succeeds, the worker remains unavailable, and the pool emits error when events are enabled.

                +

                Custom worker subclasses that defer task function operations must echo the request's taskFunctionOperationId in their acknowledgement, or retain the original taskFunctionProperties object when using the standard transport. Preserve result metadata when forwarding acknowledgements. An acknowledgement without a recoverable UUID rejects the operation. Pool-wide changes still wait for all contacted workers to respond or exit. Status-only overrides that discard this correlation must be updated.

                An object with these properties:

                  @@ -293,7 +295,7 @@ Default: () => {}

                -
                diff --git a/docs/documents/general-guidelines.html b/docs/documents/general-guidelines.html index d8e10b43b..9bde81da6 100644 --- a/docs/documents/general-guidelines.html +++ b/docs/documents/general-guidelines.html @@ -1,5 +1,5 @@ -general-guidelines | poolifier - v6.0.1
                -
                poolifier - v6.0.1 +general-guidelines | poolifier - v6.0.2
                +
                poolifier - v6.0.2
                  @@ -65,7 +65,7 @@ But in general, always profile your application.

                • Cluster vs Threads worker pools
                • Fixed vs Dynamic pools
                  • -
                  diff --git a/docs/documents/worker-choice-strategies.html b/docs/documents/worker-choice-strategies.html index ad4e81d20..24f0d9256 100644 --- a/docs/documents/worker-choice-strategies.html +++ b/docs/documents/worker-choice-strategies.html @@ -1,5 +1,5 @@ -worker-choice-strategies | poolifier - v6.0.1
                  -
                  poolifier - v6.0.1 +worker-choice-strategies | poolifier - v6.0.2
                  +
                  poolifier - v6.0.2
                    @@ -70,7 +70,7 @@ The default worker weights is the same for each and computed given the CPU cores
                    -
                    diff --git a/docs/functions/src.availableParallelism.html b/docs/functions/src.availableParallelism.html index b440014cc..0d73cbf63 100644 --- a/docs/functions/src.availableParallelism.html +++ b/docs/functions/src.availableParallelism.html @@ -1,5 +1,5 @@ -availableParallelism | poolifier - v6.0.1
                    -
                    poolifier - v6.0.1 +availableParallelism | poolifier - v6.0.2
                    +
                    poolifier - v6.0.2
                      @@ -22,7 +22,7 @@ Always returns a value greater than zero.

                      Returns number

                      The host OS optimized maximum pool size.

                      +
                    • Defined in src/utils.ts:25
                      • @@ -36,7 +36,7 @@ Always returns a value greater than zero.

                      • -
                      diff --git a/docs/hierarchy.html b/docs/hierarchy.html index 5a7b6730b..7cc67dd67 100644 --- a/docs/hierarchy.html +++ b/docs/hierarchy.html @@ -1,5 +1,5 @@ -poolifier - v6.0.1
                      -
                      poolifier - v6.0.1 +poolifier - v6.0.2
                      +
                      poolifier - v6.0.2
                        @@ -38,7 +38,7 @@
                        • -
                        diff --git a/docs/index.html b/docs/index.html index d66a80683..67a4c2241 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,5 +1,5 @@ -poolifier - v6.0.1
                        -
                        poolifier - v6.0.1 +poolifier - v6.0.2
                        +
                        poolifier - v6.0.2
                          @@ -7,7 +7,7 @@
                          -

                          poolifier - v6.0.1

                          +

                          poolifier - v6.0.2

                          api
                          general-guidelines
                          worker-choice-strategies
                          @@ -32,7 +32,7 @@
                          Modules
                          -
                          diff --git a/docs/interfaces/src.AbstractPool.html b/docs/interfaces/src.AbstractPool.html index facdd9077..07a8be609 100644 --- a/docs/interfaces/src.AbstractPool.html +++ b/docs/interfaces/src.AbstractPool.html @@ -1,5 +1,5 @@ -AbstractPool | poolifier - v6.0.1
                          -
                          poolifier - v6.0.1 +AbstractPool | poolifier - v6.0.2
                          +
                          poolifier - v6.0.2
                            @@ -39,7 +39,7 @@ +
                          • Defined in src/pools/abstract-pool.ts:83
                            • @@ -114,7 +114,7 @@

                            Whether the pool is destroying or not.

                            +
                          • Defined in src/pools/abstract-pool.ts:379
                            • emitter?: EventEmitterAsyncResource
                            @@ -123,35 +123,35 @@
                            +
                          • Defined in src/pools/abstract-pool.ts:89
                            • filePath: string

                            Path to the worker file.

                            +
                          • Defined in src/pools/abstract-pool.ts:568
                            • maximumNumberOfWorkers?: number

                            Maximum number of workers that this pool manages.

                            +
                          • Defined in src/pools/abstract-pool.ts:570
                            • minimumNumberOfWorkers: number

                            Minimum number of workers that this pool manages.

                            +
                          • Defined in src/pools/abstract-pool.ts:567
                            • opts: PoolOptions<Worker>

                            Options for the pool.

                            +
                          • Defined in src/pools/abstract-pool.ts:569
                            • promiseResponseMap: Map<
                                `${string}-${string}-${string}-${string}-${string}`,
                                PromiseResponseWrapper<Response>,
                            > = ...
                            @@ -163,28 +163,28 @@

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

                            +
                          • Defined in src/pools/abstract-pool.ts:388
                            • started: boolean

                            Whether the pool is started or not.

                            +
                          • Defined in src/pools/abstract-pool.ts:394
                            • starting: boolean

                            Whether the pool is starting or not.

                            +
                          • Defined in src/pools/abstract-pool.ts:399
                            • workerChoiceStrategiesContext?: WorkerChoiceStrategiesContext<
                                Worker,
                                Data,
                                Response,
                            >

                            Worker choice strategies context referencing worker choice algorithms implementation.

                            +
                          • Defined in src/pools/abstract-pool.ts:404
                            • workerNodes: IWorkerNode<Worker, Data>[] = []
                            @@ -193,7 +193,7 @@
                            +
                          • Defined in src/pools/abstract-pool.ts:92
                            • @@ -208,7 +208,7 @@

                            Returns boolean

                            The pool back pressure boolean status.

                            +
                          • Defined in src/pools/abstract-pool.ts:414
                            • +
                          • Defined in src/pools/abstract-pool.ts:420
                            • +
                          • Defined in src/pools/abstract-pool.ts:95
                            • +
                          • Defined in src/pools/abstract-pool.ts:427
                            • +
                          • Defined in src/pools/abstract-pool.ts:432
                            • @@ -277,7 +277,7 @@
                            +
                          • Defined in src/pools/abstract-pool.ts:617
                              • @@ -299,7 +299,7 @@ Can be overridden.

                            Returns void

                            +
                          • Defined in src/pools/abstract-pool.ts:1011
                              • @@ -317,7 +317,7 @@ Can be overridden.

                            Returns void

                            +
                          • Defined in src/pools/abstract-pool.ts:1068
                              • @@ -338,7 +338,7 @@ Can be overridden.

                            Returns void

                            +
                          • Defined in src/pools/abstract-pool.ts:1101
                            • +
                          • Defined in src/pools/abstract-pool.ts:1140
                            • +
                          • Defined in src/pools/abstract-pool.ts:1145
                            • +
                          • Defined in src/pools/abstract-pool.ts:1151
                            • +
                          • Defined in src/pools/abstract-pool.ts:1199
                              • @@ -408,7 +408,7 @@ Can be overridden.

                            Returns void

                            +
                          • Defined in src/pools/abstract-pool.ts:1335
                            • +
                          • Defined in src/pools/abstract-pool.ts:675
                              • @@ -438,7 +438,7 @@ Can be overridden.

                            Returns Promise<void>

                            +
                          • Defined in src/pools/abstract-pool.ts:1346
                            • +
                          • Defined in src/pools/abstract-pool.ts:710
                            • +
                          • Defined in src/pools/abstract-pool.ts:724
                              • @@ -489,7 +489,7 @@ Can be overridden.

                            • workerNodeKey: number

                            Returns void

                            +
                          • Defined in src/pools/abstract-pool.ts:1371
                              • @@ -502,7 +502,7 @@ Can be overridden.

                            • workerNodeKey: number

                            Returns number

                            +
                          • Defined in src/pools/abstract-pool.ts:1378
                            • +
                          • Defined in src/pools/abstract-pool.ts:1395
                            • +
                          • Defined in src/pools/abstract-pool.ts:756
                            • +
                          • Defined in src/pools/abstract-pool.ts:1403
                            • +
                          • Defined in src/pools/abstract-pool.ts:1420
                            • +
                          • Defined in src/pools/abstract-pool.ts:1435
                            • +
                          • Defined in src/pools/abstract-pool.ts:763
                            • +
                          • Defined in src/pools/abstract-pool.ts:771
                              • @@ -630,7 +630,7 @@ Can be overridden.

                            Returns void

                            +
                          • Defined in src/pools/abstract-pool.ts:1442
                              • @@ -654,7 +654,7 @@ Can be overridden.

                            Returns void

                            +
                          • Defined in src/pools/abstract-pool.ts:1454
                            • +
                          • Defined in src/pools/abstract-pool.ts:841
                              • @@ -688,7 +688,7 @@ Can be overridden.

                            Returns void

                            +
                          • Defined in src/pools/abstract-pool.ts:1465
                              • @@ -711,7 +711,7 @@ Can be overridden.

                            Returns void

                            +
                          • Defined in src/pools/abstract-pool.ts:1473
                            • +
                          • Defined in src/pools/abstract-pool.ts:879
                            • +
                          • Defined in src/pools/abstract-pool.ts:901
                            • +
                          • Defined in src/pools/abstract-pool.ts:1483
                            • +
                          • Defined in src/pools/abstract-pool.ts:928
                            • +
                          • Defined in src/pools/abstract-pool.ts:959
                            • +
                          • Defined in src/pools/abstract-pool.ts:1491
                            • +
                          • Defined in src/pools/abstract-pool.ts:984
                              • @@ -834,7 +834,7 @@ Can be overridden.

                            Returns void

                            +
                          • Defined in src/pools/abstract-pool.ts:1497
                            • @@ -857,7 +857,7 @@ Can be overridden.

                            Methods
                            -
                            diff --git a/docs/interfaces/src.AbstractWorker.html b/docs/interfaces/src.AbstractWorker.html index 02b759d9e..811e8c866 100644 --- a/docs/interfaces/src.AbstractWorker.html +++ b/docs/interfaces/src.AbstractWorker.html @@ -1,5 +1,5 @@ -AbstractWorker | poolifier - v6.0.1
                            -
                            poolifier - v6.0.1 +AbstractWorker | poolifier - v6.0.2
                            +
                            poolifier - v6.0.2
                              @@ -27,7 +27,7 @@
                            • Response = unknown

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

                              • -
                              +

                              Hierarchy (View Summary)

                              +
                            • Defined in src/worker/abstract-worker.ts:63
                              • @@ -82,63 +82,63 @@

                              Handler id of the activeInterval worker activity check.

                              +
                            • Defined in src/worker/abstract-worker.ts:71
                              • id: number

                              Worker id.

                              +
                            • Defined in src/worker/abstract-worker.ts:75
                              • isMain: boolean | undefined

                              Whether this is the main worker or not.

                              +
                            • Defined in src/worker/abstract-worker.ts:122
                              • lastTaskTimestamp: number

                              Timestamp of the last task processed by this worker.

                              +
                            • Defined in src/worker/abstract-worker.ts:79
                              • opts: WorkerOptions = DEFAULT_WORKER_OPTIONS

                              Options for the worker.

                              +
                            • Defined in src/worker/abstract-worker.ts:125
                              • statistics?: WorkerStatistics

                              Performance statistics computation requirements.

                              +
                            • Defined in src/worker/abstract-worker.ts:84
                              • taskAbortFunctions: Map<
                                  `${string}-${string}-${string}-${string}-${string}`,
                                  () => void,
                              >

                              Task abort functions processed by the worker when task operation 'abort' is received.

                              +
                            • Defined in src/worker/abstract-worker.ts:89
                              • taskFunctionOperationContext: AsyncLocalStorage<
                                  `${string}-${string}-${string}-${string}-${string}`
                                  | undefined,
                              > = ...

                              Correlation of task function operations across protected handler overrides.

                              +
                            • Defined in src/worker/abstract-worker.ts:94
                              • taskFunctions: Map<string, TaskFunctionObject<Data, Response>>

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

                              +
                            • Defined in src/worker/abstract-worker.ts:101
                              • @@ -163,7 +163,7 @@ If a task function with the same name already exists, it is replaced.

                              Returns TaskFunctionOperationResult

                              Whether the task function was added or not.

                              +
                            • Defined in src/worker/abstract-worker.ts:145
                                • @@ -179,7 +179,7 @@ If a task function with the same name already exists, it is replaced.

                                If the main worker is not set.

                              +
                            • Defined in src/worker/abstract-worker.ts:290
                                • @@ -197,7 +197,7 @@ If a task function with the same name already exists, it is replaced.

                                Returns `${string}-${string}-${string}-${string}-${string}` | undefined

                                The task function operation UUID if available.

                              +
                            • Defined in src/worker/abstract-worker.ts:302
                                • @@ -215,7 +215,7 @@ If a task function with the same name already exists, it is replaced.

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

                                The worker error object.

                              +
                            • Defined in src/worker/abstract-worker.ts:319
                                • @@ -232,7 +232,7 @@ If a task function with the same name already exists, it is replaced.

                              Returns void

                              +
                            • Defined in src/worker/abstract-worker.ts:330
                                • @@ -249,7 +249,7 @@ If a task function with the same name already exists, it is replaced.

                              Returns void

                              +
                            • Defined in src/worker/abstract-worker.ts:365
                                • @@ -269,7 +269,7 @@ An acknowledgement without a recoverable UUID rejects the pool operation.

                              Returns void

                              +
                            • Defined in src/worker/abstract-worker.ts:374
                              • +
                            • Defined in src/worker/abstract-worker.ts:180
                              • +
                            • Defined in src/worker/abstract-worker.ts:193
                                • @@ -316,7 +316,7 @@ An acknowledgement without a recoverable UUID rejects the pool operation.

                              Returns void

                              +
                            • Defined in src/worker/abstract-worker.ts:459
                              • +
                            • Defined in src/worker/abstract-worker.ts:229
                                • @@ -351,7 +351,7 @@ An acknowledgement without a recoverable UUID rejects the pool operation.

                              Returns void

                              +
                            • Defined in src/worker/abstract-worker.ts:511
                                • @@ -371,7 +371,7 @@ An acknowledgement without a recoverable UUID rejects the pool operation.

                              Returns void

                              +
                            • Defined in src/worker/abstract-worker.ts:541
                                • @@ -391,7 +391,7 @@ An acknowledgement without a recoverable UUID rejects the pool operation.

                              Returns void

                              +
                            • Defined in src/worker/abstract-worker.ts:567
                              • +
                            • Defined in src/worker/abstract-worker.ts:598
                                • @@ -419,7 +419,7 @@ An acknowledgement without a recoverable UUID rejects the pool operation.

                              Returns void

                              +
                            • Defined in src/worker/abstract-worker.ts:608
                              • +
                            • Defined in src/worker/abstract-worker.ts:263
                              • @@ -458,7 +458,7 @@ An acknowledgement without a recoverable UUID rejects the pool operation.

                              Methods
                              -
                              diff --git a/docs/interfaces/src.IPool.html b/docs/interfaces/src.IPool.html index 2c9e9e904..9e5e45dda 100644 --- a/docs/interfaces/src.IPool.html +++ b/docs/interfaces/src.IPool.html @@ -1,5 +1,5 @@ -IPool | poolifier - v6.0.1
                              -
                              poolifier - v6.0.1 +IPool | poolifier - v6.0.2
                              +
                              poolifier - v6.0.2
                                @@ -32,7 +32,7 @@ +
                              • Defined in src/pools/pool.ts:81
                                • @@ -91,14 +91,14 @@ If a task function with the same name already exists, it will be overwritten.

                                Throws

                                If the fn parameter is not a function or task function object.

                                +
                              • Defined in src/pools/pool.ts:95
                                • destroy: () => Promise<void>

                                Terminates all workers in this pool.

                                +
                              • Defined in src/pools/pool.ts:102
                                • emitter?: EventEmitterAsyncResource
                                @@ -120,7 +120,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
                                +
                              • Defined in src/pools/pool.ts:121
                                • enableTasksQueue: (
                                    enable: boolean,
                                    tasksQueueOptions?: TasksQueueOptions,
                                ) => void
                                @@ -144,7 +144,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo

                                Returns void

                                +
                              • Defined in src/pools/pool.ts:127
                                • execute: (
                                    data?: Data,
                                    name?: string,
                                    abortSignal?: AbortSignal,
                                    transferList?: readonly Transferable[],
                                ) => Promise<Response>
                                @@ -175,7 +175,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo

                                Returns Promise<Response>

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

                                +
                              • Defined in src/pools/pool.ts:139
                                • hasTaskFunction: (name: string) => boolean
                                @@ -197,14 +197,14 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo

                                Returns boolean

                                true if the task function exists, false otherwise.

                                +
                              • Defined in src/pools/pool.ts:150
                                • info: PoolInfo

                                Pool information.

                                +
                              • Defined in src/pools/pool.ts:154
                                • listTaskFunctionsProperties: () => TaskFunctionProperties[]
                                @@ -220,7 +220,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo

                                Returns TaskFunctionProperties[]

                                The properties of task functions available in this pool.

                                +
                              • Defined in src/pools/pool.ts:159
                                • mapExecute: (
                                    data: Iterable<Data>,
                                    name?: string,
                                    abortSignals?: Iterable<AbortSignal, any, any>,
                                    transferList?: readonly Transferable[],
                                ) => Promise<Response[]>
                                @@ -251,7 +251,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo

                                Returns Promise<Response[]>

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

                                +
                              • Defined in src/pools/pool.ts:168
                                • removeTaskFunction: (name: string) => Promise<boolean>
                                @@ -273,7 +273,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo

                                Returns Promise<boolean>

                                true if the task function was removed, false otherwise.

                                +
                              • Defined in src/pools/pool.ts:179
                                • setDefaultTaskFunction: (name: string) => Promise<boolean>
                                @@ -295,7 +295,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo

                                Returns Promise<boolean>

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

                                +
                              • Defined in src/pools/pool.ts:185
                                • setTasksQueueOptions: (tasksQueueOptions: TasksQueueOptions) => void
                                @@ -316,7 +316,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo

                                Returns void

                                +
                              • Defined in src/pools/pool.ts:190
                                • setWorkerChoiceStrategy: (
                                    workerChoiceStrategy:
                                        | "FAIR_SHARE"
                                        | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
                                        | "LEAST_BUSY"
                                        | "LEAST_ELU"
                                        | "LEAST_USED"
                                        | "ROUND_ROBIN"
                                        | "WEIGHTED_ROUND_ROBIN",
                                    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions,
                                ) => void
                                @@ -340,7 +340,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo

                                Returns void

                                +
                              • Defined in src/pools/pool.ts:196
                                • setWorkerChoiceStrategyOptions: (
                                    workerChoiceStrategyOptions: WorkerChoiceStrategyOptions,
                                ) => boolean
                                @@ -362,14 +362,14 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo

                                Returns boolean

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

                                +
                              • Defined in src/pools/pool.ts:205
                                • start: () => void

                                Starts the minimum number of workers in this pool.

                                +
                              • Defined in src/pools/pool.ts:211
                                • @@ -388,7 +388,7 @@ The async tracking tooling identifier is poolifier:<PoolType>-<Wo
                                Properties
                                -
                                diff --git a/docs/interfaces/src.IWorker.html b/docs/interfaces/src.IWorker.html index d0f5383d7..db65dc7b0 100644 --- a/docs/interfaces/src.IWorker.html +++ b/docs/interfaces/src.IWorker.html @@ -1,5 +1,5 @@ -IWorker | poolifier - v6.0.1
                                -
                                poolifier - v6.0.1 +IWorker | poolifier - v6.0.2
                                +
                                poolifier - v6.0.2
                                  @@ -15,14 +15,14 @@

                                  Worker interface.

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

                                  Hierarchy

                                  • EventEmitter
                                    • IWorker
                                  +
                                • Defined in src/pools/worker.ts:146
                                  • @@ -67,35 +67,35 @@

                                  Cluster worker disconnect.

                                  +
                                • Defined in src/pools/worker.ts:150
                                  • id?: number

                                  Cluster worker id.

                                  +
                                • Defined in src/pools/worker.ts:154
                                  • isConnected?: () => boolean

                                  Whether the cluster worker is connected to its primary process.

                                  +
                                • Defined in src/pools/worker.ts:158
                                  • isDead?: () => boolean

                                  Whether the cluster worker process has exited.

                                  +
                                • Defined in src/pools/worker.ts:162
                                  • kill?: (signal?: string) => void

                                  Cluster worker kill.

                                  +
                                • Defined in src/pools/worker.ts:166
                                  • on: (event: string, handler: EventHandler<IWorker>) => this
                                  @@ -120,7 +120,7 @@

                                  Returns this

                                  +
                                • Defined in src/pools/worker.ts:172
                                  • once: (event: string, handler: EventHandler<IWorker>) => this
                                  @@ -145,7 +145,7 @@

                                  Returns this

                                  +
                                • Defined in src/pools/worker.ts:178
                                  • terminate?: () => Promise<number>
                                  @@ -153,14 +153,14 @@ Returns a Promise for the exit code that is fulfilled when the 'exit' event is emitted.

                                  +
                                • Defined in src/pools/worker.ts:183
                                  • threadId?: number

                                  Worker thread worker id.

                                  +
                                • Defined in src/pools/worker.ts:187
                                  • unref?: () => void
                                  @@ -172,7 +172,7 @@ active handle in the event system. If the worker is already unref()

                                  v10.5.0

                                  +
                                • Defined in src/pools/worker.ts:193
                                  • @@ -587,7 +587,7 @@ modified for this specific EventEmitter instance. The value can be
                                  Methods
                                  -
                                  diff --git a/docs/interfaces/src.MeasurementOptions.html b/docs/interfaces/src.MeasurementOptions.html index d24cc14c0..d46d27c99 100644 --- a/docs/interfaces/src.MeasurementOptions.html +++ b/docs/interfaces/src.MeasurementOptions.html @@ -1,5 +1,5 @@ -MeasurementOptions | poolifier - v6.0.1
                                  -
                                  poolifier - v6.0.1 +MeasurementOptions | poolifier - v6.0.2
                                  +
                                  poolifier - v6.0.2
                                    @@ -16,7 +16,7 @@
                                    interface MeasurementOptions {
                                        median: boolean;
                                    }
                                    +
                                  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:124
                                    • @@ -35,7 +35,7 @@

                                    Set measurement median.

                                    +
                                  • Defined in src/pools/selection-strategies/selection-strategies-types.ts:128
                                    • @@ -54,7 +54,7 @@
                                    Properties
                                    -
                                    diff --git a/docs/interfaces/src.PoolInfo.html b/docs/interfaces/src.PoolInfo.html index 9ee41fbba..7e0d5aa44 100644 --- a/docs/interfaces/src.PoolInfo.html +++ b/docs/interfaces/src.PoolInfo.html @@ -1,5 +1,5 @@ -PoolInfo | poolifier - v6.0.1
                                    -
                                    poolifier - v6.0.1 +PoolInfo | poolifier - v6.0.2
                                    +
                                    poolifier - v6.0.2
                                      @@ -16,7 +16,7 @@
                                      interface PoolInfo {
                                          backPressure?: boolean;
                                          backPressureWorkerNodes?: number;
                                          busyWorkerNodes: number;
                                          defaultStrategy:
                                              | "FAIR_SHARE"
                                              | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
                                              | "LEAST_BUSY"
                                              | "LEAST_ELU"
                                              | "LEAST_USED"
                                              | "ROUND_ROBIN"
                                              | "WEIGHTED_ROUND_ROBIN";
                                          dynamicWorkerNodes?: number;
                                          elu?: {
                                              active: {
                                                  average?: number;
                                                  maximum: number;
                                                  median?: number;
                                                  minimum: number;
                                              };
                                              idle: {
                                                  average?: number;
                                                  maximum: number;
                                                  median?: number;
                                                  minimum: number;
                                              };
                                              utilization: { average?: number; median?: number };
                                          };
                                          executedTasks: number;
                                          executingTasks: number;
                                          failedTasks: number;
                                          idleWorkerNodes: number;
                                          maxQueuedTasks?: number;
                                          maxSize: number;
                                          minSize: number;
                                          queuedTasks?: number;
                                          ready: boolean;
                                          runTime?: {
                                              average?: number;
                                              maximum: number;
                                              median?: number;
                                              minimum: number;
                                          };
                                          started: boolean;
                                          stealingWorkerNodes?: number;
                                          stolenTasks?: number;
                                          strategyRetries: number;
                                          type: "fixed"
                                          | "dynamic";
                                          utilization?: number;
                                          version: string;
                                          waitTime?: {
                                              average?: number;
                                              maximum: number;
                                              median?: number;
                                              minimum: number;
                                          };
                                          worker: "cluster"
                                          | "thread";
                                          workerNodes: number;
                                      }
                                      +
                                    • Defined in src/pools/pool.ts:227
                                      • @@ -58,146 +58,146 @@
                                      backPressure?: boolean
                                      +
                                    • Defined in src/pools/pool.ts:228
                                      • backPressureWorkerNodes?: number

                                      Pool tasks back pressure worker nodes.

                                      +
                                    • Defined in src/pools/pool.ts:230
                                      • busyWorkerNodes: number

                                      Pool busy worker nodes.

                                      +
                                    • Defined in src/pools/pool.ts:232
                                      • defaultStrategy:
                                          | "FAIR_SHARE"
                                          | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
                                          | "LEAST_BUSY"
                                          | "LEAST_ELU"
                                          | "LEAST_USED"
                                          | "ROUND_ROBIN"
                                          | "WEIGHTED_ROUND_ROBIN"
                                      +
                                    • Defined in src/pools/pool.ts:233
                                      • dynamicWorkerNodes?: number

                                      Pool dynamic worker nodes.

                                      +
                                    • Defined in src/pools/pool.ts:235
                                      • elu?: {
                                          active: {
                                              average?: number;
                                              maximum: number;
                                              median?: number;
                                              minimum: number;
                                          };
                                          idle: {
                                              average?: number;
                                              maximum: number;
                                              median?: number;
                                              minimum: number;
                                          };
                                          utilization: { average?: number; median?: number };
                                      }
                                      +
                                    • Defined in src/pools/pool.ts:236
                                      • executedTasks: number
                                      +
                                    • Defined in src/pools/pool.ts:254
                                      • executingTasks: number
                                      +
                                    • Defined in src/pools/pool.ts:255
                                      • failedTasks: number
                                      +
                                    • Defined in src/pools/pool.ts:256
                                      • idleWorkerNodes: number

                                      Pool idle worker nodes.

                                      +
                                    • Defined in src/pools/pool.ts:258
                                      • maxQueuedTasks?: number
                                      +
                                    • Defined in src/pools/pool.ts:259
                                      • maxSize: number
                                      +
                                    • Defined in src/pools/pool.ts:260
                                      • minSize: number
                                      +
                                    • Defined in src/pools/pool.ts:261
                                      • queuedTasks?: number
                                      +
                                    • Defined in src/pools/pool.ts:262
                                      • ready: boolean
                                      +
                                    • Defined in src/pools/pool.ts:263
                                      • runTime?: {
                                          average?: number;
                                          maximum: number;
                                          median?: number;
                                          minimum: number;
                                      }
                                      +
                                    • Defined in src/pools/pool.ts:264
                                      • started: boolean
                                      +
                                    • Defined in src/pools/pool.ts:270
                                      • stealingWorkerNodes?: number

                                      Pool tasks stealing worker nodes.

                                      +
                                    • Defined in src/pools/pool.ts:272
                                      • stolenTasks?: number
                                      +
                                    • Defined in src/pools/pool.ts:273
                                      • strategyRetries: number
                                      +
                                    • Defined in src/pools/pool.ts:274
                                      • type: "fixed" | "dynamic"
                                      +
                                    • Defined in src/pools/pool.ts:275
                                      • utilization?: number

                                      Pool utilization.

                                      +
                                    • Defined in src/pools/pool.ts:277
                                      • version: string
                                      +
                                    • Defined in src/pools/pool.ts:278
                                      • waitTime?: {
                                          average?: number;
                                          maximum: number;
                                          median?: number;
                                          minimum: number;
                                      }
                                      +
                                    • Defined in src/pools/pool.ts:279
                                      • worker: "cluster" | "thread"
                                      +
                                    • Defined in src/pools/pool.ts:285
                                      • workerNodes: number

                                      Pool total worker nodes.

                                      +
                                    • Defined in src/pools/pool.ts:287
                                      • @@ -216,7 +216,7 @@
                                      Properties
                                      -
                                      diff --git a/docs/interfaces/src.PoolOptions.html b/docs/interfaces/src.PoolOptions.html index 1267d74b0..655a8dcc2 100644 --- a/docs/interfaces/src.PoolOptions.html +++ b/docs/interfaces/src.PoolOptions.html @@ -1,5 +1,5 @@ -PoolOptions | poolifier - v6.0.1
                                      -
                                      poolifier - v6.0.1 +PoolOptions | poolifier - v6.0.2
                                      +
                                      poolifier - v6.0.2
                                        @@ -22,7 +22,7 @@

                                        Type of worker.

                                        +
                                      • Defined in src/pools/pool.ts:294
                                        • @@ -60,7 +60,7 @@
                                        +
                                      • Defined in src/pools/pool.ts:299
                                        • enableTasksQueue?: boolean
                                        @@ -73,7 +73,7 @@
                                        +
                                      • Defined in src/pools/pool.ts:304
                                        • env?: Record<string, unknown>
                                        @@ -84,7 +84,7 @@

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

                                        +
                                      • Defined in src/pools/pool.ts:309
                                        • errorHandler?: ErrorHandler<Worker>
                                        @@ -95,7 +95,7 @@

                                        () => {}

                                        +
                                      • Defined in src/pools/pool.ts:314
                                        • exitHandler?: ExitHandler<Worker>
                                        @@ -106,7 +106,7 @@

                                        () => {}

                                        +
                                      • Defined in src/pools/pool.ts:319
                                        • messageHandler?: MessageHandler<Worker>
                                        @@ -117,7 +117,7 @@

                                        () => {}

                                        +
                                      • Defined in src/pools/pool.ts:324
                                        • onlineHandler?: OnlineHandler<Worker>
                                        @@ -128,14 +128,14 @@

                                        () => {}

                                        +
                                      • Defined in src/pools/pool.ts:329
                                        • restartWorkerOnError?: boolean

                                        Restart worker on error.

                                        +
                                      • Defined in src/pools/pool.ts:333
                                        • settings?: ClusterSettings
                                        @@ -146,7 +146,7 @@

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

                                        +
                                      • Defined in src/pools/pool.ts:338
                                        • startWorkers?: boolean
                                        @@ -159,14 +159,14 @@
                                        +
                                      • Defined in src/pools/pool.ts:343
                                        • tasksQueueOptions?: TasksQueueOptions

                                        Pool worker node tasks queue options.

                                        +
                                      • Defined in src/pools/pool.ts:347
                                        • workerChoiceStrategy?:
                                            | "FAIR_SHARE"
                                            | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
                                            | "LEAST_BUSY"
                                            | "LEAST_ELU"
                                            | "LEAST_USED"
                                            | "ROUND_ROBIN"
                                            | "WEIGHTED_ROUND_ROBIN"
                                        @@ -179,14 +179,14 @@
                                        +
                                      • Defined in src/pools/pool.ts:352
                                        • workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions

                                        The worker choice strategy options.

                                        +
                                      • Defined in src/pools/pool.ts:356
                                        • workerOptions?: WorkerOptions
                                        @@ -197,7 +197,7 @@

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

                                        +
                                      • Defined in src/pools/pool.ts:361
                                        • @@ -216,7 +216,7 @@
                                        Properties
                                        -
                                        diff --git a/docs/interfaces/src.TaskFunctionObject.html b/docs/interfaces/src.TaskFunctionObject.html index b2535db1f..5a08eb4c5 100644 --- a/docs/interfaces/src.TaskFunctionObject.html +++ b/docs/interfaces/src.TaskFunctionObject.html @@ -1,5 +1,5 @@ -TaskFunctionObject | poolifier - v6.0.1
                                        -
                                        poolifier - v6.0.1 +TaskFunctionObject | poolifier - v6.0.2
                                        +
                                        poolifier - v6.0.2
                                          @@ -25,7 +25,7 @@

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

                                          +
                                        • Defined in src/worker/task-functions.ts:30
                                          • @@ -47,21 +47,21 @@

                                          Task function priority. Lower values have higher priority.

                                          +
                                        • Defined in src/worker/task-functions.ts:34
                                          • strategy?:
                                              | "FAIR_SHARE"
                                              | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
                                              | "LEAST_BUSY"
                                              | "LEAST_ELU"
                                              | "LEAST_USED"
                                              | "ROUND_ROBIN"
                                              | "WEIGHTED_ROUND_ROBIN"

                                          Task function worker choice strategy.

                                          +
                                        • Defined in src/worker/task-functions.ts:38
                                          • taskFunction: TaskFunction<Data, Response>

                                          Task function.

                                          +
                                        • Defined in src/worker/task-functions.ts:42
                                          • workerNodeKeys?: number[]
                                          @@ -73,7 +73,7 @@ Task stealing ignores affinity. For strict affinity with task queues enabled, disable both taskStealing and tasksStealingOnBackPressure.

                                          +
                                        • Defined in src/worker/task-functions.ts:51
                                          • @@ -92,7 +92,7 @@ disable both taskStealing and tasksStealingOnBackPressureProperties
                                          -
                                          diff --git a/docs/interfaces/src.TaskFunctionOperationResult.html b/docs/interfaces/src.TaskFunctionOperationResult.html index a2abfbf15..89683ed03 100644 --- a/docs/interfaces/src.TaskFunctionOperationResult.html +++ b/docs/interfaces/src.TaskFunctionOperationResult.html @@ -1,5 +1,5 @@ -TaskFunctionOperationResult | poolifier - v6.0.1
                                          -
                                          poolifier - v6.0.1 +TaskFunctionOperationResult | poolifier - v6.0.2
                                          +
                                          poolifier - v6.0.2
                                            @@ -16,7 +16,7 @@
                                            interface TaskFunctionOperationResult {
                                                error?: Error;
                                                status: boolean;
                                            }
                                            +
                                          • Defined in src/worker/task-functions.ts:57
                                            • @@ -34,12 +34,12 @@
                                            error?: Error
                                            +
                                          • Defined in src/worker/task-functions.ts:58
                                            • status: boolean
                                            +
                                          • Defined in src/worker/task-functions.ts:59
                                            • @@ -58,7 +58,7 @@
                                            Properties
                                            -
                                            diff --git a/docs/interfaces/src.TaskFunctionProperties.html b/docs/interfaces/src.TaskFunctionProperties.html index bac62a207..52c4bd907 100644 --- a/docs/interfaces/src.TaskFunctionProperties.html +++ b/docs/interfaces/src.TaskFunctionProperties.html @@ -1,5 +1,5 @@ -TaskFunctionProperties | poolifier - v6.0.1
                                            -
                                            poolifier - v6.0.1 +TaskFunctionProperties | poolifier - v6.0.2
                                            +
                                            poolifier - v6.0.2
                                              @@ -16,7 +16,7 @@
                                              interface TaskFunctionProperties {
                                                  name: string;
                                                  priority?: number;
                                                  strategy?:
                                                      | "FAIR_SHARE"
                                                      | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
                                                      | "LEAST_BUSY"
                                                      | "LEAST_ELU"
                                                      | "LEAST_USED"
                                                      | "ROUND_ROBIN"
                                                      | "WEIGHTED_ROUND_ROBIN";
                                                  workerNodeKeys?: number[];
                                              }
                                              +
                                            • Defined in src/utility-types.ts:163
                                              • @@ -38,21 +38,21 @@

                                              Task function name.

                                              +
                                            • Defined in src/utility-types.ts:167
                                              • priority?: number

                                              Task function priority. Lower values have higher priority.

                                              +
                                            • Defined in src/utility-types.ts:171
                                              • strategy?:
                                                  | "FAIR_SHARE"
                                                  | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"
                                                  | "LEAST_BUSY"
                                                  | "LEAST_ELU"
                                                  | "LEAST_USED"
                                                  | "ROUND_ROBIN"
                                                  | "WEIGHTED_ROUND_ROBIN"

                                              Task function worker choice strategy.

                                              +
                                            • Defined in src/utility-types.ts:175
                                              • workerNodeKeys?: number[]
                                              @@ -64,7 +64,7 @@ Task stealing ignores affinity. For strict affinity with task queues enabled, disable both taskStealing and tasksStealingOnBackPressure.

                                              +
                                            • Defined in src/utility-types.ts:184
                                              • @@ -83,7 +83,7 @@ disable both taskStealing and tasksStealingOnBackPressureProperties
                                              -
                                              diff --git a/docs/interfaces/src.TasksQueueOptions.html b/docs/interfaces/src.TasksQueueOptions.html index ab3e0df55..ae9aa0f16 100644 --- a/docs/interfaces/src.TasksQueueOptions.html +++ b/docs/interfaces/src.TasksQueueOptions.html @@ -1,5 +1,5 @@ -TasksQueueOptions | poolifier - v6.0.1
                                              -
                                              poolifier - v6.0.1 +TasksQueueOptions | poolifier - v6.0.2
                                              +
                                              poolifier - v6.0.2
                                                @@ -16,7 +16,7 @@
                                                interface TasksQueueOptions {
                                                    agingFactor?: number;
                                                    concurrency?: number;
                                                    loadExponent?: number;
                                                    size?: number;
                                                    tasksFinishedTimeout?: number;
                                                    tasksStealingOnBackPressure?: boolean;
                                                    tasksStealingRatio?: number;
                                                    taskStealing?: boolean;
                                                }
                                                +
                                              • Defined in src/pools/pool.ts:367
                                                • @@ -48,7 +48,7 @@
                                                +
                                              • Defined in src/pools/pool.ts:372
                                                • concurrency?: number
                                                @@ -61,7 +61,7 @@
                                                +
                                              • Defined in src/pools/pool.ts:377
                                                • loadExponent?: number
                                                @@ -74,7 +74,7 @@
                                                +
                                              • Defined in src/pools/pool.ts:382
                                                • size?: number
                                                @@ -87,7 +87,7 @@
                                                +
                                              • Defined in src/pools/pool.ts:387
                                                • tasksFinishedTimeout?: number
                                                @@ -100,7 +100,7 @@
                                                +
                                              • Defined in src/pools/pool.ts:392
                                                • tasksStealingOnBackPressure?: boolean
                                                @@ -113,7 +113,7 @@
                                                +
                                              • Defined in src/pools/pool.ts:397
                                                • tasksStealingRatio?: number
                                                @@ -126,7 +126,7 @@
                                                +
                                              • Defined in src/pools/pool.ts:402
                                                • taskStealing?: boolean
                                                @@ -139,7 +139,7 @@
                                                +
                                              • Defined in src/pools/pool.ts:407
                                                • @@ -158,7 +158,7 @@
                                                Properties
                                                -
                                                diff --git a/docs/interfaces/src.WorkerChoiceStrategyOptions.html b/docs/interfaces/src.WorkerChoiceStrategyOptions.html index ab5ee9108..856d6a851 100644 --- a/docs/interfaces/src.WorkerChoiceStrategyOptions.html +++ b/docs/interfaces/src.WorkerChoiceStrategyOptions.html @@ -1,5 +1,5 @@ -WorkerChoiceStrategyOptions | poolifier - v6.0.1
                                                -
                                                poolifier - v6.0.1 +WorkerChoiceStrategyOptions | poolifier - v6.0.2
                                                +
                                                poolifier - v6.0.2
                                                  @@ -16,7 +16,7 @@
                                                  interface WorkerChoiceStrategyOptions {
                                                      elu?: MeasurementOptions;
                                                      measurement?: "elu" | "runTime" | "waitTime";
                                                      runTime?: MeasurementOptions;
                                                      waitTime?: MeasurementOptions;
                                                      weights?: Record<number, number>;
                                                  }
                                                  +
                                                • Defined in src/pools/selection-strategies/selection-strategies-types.ts:187
                                                  • @@ -45,14 +45,14 @@
                                                  +
                                                • Defined in src/pools/selection-strategies/selection-strategies-types.ts:192
                                                  • measurement?: "elu" | "runTime" | "waitTime"

                                                  Measurement to use in worker choice strategy supporting it.

                                                  +
                                                • Defined in src/pools/selection-strategies/selection-strategies-types.ts:196
                                                  • runTime?: MeasurementOptions
                                                  @@ -65,7 +65,7 @@
                                                  +
                                                • Defined in src/pools/selection-strategies/selection-strategies-types.ts:201
                                                  • waitTime?: MeasurementOptions
                                                  @@ -78,7 +78,7 @@
                                                  +
                                                • Defined in src/pools/selection-strategies/selection-strategies-types.ts:206
                                                  • weights?: Record<number, number>
                                                  @@ -92,7 +92,7 @@ A weight is tasks maximum execution time in milliseconds for a worker node.

                                                  +
                                                • Defined in src/pools/selection-strategies/selection-strategies-types.ts:212
                                                  • @@ -111,7 +111,7 @@ A weight is tasks maximum execution time in milliseconds for a worker node.

                                                  Properties
                                                  -
                                                  diff --git a/docs/interfaces/src.WorkerError.html b/docs/interfaces/src.WorkerError.html index 9392003bb..9fd896194 100644 --- a/docs/interfaces/src.WorkerError.html +++ b/docs/interfaces/src.WorkerError.html @@ -1,5 +1,5 @@ -WorkerError | poolifier - v6.0.1
                                                  -
                                                  poolifier - v6.0.1 +WorkerError | poolifier - v6.0.2
                                                  +
                                                  poolifier - v6.0.2
                                                    @@ -22,7 +22,7 @@

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

                                                    +
                                                  • Defined in src/utility-types.ts:214
                                                    • @@ -46,42 +46,42 @@

                                                    Whether the error is an abort error or not.

                                                    +
                                                  • Defined in src/utility-types.ts:218
                                                    • data?: Data

                                                    Data triggering the error.

                                                    +
                                                  • Defined in src/utility-types.ts:222
                                                    • error?: Error

                                                    Error object.

                                                    +
                                                  • Defined in src/utility-types.ts:226
                                                    • message: string

                                                    Error message.

                                                    +
                                                  • Defined in src/utility-types.ts:230
                                                    • name?: string

                                                    Task function name triggering the error.

                                                    +
                                                  • Defined in src/utility-types.ts:234
                                                    • stack?: string

                                                    Error stack trace.

                                                    +
                                                  • Defined in src/utility-types.ts:238
                                                    • @@ -100,7 +100,7 @@
                                                    Properties
                                                    -
                                                    diff --git a/docs/interfaces/src.WorkerOptions.html b/docs/interfaces/src.WorkerOptions.html index a65c8d5ea..ea99c3dc1 100644 --- a/docs/interfaces/src.WorkerOptions.html +++ b/docs/interfaces/src.WorkerOptions.html @@ -1,5 +1,5 @@ -WorkerOptions | poolifier - v6.0.1
                                                    -
                                                    poolifier - v6.0.1 +WorkerOptions | poolifier - v6.0.2
                                                    +
                                                    poolifier - v6.0.2
                                                      @@ -16,7 +16,7 @@
                                                      interface WorkerOptions {
                                                          killBehavior?: "HARD" | "SOFT";
                                                          killHandler?: KillHandler;
                                                          maxInactiveTime?: number;
                                                      }
                                                      +
                                                    • Defined in src/worker/worker-options.ts:30
                                                      • @@ -48,7 +48,7 @@
                                                      +
                                                    • Defined in src/worker/worker-options.ts:40
                                                      • killHandler?: KillHandler
                                                      @@ -59,7 +59,7 @@

                                                      () => {}

                                                      +
                                                    • Defined in src/worker/worker-options.ts:45
                                                      • maxInactiveTime?: number
                                                      @@ -79,7 +79,7 @@ when this timeout expires your tasks is interrupted before completion and remove
                                                      +
                                                    • Defined in src/worker/worker-options.ts:57
                                                      • @@ -98,7 +98,7 @@ when this timeout expires your tasks is interrupted before completion and remove
                                                      Properties
                                                      -
                                                      diff --git a/docs/modules/src.html b/docs/modules/src.html index 31a740e22..137fee084 100644 --- a/docs/modules/src.html +++ b/docs/modules/src.html @@ -1,5 +1,5 @@ -src | poolifier - v6.0.1
                                                      -
                                                      poolifier - v6.0.1 +src | poolifier - v6.0.2
                                                      +
                                                      poolifier - v6.0.2
                                                        @@ -46,7 +46,7 @@
                                                        Functions
                                                        -
                                                        diff --git a/docs/types/src.ClusterPoolOptions.html b/docs/types/src.ClusterPoolOptions.html index 5cb63efc7..a3d65976b 100644 --- a/docs/types/src.ClusterPoolOptions.html +++ b/docs/types/src.ClusterPoolOptions.html @@ -1,5 +1,5 @@ -ClusterPoolOptions | poolifier - v6.0.1
                                                        -
                                                        poolifier - v6.0.1 +ClusterPoolOptions | poolifier - v6.0.2
                                                        +
                                                        poolifier - v6.0.2
                                                          @@ -15,7 +15,7 @@

                                                          Options for a poolifier cluster pool.

                                                          +
                                                        • Defined in src/pools/cluster/fixed.ts:13
                                                          • @@ -29,7 +29,7 @@
                                                          • -
                                                          diff --git a/docs/types/src.ErrorHandler.html b/docs/types/src.ErrorHandler.html index 6b24227e5..747fcfff5 100644 --- a/docs/types/src.ErrorHandler.html +++ b/docs/types/src.ErrorHandler.html @@ -1,5 +1,5 @@ -ErrorHandler | poolifier - v6.0.1
                                                          -
                                                          poolifier - v6.0.1 +ErrorHandler | poolifier - v6.0.2
                                                          +
                                                          poolifier - v6.0.2
                                                            @@ -34,7 +34,7 @@
                                                          • error: Error

                                                            • Returns void

                                                            +
                                                          • Defined in src/pools/worker.ts:13
                                                            • @@ -48,7 +48,7 @@
                                                            • -
                                                            diff --git a/docs/types/src.EventHandler.html b/docs/types/src.EventHandler.html index 77e2c8e3c..d22a1af8c 100644 --- a/docs/types/src.EventHandler.html +++ b/docs/types/src.EventHandler.html @@ -1,5 +1,5 @@ -EventHandler | poolifier - v6.0.1
                                                            -
                                                            poolifier - v6.0.1 +EventHandler | poolifier - v6.0.2
                                                            +
                                                            poolifier - v6.0.2
                                                              @@ -21,7 +21,7 @@

                                                              Type of worker.

                                                              +
                                                            • Defined in src/pools/worker.ts:22
                                                              • @@ -35,7 +35,7 @@
                                                              • -
                                                              diff --git a/docs/types/src.ExitHandler.html b/docs/types/src.ExitHandler.html index 188bbdcfc..2857f1e97 100644 --- a/docs/types/src.ExitHandler.html +++ b/docs/types/src.ExitHandler.html @@ -1,5 +1,5 @@ -ExitHandler | poolifier - v6.0.1
                                                              -
                                                              poolifier - v6.0.1 +ExitHandler | poolifier - v6.0.2
                                                              +
                                                              poolifier - v6.0.2
                                                                @@ -34,7 +34,7 @@
                                                              • exitCode: number

                                                                • Returns void

                                                                +
                                                              • Defined in src/pools/worker.ts:32
                                                                • @@ -48,7 +48,7 @@
                                                                • -
                                                                diff --git a/docs/types/src.KillBehavior.html b/docs/types/src.KillBehavior.html index b7c1159ca..4047857f5 100644 --- a/docs/types/src.KillBehavior.html +++ b/docs/types/src.KillBehavior.html @@ -1,5 +1,5 @@ -KillBehavior | poolifier - v6.0.1
                                                                -
                                                                poolifier - v6.0.1 +KillBehavior | poolifier - v6.0.2
                                                                +
                                                                poolifier - v6.0.2
                                                                  @@ -15,7 +15,7 @@

                                                                  Kill behavior.

                                                                  +
                                                                • Defined in src/worker/worker-options.ts:19
                                                                  • @@ -29,7 +29,7 @@
                                                                  • -
                                                                  diff --git a/docs/types/src.KillHandler.html b/docs/types/src.KillHandler.html index 4bec6f887..e7d61193a 100644 --- a/docs/types/src.KillHandler.html +++ b/docs/types/src.KillHandler.html @@ -1,5 +1,5 @@ -KillHandler | poolifier - v6.0.1
                                                                  -
                                                                  poolifier - v6.0.1 +KillHandler | poolifier - v6.0.2
                                                                  +
                                                                  poolifier - v6.0.2
                                                                    @@ -24,7 +24,7 @@ Returned promises and other thenable values are awaited.

                                                                  • Returns PromiseLike<void> | void

                                                                    • +
                                                                  • Defined in src/worker/worker-options.ts:25
                                                                    • @@ -38,7 +38,7 @@ Returned promises and other thenable values are awaited.

                                                                    • -
                                                                    diff --git a/docs/types/src.Measurement.html b/docs/types/src.Measurement.html index ed864bddb..fc0504958 100644 --- a/docs/types/src.Measurement.html +++ b/docs/types/src.Measurement.html @@ -1,5 +1,5 @@ -Measurement | poolifier - v6.0.1
                                                                    -
                                                                    poolifier - v6.0.1 +Measurement | poolifier - v6.0.2
                                                                    +
                                                                    poolifier - v6.0.2
                                                                      @@ -15,7 +15,7 @@

                                                                      Measurement.

                                                                      +
                                                                    • Defined in src/pools/selection-strategies/selection-strategies-types.ts:119
                                                                      • @@ -29,7 +29,7 @@
                                                                      • -
                                                                      diff --git a/docs/types/src.MessageHandler.html b/docs/types/src.MessageHandler.html index c14a19daf..b6a72e5be 100644 --- a/docs/types/src.MessageHandler.html +++ b/docs/types/src.MessageHandler.html @@ -1,5 +1,5 @@ -MessageHandler | poolifier - v6.0.1
                                                                      -
                                                                      poolifier - v6.0.1 +MessageHandler | poolifier - v6.0.2
                                                                      +
                                                                      poolifier - v6.0.2
                                                                        @@ -34,7 +34,7 @@
                                                                      • message: unknown

                                                                        • Returns void

                                                                        +
                                                                      • Defined in src/pools/worker.ts:41
                                                                        • @@ -48,7 +48,7 @@
                                                                        • -
                                                                        diff --git a/docs/types/src.OnlineHandler.html b/docs/types/src.OnlineHandler.html index 0ef7e5faf..d4998a4bf 100644 --- a/docs/types/src.OnlineHandler.html +++ b/docs/types/src.OnlineHandler.html @@ -1,5 +1,5 @@ -OnlineHandler | poolifier - v6.0.1
                                                                        -
                                                                        poolifier - v6.0.1 +OnlineHandler | poolifier - v6.0.2
                                                                        +
                                                                        poolifier - v6.0.2
                                                                          @@ -33,7 +33,7 @@
                                                                        • this: Worker

                                                                          • Returns void

                                                                          +
                                                                        • Defined in src/pools/worker.ts:50
                                                                          • @@ -47,7 +47,7 @@
                                                                          • -
                                                                          diff --git a/docs/types/src.PoolEvent.html b/docs/types/src.PoolEvent.html index 79296268f..c7cb713a1 100644 --- a/docs/types/src.PoolEvent.html +++ b/docs/types/src.PoolEvent.html @@ -1,5 +1,5 @@ -PoolEvent | poolifier - v6.0.1
                                                                          -
                                                                          poolifier - v6.0.1 +PoolEvent | poolifier - v6.0.2
                                                                          +
                                                                          poolifier - v6.0.2
                                                                            @@ -15,7 +15,7 @@

                                                                            Pool event.

                                                                            +
                                                                          • Defined in src/pools/pool.ts:222
                                                                            • @@ -29,7 +29,7 @@
                                                                            • -
                                                                            diff --git a/docs/types/src.PoolType.html b/docs/types/src.PoolType.html index 9040d225b..ee28f23d2 100644 --- a/docs/types/src.PoolType.html +++ b/docs/types/src.PoolType.html @@ -1,5 +1,5 @@ -PoolType | poolifier - v6.0.1
                                                                            -
                                                                            poolifier - v6.0.1 +PoolType | poolifier - v6.0.2
                                                                            +
                                                                            poolifier - v6.0.2
                                                                              @@ -15,7 +15,7 @@

                                                                              Pool type.

                                                                              +
                                                                            • Defined in src/pools/pool.ts:44
                                                                              • @@ -29,7 +29,7 @@
                                                                              • -
                                                                              diff --git a/docs/types/src.TaskAsyncFunction.html b/docs/types/src.TaskAsyncFunction.html index cabe8aa9d..c36a50473 100644 --- a/docs/types/src.TaskAsyncFunction.html +++ b/docs/types/src.TaskAsyncFunction.html @@ -1,5 +1,5 @@ -TaskAsyncFunction | poolifier - v6.0.1
                                                                              -
                                                                              poolifier - v6.0.1 +TaskAsyncFunction | poolifier - v6.0.2
                                                                              +
                                                                              poolifier - v6.0.2
                                                                                @@ -40,7 +40,7 @@ This function must return a promise.

                                                                                Returns Promise<Response>

                                                                                Execution response promise.

                                                                                +
                                                                              • Defined in src/worker/task-functions.ts:11
                                                                                • @@ -54,7 +54,7 @@ This function must return a promise.

                                                                                • -
                                                                                diff --git a/docs/types/src.TaskFunction.html b/docs/types/src.TaskFunction.html index 3cd45429f..06f048a31 100644 --- a/docs/types/src.TaskFunction.html +++ b/docs/types/src.TaskFunction.html @@ -1,5 +1,5 @@ -TaskFunction | poolifier - v6.0.1
                                                                                -
                                                                                poolifier - v6.0.1 +TaskFunction | poolifier - v6.0.2
                                                                                +
                                                                                poolifier - v6.0.2
                                                                                  @@ -37,7 +37,7 @@ This function can return a value, a promise or another thenable.

                                                                                • Optionaldata: Data

                                                                                  • Returns PromiseLike<Response> | Response

                                                                                  +
                                                                                • Defined in src/worker/task-functions.ts:21
                                                                                  • @@ -51,7 +51,7 @@ This function can return a value, a promise or another thenable.

                                                                                  • -
                                                                                  diff --git a/docs/types/src.TaskFunctions.html b/docs/types/src.TaskFunctions.html index cb6c74494..6ac24ff82 100644 --- a/docs/types/src.TaskFunctions.html +++ b/docs/types/src.TaskFunctions.html @@ -1,5 +1,5 @@ -TaskFunctions | poolifier - v6.0.1
                                                                                  -
                                                                                  poolifier - v6.0.1 +TaskFunctions | poolifier - v6.0.2
                                                                                  +
                                                                                  poolifier - v6.0.2
                                                                                    @@ -26,7 +26,7 @@ The value is the task function or task function object.

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

                                                                                    +
                                                                                  • Defined in src/worker/task-functions.ts:69
                                                                                    • @@ -40,7 +40,7 @@ The value is the task function or task function object.

                                                                                    • -
                                                                                    diff --git a/docs/types/src.TaskSyncFunction.html b/docs/types/src.TaskSyncFunction.html index 23b443887..5651be01d 100644 --- a/docs/types/src.TaskSyncFunction.html +++ b/docs/types/src.TaskSyncFunction.html @@ -1,5 +1,5 @@ -TaskSyncFunction | poolifier - v6.0.1
                                                                                    -
                                                                                    poolifier - v6.0.1 +TaskSyncFunction | poolifier - v6.0.2
                                                                                    +
                                                                                    poolifier - v6.0.2
                                                                                      @@ -39,7 +39,7 @@

                                                                                      Returns Response

                                                                                      Execution response.

                                                                                      +
                                                                                    • Defined in src/worker/task-functions.ts:81
                                                                                      • @@ -53,7 +53,7 @@
                                                                                      • -
                                                                                      diff --git a/docs/types/src.ThreadPoolOptions.html b/docs/types/src.ThreadPoolOptions.html index 4815354d5..a23295887 100644 --- a/docs/types/src.ThreadPoolOptions.html +++ b/docs/types/src.ThreadPoolOptions.html @@ -1,5 +1,5 @@ -ThreadPoolOptions | poolifier - v6.0.1
                                                                                      -
                                                                                      poolifier - v6.0.1 +ThreadPoolOptions | poolifier - v6.0.2
                                                                                      +
                                                                                      poolifier - v6.0.2
                                                                                        @@ -15,7 +15,7 @@

                                                                                        Options for a poolifier thread pool.

                                                                                        +
                                                                                      • Defined in src/pools/thread/fixed.ts:16
                                                                                        • @@ -29,7 +29,7 @@
                                                                                        • -
                                                                                        diff --git a/docs/types/src.WorkerChoiceStrategy.html b/docs/types/src.WorkerChoiceStrategy.html index 7af7e5a34..db076e79b 100644 --- a/docs/types/src.WorkerChoiceStrategy.html +++ b/docs/types/src.WorkerChoiceStrategy.html @@ -1,5 +1,5 @@ -WorkerChoiceStrategy | poolifier - v6.0.1
                                                                                        -
                                                                                        poolifier - v6.0.1 +WorkerChoiceStrategy | poolifier - v6.0.2
                                                                                        +
                                                                                        poolifier - v6.0.2
                                                                                          @@ -15,7 +15,7 @@

                                                                                          Worker choice strategy.

                                                                                          +
                                                                                        • Defined in src/pools/selection-strategies/selection-strategies-types.ts:47
                                                                                          • @@ -29,7 +29,7 @@
                                                                                          • -
                                                                                          diff --git a/docs/types/src.WorkerType.html b/docs/types/src.WorkerType.html index 9905a4149..c57b672b1 100644 --- a/docs/types/src.WorkerType.html +++ b/docs/types/src.WorkerType.html @@ -1,5 +1,5 @@ -WorkerType | poolifier - v6.0.1
                                                                                          -
                                                                                          poolifier - v6.0.1 +WorkerType | poolifier - v6.0.2
                                                                                          +
                                                                                          poolifier - v6.0.2
                                                                                            @@ -15,7 +15,7 @@

                                                                                            Worker type.

                                                                                            +
                                                                                          • Defined in src/pools/worker.ts:400
                                                                                            • @@ -29,7 +29,7 @@
                                                                                            • -
                                                                                            diff --git a/docs/variables/src.KillBehaviors.html b/docs/variables/src.KillBehaviors.html index 8518d3fbf..ed158cde6 100644 --- a/docs/variables/src.KillBehaviors.html +++ b/docs/variables/src.KillBehaviors.html @@ -1,5 +1,5 @@ -KillBehaviors | poolifier - v6.0.1
                                                                                            -
                                                                                            poolifier - v6.0.1 +KillBehaviors | poolifier - v6.0.2
                                                                                            +
                                                                                            poolifier - v6.0.2
                                                                                              @@ -15,7 +15,7 @@

                                                                                              Enumeration of kill behaviors.

                                                                                              +
                                                                                            • Defined in src/worker/worker-options.ts:4
                                                                                              • @@ -29,7 +29,7 @@
                                                                                              • -
                                                                                              diff --git a/docs/variables/src.Measurements.html b/docs/variables/src.Measurements.html index 144e7ef05..741c3bd53 100644 --- a/docs/variables/src.Measurements.html +++ b/docs/variables/src.Measurements.html @@ -1,5 +1,5 @@ -Measurements | poolifier - v6.0.1
                                                                                              -
                                                                                              poolifier - v6.0.1 +Measurements | poolifier - v6.0.2
                                                                                              +
                                                                                              poolifier - v6.0.2
                                                                                                @@ -15,7 +15,7 @@

                                                                                                Enumeration of measurements.

                                                                                                +
                                                                                              • Defined in src/pools/selection-strategies/selection-strategies-types.ts:52
                                                                                                • @@ -29,7 +29,7 @@
                                                                                                • -
                                                                                                diff --git a/docs/variables/src.PoolEvents.html b/docs/variables/src.PoolEvents.html index 0c2132be5..9b765bf94 100644 --- a/docs/variables/src.PoolEvents.html +++ b/docs/variables/src.PoolEvents.html @@ -1,5 +1,5 @@ -PoolEvents | poolifier - v6.0.1
                                                                                                -
                                                                                                poolifier - v6.0.1 +PoolEvents | poolifier - v6.0.2
                                                                                                +
                                                                                                poolifier - v6.0.2
                                                                                                  @@ -15,7 +15,7 @@

                                                                                                  Enumeration of pool events.

                                                                                                  +
                                                                                                • Defined in src/pools/pool.ts:49
                                                                                                  • @@ -29,7 +29,7 @@
                                                                                                  • -
                                                                                                  diff --git a/docs/variables/src.PoolTypes.html b/docs/variables/src.PoolTypes.html index b19c2c60e..1573ce2a6 100644 --- a/docs/variables/src.PoolTypes.html +++ b/docs/variables/src.PoolTypes.html @@ -1,5 +1,5 @@ -PoolTypes | poolifier - v6.0.1
                                                                                                  -
                                                                                                  poolifier - v6.0.1 +PoolTypes | poolifier - v6.0.2
                                                                                                  +
                                                                                                  poolifier - v6.0.2
                                                                                                    @@ -15,7 +15,7 @@

                                                                                                    Enumeration of pool types.

                                                                                                    +
                                                                                                  • Defined in src/pools/pool.ts:27
                                                                                                    • @@ -29,7 +29,7 @@
                                                                                                    • -
                                                                                                    diff --git a/docs/variables/src.WorkerChoiceStrategies.html b/docs/variables/src.WorkerChoiceStrategies.html index 6a554fee9..b4e6f7d1d 100644 --- a/docs/variables/src.WorkerChoiceStrategies.html +++ b/docs/variables/src.WorkerChoiceStrategies.html @@ -1,5 +1,5 @@ -WorkerChoiceStrategies | poolifier - v6.0.1
                                                                                                    -
                                                                                                    poolifier - v6.0.1 +WorkerChoiceStrategies | poolifier - v6.0.2
                                                                                                    +
                                                                                                    poolifier - v6.0.2
                                                                                                      @@ -15,7 +15,7 @@

                                                                                                      Enumeration of worker choice strategies.

                                                                                                      +
                                                                                                    • Defined in src/pools/selection-strategies/selection-strategies-types.ts:4
                                                                                                      • @@ -29,7 +29,7 @@
                                                                                                      • -
                                                                                                      diff --git a/docs/variables/src.WorkerTypes.html b/docs/variables/src.WorkerTypes.html index cceb100eb..c476e9e01 100644 --- a/docs/variables/src.WorkerTypes.html +++ b/docs/variables/src.WorkerTypes.html @@ -1,5 +1,5 @@ -WorkerTypes | poolifier - v6.0.1
                                                                                                      -
                                                                                                      poolifier - v6.0.1 +WorkerTypes | poolifier - v6.0.2
                                                                                                      +
                                                                                                      poolifier - v6.0.2
                                                                                                        @@ -15,7 +15,7 @@

                                                                                                        Enumeration of worker types.

                                                                                                        +
                                                                                                      • Defined in src/pools/worker.ts:137
                                                                                                        • @@ -29,7 +29,7 @@
                                                                                                        • -
                                                                                                        -- 2.53.0