ws-asyncapi API / query-core / QueryCoreClient
Interface: QueryCoreClient
Defined in: .api-entries/query-core/index.d.ts:20
The subset of a ws-asyncapi client these helpers use (structurally satisfied by WsClient). Kept loose here; the bindings layer on the precise types.
Properties
connected
readonlyconnected:boolean
Defined in: .api-entries/query-core/index.d.ts:33
recovered
readonlyrecovered:boolean
Defined in: .api-entries/query-core/index.d.ts:34
presence
presence:
object
Defined in: .api-entries/query-core/index.d.ts:35
get()
get():
Map<string,unknown>
Returns
Map<string, unknown>
self
readonlyself:string
set()
set(
state):Promise<void>
Parameters
state
unknown
Returns
Promise<void>
update()
update(
patch):void
Parameters
patch
unknown
Returns
void
clear()
clear():
Promise<void>
Returns
Promise<void>
subscribe()
subscribe(
cb): () =>void
Parameters
cb
(members) => void
Returns
() => void
Methods
request()
request(
command,input,options?):Promise<unknown>
Defined in: .api-entries/query-core/index.d.ts:21
Parameters
command
string
input
unknown
options?
unknown
Returns
Promise<unknown>
history()
history(
room,options?):Promise<object[]>
Defined in: .api-entries/query-core/index.d.ts:22
Parameters
room
string
options?
limit?
number
Returns
Promise<object[]>
stream()
stream(
name,input):AsyncIterable<unknown>
Defined in: .api-entries/query-core/index.d.ts:28
Parameters
name
string
input
unknown
Returns
AsyncIterable<unknown>
onEvent()
onEvent(
event,cb): () =>void
Defined in: .api-entries/query-core/index.d.ts:29
Parameters
event
string
cb
(data) => void
Returns
() => void
onOpen()
onOpen(
cb): () =>void
Defined in: .api-entries/query-core/index.d.ts:30
Parameters
cb
() => void
Returns
() => void
onClose()
onClose(
cb): () =>void
Defined in: .api-entries/query-core/index.d.ts:31
Parameters
cb
() => void
Returns
() => void
onRecover()
onRecover(
cb): () =>void
Defined in: .api-entries/query-core/index.d.ts:32
Parameters
cb
(recovered) => void
Returns
() => void