perf: remove unneeded nullish checks in hot code paths
[poolifier.git] / src / pools / pool-internal.ts
index cf6c6a99b26235a3ee4a28042072d9d3d0d5f057..095e954e2c2bb498ad27f1e1a5999686b99249a7 100644 (file)
@@ -23,7 +23,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 +34,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,
@@ -43,7 +43,7 @@ export interface IPoolInternal<
   Response = unknown
 > extends IPool<Data, Response> {
   /**
-   * Pool workers item array.
+   * Pool worker type items array.
    */
   readonly workers: Array<WorkerType<Worker>>
 
@@ -55,16 +55,18 @@ export interface IPoolInternal<
   readonly type: PoolType
 
   /**
-   * Whether the pool is busy or not.
+   * Whether the pool is full or not.
    *
-   * The pool busyness boolean status.
+   * The pool filling boolean status.
    */
-  readonly busy: boolean
+  readonly full: boolean
 
   /**
-   * Number of tasks currently concurrently running.
+   * Whether the pool is busy or not.
+   *
+   * The pool busyness boolean status.
    */
-  readonly numberOfRunningTasks: number
+  readonly busy: boolean
 
   /**
    * Finds a free worker key based on the number of tasks the worker has applied.