Interface IPoolWorker

Basic interface that describes the minimum required implementation of listener events for a pool worker.

Hierarchy

IPoolWorker

Index

Properties

Methods

Properties

`Optional` `Readonly` id

id?: number

Worker identifier.

Methods

on

on(event: "message", handler: MessageHandler<IPoolWorker>): void
Register a listener to the message event.
Parameters
- event: "message"
  
  'message'.
- handler: MessageHandler<IPoolWorker>
  
  The message handler.
Returns void
- Defined in src/pools/pool-worker.ts:44
on(event: "error", handler: ErrorHandler<IPoolWorker>): void
Register a listener to the error event.
Parameters
- event: "error"
  
  'error'.
- handler: ErrorHandler<IPoolWorker>
  
  The error handler.
Returns void
- Defined in src/pools/pool-worker.ts:51
on(event: "online", handler: OnlineHandler<IPoolWorker>): void
Register a listener to the online event.
Parameters
- event: "online"
  
  'online'.
- handler: OnlineHandler<IPoolWorker>
  
  The online handler.
Returns void
- Defined in src/pools/pool-worker.ts:58
on(event: "exit", handler: ExitHandler<IPoolWorker>): void
Register a listener to the exit event.
Parameters
- event: "exit"
  
  'exit'.
- handler: ExitHandler<IPoolWorker>
  
  The exit handler.
Returns void
- Defined in src/pools/pool-worker.ts:65

once

once(event: "exit", handler: ExitHandler<IPoolWorker>): void
Register a listener to the exit event that will only performed once.
Parameters
- event: "exit"
  
  'exit'.
- handler: ExitHandler<IPoolWorker>
  
  The exit handler.
Returns void
- Defined in src/pools/pool-worker.ts:72

Generated using TypeDoc