ws-asyncapi API / react / ReactClient
Interface: ReactClient<T>
Defined in: .api-entries/react/index.d.ts:45
Type Parameters
T
T extends Shape
Properties
client
client:
WsClient<T>
Defined in: .api-entries/react/index.d.ts:48
the underlying, precisely-typed client (escape hatch: opened, raw request, presence.update, …; also what cursorsStore consumes)
Methods
useRequest()
useRequest<
C>(command,input,options?):UseQueryResult<T["rpcMap"][C]["output"],TypedRpcError<T["rpcMap"][C]["errors"]>>
Defined in: .api-entries/react/index.d.ts:49
Type Parameters
C
C extends string | number | symbol
Parameters
command
C
input
T["rpcMap"][C]["input"]
options?
Omit<UseQueryOptions<T["rpcMap"][C]["output"], TypedRpcError<T["rpcMap"][C]["errors"]>>, "queryKey" | "queryFn">
Returns
UseQueryResult<T["rpcMap"][C]["output"], TypedRpcError<T["rpcMap"][C]["errors"]>>
useMutate()
useMutate<
C>(command,options?):UseMutationResult<T["rpcMap"][C]["output"],TypedRpcError<T["rpcMap"][C]["errors"]>,T["rpcMap"][C]["input"]>
Defined in: .api-entries/react/index.d.ts:50
Type Parameters
C
C extends string | number | symbol
Parameters
command
C
options?
Omit<UseMutationOptions<T["rpcMap"][C]["output"], TypedRpcError<T["rpcMap"][C]["errors"]>, T["rpcMap"][C]["input"]>, "mutationFn">
Returns
UseMutationResult<T["rpcMap"][C]["output"], TypedRpcError<T["rpcMap"][C]["errors"]>, T["rpcMap"][C]["input"]>
usePresence()
usePresence():
PresenceResult<T["presenceState"]>
Defined in: .api-entries/react/index.d.ts:51
Returns
PresenceResult<T["presenceState"]>
useHistory()
useHistory(
room,options?):UseQueryResult<HistoryEntry<T["eventMap"]>[],RpcError>
Defined in: .api-entries/react/index.d.ts:52
Parameters
room
string
options?
liveEvent?
keyof T["eventMap"] & string
limit?
number
Returns
UseQueryResult<HistoryEntry<T["eventMap"]>[], RpcError>
useStream()
Call Signature
useStream<
N>(name,input):StreamResult<T["streamMap"][N]["output"]>
Defined in: .api-entries/react/index.d.ts:56
Type Parameters
N
N extends string | number | symbol
Parameters
name
N
input
T["streamMap"][N]["input"]
Returns
StreamResult<T["streamMap"][N]["output"]>
Call Signature
useStream<
N>(name,input,options):StreamResult<T["streamMap"][N]["output"][]>
Defined in: .api-entries/react/index.d.ts:57
Type Parameters
N
N extends string | number | symbol
Parameters
name
N
input
T["streamMap"][N]["input"]
options
reduce
"append"
max?
number
Returns
StreamResult<T["streamMap"][N]["output"][]>
Call Signature
useStream<
N,Acc>(name,input,options):StreamResult<Acc>
Defined in: .api-entries/react/index.d.ts:61
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
StreamResult<Acc>
useLastEvent()
useLastEvent<
E>(event):T["eventMap"][E]
Defined in: .api-entries/react/index.d.ts:65
Type Parameters
E
E extends string | number | symbol
Parameters
event
E
Returns
T["eventMap"][E]
useEvent()
useEvent<
E>(event,handler):void
Defined in: .api-entries/react/index.d.ts:66
Type Parameters
E
E extends string | number | symbol
Parameters
event
E
handler
(data, queryClient) => void
Returns
void
useConnection()
useConnection():
object
Defined in: .api-entries/react/index.d.ts:67
Returns
object
connected
connected:
boolean
recovered
recovered:
boolean