X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fpool.ts;h=dbbb5969ebd920022e31d64d156f087065aa9d12;hb=b8adcb2a14354be470de217472dc56247a99fe74;hp=78e7c981b6d9e25efb0c3af38d5cab2c4a3f6014;hpb=b4904890be69e53510b67172dda7b6bbf50a635a;p=poolifier.git diff --git a/src/pools/pool.ts b/src/pools/pool.ts index 78e7c981..dbbb5969 100644 --- a/src/pools/pool.ts +++ b/src/pools/pool.ts @@ -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,18 +62,18 @@ 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 + execute: (data: Data) => Promise /** * Shutdowns every current worker in this pool. */ - destroy(): Promise + destroy: () => Promise /** * Sets the worker choice strategy in this pool. * - * @param workerChoiceStrategy The worker choice strategy. + * @param workerChoiceStrategy - The worker choice strategy. */ - setWorkerChoiceStrategy(workerChoiceStrategy: WorkerChoiceStrategy): void + setWorkerChoiceStrategy: (workerChoiceStrategy: WorkerChoiceStrategy) => void }