X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=src%2Fpools%2Fpool-internal.ts;h=c3ec39bea578d3de3c0423f2ef789e0cd6c6f9df;hb=dba3384e0e6bc4049cb114d32e053cc4f2abe010;hp=806107ec74ea29402408abaf3cf95a8f0325581c;hpb=c2ade475e1b3b24aa2a1757b6d97a26063ec708c;p=poolifier.git

diff --git a/src/pools/pool-internal.ts b/src/pools/pool-internal.ts
index 806107ec..c3ec39be 100644
--- a/src/pools/pool-internal.ts
+++ b/src/pools/pool-internal.ts
@@ -3,6 +3,8 @@ import type { IPoolWorker } from './pool-worker'
 
 /**
  * Internal pool types.
+ *
+ * @enum
  */
 export enum PoolType {
   FIXED = 'fixed',
@@ -23,7 +25,7 @@ export interface TasksUsage {
 /**
  * Internal worker type.
  *
- * @typeParam Worker - Type of worker which manages this pool.
+ * @typeParam Worker - Type of worker type items which manages this pool.
  */
 export interface WorkerType<Worker extends IPoolWorker> {
   worker: Worker
@@ -34,8 +36,8 @@ export interface WorkerType<Worker extends IPoolWorker> {
  * Internal contract definition for a poolifier pool.
  *
  * @typeParam Worker - Type of worker which manages this pool.
- * @typeParam Data - Type of data sent to the worker.
- * @typeParam Response - Type of response of execution.
+ * @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.
  */
 export interface IPoolInternal<
   Worker extends IPoolWorker,
@@ -73,7 +75,7 @@ export interface IPoolInternal<
    *
    * If a worker is found with `0` running tasks, it is detected as free and its key is returned.
    *
-   * If no free worker is found, `false` is returned.
+   * If no free worker is found, `-1` is returned.
    *
    * @returns A worker key if there is one, `-1` otherwise.
    */