Class StreamingAPI

Index

Constructors

Properties

endpoint? key? socket? started

Accessors

Methods

addRule addRules deleteRule deleteRules getRules handleServiceMessage startWebSocket stop

Constructors

constructor

new StreamingAPI(
    __namedParameters: Partial<IStreamingAPI> & {
        api: API;
        updates: Updates;
    },
): StreamingAPI
Constructor
Parameters
- __namedParameters: Partial<IStreamingAPI> & { api: API; updates: Updates }
Returns StreamingAPI
- Defined in packages/streaming/src/streaming.ts:49

Properties

`Protected` `Optional`endpoint

endpoint?: URL

`Protected` `Optional`key

key?: string

`Protected` `Optional`socket

socket?: WebSocket

`Protected`started

started: boolean = false

Accessors

[toStringTag]

get "[toStringTag]"(): string
Returns custom tag

Returns string
- Defined in packages/streaming/src/streaming.ts:64

Methods

addRule

addRule(rule: IStreamingRule): Promise<void>
Adds a rule
Parameters
- rule: IStreamingRule
Returns Promise<void>
- Defined in packages/streaming/src/streaming.ts:231

addRules

addRules(rules: IStreamingRule[]): Promise<void>
Adds a list of rules
Parameters
- rules: IStreamingRule[]
Returns Promise<void>
- Defined in packages/streaming/src/streaming.ts:245

deleteRule

deleteRule(tag: string): Promise<void>
Removes the rule
Parameters
- tag: string
Returns Promise<void>
- Defined in packages/streaming/src/streaming.ts:238

deleteRules

deleteRules(): Promise<void>
Removes all rules

Returns Promise<void>
- Defined in packages/streaming/src/streaming.ts:252

getRules

getRules(): Promise<IStreamingRule[]>
Returns a list of rules

Returns Promise<IStreamingRule[]>
- Defined in packages/streaming/src/streaming.ts:222

handleServiceMessage

handleServiceMessage(__namedParameters: { service_code: number }): Promise<void>
Processes server messages
Parameters
- __namedParameters: { service_code: number }
Returns Promise<void>
- Defined in packages/streaming/src/streaming.ts:155

startWebSocket

startWebSocket(): Promise<void>
Starts websocket

Returns Promise<void>
- Defined in packages/streaming/src/streaming.ts:71

stop

stop(): Promise<void>
Stop all connection

Returns Promise<void>
- Defined in packages/streaming/src/streaming.ts:140