X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fpool.ts;h=7efb3808fa8e02ae6c294665461453c48e1a8451;hb=adee605399485348ae224e7e4c022f024373b0ef;hp=ddd4c2a047f9563e2ac8911f6bac0a4ec063ff9e;hpb=5972baf82c740050a6da461a8deb8497fcaa8580;p=poolifier.git diff --git a/src/pools/pool.ts b/src/pools/pool.ts index ddd4c2a0..7efb3808 100644 --- a/src/pools/pool.ts +++ b/src/pools/pool.ts @@ -136,24 +136,32 @@ export interface TasksQueueOptions { export interface PoolOptions { /** * A function that will listen for online event on each worker. + * + * @defaultValue `() => {}` */ onlineHandler?: OnlineHandler /** * A function that will listen for message event on each worker. + * + * @defaultValue `() => {}` */ messageHandler?: MessageHandler /** * A function that will listen for error event on each worker. + * + * @defaultValue `() => {}` */ errorHandler?: ErrorHandler /** * A function that will listen for exit event on each worker. + * + * @defaultValue `() => {}` */ exitHandler?: ExitHandler /** * Whether to start the minimum number of workers at pool initialization. * - * @defaultValue false + * @defaultValue true */ startWorkers?: boolean /** @@ -265,12 +273,12 @@ export interface IPool< * If a task function with the same name already exists, it will be overwritten. * * @param name - The name of the task function. - * @param taskFunction - The task function. + * @param fn - The task function. * @returns `true` if the task function was added, `false` otherwise. */ readonly addTaskFunction: ( name: string, - taskFunction: TaskFunction + fn: TaskFunction ) => Promise /** * Removes a task function from this pool.