X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=src%2Fpools%2Fpool-internal.ts;h=e0d0534f83a846cbfac77eb87e305e0975c49abf;hb=8bd0b5363ad2defbce7c1cc49e616c24ad135dde;hp=3f35ec13e25b79e67c3cb2c9084843adcbf63f99;hpb=8accb8d5d2f8a6d77017a421938796623ac2b239;p=poolifier.git diff --git a/src/pools/pool-internal.ts b/src/pools/pool-internal.ts index 3f35ec13..e0d0534f 100644 --- a/src/pools/pool-internal.ts +++ b/src/pools/pool-internal.ts @@ -1,9 +1,8 @@ -import EventEmitter from 'events' import type { IPool } from './pool' import type { IPoolWorker } from './pool-worker' /** - * Pool types. + * Internal pool types. */ export enum PoolType { FIXED = 'fixed', @@ -11,7 +10,7 @@ export enum PoolType { } /** - * Tasks usage statistics. + * Internal tasks usage statistics. */ export interface TasksUsage { run: number @@ -20,17 +19,12 @@ export interface TasksUsage { avgRunTime: number } -/** - * Internal poolifier pool emitter. - */ -export class PoolEmitter extends EventEmitter {} - /** * Internal contract definition for a poolifier pool. * - * @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. + * @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. */ export interface IPoolInternal< Worker extends IPoolWorker, @@ -50,15 +44,6 @@ export interface IPoolInternal< */ readonly workersTasksUsage: Map - /** - * Emitter on which events can be listened to. - * - * Events that can currently be listened to: - * - * - `'busy'` - */ - readonly emitter?: PoolEmitter - /** * Pool type. * @@ -66,11 +51,6 @@ export interface IPoolInternal< */ readonly type: PoolType - /** - * Maximum number of workers that can be created by this pool. - */ - readonly max?: number - /** * Whether the pool is busy or not. * @@ -92,29 +72,29 @@ export interface IPoolInternal< * * @returns A free worker if there is one, otherwise `false`. */ - findFreeWorker(): Worker | false + findFreeWorker: () => Worker | false /** * Gets worker index. * - * @param worker The worker. + * @param worker - The worker. * @returns The worker index. */ - getWorkerIndex(worker: Worker): number + getWorkerIndex: (worker: Worker) => number /** * Gets worker running tasks. * - * @param worker The worker. + * @param worker - The worker. * @returns The number of tasks currently running on the worker. */ - getWorkerRunningTasks(worker: Worker): number | undefined + getWorkerRunningTasks: (worker: Worker) => number | undefined /** * Gets worker average tasks runtime. * - * @param worker The worker. + * @param worker - The worker. * @returns The average tasks runtime on the worker. */ - getWorkerAverageTasksRunTime(worker: Worker): number | undefined + getWorkerAverageTasksRunTime: (worker: Worker) => number | undefined }