Function: useSubscription()
On this page
useSubscription<
TOutput,TError>(opts):TRPCSubscriptionResult<TOutput,TError>
Defined in: tanstack-react-query/src/internals/subscriptionOptions.ts:234
Runs a subscription while the component is mounted.
Type Parameters
| Type Parameter |
|---|
TOutput |
TError |
Parameters
| Parameter | Type |
|---|---|
opts | TRPCSubscriptionOptionsOut<TOutput, TError, any> |
Returns
TRPCSubscriptionResult<TOutput, TError>
Example
const trpc = useTRPC();
const sub = useSubscription(
trpc.chat.onMessage.subscriptionOptions({ roomId }),
);See
https://trpc.io/docs/client/tanstack-react-query/usage#subscriptionOptions