chore: migrate to eslint 9
[poolifier.git] / src / pools / worker.ts
index c1af1cf79c99d05e7c803e7d072529301b6d678a..9f5fc0c18dd1d2f214dce86d63d65e88faa11642 100644 (file)
@@ -6,14 +6,12 @@ import type { Task, TaskFunctionProperties } from '../utility-types.js'
 
 /**
  * Callback invoked when the worker has started successfully.
- *
  * @typeParam Worker - Type of worker.
  */
 export type OnlineHandler<Worker extends IWorker> = (this: Worker) => void
 
 /**
  * Callback invoked if the worker has received a message.
- *
  * @typeParam Worker - Type of worker.
  */
 export type MessageHandler<Worker extends IWorker> = (
@@ -23,7 +21,6 @@ export type MessageHandler<Worker extends IWorker> = (
 
 /**
  * Callback invoked if the worker raised an error.
- *
  * @typeParam Worker - Type of worker.
  */
 export type ErrorHandler<Worker extends IWorker> = (
@@ -33,7 +30,6 @@ export type ErrorHandler<Worker extends IWorker> = (
 
 /**
  * Callback invoked when the worker exits successfully.
- *
  * @typeParam Worker - Type of worker.
  */
 export type ExitHandler<Worker extends IWorker> = (
@@ -43,7 +39,6 @@ export type ExitHandler<Worker extends IWorker> = (
 
 /**
  * Worker event handler.
- *
  * @typeParam Worker - Type of worker.
  */
 export type EventHandler<Worker extends IWorker> =
@@ -59,7 +54,6 @@ export const MeasurementHistorySize = 386
 
 /**
  * Measurement statistics.
- *
  * @internal
  */
 export interface MeasurementStatistics {
@@ -91,7 +85,6 @@ export interface MeasurementStatistics {
 
 /**
  * Event loop utilization measurement statistics.
- *
  * @internal
  */
 export interface EventLoopUtilizationMeasurementStatistics {
@@ -102,7 +95,6 @@ export interface EventLoopUtilizationMeasurementStatistics {
 
 /**
  * Task statistics.
- *
  * @internal
  */
 export interface TaskStatistics {
@@ -139,10 +131,10 @@ export interface TaskStatistics {
 /**
  * Enumeration of worker types.
  */
-export const WorkerTypes: Readonly<{ thread: 'thread', cluster: 'cluster' }> =
+export const WorkerTypes: Readonly<{ thread: 'thread'; cluster: 'cluster' }> =
   Object.freeze({
     thread: 'thread',
-    cluster: 'cluster'
+    cluster: 'cluster',
   } as const)
 
 /**
@@ -152,7 +144,6 @@ export type WorkerType = keyof typeof WorkerTypes
 
 /**
  * Worker information.
- *
  * @internal
  */
 export interface WorkerInfo {
@@ -190,7 +181,6 @@ export interface WorkerInfo {
 
 /**
  * Worker usage statistics.
- *
  * @internal
  */
 export interface WorkerUsage {
@@ -214,7 +204,6 @@ export interface WorkerUsage {
 
 /**
  * Worker choice strategy data.
- *
  * @internal
  */
 export interface StrategyData {
@@ -235,14 +224,12 @@ export interface IWorker extends EventEmitter {
   readonly threadId?: number
   /**
    * Registers an event handler.
-   *
    * @param event - The event.
    * @param handler - The event handler.
    */
   readonly on: (event: string, handler: EventHandler<this>) => this
   /**
    * Registers once an event handler.
-   *
    * @param event - The event.
    * @param handler - The event handler.
    */
@@ -270,7 +257,6 @@ export interface IWorker extends EventEmitter {
 
 /**
  * Worker node options.
- *
  * @internal
  */
 export interface WorkerNodeOptions {
@@ -283,7 +269,6 @@ export interface WorkerNodeOptions {
 
 /**
  * Worker node interface.
- *
  * @typeParam Worker - Type of worker.
  * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
  * @internal
@@ -318,33 +303,28 @@ export interface IWorkerNode<Worker extends IWorker, Data = unknown>
   tasksQueueBackPressureSize: number
   /**
    * Sets tasks queue priority.
-   *
    * @param enablePriority - Whether to enable tasks queue priority.
    */
   readonly setTasksQueuePriority: (enablePriority: boolean) => void
   /**
    * Tasks queue size.
-   *
    * @returns The tasks queue size.
    */
   readonly tasksQueueSize: () => number
   /**
    * Enqueue task.
-   *
    * @param task - The task to queue.
    * @returns The tasks queue size.
    */
   readonly enqueueTask: (task: Task<Data>) => number
   /**
    * Dequeue task.
-   *
    * @param bucket - The prioritized bucket to dequeue from. @defaultValue 0
    * @returns The dequeued task.
    */
   readonly dequeueTask: (bucket?: number) => Task<Data> | undefined
   /**
    * Dequeue last prioritized task.
-   *
    * @returns The dequeued task.
    */
   readonly dequeueLastPrioritizedTask: () => Task<Data> | undefined
@@ -354,7 +334,6 @@ export interface IWorkerNode<Worker extends IWorker, Data = unknown>
   readonly clearTasksQueue: () => void
   /**
    * 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
@@ -364,7 +343,6 @@ export interface IWorkerNode<Worker extends IWorker, Data = unknown>
   readonly terminate: () => Promise<void>
   /**
    * Registers a worker event handler.
-   *
    * @param event - The event.
    * @param handler - The event handler.
    */
@@ -374,7 +352,6 @@ export interface IWorkerNode<Worker extends IWorker, Data = unknown>
   ) => void
   /**
    * Registers once a worker event handler.
-   *
    * @param event - The event.
    * @param handler - The event handler.
    */
@@ -384,14 +361,12 @@ export interface IWorkerNode<Worker extends IWorker, Data = unknown>
   ) => void
   /**
    * 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 getTaskFunctionWorkerUsage: (name: string) => WorkerUsage | undefined
   /**
    * Deletes task function worker usage statistics.
-   *
    * @param name - The task function name.
    * @returns `true` if the task function worker usage statistics were deleted, `false` otherwise.
    */
@@ -400,7 +375,6 @@ export interface IWorkerNode<Worker extends IWorker, Data = unknown>
 
 /**
  * Worker node event detail.
- *
  * @internal
  */
 export interface WorkerNodeEventDetail {