IWorker | poolifier

X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIWorker.html;h=b11ac4755da0582014b34231ea41f50685edfaa0;hb=cd424e3162f5ae6be04dc156cdc8562dae16c33f;hp=b8c76f6e9ec4b624bc67a8d7120e06896f21e543;hpb=afa30fd0dd5bbc5d305cc30be663966a449efc08;p=poolifier.git diff --git a/docs/interfaces/IWorker.html b/docs/interfaces/IWorker.html index b8c76f6e..b11ac475 100644 --- a/docs/interfaces/IWorker.html +++ b/docs/interfaces/IWorker.html @@ -1,13 +1,13 @@ -IWorker | poolifier

@@ -24,23 +24,33 @@

IWorker

Defined in src/pools/worker.ts:186

Index

Properties

on +

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)

Registers an event listener.

Type declaration

@@ -53,9 +63,9 @@

Parameters

-
event: "message"

event: "online"

-
handler: MessageHandler<IWorker>

handler: OnlineHandler<IWorker>

Returns void

Type declaration

@@ -68,9 +78,9 @@

Parameters

-
event: "error"

event: "message"

-
handler: ErrorHandler<IWorker>

handler: MessageHandler<IWorker>

Returns void

Type declaration

@@ -83,9 +93,9 @@

Parameters

-
event: "online"

event: "error"

-
handler: OnlineHandler<IWorker>

handler: ErrorHandler<IWorker>

Returns void

Type declaration

@@ -108,9 +118,9 @@

Param

The event handler.

Defined in src/pools/worker.ts:198

once

`Readonly` once

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

Type declaration

@@ -119,14 +129,14 @@

(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
- event: "exit"
  -
  'exit'.
  +
  The 'exit' event.
- @@ -137,78 +147,60 @@
  Returns void

Defined in src/pools/worker.ts:208

`Optional` `Readonly` threadId

threadId?: number

once

threadId

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file

Index

Index

Properties

Properties

Optional Readonly id

on

Readonly on

Type declaration

Parameters

event: "message"

event: "online"

handler: MessageHandler<IWorker>

handler: OnlineHandler<IWorker>

Returns void

Type declaration

Parameters

event: "error"

event: "message"

handler: ErrorHandler<IWorker>

handler: MessageHandler<IWorker>

Returns void

Type declaration

Parameters

event: "online"

event: "error"

handler: OnlineHandler<IWorker>

handler: ErrorHandler<IWorker>

Returns void

Type declaration

Param

once

Readonly once

Type declaration

Parameters

event: "exit"

Returns void

Optional Readonly threadId

Settings

Settings

Member Visibility

Theme

On This Page

`Optional` `Readonly` id

`Readonly` on

`Readonly` once

`Optional` `Readonly` threadId