@openhps/core
    Preparing search index...

    Interface Inlet<In>

    Inlet of a node that supports pulling and events.

    interface Inlet<In extends DataFrame> {
        get inletNode(): GraphNode<any, In>;
        emit(name: string, arg: any): boolean;
        emit(name: "completed", event: PushCompletedEvent): boolean;
        emit(name: "error", event: PushError): boolean;
        on(
            name: "push",
            listener: (
                frame: In,
                options?: PushOptions,
            ) => void | Promise<void> | PushPromise<void, any>,
        ): this;
        pull(options?: PullOptions): Promise<void> | PullPromise<void>;
    }

    Type Parameters

    Implemented by

    Index
    inletNode
    emit on pull

    • Event when a data frame is push to the node

      Parameters

      • name: "push"

        receive

      • listener: (
            frame: In,
            options?: PushOptions,
        ) => void | Promise<void> | PushPromise<void, any>

        Event callback

      Returns this

    Settings
    Member Visibility

    On This Page
    Accessors
    Methods