X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Finterfaces%2FIWorker.html;h=c915a559881645f37096e76e772c6b8aea658d85;hb=394676d15b59b7013b9d95889e47a4a49860b057;hp=f19102644d3c3d9394aaeb929c410dc5bf0c2045;hpb=e1ba9765afbf97436250d19f28c818221ebc10b9;p=poolifier.git diff --git a/docs/interfaces/IWorker.html b/docs/interfaces/IWorker.html index f1910264..c915a559 100644 --- a/docs/interfaces/IWorker.html +++ b/docs/interfaces/IWorker.html @@ -1,5 +1,5 @@ -IWorker | poolifier - v3.1.28

Interface IWorker

Worker interface.

-
interface IWorker {
    disconnect?: (() => void);
    id?: number;
    kill?: ((signal?) => void);
    on: ((event, handler) => this);
    once: ((event, handler) => this);
    terminate?: (() => Promise<number>);
    threadId?: number;
    unref?: (() => void);
    [captureRejectionSymbol]?<K>(error, event, ...args): void;
    addListener<K>(eventName, listener): this;
    emit<K>(eventName, ...args): boolean;
    eventNames(): (string | symbol)[];
    getMaxListeners(): number;
    listenerCount<K>(eventName, listener?): number;
    listeners<K>(eventName): Function[];
    off<K>(eventName, listener): this;
    prependListener<K>(eventName, listener): this;
    prependOnceListener<K>(eventName, listener): this;
    rawListeners<K>(eventName): Function[];
    removeAllListeners(eventName?): this;
    removeListener<K>(eventName, listener): this;
    setMaxListeners(n): this;
}

Hierarchy

  • EventEmitter
    • IWorker

Properties

disconnect? +IWorker | poolifier - v3.1.29

Interface IWorker

Worker interface.

+
interface IWorker {
    disconnect?: (() => void);
    id?: number;
    kill?: ((signal?) => void);
    on: ((event, handler) => this);
    once: ((event, handler) => this);
    terminate?: (() => Promise<number>);
    threadId?: number;
    unref?: (() => void);
    [captureRejectionSymbol]?<K>(error, event, ...args): void;
    addListener<K>(eventName, listener): this;
    emit<K>(eventName, ...args): boolean;
    eventNames(): (string | symbol)[];
    getMaxListeners(): number;
    listenerCount<K>(eventName, listener?): number;
    listeners<K>(eventName): Function[];
    off<K>(eventName, listener): this;
    prependListener<K>(eventName, listener): this;
    prependOnceListener<K>(eventName, listener): this;
    rawListeners<K>(eventName): Function[];
    removeAllListeners(eventName?): this;
    removeListener<K>(eventName, listener): this;
    setMaxListeners(n): this;
}

Hierarchy

  • EventEmitter
    • IWorker

Properties

disconnect? id? kill? on @@ -22,21 +22,21 @@ removeListener setMaxListeners

Properties

Optional Readonly disconnect

disconnect?: (() => void)

Cluster worker disconnect.

-

Type declaration

    • (): void

    • Returns void

Optional Readonly id

id?: number

Cluster worker id.

-

Optional Readonly kill

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

Cluster worker kill.

-

Type declaration

    • (signal?): void

    • Parameters

      • Optional signal: string

      Returns void

Readonly on

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

Registers an event handler.

+

Type declaration

    • (): void

    • Returns void

Optional Readonly id

id?: number

Cluster worker id.

+

Optional Readonly kill

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

Cluster worker kill.

+

Type declaration

    • (signal?): void

    • Parameters

      • Optional signal: string

      Returns void

Readonly on

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

Registers an event handler.

Type declaration

    • (event, handler): this

    • Parameters

      Returns this

Readonly once

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

Registers once an event handler.

+

Returns this

Readonly once

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

Registers once an event handler.

Type declaration

    • (event, handler): this

    • Parameters

      Returns this

Optional Readonly terminate

terminate?: (() => Promise<number>)

Stop all JavaScript execution in the worker thread as soon as possible. +

Returns this

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>

    • Returns Promise<number>

Optional Readonly threadId

threadId?: number

Worker thread worker id.

-

Optional Readonly unref

unref?: (() => void)

Calling unref() on a worker allows the thread to exit if this is the only +

Type declaration

    • (): Promise<number>

    • Returns Promise<number>

Optional Readonly threadId

threadId?: number

Worker thread worker id.

+

Optional Readonly unref

unref?: (() => void)

Calling unref() on a worker allows the thread to exit if this is the only active handle in the event system. If the worker is already unref()ed callingunref() again has no effect.

Type declaration

    • (): void

    • Returns void

Since

v10.5.0

-

Methods

Optional [captureRejectionSymbol]

  • [captureRejectionSymbol]<K>(error, event, ...args): void

  • Type Parameters

    • K

    Parameters

    • error: Error
    • event: string | symbol
    • Rest ...args: AnyRest

    Returns void

addListener

Methods

Optional [captureRejectionSymbol]

  • [captureRejectionSymbol]<K>(error, event, ...args): void

  • Type Parameters

    • K

    Parameters

    • error: Error
    • event: string | symbol
    • Rest ...args: AnyRest

    Returns void

addListener

  • addListener<K>(eventName, listener): this

  • Alias for emitter.on(eventName, listener).

    Type Parameters

    • K

    Parameters

    • eventName: string | symbol
    • listener: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

    Since

    v0.1.26

emit

  • emit<K>(eventName, ...args): boolean

  • Synchronously calls each of the listeners registered for the event namedeventName, in the order they were registered, passing the supplied arguments to each.

    @@ -123,4 +123,4 @@ memory leaks. The emitter.setMaxListeners() method allows the limit modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.

    Returns a reference to the EventEmitter, so that calls can be chained.

    Parameters

    • n: number

    Returns this

    Since

    v0.3.5

    -

Settings

Member Visibility

Theme

On This Page

disconnectidkillononceterminatethreadIdunref[captureRejectionSymbol]addListeneremiteventNamesgetMaxListenerslistenerCountlistenersoffprependListenerprependOnceListenerrawListenersremoveAllListenersremoveListenersetMaxListeners

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

disconnectidkillononceterminatethreadIdunref[captureRejectionSymbol]addListeneremiteventNamesgetMaxListenerslistenerCountlistenersoffprependListenerprependOnceListenerrawListenersremoveAllListenersremoveListenersetMaxListeners

Generated using TypeDoc

\ No newline at end of file