Skip to content

Commit 01abab3

Browse files
authored
docs(*): note that 'throwOnError' makes the hook rethrow the errors of 'mutate' (#11877)
* docs(*): note that 'throwOnError' makes the hook rethrow the errors of 'mutate' * docs(angular-query-experimental/types): mention that 'injectMutation' emits the error on 'ngZone.onError' before rethrowing it
1 parent c1c27a7 commit 01abab3

21 files changed

Lines changed: 33 additions & 25 deletions

File tree

‎docs/framework/angular/reference/interfaces/BaseMutationNarrowing.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ id: BaseMutationNarrowing
33
title: BaseMutationNarrowing
44
---
55

6-
Defined in: [packages/angular-query-experimental/src/types.ts:314](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L314)
6+
Defined in: [packages/angular-query-experimental/src/types.ts:315](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L315)
77

88
The `isSuccess`/`isError`/`isPending`/`isIdle` methods on a mutation result. Each is both a `Signal`
99
(its current boolean value is read reactively without calling it) and a type-guard function you can

‎docs/framework/angular/reference/type-aliases/CreateBaseMutationResult.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ type CreateBaseMutationResult<TData, TError, TVariables, TOnMutateResult> = Over
99
}> & object;
1010
```
1111

12-
Defined in: [packages/angular-query-experimental/src/types.ts:271](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L271)
12+
Defined in: [packages/angular-query-experimental/src/types.ts:272](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L272)
1313

1414
The pre-`Signal` shape [CreateMutationResult](CreateMutationResult.md) is built from — not what `injectMutation` actually
1515
returns. Same as [MutationObserverResult](MutationObserverResult.md) from `@tanstack/query-core`, with `mutate` narrowed to the

‎docs/framework/angular/reference/type-aliases/CreateMutateAsyncFunction.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ title: CreateMutateAsyncFunction
77
type CreateMutateAsyncFunction<TData, TError, TVariables, TOnMutateResult> = MutateFunction<TData, TError, TVariables, TOnMutateResult>;
88
```
99

10-
Defined in: [packages/angular-query-experimental/src/types.ts:254](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L254)
10+
Defined in: [packages/angular-query-experimental/src/types.ts:255](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L255)
1111

1212
The type of `mutateAsync`, as returned by `injectMutation`. Similar to [CreateMutateFunction](CreateMutateFunction.md), but
1313
returns a promise which can be awaited.

‎docs/framework/angular/reference/type-aliases/CreateMutateFunction.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,12 @@ title: CreateMutateFunction
77
type CreateMutateFunction<TData, TError, TVariables, TOnMutateResult> = (...args: Parameters<MutateFunction<TData, TError, TVariables, TOnMutateResult>>) => void;
88
```
99

10-
Defined in: [packages/angular-query-experimental/src/types.ts:234](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L234)
10+
Defined in: [packages/angular-query-experimental/src/types.ts:235](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L235)
1111

1212
The type of `mutate`, as returned by `injectMutation`. Forwards the variables (and an optional per-call
1313
`onSuccess`/`onError`/`onSettled`) to the underlying `mutate` call. Fire-and-forget — errors are surfaced
14-
through the mutation result, not thrown.
14+
through the mutation result instead of being thrown by `mutate`, unless `throwOnError` makes
15+
`injectMutation` rethrow them after emitting them on `ngZone.onError`.
1516

1617
## Type Parameters
1718

‎docs/framework/angular/reference/type-aliases/CreateMutationResult.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ title: CreateMutationResult
77
type CreateMutationResult<TData, TError, TVariables, TOnMutateResult, TState> = BaseMutationNarrowing<TData, TError, TVariables, TOnMutateResult> & MapToSignals<OmitKeyof<TState, keyof BaseMutationNarrowing, "safely">>;
88
```
99

10-
Defined in: [packages/angular-query-experimental/src/types.ts:401](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L401)
10+
Defined in: [packages/angular-query-experimental/src/types.ts:402](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L402)
1111

