X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIWorker.html;h=74ba9185882b520a151b2f2d2a61c51a11ebd313;hb=42283971c52896a642fafa9fd351da3ef645b7f5;hp=4fcb3bfdc7c7f0210cc4507b93ec0989e4607134;hpb=4608939f425568da5553db1f5bf883d4cca18e02;p=poolifier.git diff --git a/docs/interfaces/IWorker.html b/docs/interfaces/IWorker.html index 4fcb3bfd..74ba9185 100644 --- a/docs/interfaces/IWorker.html +++ b/docs/interfaces/IWorker.html @@ -1,206 +1,31 @@ -IWorker | poolifier - v2.6.45
-
- -
-
-
-
- -

Interface IWorker

-
-

Worker interface.

-
-
-
-

Hierarchy

-
    -
  • IWorker
-
-
-
- -
-
-

Properties

-
id? +IWorker | poolifier - v3.1.16

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

Settings

 -
-
-

Member Visibility

-
    -
    • -
    • -
    • -
-
-

Theme

-
-

On This Page

 -
-
-
-
-
-

Generated using TypeDoc

-
\ No newline at end of file +

Properties

Optional Readonly disconnect

disconnect?: (() => void)

Cluster worker disconnect.

+

Type declaration

    • (): void

    • Cluster worker disconnect.

      +

      Returns void

Optional Readonly id

id?: number

Cluster worker id.

+

Optional Readonly kill

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

Cluster worker kill.

+

Type declaration

    • (signal?): void

    • Cluster worker kill.

      +

      Parameters

      • Optional signal: string

      Returns void

Readonly on

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

Registers an event handler.

+

Type declaration

    • (event, handler): void

    • Registers an event handler.

      +

      Parameters

      Returns void

Param: event

The event.

+

Param: handler

The event handler.

+

Readonly once

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

Registers once an event handler.

+

Type declaration

    • (event, handler): void

    • Registers once an event handler.

      +

      Parameters

      Returns void

Param: event

The event.

+

Param: handler

The event handler.

+

Optional Readonly terminate

terminate?: (() => 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.

+

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