X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIWorker.html;h=f7b17da38190d9bab1cda8c7c33dec58ff87d258;hb=c87790e87f57cf89fe9489144ba8eacf617a5411;hp=38fae6a69eddf6761adec29e9949284f7f79daba;hpb=8d98e603c79d8d00b2b6a33e5f732701a7466234;p=poolifier.git diff --git a/docs/interfaces/IWorker.html b/docs/interfaces/IWorker.html index 38fae6a6..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,38 +17,110 @@

    Interface IWorker

    Worker interface.

    -
    +
    +

    Hierarchy

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

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

    Register an event listener.

    - -

    Param

    The event.

    +

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

    +

    Param

    The event handler.

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

    once

    +

    Readonly once

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

    Type declaration

    @@ -57,27 +129,35 @@
    • (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.

        +
        +
      • handler: ExitHandler<IWorker>

        The exit handler.

        -
      -

      Returns void

    +
    +

    Returns void

    +
    +
    +

    Optional Readonly threadId

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

    Settings

     +

    Settings

    Member Visibility

    @@ -89,61 +169,38 @@

    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