mirror of
https://github.com/TanStack/query.git
synced 2026-11-16 22:50:20 +00:00
* docs(query-core/utils): add missing JSDoc to utility functions * docs(query-core/utils): clarify that 'addToEnd' and 'addToStart' drop at most one item * docs(framework/*/reference): regenerate reference docs
3.1 KiB
3.1 KiB
| id | title |
|---|---|
| BaseMutationNarrowing | BaseMutationNarrowing |
Defined in: packages/angular-query-experimental/src/types.ts:314
The isSuccess/isError/isPending/isIdle methods on a mutation result. Each is both a Signal
(its current boolean value is read reactively without calling it) and a type-guard function you can
call — if (mutation.isSuccess()) — so that mutation.data narrows away undefined inside the branch.
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 = unknown
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.
Properties
| Property | Type |
|---|---|
isError |
SignalFunction<(this: CreateMutationResult<TData, TError, TVariables, TOnMutateResult>) => this is CreateMutationResult<TData, TError, TVariables, TOnMutateResult, Override<MutationObserverErrorResult<TData, TError, TVariables, TOnMutateResult>, { mutate: CreateMutateFunction<TData, TError, TVariables, TOnMutateResult> }> & { mutateAsync: CreateMutateAsyncFunction<TData, TError, TVariables, TOnMutateResult> }>> |
isIdle |
SignalFunction<(this: CreateMutationResult<TData, TError, TVariables, TOnMutateResult>) => this is CreateMutationResult<TData, TError, TVariables, TOnMutateResult, Override<MutationObserverIdleResult<TData, TError, TVariables, TOnMutateResult>, { mutate: CreateMutateFunction<TData, TError, TVariables, TOnMutateResult> }> & { mutateAsync: CreateMutateAsyncFunction<TData, TError, TVariables, TOnMutateResult> }>> |
isPending |
SignalFunction<(this: CreateMutationResult<TData, TError, TVariables, TOnMutateResult>) => this is CreateMutationResult<TData, TError, TVariables, TOnMutateResult, Override<MutationObserverLoadingResult<TData, TError, TVariables, TOnMutateResult>, { mutate: CreateMutateFunction<TData, TError, TVariables, TOnMutateResult> }> & { mutateAsync: CreateMutateAsyncFunction<TData, TError, TVariables, TOnMutateResult> }>> |
isSuccess |
SignalFunction<(this: CreateMutationResult<TData, TError, TVariables, TOnMutateResult>) => this is CreateMutationResult<TData, TError, TVariables, TOnMutateResult, Override<MutationObserverSuccessResult<TData, TError, TVariables, TOnMutateResult>, { mutate: CreateMutateFunction<TData, TError, TVariables, TOnMutateResult> }> & { mutateAsync: CreateMutateAsyncFunction<TData, TError, TVariables, TOnMutateResult> }>> |