fcf0d8dc docs(signals): add documentation for entity management (#4175)

commit_message

@@ -1 +1 @@
-60d0a766 build(codespaces): update dev-container to use node 18 image (#4181)
+fcf0d8dc docs(signals): add documentation for entity management (#4175)

generated/docs/api/data/UpdateResponseData.json

@@ -1,5 +1,5 @@
 {
   "id": "api/data/UpdateResponseData",
   "title": "UpdateResponseData",
-  "contents": "\n\n<article>\n  <div class=\"github-links\">\n  <a href=\"https://github.com/ngrx/platform/edit/main/modules/data/src/actions/update-response-data.ts?message=docs(data)%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  <a href=\"https://github.com/ngrx/platform/tree/17.0.1/modules/data/src/actions/update-response-data.ts\" 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/UpdateResponseData\", \"name\": \"UpdateResponseData\" } }\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=\"updateresponsedata\">UpdateResponseData<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/data/UpdateResponseData#updateresponsedata\"><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 returned in an EntityAction from the EntityEffects for SAVE_UPDATE_ONE_SUCCESS.\nEffectively extends Update<t> with a 'changed' flag.\nThe is true if the server sent back changes to the entity data after update.\nSuch changes must be in the entity data in changes property.\nDefault is false (server did not return entity data; assume it changed nothing).\nSee EntityEffects.</t></p>\n\n    \n  </section>\n  \n  \n  <section class=\"interface-overview\">\n<code-example language=\"ts\" hidecopy=\"true\">\ninterface <a href=\"api/data/UpdateResponseData\" class=\"code-anchor\">UpdateResponseData</a>&#x3C;T> {\n  <a class=\"code-anchor\" href=\"api/data/UpdateResponseData#id\"><span class=\"member-name\">id</span>: number | string</a>\n  <a class=\"code-anchor\" href=\"api/data/UpdateResponseData#changes\"><span class=\"member-name\">changes</span>: Partial&#x3C;T></a>\n  <a class=\"code-anchor\" href=\"api/data/UpdateResponseData#changed\"><span class=\"member-name\">changed</span>?: boolean</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/UpdateResponseData#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=\"id\"></a>\n          <code><span class=\"member-name\"><a href=\"api/data/UpdateResponseData#id\" class=\"code-anchor\">id</a></span>: number | string</code>\n        </td>\n        <td>\n          <p>Original key (id) of the entity</p>\n\n          \n          \n        </td>\n    </tr>\n    \n      <tr class=\"instance-property\">\n        <td>\n          <a id=\"changes\"></a>\n          <code><span class=\"member-name\">changes</span>: Partial&#x3C;T></code>\n        </td>\n        <td>\n          <p>Entity update data. Should include the key (original or changed)</p>\n\n          \n          \n        </td>\n    </tr>\n    \n      <tr class=\"instance-property\">\n        <td>\n          <a id=\"changed\"></a>\n          <code><span class=\"member-name\"><a href=\"api/data/UpdateResponseData#changed\" class=\"code-anchor\">changed</a></span>?: boolean</code>\n        </td>\n        <td>\n          <p>Whether the server made additional changes after processing the update.\nSuch additional changes should be in the 'changes' object.\nDefault is false</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/data\n - api/data/ChangeSetItemFactory-0\n - api/data/EntityActionGuard\n - api/data/EntityChangeTracker\n - api/data/EntityChangeTrackerBase\n - api/data/EntityCollectionDataService\n - api/data/EntityCollectionReducerMethods\n - api/data/defaultSelectId\n - api/data/toUpdateFactory\n - api/effects/provideEffects\n - api/entity/Dictionary\n - api/entity/DictionaryNum\n - api/router-store/data-persistence/fetch\n - api/router-store/data-persistence/navigation\n - api/signals/entities/removeEntity\n - api/signals/entities/updateEntity\n - api/store-devtools/StoreDevtools\n - api/store/provideState\n - guide/component-store/effect\n - guide/component-store/read\n - guide/component-store/usage\n - guide/component-store/write\n - guide/data\n - guide/data/entity-change-tracker\n - guide/data/entity-dataservice\n - guide/data/entity-metadata\n - guide/entity/adapter\n - guide/entity/interfaces\n - guide/entity/recipes/additional-state-properties\n - guide/eslint-plugin/rules/prefer-inline-action-props\n - guide/eslint-plugin/rules/prefix-selectors-with-select\n - guide/migration/v8\n - guide/operators/operators\n - guide/router-store/selectors\n - guide/store/configuration/runtime-checks\n - guide/store/selectors\n - guide/store/testing\n - guide/store/walkthrough\n-->\n<!-- links from this doc:\n - /api\n - api/data\n - api/data/UpdateResponseData#changed\n - api/data/UpdateResponseData#changes\n - api/data/UpdateResponseData#id\n - api/data/UpdateResponseData#properties\n - api/data/UpdateResponseData#updateresponsedata\n - https://github.com/ngrx/platform/edit/main/modules/data/src/actions/update-response-data.ts?message=docs(data)%3A%20describe%20your%20change...\n - https://github.com/ngrx/platform/tree/17.0.1/modules/data/src/actions/update-response-data.ts\n-->"
+  "contents": "\n\n<article>\n  <div class=\"github-links\">\n  <a href=\"https://github.com/ngrx/platform/edit/main/modules/data/src/actions/update-response-data.ts?message=docs(data)%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  <a href=\"https://github.com/ngrx/platform/tree/17.0.1/modules/data/src/actions/update-response-data.ts\" 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/UpdateResponseData\", \"name\": \"UpdateResponseData\" } }\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=\"updateresponsedata\">UpdateResponseData<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/data/UpdateResponseData#updateresponsedata\"><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 returned in an EntityAction from the EntityEffects for SAVE_UPDATE_ONE_SUCCESS.\nEffectively extends Update<t> with a 'changed' flag.\nThe is true if the server sent back changes to the entity data after update.\nSuch changes must be in the entity data in changes property.\nDefault is false (server did not return entity data; assume it changed nothing).\nSee EntityEffects.</t></p>\n\n    \n  </section>\n  \n  \n  <section class=\"interface-overview\">\n<code-example language=\"ts\" hidecopy=\"true\">\ninterface <a href=\"api/data/UpdateResponseData\" class=\"code-anchor\">UpdateResponseData</a>&#x3C;T> {\n  <a class=\"code-anchor\" href=\"api/data/UpdateResponseData#id\"><span class=\"member-name\">id</span>: number | string</a>\n  <a class=\"code-anchor\" href=\"api/data/UpdateResponseData#changes\"><span class=\"member-name\">changes</span>: Partial&#x3C;T></a>\n  <a class=\"code-anchor\" href=\"api/data/UpdateResponseData#changed\"><span class=\"member-name\">changed</span>?: boolean</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/UpdateResponseData#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=\"id\"></a>\n          <code><span class=\"member-name\"><a href=\"api/data/UpdateResponseData#id\" class=\"code-anchor\">id</a></span>: number | string</code>\n        </td>\n        <td>\n          <p>Original key (id) of the entity</p>\n\n          \n          \n        </td>\n    </tr>\n    \n      <tr class=\"instance-property\">\n        <td>\n          <a id=\"changes\"></a>\n          <code><span class=\"member-name\">changes</span>: Partial&#x3C;T></code>\n        </td>\n        <td>\n          <p>Entity update data. Should include the key (original or changed)</p>\n\n          \n          \n        </td>\n    </tr>\n    \n      <tr class=\"instance-property\">\n        <td>\n          <a id=\"changed\"></a>\n          <code><span class=\"member-name\"><a href=\"api/data/UpdateResponseData#changed\" class=\"code-anchor\">changed</a></span>?: boolean</code>\n        </td>\n        <td>\n          <p>Whether the server made additional changes after processing the update.\nSuch additional changes should be in the 'changes' object.\nDefault is false</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/data\n - api/data/ChangeSetItemFactory-0\n - api/data/EntityActionGuard\n - api/data/EntityChangeTracker\n - api/data/EntityChangeTrackerBase\n - api/data/EntityCollectionDataService\n - api/data/EntityCollectionReducerMethods\n - api/data/defaultSelectId\n - api/data/toUpdateFactory\n - api/effects/provideEffects\n - api/entity/Dictionary\n - api/entity/DictionaryNum\n - api/router-store/data-persistence/fetch\n - api/router-store/data-persistence/navigation\n - api/signals/entities/removeEntity\n - api/signals/entities/updateEntity\n - api/store-devtools/StoreDevtools\n - api/store/provideState\n - guide/component-store/effect\n - guide/component-store/read\n - guide/component-store/usage\n - guide/component-store/write\n - guide/data\n - guide/data/entity-change-tracker\n - guide/data/entity-dataservice\n - guide/data/entity-metadata\n - guide/entity/adapter\n - guide/entity/interfaces\n - guide/entity/recipes/additional-state-properties\n - guide/eslint-plugin/rules/prefer-inline-action-props\n - guide/eslint-plugin/rules/prefix-selectors-with-select\n - guide/migration/v8\n - guide/operators/operators\n - guide/router-store/selectors\n - guide/signals/signal-store/entity-management\n - guide/store/configuration/runtime-checks\n - guide/store/selectors\n - guide/store/testing\n - guide/store/walkthrough\n-->\n<!-- links from this doc:\n - /api\n - api/data\n - api/data/UpdateResponseData#changed\n - api/data/UpdateResponseData#changes\n - api/data/UpdateResponseData#id\n - api/data/UpdateResponseData#properties\n - api/data/UpdateResponseData#updateresponsedata\n - https://github.com/ngrx/platform/edit/main/modules/data/src/actions/update-response-data.ts?message=docs(data)%3A%20describe%20your%20change...\n - https://github.com/ngrx/platform/tree/17.0.1/modules/data/src/actions/update-response-data.ts\n-->"
 }