Skip to content

Commit 8ee6620

Browse files
docs: deprecate withRedux
1 parent 4cf48a5 commit 8ee6620

File tree

3 files changed

+11
-4
lines changed

3 files changed

+11
-4
lines changed

docs/docs/extensions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ It offers extensions like:
1010
- [Conditional Features](./with-conditional): Allows adding features to the store conditionally
1111
- [DataService](./with-data-service): Builds on top of `withEntities` and adds the backend synchronization to it
1212
- [Immutable State Protection](./with-immutable-state): Protects the state from being mutated outside or inside the Store.
13-
- [Redux](./with-redux): Possibility to use the Redux Pattern (Reducer, Actions, Effects)
13+
- [~Redux~](./with-redux): Possibility to use the Redux Pattern. Deprecated in favor of NgRx's `@ngrx/signals/events` starting in 19.2
1414
- [Reset](./with-reset): Adds a `resetState` method to your store
1515
- [Call State](./with-call-state): Add call state management to your signal stores
1616
- [Storage Sync](./with-storage-sync): Synchronizes the Store with Web Storage

docs/docs/with-redux.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,22 @@ title: withRedux()
33
---
44

55
```typescript
6+
// DEPRECATED
67
import { withRedux } from '@angular-architects/ngrx-toolkit';
8+
9+
// Use `@ngrx/signals/events` instead
710
```
811

912
`withRedux()` brings back the Redux pattern into the Signal Store.
1013

1114
It can be combined with any other extension of the Signal Store.
1215

13-
:::note
14-
Please note, that there is an [official RFC](https://github.com/ngrx/platform/issues/4580) that a Redux extension will be added to the SignalStore in the future.
16+
:::warning
17+
## Deprecation
18+
19+
Please note, `@ngrx/signals/events` [was released as experimental in `@ngrx/signals/` v19.2](https://dev.to/ngrx/announcing-events-plugin-for-ngrx-signalstore-a-modern-take-on-flux-architecture-4dhn).
1520

16-
If you use `withRedux`, you will probably need to refactor your store when the official Redux extension is released.
21+
If you use `withRedux`, you should transition to using the official `@ngrx/signals/events` features.
1722
:::
1823

1924
There is also a [Redux Connector](./create-redux-state) available, which is a separate package and has a dependency to `@ngrx/store`.

libs/ngrx-toolkit/src/lib/with-redux.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,8 @@ type EffectsFactory<StateActionFns extends ActionFns> = (
134134
) => Record<string, Observable<unknown>>;
135135

136136
/**
137+
* @deprecated Use NgRx's `@ngrx/signals/events` starting in 19.2
138+
*
137139
* Creates the effects function to separate the effects logic into another file.
138140
*
139141
* ```typescript

0 commit comments

Comments
 (0)