|
| 1 | +--- |
| 2 | +id: BaseMutationNarrowing |
| 3 | +title: BaseMutationNarrowing |
| 4 | +--- |
| 5 | + |
| 6 | +# Interface: BaseMutationNarrowing\<TData, TError, TVariables, TContext\> |
| 7 | + |
| 8 | +## Type Parameters |
| 9 | + |
| 10 | +• **TData** = `unknown` |
| 11 | + |
| 12 | +• **TError** = `DefaultError` |
| 13 | + |
| 14 | +• **TVariables** = `unknown` |
| 15 | + |
| 16 | +• **TContext** = `unknown` |
| 17 | + |
| 18 | +## Properties |
| 19 | + |
| 20 | +### isError() |
| 21 | + |
| 22 | +```ts |
| 23 | +isError: (this) => this is CreateMutationResult<TData, TError, TVariables, TContext, Override<MutationObserverErrorResult<TData, TError, TVariables, TContext>, Object> & Object>; |
| 24 | +``` |
| 25 | + |
| 26 | +#### Parameters |
| 27 | + |
| 28 | +• **this**: [`CreateMutationResult`](CreateMutationResult.md)\<`TData`, `TError`, `TVariables`, `TContext`, `CreateStatusBasedMutationResult`\<`"error"` \| `"success"` \| `"pending"` \| `"idle"`, `TData`, `TError`, `TVariables`, `TContext`\>\> |
| 29 | + |
| 30 | +#### Returns |
| 31 | + |
| 32 | +`this is CreateMutationResult<TData, TError, TVariables, TContext, Override<MutationObserverErrorResult<TData, TError, TVariables, TContext>, Object> & Object>` |
| 33 | + |
| 34 | +#### Defined in |
| 35 | + |
| 36 | +[types.ts:248](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/types.ts#L248) |
| 37 | + |
| 38 | +--- |
| 39 | + |
| 40 | +### isIdle() |
| 41 | + |
| 42 | +```ts |
| 43 | +isIdle: (this) => this is CreateMutationResult<TData, TError, TVariables, TContext, Override<MutationObserverIdleResult<TData, TError, TVariables, TContext>, Object> & Object>; |
| 44 | +``` |
| 45 | + |
| 46 | +#### Parameters |
| 47 | + |
| 48 | +• **this**: [`CreateMutationResult`](CreateMutationResult.md)\<`TData`, `TError`, `TVariables`, `TContext`, `CreateStatusBasedMutationResult`\<`"error"` \| `"success"` \| `"pending"` \| `"idle"`, `TData`, `TError`, `TVariables`, `TContext`\>\> |
| 49 | + |
| 50 | +#### Returns |
| 51 | + |
| 52 | +`this is CreateMutationResult<TData, TError, TVariables, TContext, Override<MutationObserverIdleResult<TData, TError, TVariables, TContext>, Object> & Object>` |
| 53 | + |
| 54 | +#### Defined in |
| 55 | + |
| 56 | +[types.ts:278](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/types.ts#L278) |
| 57 | + |
| 58 | +--- |
| 59 | + |
| 60 | +### isPending() |
| 61 | + |
| 62 | +```ts |
| 63 | +isPending: (this) => this is CreateMutationResult<TData, TError, TVariables, TContext, Override<MutationObserverLoadingResult<TData, TError, TVariables, TContext>, Object> & Object>; |
| 64 | +``` |
| 65 | + |
| 66 | +#### Parameters |
| 67 | + |
| 68 | +• **this**: [`CreateMutationResult`](CreateMutationResult.md)\<`TData`, `TError`, `TVariables`, `TContext`, `CreateStatusBasedMutationResult`\<`"error"` \| `"success"` \| `"pending"` \| `"idle"`, `TData`, `TError`, `TVariables`, `TContext`\>\> |
| 69 | + |
| 70 | +#### Returns |
| 71 | + |
| 72 | +`this is CreateMutationResult<TData, TError, TVariables, TContext, Override<MutationObserverLoadingResult<TData, TError, TVariables, TContext>, Object> & Object>` |
| 73 | + |
| 74 | +#### Defined in |
| 75 | + |
| 76 | +[types.ts:263](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/types.ts#L263) |
| 77 | + |
| 78 | +--- |
| 79 | + |
| 80 | +### isSuccess() |
| 81 | + |
| 82 | +```ts |
| 83 | +isSuccess: (this) => this is CreateMutationResult<TData, TError, TVariables, TContext, Override<MutationObserverSuccessResult<TData, TError, TVariables, TContext>, Object> & Object>; |
| 84 | +``` |
| 85 | + |
| 86 | +#### Parameters |
| 87 | + |
| 88 | +• **this**: [`CreateMutationResult`](CreateMutationResult.md)\<`TData`, `TError`, `TVariables`, `TContext`, `CreateStatusBasedMutationResult`\<`"error"` \| `"success"` \| `"pending"` \| `"idle"`, `TData`, `TError`, `TVariables`, `TContext`\>\> |
| 89 | + |
| 90 | +#### Returns |
| 91 | + |
| 92 | +`this is CreateMutationResult<TData, TError, TVariables, TContext, Override<MutationObserverSuccessResult<TData, TError, TVariables, TContext>, Object> & Object>` |
| 93 | + |
| 94 | +#### Defined in |
| 95 | + |
| 96 | +[types.ts:233](https://github.com/TanStack/query/blob/27861961bbb36e9bc25fcd45cff21b5645f02f9b/packages/angular-query-experimental/src/types.ts#L233) |
0 commit comments