Interface: DecorateQueryProcedure<TDef>
Defined in: tanstack-react-query/src/internals/createOptionsProxy.ts:158
Extends
TypeHelper<TDef>.DecorateRouterKeyable<TDef["featureFlags"]>
Type Parameters
| Type Parameter |
|---|
TDef extends ResolverDef |
Properties
pathFilter()
pathFilter: (
filters?) =>WithRequired<QueryFilters<TRPCQueryKey<TDef["featureFlags"]["keyPrefix"]>>,"queryKey">
Defined in: tanstack-react-query/src/internals/createOptionsProxy.ts:67
Calculate a TanStack Query Filter for any path, could be used to manipulate every procedure beneath this path
Parameters
| Parameter | Type |
|---|---|
filters? | QueryFilters<TRPCQueryKey<TDef["featureFlags"]["keyPrefix"]>> |
Returns
WithRequired<QueryFilters<TRPCQueryKey<TDef["featureFlags"]["keyPrefix"]>>, "queryKey">
See
- https://tanstack.com/query/latest/docs/framework/react/guides/filters
- https://trpc.io/docs/client/tanstack-react-query/usage#queryFilter
Inherited from
DecorateRouterKeyable.pathFilter
pathKey()
pathKey: () =>
TRPCQueryKey<TDef["featureFlags"]["keyPrefix"]>
Defined in: tanstack-react-query/src/internals/createOptionsProxy.ts:59
Calculate the TanStack Query Key for any path, could be used to invalidate every procedure beneath this path
Returns
TRPCQueryKey<TDef["featureFlags"]["keyPrefix"]>
See
- https://tanstack.com/query/latest/docs/framework/react/guides/query-keys
- https://trpc.io/docs/client/tanstack-react-query/usage#queryKey
Inherited from
queryFilter()
queryFilter: (
input?,filters?) =>WithRequired<QueryFilters<DataTag<TRPCQueryKey<TDef["featureFlags"]["keyPrefix"]>,TDef["output"],TRPCClientErrorLike<{errorShape:TDef["errorShape"];transformer:TDef["transformer"]; }>>>,"queryKey">
Defined in: tanstack-react-query/src/internals/createOptionsProxy.ts:189
Calculate a TanStack Query Filter for a Query Procedure
Parameters
| Parameter | Type |
|---|---|
input? | Partial<TDef["input"]> |
filters? | QueryFilters<DataTag<TRPCQueryKey<TDef["featureFlags"]["keyPrefix"]>, TDef["output"], TRPCClientErrorLike<{ errorShape: TDef["errorShape"]; transformer: TDef["transformer"]; }>>> |
Returns
WithRequired<QueryFilters<DataTag<TRPCQueryKey<TDef["featureFlags"]["keyPrefix"]>, TDef["output"], TRPCClientErrorLike<{ errorShape: TDef["errorShape"]; transformer: TDef["transformer"]; }>>>, "queryKey">
See
- https://tanstack.com/query/latest/docs/framework/react/guides/filters
- https://trpc.io/docs/client/tanstack-react-query/usage#queryFilter
queryKey()
queryKey: (
input?) =>DataTag<TRPCQueryKey<TDef["featureFlags"]["keyPrefix"]>,TDef["output"],TRPCClientErrorLike<{errorShape:TDef["errorShape"];transformer:TDef["transformer"]; }>>
Defined in: tanstack-react-query/src/internals/createOptionsProxy.ts:174
Calculate the TanStack Query Key for a Query Procedure
Parameters
| Parameter | Type |
|---|---|
input? | Partial<TDef["input"]> |
Returns
DataTag<TRPCQueryKey<TDef["featureFlags"]["keyPrefix"]>, TDef["output"], TRPCClientErrorLike<{ errorShape: TDef["errorShape"]; transformer: TDef["transformer"]; }>>
See
- https://tanstack.com/query/latest/docs/framework/react/guides/query-keys
- https://trpc.io/docs/client/tanstack-react-query/usage#queryKey
queryOptions
queryOptions:
TRPCQueryOptions<TDef>
Defined in: tanstack-react-query/src/internals/createOptionsProxy.ts:166
Create a set of type-safe query options that can be passed to useQuery, prefetchQuery etc.