Skip to main content
Version: 11.x

Interface: UseTRPCMutationOptions<TInput, TError, TOutput, TContext>

Extends

Type parameters

ParameterDefault
TInput-
TError-
TOutput-
TContextunknown

Properties

gcTime

optional gcTime: number

Source

node_modules/.pnpm/@tanstack+query-core@5.0.0/node_modules/@tanstack/query-core/build/legacy/queryClient-5b892aba.d.ts:604

Inherited from

UseMutationOptions.gcTime


meta

optional meta: Record< string, unknown >

Source

node_modules/.pnpm/@tanstack+query-core@5.0.0/node_modules/@tanstack/query-core/build/legacy/queryClient-5b892aba.d.ts:606

Inherited from

UseMutationOptions.meta


mutationFn

optional mutationFn: MutationFunction< TOutput, TInput >

Source

node_modules/.pnpm/@tanstack+query-core@5.0.0/node_modules/@tanstack/query-core/build/legacy/queryClient-5b892aba.d.ts:595

Inherited from

UseMutationOptions.mutationFn


mutationKey

optional mutationKey: MutationKey

Source

node_modules/.pnpm/@tanstack+query-core@5.0.0/node_modules/@tanstack/query-core/build/legacy/queryClient-5b892aba.d.ts:596

Inherited from

UseMutationOptions.mutationKey


networkMode

optional networkMode: NetworkMode

Source

node_modules/.pnpm/@tanstack+query-core@5.0.0/node_modules/@tanstack/query-core/build/legacy/queryClient-5b892aba.d.ts:603

Inherited from

UseMutationOptions.networkMode


onError

optional onError: (error, variables, context) => unknown

Parameters

ParameterType
errorTError
variablesTInput
contextundefined | TContext

Returns

unknown

Source

node_modules/.pnpm/@tanstack+query-core@5.0.0/node_modules/@tanstack/query-core/build/legacy/queryClient-5b892aba.d.ts:599

Inherited from

UseMutationOptions.onError


onMutate

optional onMutate: (variables) => undefined | TContext | Promise< undefined | TContext >

Parameters

ParameterType
variablesTInput

Returns

undefined | TContext | Promise< undefined | TContext >

Source

node_modules/.pnpm/@tanstack+query-core@5.0.0/node_modules/@tanstack/query-core/build/legacy/queryClient-5b892aba.d.ts:597

Inherited from

UseMutationOptions.onMutate


onSettled

optional onSettled: (data, error, variables, context) => unknown

Parameters

ParameterType
dataundefined | TOutput
errornull | TError
variablesTInput
contextundefined | TContext

Returns

unknown

Source

node_modules/.pnpm/@tanstack+query-core@5.0.0/node_modules/@tanstack/query-core/build/legacy/queryClient-5b892aba.d.ts:600

Inherited from

UseMutationOptions.onSettled


onSuccess

optional onSuccess: (data, variables, context) => unknown

Parameters

ParameterType
dataTOutput
variablesTInput
contextundefined | TContext

Returns

unknown

Source

node_modules/.pnpm/@tanstack+query-core@5.0.0/node_modules/@tanstack/query-core/build/legacy/queryClient-5b892aba.d.ts:598

Inherited from

UseMutationOptions.onSuccess


retry

optional retry: RetryValue< TError >

Source

node_modules/.pnpm/@tanstack+query-core@5.0.0/node_modules/@tanstack/query-core/build/legacy/queryClient-5b892aba.d.ts:601

Inherited from

UseMutationOptions.retry


retryDelay

optional retryDelay: RetryDelayValue< TError >

Source

node_modules/.pnpm/@tanstack+query-core@5.0.0/node_modules/@tanstack/query-core/build/legacy/queryClient-5b892aba.d.ts:602

Inherited from

UseMutationOptions.retryDelay


throwOnError

optional throwOnError: boolean | (error) => boolean

Source

node_modules/.pnpm/@tanstack+query-core@5.0.0/node_modules/@tanstack/query-core/build/legacy/queryClient-5b892aba.d.ts:609

Inherited from

UseMutationOptions.throwOnError


trpc

optional trpc: TRPCReactRequestOptions

tRPC-related options

Source

packages/react-query/src/shared/hooks/types.ts:55

Inherited from

TRPCUseQueryBaseOptions.trpc


Generated using TypeDoc and typedoc-plugin-markdown