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