Skip to content

Commit

Permalink
806c1d14 docs(eslint-plugin): add docs for signal-state-no-arrays-at-…
Browse files Browse the repository at this point in the history
…root-level (#4549)
  • Loading branch information
web-flow authored Oct 9, 2024
1 parent f92a1b8 commit d7b472c
Show file tree
Hide file tree
Showing 16 changed files with 15 additions and 15 deletions.
2 changes: 1 addition & 1 deletion commit_message
Original file line number Diff line number Diff line change
@@ -1 +1 @@
23cf7c41 chore: release 18.1.0
806c1d14 docs(eslint-plugin): add docs for signal-state-no-arrays-at-root-level (#4549)
2 changes: 1 addition & 1 deletion generated/docs/api/signals/signalStore.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion generated/docs/api/signals/withState.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion generated/docs/app/search-data.json

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"id": "guide/eslint-plugin/rules/signal-state-no-arrays-at-root-level",
"title": "signal-state-no-arrays-at-root-level",
"contents": "\n\n\n <div class=\"github-links\">\n <a href=\"https://github.com/ngrx/platform/edit/main/projects/ngrx.io/content/guide/eslint-plugin/rules/signal-state-no-arrays-at-root-level.md?message=docs%3A%20describe%20your%20change...\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n </div>\n\n\n<div class=\"content\">\n<h1 id=\"signal-state-no-arrays-at-root-level\">signal-state-no-arrays-at-root-level<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"guide/eslint-plugin/rules/signal-state-no-arrays-at-root-level#signal-state-no-arrays-at-root-level\"><i class=\"material-icons\">link</i></a></h1>\n<p>signalState should accept a record or dictionary as an input argument.</p>\n<ul>\n<li><strong>Type</strong>: problem</li>\n<li><strong>Fixable</strong>: No</li>\n<li><strong>Suggestion</strong>: No</li>\n<li><strong>Requires type checking</strong>: No</li>\n<li><strong>Configurable</strong>: No</li>\n</ul>\n<!-- Everything above this generated, do not edit -->\n<!-- MANUAL-DOC:START -->\n\n</div>\n\n<!-- links to this doc:\n-->\n<!-- links from this doc:\n - guide/eslint-plugin/rules/signal-state-no-arrays-at-root-level#signal-state-no-arrays-at-root-level\n - https://github.com/ngrx/platform/edit/main/projects/ngrx.io/content/guide/eslint-plugin/rules/signal-state-no-arrays-at-root-level.md?message=docs%3A%20describe%20your%20change...\n-->"
"contents": "\n\n\n <div class=\"github-links\">\n <a href=\"https://github.com/ngrx/platform/edit/main/projects/ngrx.io/content/guide/eslint-plugin/rules/signal-state-no-arrays-at-root-level.md?message=docs%3A%20describe%20your%20change...\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n </div>\n\n\n<div class=\"content\">\n<h1 id=\"signal-state-no-arrays-at-root-level\">signal-state-no-arrays-at-root-level<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"guide/eslint-plugin/rules/signal-state-no-arrays-at-root-level#signal-state-no-arrays-at-root-level\"><i class=\"material-icons\">link</i></a></h1>\n<p>signalState should accept a record or dictionary as an input argument.</p>\n<ul>\n<li><strong>Type</strong>: problem</li>\n<li><strong>Fixable</strong>: No</li>\n<li><strong>Suggestion</strong>: No</li>\n<li><strong>Requires type checking</strong>: No</li>\n<li><strong>Configurable</strong>: No</li>\n</ul>\n<!-- Everything above this generated, do not edit -->\n<!-- MANUAL-DOC:START -->\n<h2 id=\"rule-details\">Rule Details<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"guide/eslint-plugin/rules/signal-state-no-arrays-at-root-level#rule-details\"><i class=\"material-icons\">link</i></a></h2>\n<p>This rule ensure that a Signal State shouldn't accept an array type at the root level.</p>\n<p>Examples of <strong>correct</strong> code for this rule:</p>\n<code-example language=\"ts\">\nconst store = <a href=\"api/signals/withState\" class=\"code-anchor\">withState</a>({ foo: 'bar' });\n\nconst store = <a href=\"api/signals/withState\" class=\"code-anchor\">withState</a>({ arrayAsProperty: ['foo', 'bar'] })\n\nconst initialState = {};\nconst store = <a href=\"api/signals/signalStore\" class=\"code-anchor\">signalStore</a>(<a href=\"api/signals/withState\" class=\"code-anchor\">withState</a>(initialState));\n</code-example>\n<p>Examples of <strong>incorrect</strong> code for this rule:</p>\n<code-example language=\"ts\">\nconst store = <a href=\"api/signals/withState\" class=\"code-anchor\">withState</a>([1, 2, 3]);\n\nconst store = <a href=\"api/signals/withState\" class=\"code-anchor\">withState</a>([{ foo: 'bar' }]);\n\nconst store = <a href=\"api/signals/withState\" class=\"code-anchor\">withState</a>&#x3C;string[]>([]);\n\nconst initialState = [];\nconst store = <a href=\"api/signals/withState\" class=\"code-anchor\">withState</a>(initialState);\n</code-example>\n\n</div>\n\n<!-- links to this doc:\n-->\n<!-- links from this doc:\n - api/signals/signalStore\n - api/signals/withState\n - guide/eslint-plugin/rules/signal-state-no-arrays-at-root-level#rule-details\n - guide/eslint-plugin/rules/signal-state-no-arrays-at-root-level#signal-state-no-arrays-at-root-level\n - https://github.com/ngrx/platform/edit/main/projects/ngrx.io/content/guide/eslint-plugin/rules/signal-state-no-arrays-at-root-level.md?message=docs%3A%20describe%20your%20change...\n-->"
}
6 changes: 3 additions & 3 deletions generated/navigation.json
Original file line number Diff line number Diff line change
Expand Up @@ -791,12 +791,12 @@
"prerelease": [
"local"
],
"build": "sha.23cf7c41",
"build": "sha.806c1d14",
"version": "18.1.1-local",
"codeName": "snapshot",
"isSnapshot": true,
"full": "18.1.1-local+sha.23cf7c41",
"full": "18.1.1-local+sha.806c1d14",
"branch": "master",
"commitSHA": "23cf7c4100de549a0251ed86988284693278ef0e"
"commitSHA": "806c1d14025dc6bdc62efc34e55a92e488e51fae"
}
}
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified generated/zips/ngrx-start/ngrx-start.zip
Binary file not shown.
Binary file modified generated/zips/router-store-selectors/router-store-selectors.zip
Binary file not shown.
Binary file modified generated/zips/store-walkthrough/store-walkthrough.zip
Binary file not shown.
Binary file modified generated/zips/store/store.zip
Binary file not shown.
Binary file modified generated/zips/testing-store/testing-store.zip
Binary file not shown.
12 changes: 6 additions & 6 deletions ngsw.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"configVersion": 1,
"timestamp": 1728395868961,
"timestamp": 1728441672614,
"index": "/index.html",
"assetGroups": [
{
Expand Down Expand Up @@ -1073,7 +1073,7 @@
"/generated/docs/api/signals/rxjs-interop.json": "ae232f598175b63f6c19a9ba7d6e908d4dbc27ac",
"/generated/docs/api/signals/rxjs-interop/rxMethod.json": "0fa825e079bf4d95c67a5a31938ef736bd3f6cd1",
"/generated/docs/api/signals/signalState-0.json": "a273146574c22528c2f3dea4f49cbd912e0ac0e8",
"/generated/docs/api/signals/signalStore.json": "b7d78e7cdd2335d254942e5827a42cd42095520f",
"/generated/docs/api/signals/signalStore.json": "6e93ce40b5481b2aeaf96f6f4faaf444636f856f",
"/generated/docs/api/signals/signalStoreFeature-0.json": "3b1f37c03b0b41e7c16151361157d5782ab040b1",
"/generated/docs/api/signals/signalstate.json": "f76f09ff002074537a5a25be06e68cfea6001f0a",
"/generated/docs/api/signals/signalstorefeature.json": "633e8d2e4f0e6c6d31a3e7a376bd74668e150954",
Expand All @@ -1082,7 +1082,7 @@
"/generated/docs/api/signals/withComputed.json": "e7a36eb720d8d63f14626ba369227e98370a8c24",
"/generated/docs/api/signals/withHooks.json": "260e154cbb0207c6fa33d01a3168264bfba22bb0",
"/generated/docs/api/signals/withMethods.json": "9baff42994d93a7cad8f757ac6e1cf9eda1f1ead",
"/generated/docs/api/signals/withState.json": "7d7056e3bb8ce52cdaca77dcd76f11deab3bfac4",
"/generated/docs/api/signals/withState.json": "e45a8a4ab1b3f0a8c04de875d3c61e6ef91db570",
"/generated/docs/api/store-devtools.json": "90787c8dbf751664eca4ba7676f1dc104f30ff9f",
"/generated/docs/api/store-devtools/DevToolsFeatureOptions.json": "942562bf64fec84fcb5e0fbbaa5714c0dd15c859",
"/generated/docs/api/store-devtools/INITIAL_OPTIONS.json": "ce3ee21beab6d9604a53e9fb32e41a63d6b5abb3",
Expand Down Expand Up @@ -1174,7 +1174,7 @@
"/generated/docs/api/store/testing/createMockStore.json": "26a94dd35005fa6e7ae271459cee82e0553bf7c7",
"/generated/docs/api/store/testing/provideMockStore.json": "4db01ae6597d184b7989163d0b416d879bc2dce5",
"/generated/docs/api/store/union.json": "fd22dbb6de2a8efa526a91c796cfffd421c837f4",
"/generated/docs/app/search-data.json": "5d1639f9b1d68e999ae209f9fd511bdd0f2b31da",
"/generated/docs/app/search-data.json": "1ce66c888359671611795eaada07206d4b787170",
"/generated/docs/contributing.json": "4c7957c3c81d4b50e5084c18375edeadc6095cc1",
"/generated/docs/docs.json": "70f2e96f98c89284c124e2da590cc93fdc1fb4ec",
"/generated/docs/enterprise-support.json": "90f869e6046ad7448c0ffc2beecf0f181a6c174b",
Expand Down Expand Up @@ -1250,7 +1250,7 @@
"/generated/docs/guide/eslint-plugin/rules/prefer-selector-in-select.json": "ec2e6356c5bf6084a77d34492e8a3c82fbaa3ff4",
"/generated/docs/guide/eslint-plugin/rules/prefix-selectors-with-select.json": "7641ace14723e7f2d2b3bee18dc9b37996ff582e",
"/generated/docs/guide/eslint-plugin/rules/select-style.json": "73ac8008a79429687b2e7d1a345ca627c7e06981",
"/generated/docs/guide/eslint-plugin/rules/signal-state-no-arrays-at-root-level.json": "86c87d3dc799199fadb6701ce2097cc68fde392e",
"/generated/docs/guide/eslint-plugin/rules/signal-state-no-arrays-at-root-level.json": "adafad08b13ee2b2d977c5e7b68378e3b4df93be",
"/generated/docs/guide/eslint-plugin/rules/signal-store-feature-should-use-generic-type.json": "5ceda9be1d38cebcc86a86beab426e5260be6b1d",
"/generated/docs/guide/eslint-plugin/rules/updater-explicit-return-type.json": "761ee177e1322b06fb654a5cf144e6b8df5f45f1",
"/generated/docs/guide/eslint-plugin/rules/use-consistent-global-store-name.json": "9fbcf6491240ed1ada71ea451399bf7d1eff8182",
Expand Down Expand Up @@ -1393,7 +1393,7 @@
"/generated/images/marketing/concept-icons/universal.svg": "69516bc8a226c9df3c564f7a4f0fec1b66e7711f",
"/generated/images/marketing/features/feature-icon.svg": "2cf6c1c11faee80b101b38c91f02184dada8cbe2",
"/generated/images/marketing/home/ngrx-conf-badge.svg": "f6c369c9c05b4b4df3373a7fb31dd3f4e82c9a44",
"/generated/navigation.json": "2b4bea6b0f28d9192f7b03c192fcfc465444784a",
"/generated/navigation.json": "08512801c802fe957bcb13236236a988bd764e24",
"/generated/resources.json": "187bbb4f63bac415553db8bc033d822bb0b5a47e",
"/index.html": "29efd795cc6f1d4f94d3f3c07b700538505cfbf9",
"/light-theme.css": "af6e8fca0da10e9eed053318ea52c0434ddc7c53",
Expand Down
2 changes: 1 addition & 1 deletion stats.json

Large diffs are not rendered by default.

0 comments on commit d7b472c

Please sign in to comment.