Interface Inlet<In>

Inlet of a node that supports pulling and events.

interface Inlet<In> {
    get inletNode(): GraphNode<any, In>;
    emit(name, arg): boolean;
    emit(name, event): boolean;
    emit(name, event): boolean;
    on(name, listener): this;
    pull(options?): Promise<void>;
}

Type Parameters

Implemented by

Accessors

inletNode

Methods

emit on pull

Accessors

inletNode

Methods

emit

on

  • on(name, listener): this

  • Event when a data frame is push to the node

    Parameters

    • name: "push"

      receive

    • listener: ((frame, options?) => void | Promise<void>)

      Event callback

        • (frame, options?): void | Promise<void>

        • Parameters

          Returns void | Promise<void>

    Returns this

pull

  • pull(options?): Promise<void>

  • Pull data from the inlet

    Parameters

    Returns Promise<void>

    Pull promise

Settings

Member Visibility

Theme

On This Page

inletNodeemitonpull