Interface RemoteSinkNodeOptions<S>

Type Parameters

S extends RemoteService

Hierarchy-Diagram

UML class diagram of RemoteSinkNodeOptions

Legend

icon for an interface in the UML class diagram

interface

Hierarchy

SinkNodeOptions
RemoteNodeOptions<S>
- RemoteSinkNodeOptions

Index

Properties

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

Properties

`Optional` completedEvent

completedEvent?: boolean

Emit a completed event for this sink

Default

true

`Optional` deserialize

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

Type declaration

- (obj: any, options?: RemotePushOptions): 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: DataFrame, options?: RemotePushOptions) => any)

Type declaration

- (obj: DataFrame, options?: RemotePushOptions): any
- Parameters
  - obj: DataFrame
  - Optional options: RemotePushOptions
  Returns any

`Optional` service

service?: Serializable<S>

Service to use for the remote note

Default

RemoteService any remote service

`Optional` type

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

Node type to use

Default

RemoteNode a normal remote node

`Optional` uid

uid?: string

Manually set the unique identifier of the node