X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIWorker.html;h=1d828fccdf14c1b97ab134b031d1803c7323b30e;hb=0e16e60a89029abe61cda7ba293c036298cced05;hp=79207ad896918ff16d5f3b47b7f85b397656edeb;hpb=ccb7d1a70cd9bd4eb050160517e5bc48311d014f;p=poolifier.git diff --git a/docs/interfaces/IWorker.html b/docs/interfaces/IWorker.html index 79207ad8..1d828fcc 100644 --- a/docs/interfaces/IWorker.html +++ b/docs/interfaces/IWorker.html @@ -1,4 +1,4 @@ -IWorker | poolifier

+IWorker | poolifier - v2.6.26

@@ -17,13 +17,14 @@

Interface IWorker

Worker interface.

Hierarchy

IWorker

Defined in src/pools/worker.ts:173

@@ -31,24 +32,95 @@

Properties

on -once +

id? +on +once +threadId?

Properties

`Optional` `Readonly` id

id?: number

Worker id.

on

`Readonly` on

on: ((event, handler) => void) & ((event, handler) => void) & ((event, handler) => void) & ((event, handler) => void)

- -

Param

The event.

Registers an event listener.

Type declaration

+
- (event, handler): void
- +
  +
  Parameters
  +
  - +
    event: "message"
  - +
    handler: MessageHandler<IWorker>
  +
  Returns void

Type declaration

+
- (event, handler): void
- +
  +
  Parameters
  +
  - +
    event: "error"
  - +
    handler: ErrorHandler<IWorker>
  +
  Returns void

Type declaration

+
- (event, handler): void
- +
  +
  Parameters
  +
  - +
    event: "online"
  - +
    handler: OnlineHandler<IWorker>
  +
  Returns void

Type declaration

+
- (event, handler): void
- +
  +
  Parameters
  +
  - +
    event: "exit"
  - +
    handler: ExitHandler<IWorker>
  +
  Returns void

Param

The event.

Param

The event handler.

Param

The event handler.

Defined in src/pools/worker.ts:185

once

`Readonly` once

once: ((event, handler) => void)

Type declaration

@@ -57,7 +129,7 @@

(event, handler): 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.

Parameters
@@ -65,19 +137,27 @@
event: "exit"

'exit'.
-