インターフェース: UseTRPCMutationOptions<TInput, TError, TOutput, TContext>

継承元

• UseMutationOptions< TOutput, TError, TInput, TContext>.TRPCUseQueryBaseOptions

型パラメータ

パラメータ	デフォルト
TInput	-
TError	-
TOutput	-
TContext	unknown

プロパティ

gcTime

optional 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

optional 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

optional 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

optional 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

optional 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

optional 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

optional 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

optional 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

optional 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

optional 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

optional 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

optional 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

optional trpc: TRPCReactRequestOptions

tRPC関連オプション

ソース

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

継承元

TRPCUseQueryBaseOptions.trpc

---

TypeDoc と typedoc-plugin-markdown を使用して生成