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

diff --git a/src/pools/pool.ts b/src/pools/pool.ts
index e8f391cc..f48d8843 100644
--- a/src/pools/pool.ts
+++ b/src/pools/pool.ts
@@ -1,4 +1,19 @@
+/**
+ * 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>
 }