Type Alias: DecorateQueryProcedure<TRoot, TProcedure>

DecorateQueryProcedure<TRoot, TProcedure>: object

Defined in: packages/react-query/src/shared/proxy/utilsProxy.ts:64

Type Parameters

Type Parameter
TRoot extends AnyRootTypes
TProcedure extends AnyQueryProcedure

Type declaration

cancel()

Parameters

Parameter	Type
input?	inferProcedureInput<TProcedure>
options?	CancelOptions

Returns

Promise<void>

See

https://tanstack.com/query/v5/docs/reference/QueryClient#queryclientcancelqueries

ensureData()

Parameters

Parameter	Type
input	inferProcedureInput<TProcedure>
opts?	TRPCFetchQueryOptions<inferTransformedProcedureOutput<TRoot, TProcedure>, TRPCClientError<TRoot>>

Returns

Promise<inferTransformedProcedureOutput<TRoot, TProcedure>>

See

https://tanstack.com/query/v5/docs/reference/QueryClient#queryclientensurequerydata

fetch()

Parameters

Parameter	Type
input	inferProcedureInput<TProcedure>
opts?	TRPCFetchQueryOptions<inferTransformedProcedureOutput<TRoot, TProcedure>, TRPCClientError<TRoot>>

Returns

Promise<inferTransformedProcedureOutput<TRoot, TProcedure>>

See

https://tanstack.com/query/v5/docs/reference/QueryClient#queryclientfetchquery

fetchInfinite()

Parameters

Parameter	Type
input	inferProcedureInput<TProcedure>
opts?	TRPCFetchInfiniteQueryOptions<inferProcedureInput<TProcedure>, inferTransformedProcedureOutput<TRoot, TProcedure>, TRPCClientError<TRoot>>

Returns

Promise<InfiniteData<inferTransformedProcedureOutput<TRoot, TProcedure>, null | NonNullable<ExtractCursorType<inferProcedureInput<TProcedure>>>>>

See

https://tanstack.com/query/v5/docs/reference/QueryClient#queryclientfetchinfinitequery

getData()

Parameters

Parameter	Type
input?	inferProcedureInput<TProcedure>

Returns

undefined | inferTransformedProcedureOutput<TRoot, TProcedure>

See

https://tanstack.com/query/v5/docs/reference/QueryClient#queryclientgetquerydata

getInfiniteData()

Parameters

Parameter	Type
input?	inferProcedureInput<TProcedure>

Returns

undefined | InfiniteData<inferTransformedProcedureOutput<TRoot, TProcedure>, null | NonNullable<ExtractCursorType<inferProcedureInput<TProcedure>>>>

See

https://tanstack.com/query/v5/docs/reference/QueryClient#queryclientgetquerydata

infiniteQueryOptions()

Call Signature

Type Parameters

Type Parameter	Default type
TQueryFnData extends any	-
TData	TQueryFnData

Parameters

Parameter	Type
input	inferProcedureInput<TProcedure> | typeof skipToken
opts	DefinedTRPCInfiniteQueryOptionsIn<inferProcedureInput<TProcedure>, TQueryFnData, TData, TRPCClientError<TRoot>>

Returns

DefinedTRPCInfiniteQueryOptionsOut<inferProcedureInput<TProcedure>, TQueryFnData, TData, TRPCClientError<TRoot>>

See

https://tanstack.com/query/latest/docs/framework/react/reference/infiniteQueryOptions#infinitequeryoptions

Call Signature

Type Parameters

Type Parameter	Default type
TQueryFnData extends any	-
TData	TQueryFnData

Parameters

Parameter	Type
input	inferProcedureInput<TProcedure>
opts	UnusedSkipTokenTRPCInfiniteQueryOptionsIn<inferProcedureInput<TProcedure>, TQueryFnData, TData, TRPCClientError<TRoot>>

Returns

UnusedSkipTokenTRPCInfiniteQueryOptionsOut<inferProcedureInput<TProcedure>, TQueryFnData, TData, TRPCClientError<TRoot>>

See

https://tanstack.com/query/latest/docs/framework/react/reference/infiniteQueryOptions#infinitequeryoptions

Call Signature

Type Parameters

Type Parameter	Default type
TQueryFnData extends any	-
TData	TQueryFnData

Parameters

Parameter	Type
input	inferProcedureInput<TProcedure> | typeof skipToken
opts?	UndefinedTRPCInfiniteQueryOptionsIn<inferProcedureInput<TProcedure>, TQueryFnData, TData, TRPCClientError<TRoot>>

Returns

UndefinedTRPCInfiniteQueryOptionsOut<inferProcedureInput<TProcedure>, TQueryFnData, TData, TRPCClientError<TRoot>>

See

https://tanstack.com/query/latest/docs/framework/react/reference/infiniteQueryOptions#infinitequeryoptions

invalidate()

Parameters