1212
The result of `injectMutation`. Based on [CreateBaseMutationResult](CreateBaseMutationResult.md), but value fields are exposed as
1313
a `Signal` — read them with `mutation.data()`, not `mutation.data` — while function fields (`mutate`,

‎docs/framework/preact/reference/type-aliases/UseBaseMutationResult.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ type UseBaseMutationResult<TData, TError, TVariables, TOnMutateResult> = Overrid
99
}> & object;
1010
```
1111

12-
Defined in: [packages/preact-query/src/types.ts:451](https://github.com/TanStack/query/blob/main/packages/preact-query/src/types.ts#L451)
12+
Defined in: [packages/preact-query/src/types.ts:452](https://github.com/TanStack/query/blob/main/packages/preact-query/src/types.ts#L452)
1313

1414
The result of `useMutation`. Same as [MutationObserverResult](MutationObserverResult.md) from `@tanstack/query-core`, with
1515
`mutate` narrowed to the fire-and-forget [UseMutateFunction](UseMutateFunction.md) signature, plus the added `mutateAsync`.

‎docs/framework/preact/reference/type-aliases/UseMutateAsyncFunction.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ title: UseMutateAsyncFunction
77
type UseMutateAsyncFunction<TData, TError, TVariables, TOnMutateResult> = MutateFunction<TData, TError, TVariables, TOnMutateResult>;
88
```
99

10-
Defined in: [packages/preact-query/src/types.ts:435](https://github.com/TanStack/query/blob/main/packages/preact-query/src/types.ts#L435)
10+
Defined in: [packages/preact-query/src/types.ts:436](https://github.com/TanStack/query/blob/main/packages/preact-query/src/types.ts#L436)
1111

1212
The type of `mutateAsync`, as returned by `useMutation`. Similar to [UseMutateFunction](UseMutateFunction.md), but returns a
1313
promise which can be awaited.

‎docs/framework/preact/reference/type-aliases/UseMutateFunction.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,12 @@ title: UseMutateFunction
77
type UseMutateFunction<TData, TError, TVariables, TOnMutateResult> = (...args: Parameters<MutateFunction<TData, TError, TVariables, TOnMutateResult>>) => void;
88
```
99

10-
Defined in: [packages/preact-query/src/types.ts:415](https://github.com/TanStack/query/blob/main/packages/preact-query/src/types.ts#L415)
10+
Defined in: [packages/preact-query/src/types.ts:416](https://github.com/TanStack/query/blob/main/packages/preact-query/src/types.ts#L416)
1111

1212
The type of `mutate`, as returned by `useMutation`. Forwards the variables (and an optional per-call
1313
`onSuccess`/`onError`/`onSettled`) to the underlying `mutate` call. Fire-and-forget — errors are surfaced
14-
through the mutation result, not thrown.
14+
through the mutation result instead of being thrown by `mutate`, unless `throwOnError` makes `useMutation`
15+
rethrow them.
1516

1617
## Type Parameters
1718

‎docs/framework/preact/reference/type-aliases/UseMutationResult.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ title: UseMutationResult
77
type UseMutationResult<TData, TError, TVariables, TOnMutateResult> = UseBaseMutationResult<TData, TError, TVariables, TOnMutateResult>;
88
```
99

10-
Defined in: [packages/preact-query/src/types.ts:479](https://github.com/TanStack/query/blob/main/packages/preact-query/src/types.ts#L479)
10+
Defined in: [packages/preact-query/src/types.ts:480](https://github.com/TanStack/query/blob/main/packages/preact-query/src/types.ts#L480)
1111

1212
The result of `useMutation`. Same as [UseBaseMutationResult](UseBaseMutationResult.md).
1313

‎docs/framework/react/reference/type-aliases/UseBaseMutationResult.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ type UseBaseMutationResult<TData, TError, TVariables, TOnMutateResult> = Overrid
99
}> & object;
1010
```
1111

12-
Defined in: [packages/react-query/src/types.ts:452](https://github.com/TanStack/query/blob/main/packages/react-query/src/types.ts#L452)
12+
Defined in: [packages/react-query/src/types.ts:453](https://github.com/TanStack/query/blob/main/packages/react-query/src/types.ts#L453)
1313

1414
The result of `useMutation`. Same as [MutationObserverResult](MutationObserverResult.md) from `@tanstack/query-core`, with
1515
`mutate` narrowed to the fire-and-forget [UseMutateFunction](UseMutateFunction.md) signature, plus the added `mutateAsync`.

0 commit comments

Comments
 (0)