X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIWorker.html;h=2acbc6faae42d733678bdb3426ee3244a55df048;hb=d087803425ae5b3577028029dd1d2dae67d7f63b;hp=4fad5ee19797fa49ecf9de717a770e4f2c2afadd;hpb=f63918da6f3fc77cc7f98e4d43e3f37955140468;p=poolifier.git diff --git a/docs/interfaces/IWorker.html b/docs/interfaces/IWorker.html index 4fad5ee1..2acbc6fa 100644 --- a/docs/interfaces/IWorker.html +++ b/docs/interfaces/IWorker.html @@ -1,140 +1,21 @@ -IWorker | poolifier
-
- -
-
-
-
- -

Interface IWorker

-
-

Worker interface.

-
-
-

Hierarchy

-
    -
  • IWorker
-
-
-
- -
-
-

Properties

-
on -once -
-
-

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.

- -

Param

The event listener.

-
-
-

once

-
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

-
-
-
-
-

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

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

Interface IWorker

Worker interface.

+
interface IWorker {
    disconnect?: (() => void);
    id?: number;
    kill?: ((signal?) => void);
    on: ((event, handler) => void);
    once: ((event, handler) => void);
    terminate?: (() => Promise<number>);
    threadId?: number;
}

Properties

disconnect? +id? +kill? +on +once +terminate? +threadId? +

Properties

Optional Readonly disconnect

disconnect?: (() => void)

Type declaration

    • (): void

    • Cluster worker disconnect.

      +

      Returns void

Optional Readonly id

id?: number

Cluster worker id.

+

Optional Readonly kill

kill?: ((signal?) => void)

Type declaration

    • (signal?): void

    • Cluster worker kill.

      +

      Parameters

      • Optional signal: string

      Returns void

Readonly on

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

Type declaration

Readonly once

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

Type declaration

Optional Readonly terminate

terminate?: (() => Promise<number>)

Type declaration

    • (): Promise<number>

    • Stop all JavaScript execution in the worker thread as soon as possible. +Returns a Promise for the exit code that is fulfilled when the 'exit' event is emitted.

      +

      Returns Promise<number>

Optional Readonly threadId

threadId?: number

Worker thread worker id.

+

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file