charton API / @chart-on/core / index / WebSocketDataSourceOptions
Interface: WebSocketDataSourceOptions
Defined in: packages/core/src/data/adapters.ts:272
Options for the WebSocket data source: the socket URL, the history source behind it, the subscribe and unsubscribe messages, how to parse incoming bars, and reconnect backoff.
Properties
history
history:
Pick<DataSource,"symbol"|"search"|"history">
Defined in: packages/core/src/data/adapters.ts:275
Symbol lookup and history, e.g. a REST data source.
reconnect?
optionalreconnect?:object
Defined in: packages/core/src/data/adapters.ts:287
Reconnect backoff bounds in ms (default 1000 to 30000).
maxMs
maxMs:
number
minMs
minMs:
number
url
url:
string
Defined in: packages/core/src/data/adapters.ts:273
Methods
createSocket()?
optionalcreateSocket(url):SocketLike
Defined in: packages/core/src/data/adapters.ts:289
Socket factory; defaults to the global WebSocket.
Parameters
url
string
Returns
key()?
optionalkey(symbol,interval):string
Defined in: packages/core/src/data/adapters.ts:285
Stream key for a subscription; must match parse. Default symbol:interval.
Parameters
symbol
interval
Returns
string
parse()
parse(
message): {bar:Bar;key:string; } |null
Defined in: packages/core/src/data/adapters.ts:283
Read a message (JSON-parsed when possible). Return the stream key and bar it carries, or null to ignore it.
Parameters
message
unknown
Returns
{ bar: Bar; key: string; } | null
subscribeMessage()
subscribeMessage(
symbol,interval):unknown
Defined in: packages/core/src/data/adapters.ts:277
Message that starts a stream; strings are sent as is, anything else as JSON.
Parameters
symbol
interval
Returns
unknown
unsubscribeMessage()?
optionalunsubscribeMessage(symbol,interval):unknown
Defined in: packages/core/src/data/adapters.ts:278
Parameters
symbol
interval
Returns
unknown