Skip to content

docs: mention hasValue issue disclaimers #258

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rainerhahnekamp merged 1 commit into from
Nov 26, 2025
+5 −1
Merged

docs: mention hasValue issue disclaimers #258

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/docs/mutations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ This guide covers
- State signals available (`value/status/error/isPending`)
<!-- TODO - resolve when #235 closed-->
- For `httpMutation`, the response type is specified with the param `parse: (res: T) => res as T`
- `hasValue` signal to narrow type. NOTE: currently there is an outstanding bug that this does not properly narrow.
- `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.
- [How to use](#usage-withmutations-or-solo-functions), as:
- _standalone functions_
- In `withMutations` store _feature_
Expand Down
2 changes: 2 additions & 0 deletions docs/docs/with-entity-resources.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ title: withEntityResources()
import { withEntityResources } from '@angular-architects/ngrx-toolkit';
```

> **⚠️ 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)

`withEntityResources()` integrates Angular Resources that return arrays into NgRx SignalStore using the Entity helpers from `@ngrx/signals/entities`.

> Note: This feature builds on [withResource()](./with-resource.md) and adds an entity view over array resources.
Expand Down
2 changes: 2 additions & 0 deletions docs/docs/with-resource.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ import { withResource } from '@angular-architects/ngrx-toolkit';

> **⚠️ 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.

> **⚠️ 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)

`withResource()` is a feature in NgRx SignalStore that connects Angular's Resource API with the store.
The idea: you can use a store to directly manage async data (like loading from an API), and `withResource()` helps you wire that in.

Expand Down