X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIWorker.html;h=e1e40c63e225c906e41ba93bc52f98d2fb0191f5;hb=refs%2Ftags%2Fv3.1.7;hp=d2ebd02c8c7651b85c4bd7346bb9688270a16abb;hpb=10fdf6b15d99197b3e9a783dcc697f1acaf02cd2;p=poolifier.git diff --git a/docs/interfaces/IWorker.html b/docs/interfaces/IWorker.html index d2ebd02c..e1e40c63 100644 --- a/docs/interfaces/IWorker.html +++ b/docs/interfaces/IWorker.html @@ -1,13 +1,21 @@ -IWorker | poolifier - v3.0.5

Interface IWorker

Worker interface.

-

Hierarchy

  • IWorker

Properties

id? +IWorker | poolifier - v3.1.6

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

id?: number

Worker id.

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

Registers an event listener.

-

Type declaration

Type declaration

Type declaration

Type declaration

Param

The event.

-

Param

The event handler.

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

Type declaration

    • (event, handler): void
    • Registers a listener to the exit event that will only be performed once.

      -

      Parameters

      Returns void

threadId?: number

Generated using TypeDoc

\ No newline at end of file +

Properties

disconnect?: (() => void)

Type declaration

    • (): void
    • Cluster worker disconnect.

      +

      Returns void

id?: number

Cluster worker id.

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

Type declaration

    • (signal?): void
    • Cluster worker kill.

      +

      Parameters

      • Optional signal: string

      Returns void

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

Type declaration

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

Type declaration

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>

threadId?: number

Worker thread worker id.

+

Generated using TypeDoc

\ No newline at end of file