X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fpool.ts;h=8a5e505f4f2d23909db36ef3d66e987eee9e9afd;hb=bf90656cacf88d2cfdd5b3262086ba55b2ff9818;hp=2ce311f710e0d7a809b5b219cd7309c9354d15cf;hpb=78cea37e264d5ca527bc42eb056f3b9579a2b2c4;p=poolifier.git diff --git a/src/pools/pool.ts b/src/pools/pool.ts index 2ce311f7..8a5e505f 100644 --- a/src/pools/pool.ts +++ b/src/pools/pool.ts @@ -1,4 +1,4 @@ -import EventEmitter from 'events' +import EventEmitter from 'node:events' import type { ErrorHandler, ExitHandler, @@ -39,7 +39,7 @@ export interface PoolOptions { /** * Pool events emission. * - * @default true + * @defaultValue true */ enableEvents?: boolean } @@ -47,8 +47,8 @@ export interface PoolOptions { /** * Contract definition for a poolifier pool. * - * @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. + * @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 IPool { /** @@ -62,7 +62,7 @@ export interface IPool { /** * Performs the task specified in the constructor with the data parameter. * - * @param data The input for the specified task. This can only be serializable data. + * @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. */ execute: (data: Data) => Promise @@ -73,7 +73,7 @@ export interface IPool { /** * Sets the worker choice strategy in this pool. * - * @param workerChoiceStrategy The worker choice strategy. + * @param workerChoiceStrategy - The worker choice strategy. */ setWorkerChoiceStrategy: (workerChoiceStrategy: WorkerChoiceStrategy) => void }