Class Mutation<TData, TError, TVariables, TContext>

Type Parameters

TData = unknown
TError = unknown
TVariables = void
TContext = unknown

Hierarchy

Removable
- Mutation

Index

Accessors

Constructors

Methods

addObserver clearGcTimeout continue destroy execute optionalRemove removeObserver scheduleGc setOptions setState updateCacheTime

Properties

cacheTime defaultOptions? dispatch logger mutationCache mutationId observers options retryer? state

Accessors

meta

get meta(): undefined | MutationMeta
Returns undefined | MutationMeta
- Defined in node_modules/@tanstack/query-core/build/lib/mutation.d.ts:65

Constructors

constructor

new Mutation<TData, TError, TVariables, TContext>(config): Mutation<TData, TError, TVariables, TContext>
Type Parameters
- TData = unknown
- TError = unknown
- TVariables = void
- TContext = unknown
Parameters
- config: MutationConfig<TData, TError, TVariables, TContext>
Returns Mutation<TData, TError, TVariables, TContext>
Overrides Removable.constructor
- Defined in node_modules/@tanstack/query-core/build/lib/mutation.d.ts:63

Methods

addObserver

addObserver(observer): void
Parameters
- observer: MutationObserver<any, any, any, any>
Returns void
- Defined in node_modules/@tanstack/query-core/build/lib/mutation.d.ts:67

`Protected` clearGcTimeout

clearGcTimeout(): void
Returns void
Inherited from Removable.clearGcTimeout
- Defined in node_modules/@tanstack/query-core/build/lib/removable.d.ts:7

continue

continue(): Promise<unknown>
Returns Promise<unknown>
- Defined in node_modules/@tanstack/query-core/build/lib/mutation.d.ts:70

destroy

destroy(): void
Returns void
Inherited from Removable.destroy
- Defined in node_modules/@tanstack/query-core/build/lib/removable.d.ts:4

execute

execute(): Promise<TData>
Returns Promise<TData>
- Defined in node_modules/@tanstack/query-core/build/lib/mutation.d.ts:71

`Protected` optionalRemove

optionalRemove(): void
Returns void
Overrides Removable.optionalRemove
- Defined in node_modules/@tanstack/query-core/build/lib/mutation.d.ts:69

removeObserver

removeObserver(observer): void
Parameters
- observer: MutationObserver<any, any, any, any>
Returns void
- Defined in node_modules/@tanstack/query-core/build/lib/mutation.d.ts:68

`Protected` scheduleGc

scheduleGc(): void
Returns void
Inherited from Removable.scheduleGc
- Defined in node_modules/@tanstack/query-core/build/lib/removable.d.ts:5

setOptions

setOptions(options?): void
Parameters
- Optional options: MutationOptions<TData, TError, TVariables, TContext>
Returns void
- Defined in node_modules/@tanstack/query-core/build/lib/mutation.d.ts:64

setState

setState(state): void
Parameters
- state: MutationState<TData, TError, TVariables, TContext>
Returns void
- Defined in node_modules/@tanstack/query-core/build/lib/mutation.d.ts:66

`Protected` updateCacheTime

updateCacheTime(newCacheTime): void
Parameters
- newCacheTime: undefined | number
Returns void
Inherited from Removable.updateCacheTime
- Defined in node_modules/@tanstack/query-core/build/lib/removable.d.ts:6

Properties

cacheTime

cacheTime: number

`Private` `Optional` defaultOptions

defaultOptions?: any

`Private` dispatch

dispatch: any

`Private` logger

logger: any

`Private` mutationCache

mutationCache: any

mutationId

mutationId: number

`Private` observers

observers: any

options

options: MutationOptions<TData, TError, TVariables, TContext>

`Private` `Optional` retryer

retryer?: any

state

state: MutationState<TData, TError, TVariables, TContext>