* 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
3.1 KiB
| id | title |
|---|---|
| MutationCacheConfig | MutationCacheConfig |
Defined in: packages/query-core/src/mutationCache.ts:26
Global callbacks that fire for every mutation handled by a MutationCache, regardless of which
component or observer triggered it. They differ from the defaultOptions provided to a
QueryClient in two ways: defaultOptions can be overridden by each mutation, while these
callbacks are always called, and onMutate here does not allow returning a result.
If a callback returns a promise, it will be awaited before the mutation continues.
Properties
onError()?
optional onError: (error, variables, onMutateResult, mutation, context) => unknown;
Defined in: packages/query-core/src/mutationCache.ts:28
Called when any mutation in the cache encounters an error.
Parameters
error
Error
variables
unknown
onMutateResult
unknown
mutation
Mutation<unknown, unknown, unknown>
context
Returns
unknown
onMutate()?
optional onMutate: (variables, mutation, context) => unknown;
Defined in: packages/query-core/src/mutationCache.ts:44
Called before any mutation in the cache executes.
Parameters
variables
unknown
mutation
Mutation<unknown, unknown, unknown>
context
Returns
unknown
onSettled()?
optional onSettled: (data, error, variables, onMutateResult, mutation, context) => unknown;
Defined in: packages/query-core/src/mutationCache.ts:50
Called when any mutation in the cache is settled, either successfully or with an error.
Parameters
data
unknown
error
Error | null
variables
unknown
onMutateResult
unknown
mutation
Mutation<unknown, unknown, unknown>
context
Returns
unknown
onSuccess()?
optional onSuccess: (data, variables, onMutateResult, mutation, context) => unknown;
Defined in: packages/query-core/src/mutationCache.ts:36
Called when any mutation in the cache is successful.
Parameters
data
unknown
variables
unknown
onMutateResult
unknown
mutation
Mutation<unknown, unknown, unknown>
context
Returns
unknown