接口: UseTRPCMutationOptions<TInput, TError, TOutput, TContext>
扩展
UseMutationOptions<TOutput,TError,TInput,TContext>.TRPCUseQueryBaseOptions
类型参数
| 参数 | 默认值 |
|---|---|
TInput | - |
TError | - |
TOutput | - |
TContext | unknown |
属性
gcTime
可选gcTime:number
来源
node_modules/.pnpm/@tanstack+query-core@5.25.0/node_modules/@tanstack/query-core/build/legacy/queryClient-pTTqDRDI.d.ts:636
继承自
UseMutationOptions.gcTime
meta
可选meta:Record<string,unknown>
来源
node_modules/.pnpm/@tanstack+query-core@5.25.0/node_modules/@tanstack/query-core/build/legacy/queryClient-pTTqDRDI.d.ts:638
继承自
UseMutationOptions.meta
mutationFn
可选mutationFn:MutationFunction<TOutput,TInput>
来源
node_modules/.pnpm/@tanstack+query-core@5.25.0/node_modules/@tanstack/query-core/build/legacy/queryClient-pTTqDRDI.d.ts:627
继承自
UseMutationOptions.mutationFn
mutationKey
可选mutationKey:MutationKey
来源
node_modules/.pnpm/@tanstack+query-core@5.25.0/node_modules/@tanstack/query-core/build/legacy/queryClient-pTTqDRDI.d.ts:628
继承自
UseMutationOptions.mutationKey
networkMode
可选networkMode:NetworkMode
来源
node_modules/.pnpm/@tanstack+query-core@5.25.0/node_modules/@tanstack/query-core/build/legacy/queryClient-pTTqDRDI.d.ts:635
继承自
UseMutationOptions.networkMode
onError
可选onError: (error,variables,context) =>unknown
参数
| 参数 | 类型 |
|---|---|
error | TError |
variables | TInput |
context | undefined | TContext |
返回值
unknown
来源
node_modules/.pnpm/@tanstack+query-core@5.25.0/node_modules/@tanstack/query-core/build/legacy/queryClient-pTTqDRDI.d.ts:631
继承自
UseMutationOptions.onError
onMutate
可选onMutate: (variables) =>undefined|TContext|Promise<undefined|TContext>
参数
| 参数 | 类型 |
|---|---|
variables | TInput |
返回值
undefined | TContext | Promise< undefined| TContext >
来源
node_modules/.pnpm/@tanstack+query-core@5.25.0/node_modules/@tanstack/query-core/build/legacy/queryClient-pTTqDRDI.d.ts:629
继承自
UseMutationOptions.onMutate
onSettled
可选onSettled: (data,error,variables,context) =>unknown
参数
| 参数 | 类型 |
|---|---|
data | undefined | TOutput |
error | null | TError |
variables | TInput |
context | undefined | TContext |
返回值
unknown
来源
node_modules/.pnpm/@tanstack+query-core@5.25.0/node_modules/@tanstack/query-core/build/legacy/queryClient-pTTqDRDI.d.ts:632
继承自
UseMutationOptions.onSettled
onSuccess
可选onSuccess: (data,variables,context) =>unknown
参数
| 参数 | 类型 |
|---|---|
data | TOutput |
variables | TInput |
context | TContext |
返回值
unknown
来源
node_modules/.pnpm/@tanstack+query-core@5.25.0/node_modules/@tanstack/query-core/build/legacy/queryClient-pTTqDRDI.d.ts:630
继承自
UseMutationOptions.onSuccess
retry
可选retry:RetryValue<TError>
来源
node_modules/.pnpm/@tanstack+query-core@5.25.0/node_modules/@tanstack/query-core/build/legacy/queryClient-pTTqDRDI.d.ts:633
继承自
UseMutationOptions.retry
retryDelay
可选retryDelay:RetryDelayValue<TError>
来源
node_modules/.pnpm/@tanstack+query-core@5.25.0/node_modules/@tanstack/query-core/build/legacy/queryClient-pTTqDRDI.d.ts:634
继承自
UseMutationOptions.retryDelay
throwOnError
可选throwOnError:boolean|(error) =>boolean
来源
node_modules/.pnpm/@tanstack+query-core@5.25.0/node_modules/@tanstack/query-core/build/legacy/queryClient-pTTqDRDI.d.ts:641
继承自
UseMutationOptions.throwOnError
trpc
可选trpc:TRPCReactRequestOptions
与 tRPC 相关的选项
来源
packages/react-query/src/shared/hooks/types.ts:55
继承自
使用 TypeDoc 和 typedoc-plugin-markdown 生成