X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fpool.ts;h=396c59ad987ea5c9e8294190587917d8036990b5;hb=8f52842f4b4fa9059f25fc4a90e8bbe8db2f5e63;hp=92e399edf37bc51f2af2a45db428851f2e63be18;hpb=c4855468bc26a7ee37d2c8ef34bb1ac864448e77;p=poolifier.git

diff --git a/src/pools/pool.ts b/src/pools/pool.ts
index 92e399ed..396c59ad 100644
--- a/src/pools/pool.ts
+++ b/src/pools/pool.ts
@@ -16,6 +16,7 @@ import type {
  * Pool types.
  *
  * @enum
+ * @internal
  */
 export enum PoolType {
   /**
@@ -60,6 +61,8 @@ export interface TasksQueueOptions {
 
 /**
  * Options for a poolifier pool.
+ *
+ * @typeParam Worker - Type of worker.
  */
 export interface PoolOptions<Worker extends IWorker> {
   /**
@@ -95,14 +98,11 @@ export interface PoolOptions<Worker extends IWorker> {
   /**
    * Pool worker tasks queue.
    *
-   * @experimental
    * @defaultValue false
    */
   enableTasksQueue?: boolean
   /**
    * Pool worker tasks queue options.
-   *
-   * @experimental
    */
   tasksQueueOptions?: TasksQueueOptions
 }
@@ -112,7 +112,7 @@ export interface PoolOptions<Worker extends IWorker> {
  *
  * @typeParam Worker - Type of worker which manages this pool.
  * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
- * @typeParam Response - Type of response of execution. This can only be serializable data.
+ * @typeParam Response - Type of execution response. This can only be serializable data.
  */
 export interface IPool<
   Worker extends IWorker,
@@ -138,18 +138,6 @@ export interface IPool<
    * - `'busy'`: Emitted when the pool is busy.
    */
   readonly emitter?: PoolEmitter
-  /**
-   * Whether the pool is full or not.
-   *
-   * The pool filling boolean status.
-   */
-  readonly full: boolean
-  /**
-   * Whether the pool is busy or not.
-   *
-   * The pool busyness boolean status.
-   */
-  readonly busy: boolean
   /**
    * Finds a free worker node key based on the number of tasks the worker has applied.
    *
@@ -161,7 +149,7 @@ export interface IPool<
    */
   findFreeWorkerNodeKey: () => number
   /**
-   * Performs the task specified in the constructor with the data parameter.
+   * Executes the function specified in the constructor with the task data parameter.
    *
    * @param data - The input for the specified task. This can only be serializable data.
    * @returns Promise that will be resolved when the task is successfully completed.
@@ -175,6 +163,34 @@ export interface IPool<
    * Sets the worker choice strategy in this pool.
    *
    * @param workerChoiceStrategy - The worker choice strategy.
+   * @param workerChoiceStrategyOptions - The worker choice strategy options.
+   */
+  setWorkerChoiceStrategy: (
+    workerChoiceStrategy: WorkerChoiceStrategy,
+    workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
+  ) => void
+  /**
+   * Sets the worker choice strategy options in this pool.
+   *
+   * @param workerChoiceStrategyOptions - The worker choice strategy options.
+   */
+  setWorkerChoiceStrategyOptions: (
+    workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
+  ) => void
+  /**
+   * Enables/disables the worker tasks queue in this pool.
+   *
+   * @param enable - Whether to enable or disable the worker tasks queue.
+   * @param tasksQueueOptions - The worker tasks queue options.
+   */
+  enableTasksQueue: (
+    enable: boolean,
+    tasksQueueOptions?: TasksQueueOptions
+  ) => void
+  /**
+   * Sets the worker tasks queue options in this pool.
+   *
+   * @param tasksQueueOptions - The worker tasks queue options.
    */
-  setWorkerChoiceStrategy: (workerChoiceStrategy: WorkerChoiceStrategy) => void
+  setTasksQueueOptions: (tasksQueueOptions: TasksQueueOptions) => void
 }