Bump eslint-plugin-jsdoc from 32.0.2 to 32.1.0 (#212)

[poolifier.git] / src / pools / pool.ts

diff --git a/src/pools/pool.ts b/src/pools/pool.ts
index e8f391cc4dc3c6f399194d82d93e92ec00c22dfc..f48d8843d9596f914f60ae1349ff258af7df4518 100644 (file)
--- 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>
 }