X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2Fiworker.html;h=661198dd2faf55f35ceaa62df80a48acd09a4a2c;hb=0136f64e4790627dd07ec018e9c2e4cd8888191e;hp=6c103f06e41bc0a6eb80753aad9fcc087235bc8d;hpb=24c3fcb499d1594f698611fd10219de01993071e;p=poolifier.git diff --git a/docs/interfaces/iworker.html b/docs/interfaces/iworker.html index 6c103f06..661198dd 100644 --- a/docs/interfaces/iworker.html +++ b/docs/interfaces/iworker.html @@ -1,30 +1,30 @@ IWorker | poolifier

Interface IWorker

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

-

Hierarchy

IWorker

Index

Methods

Methods

on

on(event: "message", handler: MessageHandler<IWorker>): void
on(event: "error", handler: ErrorHandler<IWorker>): void
on(event: "online", handler: OnlineHandler<IWorker>): void
on(event: "exit", handler: ExitHandler<IWorker>): void

- Defined in src/pools/abstract-pool.ts:45
+

Hierarchy

IWorker

Index

Methods

Methods

on

on(event: "message", handler: MessageHandler<IWorker>): void
on(event: "error", handler: ErrorHandler<IWorker>): void
on(event: "online", handler: OnlineHandler<IWorker>): void
on(event: "exit", handler: ExitHandler<IWorker>): void

- Defined in src/pools/abstract-pool.ts:45
Register a listener to the message event.

Parameters
- event: "message"
  
  'message'.
- handler: MessageHandler<IWorker>
  
  The message handler.
  -
Returns void
- Defined in src/pools/abstract-pool.ts:52
+

Returns void

Register a listener to the error event.

Parameters

event: "error"

'error'.
handler: ErrorHandler<IWorker>

The error handler.
-

Returns void

+

Returns void

Register a listener to the online event.

Parameters

event: "online"

'online'.
handler: OnlineHandler<IWorker>

The online handler.
-

Returns void

+

Returns void

Register a listener to the exit event.

Parameters

event: "exit"

'exit'.
handler: ExitHandler<IWorker>

The exit handler.
-

Returns void

once

once(event: "exit", handler: ExitHandler<IWorker>): void

- Defined in src/pools/abstract-pool.ts:73
+

Returns void

once

once(event: "exit", handler: ExitHandler<IWorker>): void

- Defined in src/pools/abstract-pool.ts:73
Register a listener to the exit event that will only performed once.

Parameters
- event: "exit"
  
  'exit'.