mirror of
https://github.com/TanStack/query.git
synced 2026-11-16 22:50:20 +00:00
* docs(query-core): add JSDoc across the package and expose it in generated reference docs * docs(config.json): add sidebar entries for newly generated query-core reference docs * docs(query-core): migrate remaining prose from the legacy 'docs/reference' pages into JSDoc * docs(query-core): remove legacy 'docs/reference' pages superseded by the generated reference * docs(query-core): regenerate reference docs after merging main * docs(query-core): document missing default values for MutationOptions, combine, and QueryFilters.type * fix(query-devtools): drop unnecessary 'query-core' project reference * docs(query-core): document missing default values and normalize 'Defaults to' spacing * docs(query-core): fix 'environmentManager' JSDoc example
1.8 KiB
1.8 KiB
| id | title |
|---|---|
| MutateOptions | MutateOptions |
Defined in: packages/query-core/src/types.ts:1284
Type Parameters
TData
TData = unknown
TError
TError = DefaultError
TVariables
TVariables = void
TOnMutateResult
TOnMutateResult = unknown
Properties
onError()?
optional onError: (error, variables, onMutateResult, context) => void;
Defined in: packages/query-core/src/types.ts:1296
Parameters
error
TError
variables
TVariables
onMutateResult
TOnMutateResult | undefined
context
Returns
void
onSettled()?
optional onSettled: (data, error, variables, onMutateResult, context) => void;
Defined in: packages/query-core/src/types.ts:1302
Parameters
data
TData | undefined
error
TError | null
variables
TVariables
onMutateResult
TOnMutateResult | undefined
context
Returns
void
onSuccess()?
optional onSuccess: (data, variables, onMutateResult, context) => void;
Defined in: packages/query-core/src/types.ts:1290
Parameters
data
TData
variables
TVariables
onMutateResult
TOnMutateResult | undefined
context
Returns
void