Interface: TRPCSubscriptionOptions()<TDef, TFeatureFlags>
On this page
Defined in: tanstack-react-query/src/internals/subscriptionOptions.ts:63
The subscriptionOptions helper on a subscription procedure. Returns options for useSubscription.
See
https://trpc.io/docs/client/tanstack-react-query/usage#subscriptionOptions
Type Parameters
| Type Parameter | Default type |
|---|---|
TDef extends ResolverDef | - |
TFeatureFlags extends FeatureFlags | DefaultFeatureFlags |
TRPCSubscriptionOptions(
input,opts?):TRPCSubscriptionOptionsOut<inferAsyncIterableYield<TDef["output"]>,TRPCClientErrorLike<TDef>,TFeatureFlags>
Defined in: tanstack-react-query/src/internals/subscriptionOptions.ts:67
The subscriptionOptions helper on a subscription procedure. Returns options for useSubscription.
Parameters
| Parameter | Type |
|---|---|
input | TDef["input"] |
opts? | UnusedSkipTokenTRPCSubscriptionOptionsIn<inferAsyncIterableYield<TDef["output"]>, TRPCClientErrorLike<TDef>> |
Returns
TRPCSubscriptionOptionsOut<inferAsyncIterableYield<TDef["output"]>, TRPCClientErrorLike<TDef>, TFeatureFlags>
See
https://trpc.io/docs/client/tanstack-react-query/usage#subscriptionOptions
TRPCSubscriptionOptions(
input,opts?):TRPCSubscriptionOptionsOut<inferAsyncIterableYield<TDef["output"]>,TRPCClientErrorLike<TDef>,TFeatureFlags>
Defined in: tanstack-react-query/src/internals/subscriptionOptions.ts:78
The subscriptionOptions helper on a subscription procedure. Returns options for useSubscription.
Parameters
| Parameter | Type |
|---|---|
input | typeof skipToken | TDef["input"] |
opts? | BaseTRPCSubscriptionOptionsIn<inferAsyncIterableYield<TDef["output"]>, TRPCClientErrorLike<TDef>> |
Returns
TRPCSubscriptionOptionsOut<inferAsyncIterableYield<TDef["output"]>, TRPCClientErrorLike<TDef>, TFeatureFlags>
See
https://trpc.io/docs/client/tanstack-react-query/usage#subscriptionOptions