X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fworker.ts;h=2db5f630fefa5a1e81161ca75362e7c73fc450a1;hb=dab8c377b70fc962ec217f2aeb719842f9f94cd6;hp=05b559850c3a16f4d682f25acaf42e20a3f982e0;hpb=027063571693f211b35c8851566a063201adb9af;p=poolifier.git diff --git a/src/pools/worker.ts b/src/pools/worker.ts index 05b55985..2db5f630 100644 --- a/src/pools/worker.ts +++ b/src/pools/worker.ts @@ -1,4 +1,5 @@ import type { CircularArray } from '../circular-array' +import type { Queue } from '../queue' /** * Callback invoked if the worker has received a message. @@ -37,17 +38,23 @@ export type ExitHandler = ( */ export interface Task { /** - * Input data that will be passed to the worker. + * Task name. + */ + readonly name?: string + /** + * Task input data that will be passed to the worker. */ readonly data?: Data /** - * UUID of the message. + * Message UUID. */ readonly id?: string } /** * Worker tasks usage statistics. + * + * @internal */ export interface TasksUsage { /** @@ -88,14 +95,14 @@ export interface IWorker { * Register an event listener. * * @param event - The event. - * @param handler - The event listener. + * @param handler - The event handler. */ on: ((event: 'message', handler: MessageHandler) => void) & ((event: 'error', handler: ErrorHandler) => void) & ((event: 'online', handler: OnlineHandler) => void) & ((event: 'exit', handler: ExitHandler) => void) /** - * Register a listener to the exit event that will only performed once. + * Register a listener to the exit event that will only be performed once. * * @param event - `'exit'`. * @param handler - The exit handler. @@ -122,5 +129,5 @@ export interface WorkerNode { /** * Worker node tasks queue. */ - readonly tasksQueue: Array> + readonly tasksQueue: Queue> }