Skip to content

Commit

Permalink
chore: adjusted version range to allow major version of @ngrx/signal …
Browse files Browse the repository at this point in the history
…6ca84b
  • Loading branch information
Zwergenpunk authored and rainerhahnekamp committed Nov 4, 2024
1 parent 6ca84ba commit 287a264
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 29 deletions.
29 changes: 2 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,39 +19,20 @@ To install it, run
npm i @angular-architects/ngrx-toolkit
```

Starting with 18.0.0-rc.2, we have a [strict version dependency](#why-is-the-version-range-to-the-ngrxsignals-dependency-so-strict) to `@ngrx/signals`:

| @ngrx/signals | @angular-architects/ngrx-toolkit |
|----------------|----------------------------------|
| 18.1.1 | 18.1.0 & 18.1.1 |
| 18.1.0 | 18.1.0 |
| 18.0.2 | 18.0.3 |
| 18.0.0 | 18.0.0 |
| 18.0.0-rc.3 | (not supported) |
| 18.0.0-rc.2 | 18.0.0-rc.2.x |
| <= 18.0.0-rc.1 | 0.0.4 |

To install it, run

```shell
npm i @angular-architects/ngrx-toolkit
```

- [NgRx Toolkit](#ngrx-toolkit)
- [Devtools: `withDevtools()`](#devtools-withdevtools)
- [Redux: `withRedux()`](#redux-withredux)
- [DataService `withDataService()`](#dataservice-withdataservice)
- [DataService with Dynamic Properties](#dataservice-with-dynamic-properties)
- [Storage Sync `withStorageSync`](#storage-sync-withstoragesync)
- [Undo-Redo `withUndoRedo`](#undo-redo-withUndoRedo)
- [Storage Sync `withStorageSync()`](#storage-sync-withstoragesync)
- [Undo-Redo `withUndoRedo()`](#undo-redo-withundoredo)
- [Redux Connector for the NgRx Signal Store `createReduxState()`](#redux-connector-for-the-ngrx-signal-store-createreduxstate)
- [Use a present Signal Store](#use-a-present-signal-store)
- [Use well-known NgRx Store Actions](#use-well-known-ngrx-store-actions)
- [Map Actions to Methods](#map-actions-to-methods)
- [Register an Angular Dependency Injection Provider](#register-an-angular-dependency-injection-provider)
- [Use the Store in your Component](#use-the-store-in-your-component)
- [FAQ](#faq)
- [Why is the version range to the `@ngrx/signals` dependency so strict?](#why-is-the-version-range-to-the-ngrxsignals-dependency-so-strict)
- [I have an idea for a new extension, can I contribute?](#i-have-an-idea-for-a-new-extension-can-i-contribute)
- [I require a feature that is not available in a lower version. What should I do?](#i-require-a-feature-that-is-not-available-in-a-lower-version-what-should-i-do)

Expand Down Expand Up @@ -547,12 +528,6 @@ export class FlightSearchReducConnectorComponent {

## FAQ

### Why is the version range to the `@ngrx/signals` dependency so strict?

The strict version range for @ngrx/signals is necessary because some of our features rely on encapsulated types, which can change even in a patch release.

To ensure stability, we clone these internal types and run integration tests for each release. This rigorous testing means we may need to update our version, even for a patch release, to maintain compatibility and stability.

### I have an idea for a new extension, can I contribute?

Yes, please! We are always looking for new ideas and contributions.
Expand Down
4 changes: 2 additions & 2 deletions libs/ngrx-toolkit/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
"url": "https://github.com/angular-architects/ngrx-toolkit"
},
"peerDependencies": {
"@ngrx/signals": ">=18.1.0 <=18.1.1",
"@ngrx/store": ">=18.0.0"
"@ngrx/signals": "^18.1.0",
"@ngrx/store": "^18.0.0"
},
"peerDependenciesMeta": {
"@ngrx/store": {
Expand Down

0 comments on commit 287a264

Please sign in to comment.