JSONValue can not be used by custom defined interfaces (#201)

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

diff --git a/src/pools/abstract-pool.ts b/src/pools/abstract-pool.ts
index c951c6f23792ea631b8804e11c7ff25719ce5fa5..0435a32c47067442af13cde6773a7831754e516f 100644 (file)
--- a/src/pools/abstract-pool.ts
+++ b/src/pools/abstract-pool.ts
@@ -94,8 +94,8 @@ class PoolEmitter extends EventEmitter {}
  * Base class containing some shared logic for all poolifier pools.
  *
  * @template Worker Type of worker which manages this pool.
- * @template Data Type of data sent to the worker.
- * @template Response Type of response of execution.
+ * @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 abstract class AbstractPool<
   Worker extends IWorker,
@@ -168,7 +168,7 @@ export abstract class AbstractPool<
   /**
    * Perform the task specified in the constructor with the data parameter.
    *
-   * @param data The input for the specified task.
+   * @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.
    */
   public execute (data: Data): Promise<Response> {