Skip to content

Commit 452c787

Browse files
committed
docs: link to JSDoc for resource error handling
1 parent 9ece275 commit 452c787

2 files changed

Lines changed: 6 additions & 6 deletions

File tree

docs/docs/with-entity-resources.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,8 @@ This exposes per-resource members with the resource name as a prefix:
8888

8989
## Error Handling
9090

91+
Starting in NgRx Toolkit v20.6.0, error handling now has more resilient options.
92+
9193
The behavior of Angular's resources' error handling and the NgRx SignalStore's `getState/patchState` required `withEntityResource` to approach error handling
9294
with a particular strategy unique to the intersection of resources and the Signal Store.
9395
To prevent resource failures from blocking the store, the Toolkit provides some strategies to handle errors.
@@ -111,9 +113,7 @@ Options:
111113
1. `'previous value'`. Provided the resource had a previous value, that previous value will be returned. If not, an error is thrown.
112114
1. `'native'`. No special handling is provided, inline with default error behavior.
113115

114-
<!-- TODO - update link when the code is merged -->
115-
116-
Under the hood, `'previous value'` and `'undefined value'` proxy the value. For a detailed explanation for why this is done and what a more longterm solution may be with some framework enhancements, check out the [JSDoc for the error handling strategy](https://google.com).
116+
Under the hood, `'previous value'` and `'undefined value'` proxy the value. For a detailed explanation for why this is done and what a more longterm solution may be with some framework enhancements, check out the [JSDoc for the error handling strategy](https://github.com/angular-architects/ngrx-toolkit/blob/main/libs/ngrx-toolkit/src/lib/with-resource.ts#L402).
117117

118118
## Component Usage
119119

docs/docs/with-resource.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,8 @@ With named resources, each resource gets prefixed properties:
8585

8686
## Error Handling
8787

88+
Starting in NgRx Toolkit v20.6.0, error handling now has more resilient options.
89+
8890
The behavior of Angular's resources' error handling and the NgRx SignalStore's `getState/patchState` required `withResource` to approach error handling
8991
with a particular strategy unique to the intersection of resources and the Signal Store.
9092
To prevent resource failures from blocking the store, the Toolkit provides some strategies to handle errors.
@@ -108,9 +110,7 @@ Options:
108110
1. `'previous value'`. Provided the resource had a previous value, that previous value will be returned. If not, an error is thrown.
109111
1. `'native'`. No special handling is provided, inline with default error behavior.
110112

111-
<!-- TODO - update link when the code is merged -->
112-
113-
Under the hood, `'previous value'` and `'undefined value'` proxy the value. For a detailed explanation for why this is done and what a more longterm solution may be with some framework enhancements, check out the [JSDoc for the error handling strategy](https://google.com).
113+
Under the hood, `'previous value'` and `'undefined value'` proxy the value. For a detailed explanation for why this is done and what a more longterm solution may be with some framework enhancements, check out the [JSDoc for the error handling strategy](https://github.com/angular-architects/ngrx-toolkit/blob/main/libs/ngrx-toolkit/src/lib/with-resource.ts#L402).
114114

115115
## Component Usage
116116

0 commit comments

Comments
 (0)