X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIWorker.html;h=a25b63e8bde3214ed8d86dc1991f9a923e7777f2;hb=1d9e702392092e351b448175a77c16234eec9212;hp=0f47810ec65acbcdc8cb4beaba128968d576aee4;hpb=d0f1dce33156fdb99f0ca3627839001909419497;p=poolifier.git diff --git a/docs/interfaces/IWorker.html b/docs/interfaces/IWorker.html index 0f47810e..a25b63e8 100644 --- a/docs/interfaces/IWorker.html +++ b/docs/interfaces/IWorker.html @@ -1,33 +1,140 @@ -IWorker | poolifier
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IWorker

-

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

-

Hierarchy

  • IWorker

Index

Methods

Methods

on

once

Generated using TypeDoc

\ No newline at end of file +IWorker | poolifier
+
+ +
+
+
+
+ +

Interface IWorker

+
+

Worker interface.

+
+
+

Hierarchy

+
    +
  • IWorker
+
+
+
+ +
+
+

Properties

+
on +once +
+
+

Properties

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

Register an event listener.

+ +

Param

The event.

+ +

Param

The event listener.

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

Type declaration

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

      Register a listener to the exit event that will only performed once.

      +
      +
      +

      Parameters

      +
      +

      Returns void

+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file