mirror of
https://github.com/TanStack/query.git
synced 2026-11-16 22:50:20 +00:00
* docs(vue-query,solid-query): inline react reference content instead of 'ref'-ing hand-written react docs * docs(react-query): generate reference docs with TypeDoc * docs(vue-query,solid-query): fix dangling suspense-hook links left over from the react content copy * docs(solid-query): apply solid's callback call form to inlined reference examples * docs(react-query): correct inaccurate JSDoc statements flagged in review * docs(vue-query,solid-query): fix reactivity-aware examples and inaccurate type signatures flagged in review * docs(vue-query,solid-query): fix remaining type/behavior inaccuracies flagged in second review * docs(react-query): stop implying a default queryFn defers a fetch the way 'enabled: false' does * docs(vue-query): mark 'mutate'/'mutateAsync' per-call options as optional
954 B
954 B
| id | title |
|---|---|
| UseMutationOptions | UseMutationOptions |
Defined in: react-query/src/types.ts:412
The options accepted by useMutation. Same as MutationObserverOptions from @tanstack/query-core,
minus the internal _defaulted flag.
Extends
OmitKeyof<MutationObserverOptions<TData,TError,TVariables,TOnMutateResult>,"_defaulted">
Type Parameters
TData
TData = unknown
The type your mutation function resolves to.
TError
TError = DefaultError
The type of errors your mutation function may throw.
TVariables
TVariables = void
The type of the variable passed to mutate/mutateAsync.
TOnMutateResult
TOnMutateResult = unknown
The type returned by onMutate, passed to onSuccess/onError/onSettled as
their onMutateResult parameter — useful for optimistic-update rollback data.