1f7f7405 docs(signals): add testing guide (#4461)

commit_message

@@ -1 +1 @@
-51df3aee docs(eslint-plugin): add docs for signal-store-feature-should-use-generic-type (#4521)
+1f7f7405 docs(signals): add testing guide (#4461)

generated/docs/api/data/EntityCollection.json

@@ -1,5 +1,5 @@
 {
   "id": "api/data/EntityCollection",
   "title": "EntityCollection",
-  "contents": "\n\n<article>\n  <div class=\"github-links\">\n  <a href=\"https://github.com/ngrx/platform/edit/main/modules/data/src/reducers/entity-collection.ts?message=docs(data)%3A%20describe%20your%20change...#L29-L45\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n  <a href=\"https://github.com/ngrx/platform/tree/18.0.2/modules/data/src/reducers/entity-collection.ts#L29-L45\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n  <div class=\"breadcrumb\">\n    <script type=\"application/ld+json\">\n      {\n        \"@context\": \"http://schema.org\",\n        \"@type\": \"BreadcrumbList\",\n        \"itemListElement\": [\n          { \"@type\": \"ListItem\", \"position\": 1, \"item\": { \"@id\": \"https://ngrx.io//api\", \"name\": \"API\" } },\n          { \"@type\": \"ListItem\", \"position\": 2, \"item\": { \"@id\": \"https://ngrx.io/api/data\", \"name\": \"@ngrx/data\" } },\n          { \"@type\": \"ListItem\", \"position\": 3, \"item\": { \"@id\": \"https://ngrx.io/api/data/EntityCollection\", \"name\": \"EntityCollection\" } }\n        ]\n      }\n    </script>\n      <a href=\"/api\">API</a> > <a href=\"api/data\">@ngrx/data</a>\n  </div>\n  \n  <header class=\"api-header\">\n    <h1 id=\"entitycollection\">EntityCollection<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/data/EntityCollection#entitycollection\"><i class=\"material-icons\">link</i></a></h1>\n    <label class=\"api-type-label interface\">interface</label>\n    \n    \n    \n  </header>\n  \n  <aio-toc class=\"embedded\"></aio-toc>\n\n  <div class=\"api-body\">\n    \n  <section class=\"short-description\">\n    <p>Data and information about a collection of entities of a single type.\nEntityCollections are maintained in the EntityCache within the ngrx store.</p>\n\n    \n  </section>\n  \n  \n  <section class=\"interface-overview\">\n<code-example language=\"ts\" hidecopy=\"true\">\ninterface <a href=\"api/data/EntityCollection\" class=\"code-anchor\">EntityCollection</a>&#x3C;T = any> extends EntityState&#x3C;T> {\n  <a class=\"code-anchor\" href=\"api/data/EntityCollection#entityName\"><span class=\"member-name\">entityName</span>: string</a>\n  <a class=\"code-anchor\" href=\"api/data/EntityCollection#changeState\"><span class=\"member-name\">changeState</span>: ChangeStateMap&#x3C;T></a>\n  <a class=\"code-anchor\" href=\"api/data/EntityCollection#filter\"><span class=\"member-name\">filter</span>?: string</a>\n  <a class=\"code-anchor\" href=\"api/data/EntityCollection#loaded\"><span class=\"member-name\">loaded</span>: boolean</a>\n  <a class=\"code-anchor\" href=\"api/data/EntityCollection#loading\"><span class=\"member-name\">loading</span>: boolean</a>\n\n  // inherited from <a class=\"code-anchor\" href=\"api/entity/EntityState\">entity/EntityState</a>\n  <a class=\"code-anchor\" href=\"api/entity/EntityState#ids\"><span class=\"member-name\">ids</span>: string[] | number[]</a>\n  <a class=\"code-anchor\" href=\"api/entity/EntityState#entities\"><span class=\"member-name\">entities</span>: Dictionary&#x3C;T></a>\n}\n</code-example>\n\n  \n  \n\n\n  \n  \n\n</section>\n  \n\n  \n  \n  \n<section class=\"instance-properties\">\n  <h2 id=\"properties\">Properties<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/data/EntityCollection#properties\"><i class=\"material-icons\">link</i></a></h2>\n  <table class=\"is-full-width list-table property-table\">\n    <thead>\n      <tr>\n        <th>Property</th>\n        <th>Description</th>\n      </tr>\n    </thead>\n    <tbody>\n    \n      <tr class=\"instance-property\">\n        <td>\n          <a id=\"entityName\"></a>\n          <code><span class=\"member-name\">entityName</span>: string</code>\n        </td>\n        <td>\n          <p>Name of the entity type for this collection</p>\n\n          \n          \n        </td>\n    </tr>\n    \n      <tr class=\"instance-property\">\n        <td>\n          <a id=\"changeState\"></a>\n          <code><span class=\"member-name\"><a href=\"api/data/EntityCollection#changeState\" class=\"code-anchor\">changeState</a></span>: <a href=\"api/data/ChangeStateMap\" class=\"code-anchor\">ChangeStateMap</a>&#x3C;T></code>\n        </td>\n        <td>\n          <p>A map of ChangeStates, keyed by id, for entities with unsaved changes</p>\n\n          \n          \n        </td>\n    </tr>\n    \n      <tr class=\"instance-property\">\n        <td>\n          <a id=\"filter\"></a>\n          <code><span class=\"member-name\"><a href=\"api/data/EntityCollection#filter\" class=\"code-anchor\">filter</a></span>?: string</code>\n        </td>\n        <td>\n          <p>The user's current collection filter pattern</p>\n\n          \n          \n        </td>\n    </tr>\n    \n      <tr class=\"instance-property\">\n        <td>\n          <a id=\"loaded\"></a>\n          <code><span class=\"member-name\"><a href=\"api/data/EntityCollection#loaded\" class=\"code-anchor\">loaded</a></span>: boolean</code>\n        </td>\n        <td>\n          <p>true if collection was ever filled by QueryAll; forced false if cleared</p>\n\n          \n          \n        </td>\n    </tr>\n    \n      <tr class=\"instance-property\">\n        <td>\n          <a id=\"loading\"></a>\n          <code><span class=\"member-name\"><a href=\"api/data/EntityCollection#loading\" class=\"code-anchor\">loading</a></span>: boolean</code>\n        </td>\n        <td>\n          <p>true when a query or save operation is in progress</p>\n\n          \n          \n        </td>\n    </tr>\n    \n    </tbody>\n  </table>\n</section>\n  \n\n\n  \n\n\n  </div>\n</article>\n\n<!-- links to this doc:\n - api/component/LetDirective\n - api/component/RenderScheduler\n - api/data\n - api/data/CollectionSelectors\n - api/data/EntityCache\n - api/data/EntityChangeTracker\n - api/data/EntityChangeTrackerBase\n - api/data/EntityCollectionCreator\n - api/data/EntityCollectionReducer\n - api/data/EntityCollectionReducerMethodMap\n - api/data/EntityCollectionReducerMethods\n - api/data/EntityCollectionServiceBase\n - api/data/EntityDataModuleConfig\n - api/data/EntityDefinition\n - api/data/EntitySelectors\n - api/data/EntitySelectors$\n - api/data/EntitySelectorsFactory\n - api/data/MergeStrategy\n - api/data/createEmptyEntityCollection\n - api/entity/EntityState\n - api/operators/tapResponse\n - api/store/createFeature\n - guide/component-store/usage\n - guide/component/let\n - guide/data/entity-change-tracker\n - guide/data/entity-collection\n - guide/data/entity-effects\n - guide/data/entity-metadata\n - guide/data/entity-reducer\n - guide/data/save-entities\n - guide/eslint-plugin/rules/avoid-cyclic-effects\n - guide/eslint-plugin/rules/avoid-duplicate-actions-in-reducer\n - guide/eslint-plugin/rules/no-dispatch-in-effects\n - guide/migration/v13\n - guide/operators/operators\n - guide/signals/rxjs-integration\n - guide/signals/signal-store\n - guide/store/feature-creators\n - guide/store/selectors\n-->\n<!-- links from this doc:\n - /api\n - api/data\n - api/data/ChangeStateMap\n - api/data/EntityCollection#changeState\n - api/data/EntityCollection#entityName\n - api/data/EntityCollection#entitycollection\n - api/data/EntityCollection#filter\n - api/data/EntityCollection#loaded\n - api/data/EntityCollection#loading\n - api/data/EntityCollection#properties\n - api/entity/EntityState\n - api/entity/EntityState#entities\n - api/entity/EntityState#ids\n - https://github.com/ngrx/platform/edit/main/modules/data/src/reducers/entity-collection.ts?message=docs(data)%3A%20describe%20your%20change...#L29-L45\n - https://github.com/ngrx/platform/tree/18.0.2/modules/data/src/reducers/entity-collection.ts#L29-L45\n-->"
+  "contents": "\n\n<article>\n  <div class=\"github-links\">\n  <a href=\"https://github.com/ngrx/platform/edit/main/modules/data/src/reducers/entity-collection.ts?message=docs(data)%3A%20describe%20your%20change...#L29-L45\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n  <a href=\"https://github.com/ngrx/platform/tree/18.0.2/modules/data/src/reducers/entity-collection.ts#L29-L45\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n  <div class=\"breadcrumb\">\n    <script type=\"application/ld+json\">\n      {\n        \"@context\": \"http://schema.org\",\n        \"@type\": \"BreadcrumbList\",\n        \"itemListElement\": [\n          { \"@type\": \"ListItem\", \"position\": 1, \"item\": { \"@id\": \"https://ngrx.io//api\", \"name\": \"API\" } },\n          { \"@type\": \"ListItem\", \"position\": 2, \"item\": { \"@id\": \"https://ngrx.io/api/data\", \"name\": \"@ngrx/data\" } },\n          { \"@type\": \"ListItem\", \"position\": 3, \"item\": { \"@id\": \"https://ngrx.io/api/data/EntityCollection\", \"name\": \"EntityCollection\" } }\n        ]\n      }\n    </script>\n      <a href=\"/api\">API</a> > <a href=\"api/data\">@ngrx/data</a>\n  </div>\n  \n  <header class=\"api-header\">\n    <h1 id=\"entitycollection\">EntityCollection<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/data/EntityCollection#entitycollection\"><i class=\"material-icons\">link</i></a></h1>\n    <label class=\"api-type-label interface\">interface</label>\n    \n    \n    \n  </header>\n  \n  <aio-toc class=\"embedded\"></aio-toc>\n\n  <div class=\"api-body\">\n    \n  <section class=\"short-description\">\n    <p>Data and information about a collection of entities of a single type.\nEntityCollections are maintained in the EntityCache within the ngrx store.</p>\n\n    \n  </section>\n  \n  \n  <section class=\"interface-overview\">\n<code-example language=\"ts\" hidecopy=\"true\">\ninterface <a href=\"api/data/EntityCollection\" class=\"code-anchor\">EntityCollection</a>&#x3C;T = any> extends EntityState&#x3C;T> {\n  <a class=\"code-anchor\" href=\"api/data/EntityCollection#entityName\"><span class=\"member-name\">entityName</span>: string</a>\n  <a class=\"code-anchor\" href=\"api/data/EntityCollection#changeState\"><span class=\"member-name\">changeState</span>: ChangeStateMap&#x3C;T></a>\n  <a class=\"code-anchor\" href=\"api/data/EntityCollection#filter\"><span class=\"member-name\">filter</span>?: string</a>\n  <a class=\"code-anchor\" href=\"api/data/EntityCollection#loaded\"><span class=\"member-name\">loaded</span>: boolean</a>\n  <a class=\"code-anchor\" href=\"api/data/EntityCollection#loading\"><span class=\"member-name\">loading</span>: boolean</a>\n\n  // inherited from <a class=\"code-anchor\" href=\"api/entity/EntityState\">entity/EntityState</a>\n  <a class=\"code-anchor\" href=\"api/entity/EntityState#ids\"><span class=\"member-name\">ids</span>: string[] | number[]</a>\n  <a class=\"code-anchor\" href=\"api/entity/EntityState#entities\"><span class=\"member-name\">entities</span>: Dictionary&#x3C;T></a>\n}\n</code-example>\n\n  \n  \n\n\n  \n  \n\n</section>\n  \n\n  \n  \n  \n<section class=\"instance-properties\">\n  <h2 id=\"properties\">Properties<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/data/EntityCollection#properties\"><i class=\"material-icons\">link</i></a></h2>\n  <table class=\"is-full-width list-table property-table\">\n    <thead>\n      <tr>\n        <th>Property</th>\n        <th>Description</th>\n      </tr>\n    </thead>\n    <tbody>\n    \n      <tr class=\"instance-property\">\n        <td>\n          <a id=\"entityName\"></a>\n          <code><span class=\"member-name\">entityName</span>: string</code>\n        </td>\n        <td>\n          <p>Name of the entity type for this collection</p>\n\n          \n          \n        </td>\n    </tr>\n    \n      <tr class=\"instance-property\">\n        <td>\n          <a id=\"changeState\"></a>\n          <code><span class=\"member-name\"><a href=\"api/data/EntityCollection#changeState\" class=\"code-anchor\">changeState</a></span>: <a href=\"api/data/ChangeStateMap\" class=\"code-anchor\">ChangeStateMap</a>&#x3C;T></code>\n        </td>\n        <td>\n          <p>A map of ChangeStates, keyed by id, for entities with unsaved changes</p>\n\n          \n          \n        </td>\n    </tr>\n    \n      <tr class=\"instance-property\">\n        <td>\n          <a id=\"filter\"></a>\n          <code><span class=\"member-name\"><a href=\"api/data/EntityCollection#filter\" class=\"code-anchor\">filter</a></span>?: string</code>\n        </td>\n        <td>\n          <p>The user's current collection filter pattern</p>\n\n          \n          \n        </td>\n    </tr>\n    \n      <tr class=\"instance-property\">\n        <td>\n          <a id=\"loaded\"></a>\n          <code><span class=\"member-name\"><a href=\"api/data/EntityCollection#loaded\" class=\"code-anchor\">loaded</a></span>: boolean</code>\n        </td>\n        <td>\n          <p>true if collection was ever filled by QueryAll; forced false if cleared</p>\n\n          \n          \n        </td>\n    </tr>\n    \n      <tr class=\"instance-property\">\n        <td>\n          <a id=\"loading\"></a>\n          <code><span class=\"member-name\"><a href=\"api/data/EntityCollection#loading\" class=\"code-anchor\">loading</a></span>: boolean</code>\n        </td>\n        <td>\n          <p>true when a query or save operation is in progress</p>\n\n          \n          \n        </td>\n    </tr>\n    \n    </tbody>\n  </table>\n</section>\n  \n\n\n  \n\n\n  </div>\n</article>\n\n<!-- links to this doc:\n - api/component/LetDirective\n - api/component/RenderScheduler\n - api/data\n - api/data/CollectionSelectors\n - api/data/EntityCache\n - api/data/EntityChangeTracker\n - api/data/EntityChangeTrackerBase\n - api/data/EntityCollectionCreator\n - api/data/EntityCollectionReducer\n - api/data/EntityCollectionReducerMethodMap\n - api/data/EntityCollectionReducerMethods\n - api/data/EntityCollectionServiceBase\n - api/data/EntityDataModuleConfig\n - api/data/EntityDefinition\n - api/data/EntitySelectors\n - api/data/EntitySelectors$\n - api/data/EntitySelectorsFactory\n - api/data/MergeStrategy\n - api/data/createEmptyEntityCollection\n - api/entity/EntityState\n - api/operators/tapResponse\n - api/store/createFeature\n - guide/component-store/usage\n - guide/component/let\n - guide/data/entity-change-tracker\n - guide/data/entity-collection\n - guide/data/entity-effects\n - guide/data/entity-metadata\n - guide/data/entity-reducer\n - guide/data/save-entities\n - guide/eslint-plugin/rules/avoid-cyclic-effects\n - guide/eslint-plugin/rules/avoid-duplicate-actions-in-reducer\n - guide/eslint-plugin/rules/no-dispatch-in-effects\n - guide/migration/v13\n - guide/operators/operators\n - guide/signals/rxjs-integration\n - guide/signals/signal-store\n - guide/signals/signal-store/testing\n - guide/store/feature-creators\n - guide/store/selectors\n-->\n<!-- links from this doc:\n - /api\n - api/data\n - api/data/ChangeStateMap\n - api/data/EntityCollection#changeState\n - api/data/EntityCollection#entityName\n - api/data/EntityCollection#entitycollection\n - api/data/EntityCollection#filter\n - api/data/EntityCollection#loaded\n - api/data/EntityCollection#loading\n - api/data/EntityCollection#properties\n - api/entity/EntityState\n - api/entity/EntityState#entities\n - api/entity/EntityState#ids\n - https://github.com/ngrx/platform/edit/main/modules/data/src/reducers/entity-collection.ts?message=docs(data)%3A%20describe%20your%20change...#L29-L45\n - https://github.com/ngrx/platform/tree/18.0.2/modules/data/src/reducers/entity-collection.ts#L29-L45\n-->"
 }