Skip to content

Commit 38e178a

Browse files
docs: mention hasValue issue disclaimers (#258)
1 parent cef85a9 commit 38e178a

File tree

3 files changed

+5
-1
lines changed

3 files changed

+5
-1
lines changed

docs/docs/mutations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ This guide covers
3434
- State signals available (`value/status/error/isPending`)
3535
<!-- TODO - resolve when #235 closed-->
3636
- For `httpMutation`, the response type is specified with the param `parse: (res: T) => res as T`
37-
- `hasValue` signal to narrow type. NOTE: currently there is an outstanding bug that this does not properly narrow.
37+
- `hasValue` signal to narrow type. ⚠️NOTE⚠️: currently there is an [outstanding bug](https://github.com/angular-architects/ngrx-toolkit/issues/235) that this does not properly narrow.
3838
- [How to use](#usage-withmutations-or-solo-functions), as:
3939
- _standalone functions_
4040
- In `withMutations` store _feature_

docs/docs/with-entity-resources.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ title: withEntityResources()
66
import { withEntityResources } from '@angular-architects/ngrx-toolkit';
77
```
88

9+
> **⚠️ Important Note**: We have found some issues with `hasValue()` not narrowing correctly. If you have any insights or want to follow developments, please refer to our issue: ["bug(withResource and Mutations): hasValue() does not narrow the respective value signal #235"](https://github.com/angular-architects/ngrx-toolkit/issues/235)
10+
911
`withEntityResources()` integrates Angular Resources that return arrays into NgRx SignalStore using the Entity helpers from `@ngrx/signals/entities`.
1012

1113
> Note: This feature builds on [withResource()](./with-resource.md) and adds an entity view over array resources.

docs/docs/with-resource.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ import { withResource } from '@angular-architects/ngrx-toolkit';
88

99
> **⚠️ Important Note**: This extension is very likely to land in NgRx once Angular's `Resource` enters developer preview. The `withResource` extension provides early access to this functionality and will be maintained for compatibility until the official NgRx implementation is available.
1010
11+
> **⚠️ Important Note**: We have found some issues with `hasValue()` not narrowing correctly. If you have any insights or want to follow developments, please refer to our issue: ["bug(withResource and Mutations): hasValue() does not narrow the respective value signal #235"](https://github.com/angular-architects/ngrx-toolkit/issues/235)
12+
1113
`withResource()` is a feature in NgRx SignalStore that connects Angular's Resource API with the store.
1214
The idea: you can use a store to directly manage async data (like loading from an API), and `withResource()` helps you wire that in.
1315

0 commit comments

Comments
 (0)