refactor: improve error messages

[poolifier.git] / src / pools / worker.ts

diff --git a/src/pools/worker.ts b/src/pools/worker.ts
index 4e6aea4eef596df89bf828cd24a9d00f335ed7f8..664b6a7695ef42a088732812a7eac270e9f87a00 100644 (file)
--- a/src/pools/worker.ts
+++ b/src/pools/worker.ts
@@ -6,7 +6,7 @@ import type { Queue } from '../queue'
  */
 export type MessageHandler<Worker extends IWorker> = (
   this: Worker,
-  m: unknown
+  message: unknown
 ) => void
 
 /**
@@ -14,7 +14,7 @@ export type MessageHandler<Worker extends IWorker> = (
  */
 export type ErrorHandler<Worker extends IWorker> = (
   this: Worker,
-  e: Error
+  error: Error
 ) => void
 
 /**
@@ -27,13 +27,13 @@ export type OnlineHandler<Worker extends IWorker> = (this: Worker) => void
  */
 export type ExitHandler<Worker extends IWorker> = (
   this: Worker,
-  code: number
+  exitCode: number
 ) => void
 
 /**
  * Message object that is passed as a task between main worker and worker.
  *
- * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
+ * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
  * @internal
  */
 export interface Task<Data = unknown> {
@@ -118,6 +118,22 @@ export interface TaskStatistics {
   failed: number
 }
 
+/**
+ * Worker information.
+ *
+ * @internal
+ */
+export interface WorkerInfo {
+  /**
+   * Worker id.
+   */
+  id: number | undefined
+  /**
+   * Started flag.
+   */
+  started: boolean
+}
+
 /**
  * Worker usage statistics.
  *
@@ -147,7 +163,12 @@ export interface WorkerUsage {
  */
 export interface IWorker {
   /**
-   * Register an event listener.
+   * Worker id.
+   */
+  readonly id?: number
+  readonly threadId?: number
+  /**
+   * Registers an event listener.
    *
    * @param event - The event.
    * @param handler - The event handler.
@@ -157,7 +178,7 @@ export interface IWorker {
   ((event: 'online', handler: OnlineHandler<this>) => void) &
   ((event: 'exit', handler: ExitHandler<this>) => void)
   /**
-   * Register a listener to the exit event that will only be performed once.
+   * Registers a listener to the exit event that will only be performed once.
    *
    * @param event - `'exit'`.
    * @param handler - The exit handler.
@@ -169,7 +190,7 @@ export interface IWorker {
  * Worker node interface.
  *
  * @typeParam Worker - Type of worker.
- * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
+ * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
  * @internal
  */
 export interface WorkerNode<Worker extends IWorker, Data = unknown> {
@@ -177,10 +198,14 @@ export interface WorkerNode<Worker extends IWorker, Data = unknown> {
    * Worker node worker.
    */
   readonly worker: Worker
+  /**
+   * Worker node worker info.
+   */
+  info: WorkerInfo
   /**
    * Worker node worker usage statistics.
    */
-  workerUsage: WorkerUsage
+  usage: WorkerUsage
   /**
    * Worker node tasks queue.
    */