X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIWorker.html;h=f36dbb9b4e8b1047b338b385e39142e3688f2a7c;hb=04d875a3942abe97ce35c177c6e6f41619be974b;hp=fe52798ea0a5fa6da21078fa1e6c3f5e80397ff5;hpb=90e3ad3a6abc5f39b81fb32e32d1d787bf85cf5d;p=poolifier.git diff --git a/docs/interfaces/IWorker.html b/docs/interfaces/IWorker.html index fe52798e..f36dbb9b 100644 --- a/docs/interfaces/IWorker.html +++ b/docs/interfaces/IWorker.html @@ -1,21 +1,31 @@ -IWorker | poolifier - v3.1.11

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? +IWorker | poolifier - v3.1.14

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

    • (event, handler): void

    • Registers an event handler.

      +

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

Readonly once

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

Type declaration

    • (event, handler): void

    • Registers once an event handler.

      +

Returns void

Param: event

The event.

+

Param: handler

The event handler.

+

Readonly once

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

Registers once an event handler.

+

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

-

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 +

Type declaration

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