Skip to content
Source
Sign inSign up
TanStack/query
Open History to see the last commit

BaseMutationNarrowing.md

37 lines3.1 KB

1---
2id: BaseMutationNarrowing
3title: BaseMutationNarrowing
4---
5​
6<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
7​
8Defined in: [packages/angular-query/src/types.ts:423](https://github.com/TanStack/query/blob/main/packages/angular-query/src/types.ts#L423)
9​
10Signal-backed guards that narrow mutation data, errors, and variables by the current status.
11​
12## Type Parameters
13​
14### TData
15​
16`TData` = `unknown`
17​
18### TError
19​
20`TError` = [`DefaultError`](../type-aliases/DefaultError.md)
21​
22### TVariables
23​
24`TVariables` = `unknown`
25​
26### TOnMutateResult
27​
28`TOnMutateResult` = `unknown`
29​
30## Properties
31​
32| Property | Type | Description |
33| ------ | ------ | ------ |
34| <a id="property-iserror"></a> `isError` | `SignalFunction`\<(`this`: [`CreateMutationResult`](../type-aliases/CreateMutationResult.md)\<`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> }>`\> | Whether the mutation is in the `error` state. Calling it narrows the result to that state. |
35| <a id="property-isidle"></a> `isIdle` | `SignalFunction`\<(`this`: [`CreateMutationResult`](../type-aliases/CreateMutationResult.md)\<`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> }>`\> | Whether the mutation is in the `idle` state. Calling it narrows the result to that state. |
36| <a id="property-ispending"></a> `isPending` | `SignalFunction`\<(`this`: [`CreateMutationResult`](../type-aliases/CreateMutationResult.md)\<`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> }>`\> | Whether the mutation is in the `pending` state. Calling it narrows the result to that state. |
37| <a id="property-issuccess"></a> `isSuccess` | `SignalFunction`\<(`this`: [`CreateMutationResult`](../type-aliases/CreateMutationResult.md)\<`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> }>`\> | Whether the mutation is in the `success` state. Calling it narrows the result to that state. |