Interface Inlet<In>

Inlet of a node that supports pulling and events.

Type Parameters

Hierarchy-Diagram

UML class diagram of Inlet
Legend
icon for a class in the UML class diagram class
icon for an interface in the UML class diagram interface

Hierarchy

  • Inlet

Implemented by

Methods

Methods

  • 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 Inlet<In>

  • Pull data from the inlet

    Parameters

    Returns Promise<void>

    Pull promise