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

Interface IWorker

Worker interface.

-
interface IWorker {
    id?: number;
    on: ((event, handler) => void) & ((event, handler) => void) & ((event, handler) => void) & ((event, handler) => void);
    once: ((event, handler) => void);
    threadId?: number;
}

Properties

id? +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 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

Type declaration

Type declaration

Type declaration

Param: event

The event.

-

Param: handler

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

      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)

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