Interface Outlet<Out>

Outlet of a node that supports push events and pull listening.

Type Parameters

Hierarchy-Diagram

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

Hierarchy

  • Outlet

Implemented by

Methods

Methods

  • Event when a data frame is pulled

    Parameters

    • name: "pull"

      receive

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

      Event callback

        • (options?: PullOptions): void | Promise<void>
        • Parameters

          Returns void | Promise<void>

    Returns Outlet<Out>

  • Push data to the outlet

    Returns

    Push promise

    Parameters

    • data: Out | Out[]

      Data frame to push

    • Optional options: PushOptions

      Push options

    Returns Promise<void>