Interface SocketSinkNodeOptions

Hierarchy

Properties

broadcast? completedEvent? deserialize? name? persistence? serialize? service? type? uid?

Properties

Optional broadcast

broadcast?: boolean

Broadcast the pushed data frames to all clients

Default

true

Optional completedEvent

completedEvent?: boolean

Emit a completed event for this sink

Default

true

Optional deserialize

deserialize?: ((obj, options?) => DataFrame)

Type declaration

    • (obj, options?): DataFrame

    • Parameters

      • obj: any
      • Optional options: RemotePushOptions

      Returns DataFrame

Optional name

name?: string

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

Optional persistence

persistence?: boolean

Store objects in data services

Default

true

Optional serialize

serialize?: ((obj, options?) => any)

Type declaration

    • (obj, options?): any

    • Parameters

      • obj: DataFrame
      • Optional options: RemotePushOptions

      Returns any

Optional service

service?: Serializable<SocketServer>

Service to use for the remote note

Default

RemoteService any remote service

Optional type

type?: Constructor<RemoteNode<any, any, SocketServer>>

Node type to use

Default

RemoteNode a normal remote node

Optional uid

uid?: string

Manually set the unique identifier of the node

Settings

Member Visibility

Theme

On This Page