X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fworker.ts;h=1d0c4e22e47f073384bdf8c69e3c477ea9cb1d2b;hb=a1763c54c962c69b5e02a30c0909724986495fcd;hp=cd395bbdd0301948937bc7c1ba06d3f2f68d540f;hpb=671d515455c745dc74f4c385fe23683975bfc3df;p=poolifier.git diff --git a/src/pools/worker.ts b/src/pools/worker.ts index cd395bbd..1d0c4e22 100644 --- a/src/pools/worker.ts +++ b/src/pools/worker.ts @@ -229,7 +229,7 @@ export interface IWorkerNode { * Enqueue task. * * @param task - The task to queue. - * @returns The task queue size. + * @returns The tasks queue size. */ readonly enqueueTask: (task: Task) => number /** @@ -243,13 +243,13 @@ export interface IWorkerNode { */ readonly clearTasksQueue: () => void /** - * Whether the worker node has back pressure. + * Whether the worker node has back pressure (i.e. its tasks queue is full). * * @returns `true` if the worker node has back pressure, `false` otherwise. */ readonly hasBackPressure: () => boolean /** - * Resets usage statistics . + * Resets usage statistics. */ readonly resetUsage: () => void /** @@ -257,7 +257,10 @@ export interface IWorkerNode { */ readonly closeChannel: () => void /** - * Gets task worker usage statistics. + * Gets task function worker usage statistics. + * + * @param name - The task function name. + * @returns The task function worker usage statistics if the task function worker usage statistics are initialized, `undefined` otherwise. */ - readonly getTaskWorkerUsage: (name: string) => WorkerUsage | undefined + readonly getTaskFunctionWorkerUsage: (name: string) => WorkerUsage | undefined }