@cubejs-client/ws-transport
WebSocket transport for Cube.js client
WebSocketTransport
constructor
new WebSocketTransport(__namedParameters: object): WebSocketTransport
apiUrl
apiUrl: string
heartBeatInterval
heartBeatInterval: number
messageCounter
messageCounter: number
messageIdToSubscription
messageIdToSubscription: Record<number, Subscription>
messageQueue
messageQueue: Message[]
token
token: string | undefined
ws
ws: any
authorization
close
close(): Promise<void>
initSocket
protected initSocket(): any
request
request(method: string, __namedParameters: object): ITransportResponse<WebSocketTransportResult>
sendMessage
protected sendMessage(message: any): void
WebSocketTransportResult
constructor
new WebSocketTransportResult(__namedParameters: object): WebSocketTransportResult
result
result: unknown
status
status: unknown
json
json(): Promise<unknown>
Types
Message
Name | Type |
---|---|
messageId | number |
method | string |
params | Record<string, unknown> |
requestId | any |
Subscription
Name | Type |
---|---|
callback | (result: WebSocketTransportResult) => void |
message | Message |
WebSocketTransportOptions
Name | Type |
---|---|
apiUrl | string |
authorization? | string |
hearBeatInterval? | number |
heartBeatInterval? | number |