1 import type { CircularArray
} from
'../circular-array'
4 * Callback invoked if the worker has received a message.
6 export type MessageHandler
<Worker
extends IWorker
> = (
12 * Callback invoked if the worker raised an error.
14 export type ErrorHandler
<Worker
extends IWorker
> = (
20 * Callback invoked when the worker has started successfully.
22 export type OnlineHandler
<Worker
extends IWorker
> = (this: Worker
) => void
25 * Callback invoked when the worker exits successfully.
27 export type ExitHandler
<Worker
extends IWorker
> = (
33 * Worker task interface.
35 export interface Task
<Data
= unknown
> {
47 * Worker tasks usage statistics.
49 export interface TasksUsage
{
53 runTimeHistory
: CircularArray
<number>
62 export interface IWorker
{
64 * Register an event listener.
66 * @param event - The event.
67 * @param handler - The event listener.
69 on
: ((event
: 'message', handler
: MessageHandler
<this>) => void) &
70 ((event
: 'error', handler
: ErrorHandler
<this>) => void) &
71 ((event
: 'online', handler
: OnlineHandler
<this>) => void) &
72 ((event
: 'exit', handler
: ExitHandler
<this>) => void)
74 * Register a listener to the exit event that will only performed once.
76 * @param event - `'exit'`.
77 * @param handler - The exit handler.
79 once
: (event
: 'exit', handler
: ExitHandler
<this>) => void
83 * Worker node interface.
85 export interface WorkerNode
<Worker
extends IWorker
, Data
= unknown
> {
87 tasksUsage
: TasksUsage
88 tasksQueue
: Array<Task
<Data
>>