docs(signals): clarify that signal type can only be an object literal.

rainerhahnekamp commented 2 months ago

Clarify that the state's type must be an object literal. See referenced issue below.

Closes #4316

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)
[x] Documentation has been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

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

Does this PR introduce a breaking change?

[ ] Yes
[x] No

netlify[bot] commented 2 months ago

Deploy Preview for ngrx-io ready!

Built without sensitive environment variables

Name	Link
Latest commit	87943525a03740344bee1b6630a468d1666e72b0
Latest deploy log	https://app.netlify.com/sites/ngrx-io/deploys/6640d84e5ffeb30008257820
Deploy Preview	https://deploy-preview-4327--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.

rainerhahnekamp commented 1 month ago

@timdeschryver If you want to hear my opinion: an eslint rule would definitely make sense.

ngrx / platform

docs(signals): clarify that signal type can only be an object literal. #4327

PR Checklist

PR Type

Does this PR introduce a breaking change?

Deploy Preview for ngrx-io ready!

ngrx / platform

docs(signals): clarify that signal type can only be an object literal. #4327

PR Checklist

PR Type

Does this PR introduce a breaking change?

✅ Deploy Preview for ngrx-io ready!

Deploy Preview for ngrx-io ready!