Class StreamingAPI

Index

Constructors

Properties

api endpoint? key? options socket? started updates

Accessors

Methods

addRule addRules deleteRule deleteRules fetchRules getRules handleEvent handleServiceMessage startWebSocket stop

Constructors

constructor

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

Properties

`Private` api

api: API

`Protected` `Optional` endpoint

endpoint?: URL

`Protected` `Optional` key

key?: string

`Private` options

options: Omit<IStreamingAPI, "api" | "updates">

`Protected` `Optional` socket

socket?: WebSocket

`Protected` started

started: boolean = false

`Private` updates

updates: Updates

Accessors

[toStringTag]

get [toStringTag](): string
Returns custom tag

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

Methods

addRule

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

addRules

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

deleteRule

deleteRule(tag): 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:254

`Private` fetchRules

fetchRules<T>(method, payload?): Promise<T>
Executes the HTTP request for rules
Type Parameters
- T = never
Parameters
- method: string
- payload: object = {}
Returns Promise<T>
- Defined in packages/streaming/src/streaming.ts:189

getRules

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

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

`Private` handleEvent

handleEvent(event): Promise<void>
Handles events
Parameters
- event: IStreamingContextPayload
Returns Promise<void>
- Defined in packages/streaming/src/streaming.ts:170

handleServiceMessage

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

startWebSocket

startWebSocket(): Promise<void>
Starts websocket

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

stop

stop(): Promise<void>
Stop all connection

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

Generated using TypeDoc