@openhps/socket
    Preparing search index...

    Interface SocketSinkNodeOptions

    interface SocketSinkNodeOptions {
        broadcast?: boolean;
        completedEvent?: boolean;
        deserialize?: (obj: any, options?: RemotePushOptions) => DataFrame;
        name?: string;
        persistence?: boolean;
        serialize?: (obj: DataFrame, options?: RemotePushOptions) => any;
        service?: Serializable<SocketServer>;
        type?: Constructor<RemoteNode<any, any, SocketServer>>;
        uid?: string;
    }

    Hierarchy

    Index
    broadcast? completedEvent? deserialize? name? persistence? serialize? service? type? uid?
    broadcast?: boolean

    Broadcast the pushed data frames to all clients

    true
    completedEvent?: boolean

    Emit a completed event for this sink

    true
    deserialize?: (obj: any, options?: RemotePushOptions) => DataFrame
    name?: string

    User friendly name of the node Used for querying a node by its name.

    persistence?: boolean

    Store objects in data services

    true
    serialize?: (obj: DataFrame, options?: RemotePushOptions) => any
    service?: Serializable<SocketServer>

    Service to use for the remote note

    RemoteService any remote service
    type?: Constructor<RemoteNode<any, any, SocketServer>>

    Node type to use

    RemoteNode a normal remote node
    uid?: string

    Manually set the unique identifier of the node

    Settings
    Member Visibility

    On This Page
    Properties