ws-asyncapi API / solid / SolidClient
Interface: SolidClient<T>
Defined in: .api-entries/solid/index.d.ts:49
Type Parameters
T
T extends Shape
Properties
client
client:
WsClient<T>
Defined in: .api-entries/solid/index.d.ts:52
the underlying, precisely-typed client (escape hatch: opened, raw request, presence.update, …; also what cursorsStore consumes)
Methods
createRequest()
createRequest<
C>(command,input):UseQueryResult<T["rpcMap"][C]["output"],TypedRpcError<T["rpcMap"][C]["errors"]>>
Defined in: .api-entries/solid/index.d.ts:53
Type Parameters
C
C extends string | number | symbol
Parameters
command
C
input
T["rpcMap"][C]["input"] | Accessor<T["rpcMap"][C]["input"]>
Returns
UseQueryResult<T["rpcMap"][C]["output"], TypedRpcError<T["rpcMap"][C]["errors"]>>
createMutate()
createMutate<
C>(command):UseMutationResult<T["rpcMap"][C]["output"],TypedRpcError<T["rpcMap"][C]["errors"]>,T["rpcMap"][C]["input"]>
Defined in: .api-entries/solid/index.d.ts:54
Type Parameters
C
C extends string | number | symbol
Parameters
command
C
Returns
UseMutationResult<T["rpcMap"][C]["output"], TypedRpcError<T["rpcMap"][C]["errors"]>, T["rpcMap"][C]["input"]>
createPresence()
createPresence():
PresenceAccessors<T["presenceState"]>
Defined in: .api-entries/solid/index.d.ts:55
Returns
PresenceAccessors<T["presenceState"]>
createHistory()
createHistory(
room,options?):UseQueryResult<HistoryEntry<T["eventMap"]>[],RpcError>
Defined in: .api-entries/solid/index.d.ts:56
Parameters
room
string
options?
liveEvent?
keyof T["eventMap"] & string
limit?
number
Returns
UseQueryResult<HistoryEntry<T["eventMap"]>[], RpcError>
createStream()
Call Signature
createStream<
N>(name,input):StreamAccessors<T["streamMap"][N]["output"]>
Defined in: .api-entries/solid/index.d.ts:60
Type Parameters
N
N extends string | number | symbol
Parameters
name
N
input
T["streamMap"][N]["input"]
Returns
StreamAccessors<T["streamMap"][N]["output"]>
Call Signature
createStream<
N>(name,input,options):StreamAccessors<T["streamMap"][N]["output"][]>
Defined in: .api-entries/solid/index.d.ts:61
Type Parameters
N
N extends string | number | symbol
Parameters
name
N
input
T["streamMap"][N]["input"]
options
reduce
"append"
max?
number
Returns
StreamAccessors<T["streamMap"][N]["output"][]>
Call Signature
createStream<
N,Acc>(name,input,options):StreamAccessors<Acc>
Defined in: .api-entries/solid/index.d.ts:65
Type Parameters
N
N extends string | number | symbol
Acc
Acc
Parameters
name
N
input
T["streamMap"][N]["input"]
options
reduce
(acc, item) => Acc
initial
Acc
Returns
StreamAccessors<Acc>
createLastEvent()
createLastEvent<
E>(event):Accessor<T["eventMap"][E]>
Defined in: .api-entries/solid/index.d.ts:69
Type Parameters
E
E extends string | number | symbol
Parameters
event
E
Returns
Accessor<T["eventMap"][E]>
createEvent()
createEvent<
E>(event,handler):void
Defined in: .api-entries/solid/index.d.ts:70
Type Parameters
E
E extends string | number | symbol
Parameters
event
E
handler
(data, queryClient) => void
Returns
void
createConnection()
createConnection():
object
Defined in: .api-entries/solid/index.d.ts:71
Returns
object
connected
connected:
Accessor<boolean>
recovered
recovered:
Accessor<boolean>