feat(store): enable dispatching actions on signal changes

[rainerhahnekamp]

A type of Signal can be passed to dispatch:

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:

this.store.dispatch(this.bookAction, {injector: this.injector});

PR Checklist

Please check if your PR fulfills the following requirements:

• The commit message follows our guidelines: https://github.com/ngrx/platform/blob/main/CONTRIBUTING.md#commit
• Tests for the changes have been added (for bug fixes / features)
• Documentation has been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

[ ] Bugfix
[x] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[ ] Documentation content changes
[ ] Other... Please describe:

What is the current behavior?

Users need to manually track Signals via effect

Closes #4537

What is the new behavior?

Does this PR introduce a breaking change?

[ ] Yes
[x] No

[netlify]

✅ Deploy Preview for ngrx-io ready!

Built without sensitive environment variables

Name	Link
🔨 Latest commit	0c8d5af
🔍 Latest deploy log	https://app.netlify.com/sites/ngrx-io/deploys/6747573ba4d3050008b50fe4
😎 Deploy Preview	https://deploy-preview-4600--ngrx-io.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[timdeschryver]

Nice!
I left some comments for the syntax in the docs.

[rainerhahnekamp]

Thanks @timdeschryver, I've applied all your changes

[rainerhahnekamp]

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.

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.

[markostanimirovic]

🚀

[rainerhahnekamp]

Branch has been rebased and commits have been squashed with a meaningful commit message.

[timdeschryver]

Nice work and review! 🤜🤛