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.1 KiB
1.1 KiB
| id | title |
|---|---|
| mutationOptions | mutationOptions |
function mutationOptions<TData, TError, TVariables, TOnMutateResult>(options): MutationObserverOptions<TData, TError, TVariables, TOnMutateResult>;
Defined in: packages/lit-query/src/mutationOptions.ts:22
Preserves and types mutation options for reuse across Lit Query APIs.
Type Parameters
TData
TData = unknown
TError
TError = Error
TVariables
TVariables = void
TOnMutateResult
TOnMutateResult = unknown
Parameters
options
MutationObserverOptions<TData, TError, TVariables, TOnMutateResult>
Mutation options to preserve.
Returns
MutationObserverOptions<TData, TError, TVariables, TOnMutateResult>
The same options object.
Example
import { mutationOptions } from '@tanstack/lit-query'
const addTodoOptions = mutationOptions({
mutationKey: ['add-todo'],
mutationFn: (title: string) => addTodo(title),
})