afc14de3 docs(operators): add JSDoc for mapResponse (#4337)

commit_message

@@ -1 +1 @@
-c4609203 feat(operators): add `mapResponse` (#4302)
+afc14de3 docs(operators): add JSDoc for `mapResponse` (#4337)

generated/docs/api/operators.json

@@ -1,5 +1,5 @@
 {
   "id": "api/operators",
   "title": "@ngrx/operators",
-  "contents": "\n\n<article>\n  <div class=\"github-links\">\n  <a href=\"https://github.com/ngrx/platform/edit/main/operators/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/18.0.0-beta.0/operators/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/operators\", \"name\": \"@ngrx/operators\" } }\n        ]\n      }\n    </script>\n      <a href=\"/api\">API</a>\n  </div>\n  \n<header class=\"api-header\">\n  <h1 id=\"ngrxoperators\">@ngrx/operators<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/operators#ngrxoperators\"><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/operators#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/operators#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/operators#primary-entry-point-exports\">@ngrx/operators</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/operators#primary-entry-point-exports\"><i class=\"material-icons\">link</i></a></h2>\n  \n  \n  \n  \n\n  \n  \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/operators#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/operators/concatLatestFrom\">concatLatestFrom</a></code></td>\n        <td>\n          \n          <p><code><a href=\"api/operators/concatLatestFrom\" class=\"code-anchor\">concatLatestFrom</a></code> combines the source value\nand the last available value from a lazily evaluated Observable\nin a new array</p>\n\n        </td>\n      </tr>\n      \n      <tr>\n        <td><code class=\"code-anchor\"><a href=\"api/operators/mapResponse\">mapResponse</a></code></td>\n        <td>\n          \n          \n        </td>\n      </tr>\n      \n      <tr>\n        <td><code class=\"code-anchor\"><a href=\"api/operators/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\n  \n  \n  \n\n  \n  \n  \n\n  \n  \n  \n\n  </div>\n</article>\n\n<!-- links to this doc:\n - api/operators/concatLatestFrom\n - api/operators/mapResponse\n - api/operators/tapResponse\n-->\n<!-- links from this doc:\n - /api\n - api/operators#entry-points\n - api/operators#functions\n - api/operators#ngrxoperators\n - api/operators#primary\n - api/operators#primary-entry-point-exports\n - api/operators/concatLatestFrom\n - api/operators/mapResponse\n - api/operators/tapResponse\n - https://github.com/ngrx/platform/edit/main/operators/index.ts?message=docs(...)%3A%20describe%20your%20change...\n - https://github.com/ngrx/platform/tree/18.0.0-beta.0/operators/index.ts\n-->"
+  "contents": "\n\n<article>\n  <div class=\"github-links\">\n  <a href=\"https://github.com/ngrx/platform/edit/main/operators/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/18.0.0-beta.0/operators/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/operators\", \"name\": \"@ngrx/operators\" } }\n        ]\n      }\n    </script>\n      <a href=\"/api\">API</a>\n  </div>\n  \n<header class=\"api-header\">\n  <h1 id=\"ngrxoperators\">@ngrx/operators<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/operators#ngrxoperators\"><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/operators#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/operators#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/operators#primary-entry-point-exports\">@ngrx/operators</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/operators#primary-entry-point-exports\"><i class=\"material-icons\">link</i></a></h2>\n  \n  \n  \n  \n\n  \n  \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/operators#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/operators/concatLatestFrom\">concatLatestFrom</a></code></td>\n        <td>\n          \n          <p><code><a href=\"api/operators/concatLatestFrom\" class=\"code-anchor\">concatLatestFrom</a></code> combines the source value\nand the last available value from a lazily evaluated Observable\nin a new array</p>\n\n        </td>\n      </tr>\n      \n      <tr>\n        <td><code class=\"code-anchor\"><a href=\"api/operators/mapResponse\">mapResponse</a></code></td>\n        <td>\n          \n          <p><code><a href=\"api/operators/mapResponse\" class=\"code-anchor\">mapResponse</a></code> is a map operator with included error handling.\nIt is similar to <code><a href=\"api/operators/tapResponse\" class=\"code-anchor\">tapResponse</a></code>, but allows to map the response as well.</p>\n\n        </td>\n      </tr>\n      \n      <tr>\n        <td><code class=\"code-anchor\"><a href=\"api/operators/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\n  \n  \n  \n\n  \n  \n  \n\n  \n  \n  \n\n  </div>\n</article>\n\n<!-- links to this doc:\n - api/operators/concatLatestFrom\n - api/operators/mapResponse\n - api/operators/tapResponse\n-->\n<!-- links from this doc:\n - /api\n - api/operators#entry-points\n - api/operators#functions\n - api/operators#ngrxoperators\n - api/operators#primary\n - api/operators#primary-entry-point-exports\n - api/operators/concatLatestFrom\n - api/operators/mapResponse\n - api/operators/tapResponse\n - https://github.com/ngrx/platform/edit/main/operators/index.ts?message=docs(...)%3A%20describe%20your%20change...\n - https://github.com/ngrx/platform/tree/18.0.0-beta.0/operators/index.ts\n-->"
 }