X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fpool.ts;h=752045829214f76681f92d36fce414c581fd0c95;hb=897beca72d8ea0b909f5c9cd6deb8c5e58b1dd7f;hp=e8f391cc4dc3c6f399194d82d93e92ec00c22dfc;hpb=d3c8a1a8022726094160d1413f1f289c5d84d715;p=poolifier.git

diff --git a/src/pools/pool.ts b/src/pools/pool.ts
index e8f391cc..75204582 100644
--- a/src/pools/pool.ts
+++ b/src/pools/pool.ts
@@ -1,4 +1,27 @@
+import type { WorkerChoiceStrategy } from './selection-strategies'
+
+/**
+ * Contract definition for a poolifier pool.
+ *
+ * @template Data Type of data sent to the worker. This can only be serializable data.
+ * @template Response Type of response of execution. This can only be serializable data.
+ */
 export interface IPool<Data = unknown, Response = unknown> {
-  destroy(): Promise<void>
+  /**
+   * Perform the task specified in the constructor with the 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.
+   */
   execute(data: Data): Promise<Response>
+  /**
+   * Shut down every current worker in this pool.
+   */
+  destroy(): Promise<void>
+  /**
+   * Set the worker choice strategy in this pool.
+   *
+   * @param workerChoiceStrategy The worker choice strategy.
+   */
+  setWorkerChoiceStrategy(workerChoiceStrategy: WorkerChoiceStrategy): void
 }