feat(store): add possibility to dispatch Signal<Action> #4600
+234
−16
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for ngrx-io ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
rainerhahnekamp
force-pushed
the
feature/store/signal-actions
branch
2 times, most recently
from
f70110f
to
dc049ef
Compare
A type of Signal<Action> can be passed to dispatch:
```typescript
class BookComponent {
bookId = input.required<number>();
bookAction = computed(() => loadBook({id: this.bookId()}));
store = inject(Store);
constructor() {
this.store.dispatch(this.bookAction);
}
}
```
The benefit is that users no longer need to use an effect to track the Signal.
The Store handles this internally.
If `dispatch` receives a `Signal` it returns an `EffectRef`, allowing manual
destruction.
By default, the injection context of the caller is used. If the call happens
outside an injection context, the Store will use its own injection context,
which is usually the root injector.
It is also possible to provide a custom injector as the second parameter:
```typescript
this.store.dispatch(this.bookAction, {injector: this.injector});
```
rainerhahnekamp
force-pushed
the
feature/store/signal-actions
branch
from
dc049ef
to
58da96d
Compare
Co-authored-by: Tim Deschryver <[email protected]>
Co-authored-by: Tim Deschryver <[email protected]>
Co-authored-by: Tim Deschryver <[email protected]>
Co-authored-by: Tim Deschryver <[email protected]>
|
Thanks @timdeschryver, I've applied all your changes |
`dispatch` now accepts a function that returns an `Action`. Providing a `Signal<Action>` will still be possible (`Signal` is also a function).
I had to rename the type `FunctionIsNotAllowed` to `NoActionCreator`.
Previously, `FunctionIsNotAllowed` was used to prevent passing functions to `dispatch`, but the primary intent was to forbid `ActionCreator`.
```typescript
store.dispatch(loadBook); // 👎
store.dispatch(loadBook({id: 1})); // 👍
```
As the name says, `NoActionCreator` now explicitly forbids only `ActionCreator`. Functions are fine. Otherwise, the new feature would not be possible.
|
I had to rename the type Previously, store.dispatch(loadBook); // 👎
store.dispatch(loadBook({id: 1})); // 👍As the name says, |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
A type of Signal can be passed to dispatch:
The benefit is that users no longer need to use an effect to track the Signal. The Store handles this internally.
If
dispatchreceives aSignalit returns anEffectRef, allowing manual destruction.By default, the injection context of the caller is used. If the call happens outside an injection context, the Store will use its own injection context, which is usually the root injector.
It is also possible to provide a custom injector as the second parameter:
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
Users need to manually track Signals via
effectCloses #4537
What is the new behavior?
Does this PR introduce a breaking change?