X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fpool-internal.ts;h=095e954e2c2bb498ad27f1e1a5999686b99249a7;hb=53cf34054602ef192d39c45ef257eddc0ae0fa97;hp=cf6c6a99b26235a3ee4a28042072d9d3d0d5f057;hpb=bf90656cacf88d2cfdd5b3262086ba55b2ff9818;p=poolifier.git diff --git a/src/pools/pool-internal.ts b/src/pools/pool-internal.ts index cf6c6a99..095e954e 100644 --- a/src/pools/pool-internal.ts +++ b/src/pools/pool-internal.ts @@ -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: Worker @@ -34,8 +34,8 @@ export interface WorkerType { * 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 { /** - * Pool workers item array. + * Pool worker type items array. */ readonly workers: Array> @@ -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.