125bc422 chore: release 17.0.0

commit_message

@@ -1 +1 @@
-c6d17cdb docs: add API docs for signals and operators packages (#4139)
+125bc422 chore: release 17.0.0

generated/docs/api/component-store.json

@@ -1,5 +1,5 @@
 {
   "id": "api/component-store",
   "title": "@ngrx/component-store",
-  "contents": "\n\n<article>\n  <div class=\"github-links\">\n  <a href=\"https://github.com/ngrx/platform/edit/main/component-store/index.ts?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  <a href=\"https://github.com/ngrx/platform/tree/17.0.0-rc.0/component-store/index.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/component-store\", \"name\": \"@ngrx/component-store\" } }\n        ]\n      }\n    </script>\n      <a href=\"/api\">API</a>\n  </div>\n  \n<header class=\"api-header\">\n  <h1 id=\"ngrxcomponent-store\">@ngrx/component-store<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/component-store#ngrxcomponent-store\"><i class=\"material-icons\">link</i></a></h1>\n  <label class=\"api-type-label package\">package</label>\n  \n  \n  \n</header>\n\n  <aio-toc class=\"embedded\"></aio-toc>\n\n  <div class=\"api-body\">\n    \n  \n\n  \n\n\n  \n  <h2 id=\"entry-points\">Entry points<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/component-store#entry-points\"><i class=\"material-icons\">link</i></a></h2>\n  \n  \n  \n  <section class=\"export-list\">\n    <h3 id=\"primary\">Primary<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/component-store#primary\"><i class=\"material-icons\">link</i></a></h3>\n    <table class=\"is-full-width list-table\">\n      \n      <tbody><tr>\n        <td><code class=\"code-anchor\"><a href=\"api/component-store#primary-entry-point-exports\">@ngrx/component-store</a></code></td>\n        <td>\n          \n          \n        </td>\n      </tr>\n      \n    </tbody></table>\n  </section>\n  \n\n  \n  \n  \n\n  \n\n  <h2 id=\"primary-entry-point-exports\">Primary entry point exports<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/component-store#primary-entry-point-exports\"><i class=\"material-icons\">link</i></a></h2>\n  \n  \n  \n  \n\n  \n  \n  \n  <section class=\"export-list\">\n    <h3 id=\"classes\">Classes<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/component-store#classes\"><i class=\"material-icons\">link</i></a></h3>\n    <table class=\"is-full-width list-table\">\n      \n      <tbody><tr>\n        <td><code class=\"code-anchor\"><a href=\"api/component-store/ComponentStore\">ComponentStore</a></code></td>\n        <td>\n          \n          \n        </td>\n      </tr>\n      \n    </tbody></table>\n  </section>\n  \n\n  \n  \n  \n\n  \n  \n  \n  <section class=\"export-list\">\n    <h3 id=\"functions\">Functions<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/component-store#functions\"><i class=\"material-icons\">link</i></a></h3>\n    <table class=\"is-full-width list-table\">\n      \n      <tbody><tr>\n        <td><code class=\"code-anchor\"><a href=\"api/component-store/provideComponentStore\">provideComponentStore</a></code></td>\n        <td>\n          \n          <p>Function that returns the ComponentStore\nclass registered as a provider,\nand uses a factory provider to instantiate the\nComponentStore and run the lifecycle hooks\ndefined on the ComponentStore.</p>\n\n        </td>\n      </tr>\n      \n      <tr>\n        <td><code class=\"code-anchor\"><a href=\"api/component-store/tapResponse\">tapResponse</a></code></td>\n        <td>\n          \n          <p>Handles the response in ComponentStore effects in a safe way, without\nadditional boilerplate. It enforces that the error case is handled and\nthat the effect would still be running should an error occur.</p>\n\n        </td>\n      </tr>\n      \n    </tbody></table>\n  </section>\n  \n\n  \n  \n  \n  <section class=\"export-list\">\n    <h3 id=\"structures\">Structures<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/component-store#structures\"><i class=\"material-icons\">link</i></a></h3>\n    <table class=\"is-full-width list-table\">\n      \n      <tbody><tr>\n        <td><code class=\"code-anchor\"><a href=\"api/component-store/OnStateInit\">OnStateInit</a></code></td>\n        <td>\n          \n          <p>The interface for the lifecycle hook\ncalled only once after the ComponentStore\nstate is first initialized.</p>\n\n        </td>\n      </tr>\n      \n      <tr>\n        <td><code class=\"code-anchor\"><a href=\"api/component-store/OnStoreInit\">OnStoreInit</a></code></td>\n        <td>\n          \n          <p>The interface for the lifecycle hook\ncalled after the ComponentStore is instantiated.</p>\n\n        </td>\n      </tr>\n      \n      <tr>\n        <td><code class=\"code-anchor\"><a href=\"api/component-store/SelectConfig\">SelectConfig</a></code></td>\n        <td>\n          \n          \n        </td>\n      </tr>\n      \n    </tbody></table>\n  </section>\n  \n\n  \n  \n  \n\n  \n  \n  \n\n  \n  \n  \n  <section class=\"export-list\">\n    <h3 id=\"types\">Types<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/component-store#types\"><i class=\"material-icons\">link</i></a></h3>\n    <table class=\"is-full-width list-table\">\n      \n      <tbody><tr>\n        <td><code class=\"code-anchor\"><a href=\"api/component-store/INITIAL_STATE_TOKEN\">INITIAL_STATE_TOKEN</a></code></td>\n        <td>\n          \n          \n        </td>\n      </tr>\n      \n      <tr>\n        <td><code class=\"code-anchor\"><a href=\"api/component-store/Projector\">Projector</a></code></td>\n        <td>\n          \n          \n        </td>\n      </tr>\n      \n      <tr>\n        <td><code class=\"code-anchor\"><a href=\"api/component-store/SelectorResults\">SelectorResults</a></code></td>\n        <td>\n          \n          \n        </td>\n      </tr>\n      \n    </tbody></table>\n  </section>\n  \n\n  </div>\n</article>\n\n<!-- links to this doc:\n - api/component-store/ComponentStore\n - api/component-store/INITIAL_STATE_TOKEN\n - api/component-store/OnStateInit\n - api/component-store/OnStoreInit\n - api/component-store/Projector\n - api/component-store/SelectConfig\n - api/component-store/SelectorResults\n - api/component-store/provideComponentStore\n - api/component-store/tapResponse\n-->\n<!-- links from this doc:\n - /api\n - api/component-store#classes\n - api/component-store#entry-points\n - api/component-store#functions\n - api/component-store#ngrxcomponent-store\n - api/component-store#primary\n - api/component-store#primary-entry-point-exports\n - api/component-store#structures\n - api/component-store#types\n - api/component-store/ComponentStore\n - api/component-store/INITIAL_STATE_TOKEN\n - api/component-store/OnStateInit\n - api/component-store/OnStoreInit\n - api/component-store/Projector\n - api/component-store/SelectConfig\n - api/component-store/SelectorResults\n - api/component-store/provideComponentStore\n - api/component-store/tapResponse\n - https://github.com/ngrx/platform/edit/main/component-store/index.ts?message=docs(...)%3A%20describe%20your%20change...\n - https://github.com/ngrx/platform/tree/17.0.0-rc.0/component-store/index.ts\n-->"
+  "contents": "\n\n<article>\n  <div class=\"github-links\">\n  <a href=\"https://github.com/ngrx/platform/edit/main/component-store/index.ts?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  <a href=\"https://github.com/ngrx/platform/tree/17.0.0/component-store/index.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/component-store\", \"name\": \"@ngrx/component-store\" } }\n        ]\n      }\n    </script>\n      <a href=\"/api\">API</a>\n  </div>\n  \n<header class=\"api-header\">\n  <h1 id=\"ngrxcomponent-store\">@ngrx/component-store<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/component-store#ngrxcomponent-store\"><i class=\"material-icons\">link</i></a></h1>\n  <label class=\"api-type-label package\">package</label>\n  \n  \n  \n</header>\n\n  <aio-toc class=\"embedded\"></aio-toc>\n\n  <div class=\"api-body\">\n    \n  \n\n  \n\n\n  \n  <h2 id=\"entry-points\">Entry points<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/component-store#entry-points\"><i class=\"material-icons\">link</i></a></h2>\n  \n  \n  \n  <section class=\"export-list\">\n    <h3 id=\"primary\">Primary<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/component-store#primary\"><i class=\"material-icons\">link</i></a></h3>\n    <table class=\"is-full-width list-table\">\n      \n      <tbody><tr>\n        <td><code class=\"code-anchor\"><a href=\"api/component-store#primary-entry-point-exports\">@ngrx/component-store</a></code></td>\n        <td>\n          \n          \n        </td>\n      </tr>\n      \n    </tbody></table>\n  </section>\n  \n\n  \n  \n  \n\n  \n\n  <h2 id=\"primary-entry-point-exports\">Primary entry point exports<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/component-store#primary-entry-point-exports\"><i class=\"material-icons\">link</i></a></h2>\n  \n  \n  \n  \n\n  \n  \n  \n  <section class=\"export-list\">\n    <h3 id=\"classes\">Classes<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/component-store#classes\"><i class=\"material-icons\">link</i></a></h3>\n    <table class=\"is-full-width list-table\">\n      \n      <tbody><tr>\n        <td><code class=\"code-anchor\"><a href=\"api/component-store/ComponentStore\">ComponentStore</a></code></td>\n        <td>\n          \n          \n        </td>\n      </tr>\n      \n    </tbody></table>\n  </section>\n  \n\n  \n  \n  \n\n  \n  \n  \n  <section class=\"export-list\">\n    <h3 id=\"functions\">Functions<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/component-store#functions\"><i class=\"material-icons\">link</i></a></h3>\n    <table class=\"is-full-width list-table\">\n      \n      <tbody><tr>\n        <td><code class=\"code-anchor\"><a href=\"api/component-store/provideComponentStore\">provideComponentStore</a></code></td>\n        <td>\n          \n          <p>Function that returns the ComponentStore\nclass registered as a provider,\nand uses a factory provider to instantiate the\nComponentStore and run the lifecycle hooks\ndefined on the ComponentStore.</p>\n\n        </td>\n      </tr>\n      \n      <tr>\n        <td><code class=\"code-anchor\"><a href=\"api/component-store/tapResponse\">tapResponse</a></code></td>\n        <td>\n          \n          <p>Handles the response in ComponentStore effects in a safe way, without\nadditional boilerplate. It enforces that the error case is handled and\nthat the effect would still be running should an error occur.</p>\n\n        </td>\n      </tr>\n      \n    </tbody></table>\n  </section>\n  \n\n  \n  \n  \n  <section class=\"export-list\">\n    <h3 id=\"structures\">Structures<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/component-store#structures\"><i class=\"material-icons\">link</i></a></h3>\n    <table class=\"is-full-width list-table\">\n      \n      <tbody><tr>\n        <td><code class=\"code-anchor\"><a href=\"api/component-store/OnStateInit\">OnStateInit</a></code></td>\n        <td>\n          \n          <p>The interface for the lifecycle hook\ncalled only once after the ComponentStore\nstate is first initialized.</p>\n\n        </td>\n      </tr>\n      \n      <tr>\n        <td><code class=\"code-anchor\"><a href=\"api/component-store/OnStoreInit\">OnStoreInit</a></code></td>\n        <td>\n          \n          <p>The interface for the lifecycle hook\ncalled after the ComponentStore is instantiated.</p>\n\n        </td>\n      </tr>\n      \n      <tr>\n        <td><code class=\"code-anchor\"><a href=\"api/component-store/SelectConfig\">SelectConfig</a></code></td>\n        <td>\n          \n          \n        </td>\n      </tr>\n      \n    </tbody></table>\n  </section>\n  \n\n  \n  \n  \n\n  \n  \n  \n\n  \n  \n  \n  <section class=\"export-list\">\n    <h3 id=\"types\">Types<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/component-store#types\"><i class=\"material-icons\">link</i></a></h3>\n    <table class=\"is-full-width list-table\">\n      \n      <tbody><tr>\n        <td><code class=\"code-anchor\"><a href=\"api/component-store/INITIAL_STATE_TOKEN\">INITIAL_STATE_TOKEN</a></code></td>\n        <td>\n          \n          \n        </td>\n      </tr>\n      \n      <tr>\n        <td><code class=\"code-anchor\"><a href=\"api/component-store/Projector\">Projector</a></code></td>\n        <td>\n          \n          \n        </td>\n      </tr>\n      \n      <tr>\n        <td><code class=\"code-anchor\"><a href=\"api/component-store/SelectorResults\">SelectorResults</a></code></td>\n        <td>\n          \n          \n        </td>\n      </tr>\n      \n    </tbody></table>\n  </section>\n  \n\n  </div>\n</article>\n\n<!-- links to this doc:\n - api/component-store/ComponentStore\n - api/component-store/INITIAL_STATE_TOKEN\n - api/component-store/OnStateInit\n - api/component-store/OnStoreInit\n - api/component-store/Projector\n - api/component-store/SelectConfig\n - api/component-store/SelectorResults\n - api/component-store/provideComponentStore\n - api/component-store/tapResponse\n-->\n<!-- links from this doc:\n - /api\n - api/component-store#classes\n - api/component-store#entry-points\n - api/component-store#functions\n - api/component-store#ngrxcomponent-store\n - api/component-store#primary\n - api/component-store#primary-entry-point-exports\n - api/component-store#structures\n - api/component-store#types\n - api/component-store/ComponentStore\n - api/component-store/INITIAL_STATE_TOKEN\n - api/component-store/OnStateInit\n - api/component-store/OnStoreInit\n - api/component-store/Projector\n - api/component-store/SelectConfig\n - api/component-store/SelectorResults\n - api/component-store/provideComponentStore\n - api/component-store/tapResponse\n - https://github.com/ngrx/platform/edit/main/component-store/index.ts?message=docs(...)%3A%20describe%20your%20change...\n - https://github.com/ngrx/platform/tree/17.0.0/component-store/index.ts\n-->"
 }