X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIWorker.html;h=f7b17da38190d9bab1cda8c7c33dec58ff87d258;hb=c87790e87f57cf89fe9489144ba8eacf617a5411;hp=092634850474290cd6220e6131d5507dd1947f3f;hpb=5abbf08a224670226e5432695f490fa44ff34937;p=poolifier.git diff --git a/docs/interfaces/IWorker.html b/docs/interfaces/IWorker.html index 09263485..f7b17da3 100644 --- a/docs/interfaces/IWorker.html +++ b/docs/interfaces/IWorker.html @@ -1,13 +1,13 @@ -IWorker | poolifier
+IWorker | poolifier - v3.0.0
-
+
  • The search index is not available
    • poolifier - v3.0.0 +
    @@ -17,67 +17,147 @@

    Interface IWorker

    Worker interface.

    -
    +
    +

    Hierarchy

    +
  • Defined in src/pools/worker.ts:186
    • - +

    Properties

    -
    on -once +
    id? +on +once +threadId?

    Properties

    -
    -

    on

    -
    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.

    +
    +

    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

        +
        +

        Returns void

    +
    +

    Type declaration

    +
      +
    • +
        +
      • (event, handler): void
        • +
      • +
        +

        Parameters

        +
        +

        Returns void

    +
    +

    Type declaration

    +
      +
    • +
        +
      • (event, handler): void
        • +
      • +
        +

        Parameters

        +
        +

        Returns void

    +
    +

    Type declaration

    +
      +
    • +
        +
      • (event, handler): void
        • +
      • +
        +

        Parameters

        +
        +

        Returns void

    +
    +

    Param

    The event.

    -

    Param

    The event listener.

    +

    Param

    The event handler.

    -
    -

    once

    -
    once: ((event: "exit", handler: ExitHandler<IWorker>) => void)
    +
  • Defined in src/pools/worker.ts:198
    • +
    +

    Readonly once

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

    Type declaration

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

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

          +

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

          Parameters

          -

          Returns void

    +
    +

    Returns void

    +
    +
    +

    Optional Readonly threadId

    +
    threadId?: number
    +
  • Defined in src/pools/worker.ts:191
    • -

    Settings

     +

    Settings

    Member Visibility

    @@ -87,54 +167,40 @@
    • -

    Theme

    +

    Theme

    -

    On This Page

     +

    On This Page

    +
  • id
    • +
  • on
    • +
  • once
    • +
  • threadId
    • -
    +
    -

    Generated using TypeDoc

    -
    \ No newline at end of file +

    Generated using TypeDoc

    +
    \ No newline at end of file