Create a new StreamMetadata instance, connects to the server using WebSocket and listen to metadata events.
Private
_connectPrivate
Optional
_metadataPrivate
_streamPrivate
_wsStart a log
a Log object with the levels of log to call
Returns true if the connection is closed
Returns the Connect.Params object containing the connection parameters
State of the stream as indicated by the server
URL of the connection
Private
_addClose the stream metadata channel
Optional
error: StreamMetadataErrorerror description on an improper closure
Event subscription
Name of event without the on
prefix (ex: log
to onLog
event declared)
Subscriber Function
Optional
options: { Optional
signal?: AbortSignalOptional AbortSignal
to stop this or multiple subscriptions in same time
Event fired when stream state is changing
Event subscription only one time, once time fired it's automatically unsubscribe
Name of event without the on
prefix (ex: log
to onLog
event declared)
Subscriber Function
Optional
options: { Optional
signal?: AbortSignalEvent fired when the stream is closed
Optional
error: StreamMetadataErrorerror description on an improper closure
Event fired when metadata is present in the stream
Generated using TypeDoc
Use StreamMetadata to get real-time information on a server stream, including:
Example