Parameter	Type
input?	DeepPartial<inferProcedureInput<TProcedure>>
filters?	Omit<InvalidateQueryFilters<readonly unknown[]>, "predicate"> & object
options?	InvalidateOptions

Returns

Promise<void>

See

https://tanstack.com/query/v5/docs/reference/QueryClient#queryclientinvalidatequeries

prefetch()

Parameters

Parameter	Type
input	inferProcedureInput<TProcedure>
opts?	TRPCFetchQueryOptions<inferTransformedProcedureOutput<TRoot, TProcedure>, TRPCClientError<TRoot>>

Returns

Promise<void>

See

https://tanstack.com/query/v5/docs/reference/QueryClient#queryclientprefetchquery

prefetchInfinite()

Parameters

Parameter	Type
input	inferProcedureInput<TProcedure>
opts?	TRPCFetchInfiniteQueryOptions<inferProcedureInput<TProcedure>, inferTransformedProcedureOutput<TRoot, TProcedure>, TRPCClientError<TRoot>>

Returns

Promise<void>

See

https://tanstack.com/query/v5/docs/reference/QueryClient#queryclientprefetchinfinitequery

queryOptions()

Call Signature

Type Parameters

Type Parameter	Default type
TQueryFnData extends any	-
TData	TQueryFnData

Parameters

Parameter	Type
input	inferProcedureInput<TProcedure> | typeof skipToken
opts	DefinedTRPCQueryOptionsIn<TQueryFnData, TData, TRPCClientError<TRoot>>

Returns

DefinedTRPCQueryOptionsOut<TQueryFnData, TData, TRPCClientError<TRoot>>

See

https://tanstack.com/query/latest/docs/framework/react/reference/queryOptions#queryoptions

Call Signature

Type Parameters

Type Parameter	Default type
TQueryFnData extends any	-
TData	TQueryFnData

Parameters

Parameter	Type
input	inferProcedureInput<TProcedure> | typeof skipToken
opts?	UnusedSkipTokenTRPCQueryOptionsIn<TQueryFnData, TData, TRPCClientError<TRoot>>

Returns

UnusedSkipTokenTRPCQueryOptionsOut<TQueryFnData, TData, TRPCClientError<TRoot>>

See

https://tanstack.com/query/latest/docs/framework/react/reference/queryOptions#queryoptions

Call Signature

Type Parameters

Type Parameter	Default type
TQueryFnData extends any	-
TData	TQueryFnData

Parameters

Parameter	Type
input	inferProcedureInput<TProcedure> | typeof skipToken
opts?	UndefinedTRPCQueryOptionsIn<TQueryFnData, TData, TRPCClientError<TRoot>>

Returns

UndefinedTRPCQueryOptionsOut<TQueryFnData, TData, TRPCClientError<TRoot>>

See

https://tanstack.com/query/latest/docs/framework/react/reference/queryOptions#queryoptions

refetch()

Parameters

Parameter	Type
input?	inferProcedureInput<TProcedure>
filters?	RefetchQueryFilters<readonly unknown[]>
options?	RefetchOptions

Returns

Promise<void>

See

https://tanstack.com/query/v5/docs/reference/QueryClient#queryclientrefetchqueries

reset()

Parameters

Parameter	Type
input?	inferProcedureInput<TProcedure>
options?	ResetOptions

Returns

Promise<void>

See

https://tanstack.com/query/v5/docs/reference/QueryClient#queryclientresetqueries

setData()

Parameters

Parameter	Type	Description
input	inferProcedureInput<TProcedure>	The input of the procedure
updater	Updater<undefined | inferTransformedProcedureOutput<TRoot, TProcedure>, undefined | inferTransformedProcedureOutput<TRoot, TProcedure>>	-
options?	SetDataOptions	-

Returns

void

See

https://tanstack.com/query/v5/docs/reference/QueryClient#queryclientsetquerydata

setInfiniteData()

Parameters

Parameter	Type
input	inferProcedureInput<TProcedure>
updater	Updater<undefined | InfiniteData<inferTransformedProcedureOutput<TRoot, TProcedure>, null | NonNullable<ExtractCursorType<inferProcedureInput<TProcedure>>>>, undefined | InfiniteData<inferTransformedProcedureOutput<TRoot, TProcedure>, null | NonNullable<ExtractCursorType<inferProcedureInput<TProcedure>>>>>
options?	SetDataOptions

Returns

void

See

https://tanstack.com/query/v5/docs/reference/QueryClient#queryclientsetquerydata

setQueriesData()

Parameters

Parameter	Type	Description
input	inferProcedureInput<TProcedure>	The input of the procedure
filters	QueryFilters	-
updater	Updater<undefined | inferTransformedProcedureOutput<TRoot, TProcedure>, undefined | inferTransformedProcedureOutput<TRoot, TProcedure>>	-
options?	SetDataOptions	-

Returns

[readonly unknown[], inferTransformedProcedureOutput<TRoot, TProcedure>]

See

https://tanstack.com/query/v5/docs/reference/QueryClient#queryclientsetquerydata