X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIWorker.html;h=ea00624e9c2b875688a80f4153585ee6f12b7fa1;hb=049c42848206f2c5c0db5a35efd8adc8796d1027;hp=0f47810ec65acbcdc8cb4beaba128968d576aee4;hpb=d0f1dce33156fdb99f0ca3627839001909419497;p=poolifier.git diff --git a/docs/interfaces/IWorker.html b/docs/interfaces/IWorker.html index 0f47810e..ea00624e 100644 --- a/docs/interfaces/IWorker.html +++ b/docs/interfaces/IWorker.html @@ -1,33 +1,206 @@ -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
-
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
-
Register a listener to the error event.
-
Parameters
- event: "error"
  -
  'error'.
  -
- handler: ErrorHandler<IWorker>
  -
  The error handler.
  -
Returns void
- Defined in src/pools/abstract-pool.ts:59
-
Register a listener to the online event.
-
Parameters
- event: "online"
  -
  'online'.
  -
- handler: OnlineHandler<IWorker>
  -
  The online handler.
  -
Returns void
- Defined in src/pools/abstract-pool.ts:66
-
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
-
Register a listener to the exit event that will only performed once.
-
Parameters
- event: "exit"
  -
  'exit'.
  -
- handler: ExitHandler<IWorker>
  -
  The exit handler.
  -
Returns void

Generated using TypeDoc

\ No newline at end of file +IWorker | poolifier - v3.0.2 +

+

+

+ +

Interface IWorker

+

+

Worker interface.

+

+

+

+

Hierarchy

+

IWorker

+

+

+

+

Index

+

+

+

Properties

+

id? +on +once +threadId? +

+

+

Properties

+

+

`Optional` `Readonly` id

+

id?: number

+

Worker id.

+

+

+

+

`Readonly` on

+

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

+

Registers an event listener.

+

+

+

Type declaration

+

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

+

+

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: "exit"
  - +
    handler: ExitHandler<IWorker>
  +
  Returns void

+

+

Param

The event.

+ +

Param

The event handler.

+

+

+

`Readonly` once

+

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

+

+

Type declaration

+

+
- (event, handler): void
- +
  Registers a listener to the exit event that will only be performed once.
  +
  +
  +
  Parameters
  +
  - +
    event: "exit"
    +
    The 'exit' event.
    +
    +
  - +
    handler: ExitHandler<IWorker>
    +
    The exit handler.
    +
    +
  +
  Returns void
  +

+

+

`Optional` `Readonly` threadId

+

threadId?: number

+

+

+

Generated using TypeDoc

+

\ No newline at end of file