Skip to content
tRPC

Partners

Interface: TRPCQueryOptions()<TDef, TFeatureFlags>

On this page

Defined in: tanstack-react-query/src/internals/queryOptions.ts:155

The queryOptions helper on a query procedure. Returns options for useQuery, prefetchQuery and so on.

See

https://trpc.io/docs/client/tanstack-react-query/usage#queryOptions

Type Parameters

Type ParameterDefault type
TDef extends ResolverDef-
TFeatureFlags extends FeatureFlagsDefaultFeatureFlags

TRPCQueryOptions<TQueryFnData, TData>(input, opts): DefinedTRPCQueryOptionsOut<TQueryFnData, TData, TRPCClientErrorLike<{ errorShape: TDef["errorShape"]; transformer: TDef["transformer"]; }>, TFeatureFlags>

Defined in: tanstack-react-query/src/internals/queryOptions.ts:159

The queryOptions helper on a query procedure. Returns options for useQuery, prefetchQuery and so on.

Type Parameters

Type ParameterDefault type
TQueryFnData extends any-
TDataTQueryFnData

Parameters

ParameterType
inputTDef["input"] | typeof skipToken
optsDefinedTRPCQueryOptionsIn<TQueryFnData, TData, TRPCClientErrorLike<{ errorShape: TDef["errorShape"]; transformer: TDef["transformer"]; }>, TFeatureFlags>

Returns

DefinedTRPCQueryOptionsOut<TQueryFnData, TData, TRPCClientErrorLike<{ errorShape: TDef["errorShape"]; transformer: TDef["transformer"]; }>, TFeatureFlags>

See

https://trpc.io/docs/client/tanstack-react-query/usage#queryOptions

TRPCQueryOptions<TQueryFnData, TData>(input, opts?): UnusedSkipTokenTRPCQueryOptionsOut<TQueryFnData, TData, TRPCClientErrorLike<{ errorShape: TDef["errorShape"]; transformer: TDef["transformer"]; }>, TFeatureFlags>

Defined in: tanstack-react-query/src/internals/queryOptions.ts:179

The queryOptions helper on a query procedure. Returns options for useQuery, prefetchQuery and so on.

Type Parameters

Type ParameterDefault type
TQueryFnData extends any-
TDataTQueryFnData

Parameters

ParameterType
inputTDef["input"]
opts?UnusedSkipTokenTRPCQueryOptionsIn<TQueryFnData, TData, TRPCClientErrorLike<{ errorShape: TDef["errorShape"]; transformer: TDef["transformer"]; }>, TFeatureFlags>

Returns

UnusedSkipTokenTRPCQueryOptionsOut<TQueryFnData, TData, TRPCClientErrorLike<{ errorShape: TDef["errorShape"]; transformer: TDef["transformer"]; }>, TFeatureFlags>

See

https://trpc.io/docs/client/tanstack-react-query/usage#queryOptions

TRPCQueryOptions<TQueryFnData, TData>(input, opts?): UndefinedTRPCQueryOptionsOut<TQueryFnData, TData, TRPCClientErrorLike<{ errorShape: TDef["errorShape"]; transformer: TDef["transformer"]; }>, TFeatureFlags>

Defined in: tanstack-react-query/src/internals/queryOptions.ts:199

The queryOptions helper on a query procedure. Returns options for useQuery, prefetchQuery and so on.

Type Parameters

Type ParameterDefault type
TQueryFnData extends any-
TDataTQueryFnData

Parameters

ParameterType
inputTDef["input"] | typeof skipToken
opts?UndefinedTRPCQueryOptionsIn<TQueryFnData, TData, TRPCClientErrorLike<{ errorShape: TDef["errorShape"]; transformer: TDef["transformer"]; }>, TFeatureFlags>

Returns

UndefinedTRPCQueryOptionsOut<TQueryFnData, TData, TRPCClientErrorLike<{ errorShape: TDef["errorShape"]; transformer: TDef["transformer"]; }>, TFeatureFlags>

See

https://trpc.io/docs/client/tanstack-react-query/usage#queryOptions