a31c2a61 docs(effects): update examples to standalone api (#4522)

Author: web-flow

commit_message

@@ -1 +1 @@
-cb6e2581 docs: update to year 2025 (#4616)
+a31c2a61 docs(effects): update examples to standalone api (#4522)

generated/docs/api/effects/EffectsModule.json

@@ -1,5 +1,5 @@
 {
   "id": "guide/effects/operators",
   "title": "Effects operators",
-  "contents": "\n\n\n  <div class=\"github-links\">\n    <a href=\"https://github.com/ngrx/platform/edit/main/projects/ngrx.io/content/guide/effects/operators.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=\"effects-operators\">Effects operators<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"guide/effects/operators#effects-operators\"><i class=\"material-icons\">link</i></a></h1>\n<p>As part of the <code>Effects</code> library, NgRx provides some useful operators that are frequently\nused. </p>\n<h2 id=\"oftype\"><code><a href=\"api/effects/ofType\" class=\"code-anchor\">ofType</a></code><a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"guide/effects/operators#oftype\"><i class=\"material-icons\">link</i></a></h2>\n<p>The <code><a href=\"api/effects/ofType\" class=\"code-anchor\">ofType</a></code> operator filters the stream of actions based on either string\nvalues (that represent <code><a href=\"api/signals/type\" class=\"code-anchor\">type</a></code>s of actions) or Action Creators.</p>\n<p>The generic for the <code><a href=\"api/effects/Actions\" class=\"code-anchor\">Actions</a>&#x3C;TypeUnion></code> must be provided in order for type\ninference to work properly with string values. Action Creators that are based on\n<code><a href=\"api/store/createAction\" class=\"code-anchor\">createAction</a></code> function do not have the same limitation.</p>\n<p>The <code><a href=\"api/effects/ofType\" class=\"code-anchor\">ofType</a></code> operator takes up to 5 arguments with proper type inference. It can\ntake even more, however the type would be inferred as an <code><a href=\"api/store/Action\" class=\"code-anchor\">Action</a></code> interface.</p>\n<code-example header=\"auth.effects.ts\">\n<a href=\"api/store-devtools/DevToolsFeatureOptions#import\" class=\"code-anchor\">import</a> { Injectable } from '@angular/core';\n<a href=\"api/store-devtools/DevToolsFeatureOptions#import\" class=\"code-anchor\">import</a> { <a href=\"api/effects/Actions\" class=\"code-anchor\">Actions</a>, <a href=\"api/effects/ofType\" class=\"code-anchor\">ofType</a>, <a href=\"api/effects/createEffect\" class=\"code-anchor\">createEffect</a> } from '@ngrx/effects';\n<a href=\"api/store-devtools/DevToolsFeatureOptions#import\" class=\"code-anchor\">import</a> { of } from 'rxjs';\n<a href=\"api/store-devtools/DevToolsFeatureOptions#import\" class=\"code-anchor\">import</a> { catchError, exhaustMap, map } from 'rxjs/operators';\n<a href=\"api/store-devtools/DevToolsFeatureOptions#import\" class=\"code-anchor\">import</a> {\n  LoginPageActions,\n  AuthApiActions,\n} from '../actions';\n<a href=\"api/store-devtools/DevToolsFeatureOptions#import\" class=\"code-anchor\">import</a> { Credentials } from '../models/user';\n<a href=\"api/store-devtools/DevToolsFeatureOptions#import\" class=\"code-anchor\">import</a> { AuthService } from '../<a href=\"api/data/EntityDataService#services\" class=\"code-anchor\">services</a>/auth.service';\n\n@Injectable()\n<a href=\"api/store-devtools/DevToolsFeatureOptions#export\" class=\"code-anchor\">export</a> class AuthEffects {\n  login$ = <a href=\"api/effects/createEffect\" class=\"code-anchor\">createEffect</a>(() =>\n    this.actions$.pipe(\n      // Filters by <a href=\"api/store/Action\" class=\"code-anchor\">Action</a> <a href=\"api/store/Creator\" class=\"code-anchor\">Creator</a> 'login'\n      <a href=\"api/effects/ofType\" class=\"code-anchor\">ofType</a>(LoginPageActions.login),\n      exhaustMap(action =>\n        this.authService.login(action.credentials).pipe(\n          map(user => AuthApiActions.loginSuccess({ user })),\n          catchError(error => of(AuthApiActions.loginFailure({ error })))\n        )\n      )\n    )\n  );\n\n  constructor(\n    private actions$: <a href=\"api/effects/Actions\" class=\"code-anchor\">Actions</a>,\n    private authService: AuthService\n  ) {}\n}\n</code-example>\n\n</div>\n\n<!-- links to this doc:\n - guide/effects\n-->\n<!-- links from this doc:\n - api/data/EntityDataService#services\n - api/effects/Actions\n - api/effects/createEffect\n - api/effects/ofType\n - api/signals/type\n - api/store-devtools/DevToolsFeatureOptions#export\n - api/store-devtools/DevToolsFeatureOptions#import\n - api/store/Action\n - api/store/Creator\n - api/store/createAction\n - guide/effects/operators#effects-operators\n - guide/effects/operators#oftype\n - https://github.com/ngrx/platform/edit/main/projects/ngrx.io/content/guide/effects/operators.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/effects/operators.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=\"effects-operators\">Effects operators<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"guide/effects/operators#effects-operators\"><i class=\"material-icons\">link</i></a></h1>\n<p>As part of the <code>Effects</code> library, NgRx provides some useful operators that are frequently\nused. </p>\n<h2 id=\"oftype\"><code><a href=\"api/effects/ofType\" class=\"code-anchor\">ofType</a></code><a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"guide/effects/operators#oftype\"><i class=\"material-icons\">link</i></a></h2>\n<p>The <code><a href=\"api/effects/ofType\" class=\"code-anchor\">ofType</a></code> operator filters the stream of actions based on either string\nvalues (that represent <code><a href=\"api/signals/type\" class=\"code-anchor\">type</a></code>s of actions) or Action Creators.</p>\n<p>The generic for the <code><a href=\"api/effects/Actions\" class=\"code-anchor\">Actions</a>&#x3C;TypeUnion></code> must be provided in order for type\ninference to work properly with string values. Action Creators that are based on\n<code><a href=\"api/store/createAction\" class=\"code-anchor\">createAction</a></code> function do not have the same limitation.</p>\n<p>The <code><a href=\"api/effects/ofType\" class=\"code-anchor\">ofType</a></code> operator takes up to 5 arguments with proper type inference. It can\ntake even more, however the type would be inferred as an <code><a href=\"api/store/Action\" class=\"code-anchor\">Action</a></code> interface.</p>\n<code-example header=\"auth.effects.ts\">\n<a href=\"api/store-devtools/DevToolsFeatureOptions#import\" class=\"code-anchor\">import</a> { Injectable, inject } from '@angular/core';\n<a href=\"api/store-devtools/DevToolsFeatureOptions#import\" class=\"code-anchor\">import</a> { <a href=\"api/effects/Actions\" class=\"code-anchor\">Actions</a>, <a href=\"api/effects/ofType\" class=\"code-anchor\">ofType</a>, <a href=\"api/effects/createEffect\" class=\"code-anchor\">createEffect</a> } from '@ngrx/effects';\n<a href=\"api/store-devtools/DevToolsFeatureOptions#import\" class=\"code-anchor\">import</a> { of } from 'rxjs';\n<a href=\"api/store-devtools/DevToolsFeatureOptions#import\" class=\"code-anchor\">import</a> { catchError, exhaustMap, map } from 'rxjs/operators';\n<a href=\"api/store-devtools/DevToolsFeatureOptions#import\" class=\"code-anchor\">import</a> {\n  LoginPageActions,\n  AuthApiActions,\n} from '../actions';\n<a href=\"api/store-devtools/DevToolsFeatureOptions#import\" class=\"code-anchor\">import</a> { Credentials } from '../models/user';\n<a href=\"api/store-devtools/DevToolsFeatureOptions#import\" class=\"code-anchor\">import</a> { AuthService } from '../<a href=\"api/data/EntityDataService#services\" class=\"code-anchor\">services</a>/auth.service';\n\n@Injectable()\n<a href=\"api/store-devtools/DevToolsFeatureOptions#export\" class=\"code-anchor\">export</a> class AuthEffects {\n  private actions$ = inject(<a href=\"api/effects/Actions\" class=\"code-anchor\">Actions</a>);\n  private authService = inject(AuthService);\n\n  login$ = <a href=\"api/effects/createEffect\" class=\"code-anchor\">createEffect</a>(() => {\n    return this.actions$.pipe(\n      // Filters by <a href=\"api/store/Action\" class=\"code-anchor\">Action</a> <a href=\"api/store/Creator\" class=\"code-anchor\">Creator</a> 'login'\n      <a href=\"api/effects/ofType\" class=\"code-anchor\">ofType</a>(LoginPageActions.login),\n      exhaustMap(action =>\n        this.authService.login(action.credentials).pipe(\n          map(user => AuthApiActions.loginSuccess({ user })),\n          catchError(error => of(AuthApiActions.loginFailure({ error })))\n        )\n      )\n    );\n  });\n}\n</code-example>\n\n</div>\n\n<!-- links to this doc:\n - guide/effects\n-->\n<!-- links from this doc:\n - api/data/EntityDataService#services\n - api/effects/Actions\n - api/effects/createEffect\n - api/effects/ofType\n - api/signals/type\n - api/store-devtools/DevToolsFeatureOptions#export\n - api/store-devtools/DevToolsFeatureOptions#import\n - api/store/Action\n - api/store/Creator\n - api/store/createAction\n - guide/effects/operators#effects-operators\n - guide/effects/operators#oftype\n - https://github.com/ngrx/platform/edit/main/projects/ngrx.io/content/guide/effects/operators.md?message=docs%3A%20describe%20your%20change...\n-->"
 }

generated/docs/app/search-data.json

@@ -807,12 +807,12 @@
     "prerelease": [
       "local"
     ],
-    "build": "sha.cb6e2581",
+    "build": "sha.a31c2a61",
     "version": "19.0.0-local",
     "codeName": "snapshot",
     "isSnapshot": true,
-    "full": "19.0.0-local+sha.cb6e2581",
+    "full": "19.0.0-local+sha.a31c2a61",
     "branch": "master",
-    "commitSHA": "cb6e25811d726855520b99faa8cf94b0e5f1acdb"
+    "commitSHA": "a31c2a6131482f0e26879d44991dfd8f2ec65b40"
   }
 }

generated/docs/guide/effects.json

@@ -1,6 +1,6 @@
 {
   "configVersion": 1,
-  "timestamp": 1733775104586,
+  "timestamp": 1733782149151,
   "index": "/index.html",
   "assetGroups": [
     {
@@ -955,7 +955,7 @@
     "/generated/docs/api/effects/EffectsErrorHandler.json": "9e3013633cfda5f089f14612acc95c561ad38956",
     "/generated/docs/api/effects/EffectsFeatureModule.json": "7f34323d55481d899f0f4c2171b5c7f302c19bdd",
     "/generated/docs/api/effects/EffectsMetadata.json": "b5606c013d6e1a391c25d8f98e984c32618ff2a0",
-    "/generated/docs/api/effects/EffectsModule.json": "a0a57ddc39e0a5a2901f0daa6e21e7e11774f1ed",
+    "/generated/docs/api/effects/EffectsModule.json": "ece70530c46f2aba35c57dcab292560c6a4ba6b0",
     "/generated/docs/api/effects/EffectsRootModule.json": "3cdbdaeb3205d2bfe936107268a728563fd42a3f",
     "/generated/docs/api/effects/EffectsRunner.json": "0ff6564420a6a54b6506ba8676b6b3492093e853",
     "/generated/docs/api/effects/FunctionalEffect.json": "7ca9b81f6906b816a593d31dc2903327c61e96b4",
@@ -1183,7 +1183,7 @@
     "/generated/docs/api/store/testing/createMockStore.json": "6df49197ee719daf42241580cc0f8d93a4b20856",
     "/generated/docs/api/store/testing/provideMockStore.json": "ee2729311386493b742eccc7af7976c14372c5b4",
     "/generated/docs/api/store/union.json": "f79fd942d2c65a36be58540aaba426155a9f70be",
-    "/generated/docs/app/search-data.json": "13c31aeedf1e097f7fd73873bdb8528d1276bb06",
+    "/generated/docs/app/search-data.json": "c979b43823e664076ca63f898ba8aa8895f6e55c",
     "/generated/docs/contributing.json": "4c7957c3c81d4b50e5084c18375edeadc6095cc1",
     "/generated/docs/docs.json": "70f2e96f98c89284c124e2da590cc93fdc1fb4ec",
     "/generated/docs/enterprise-support.json": "90f869e6046ad7448c0ffc2beecf0f181a6c174b",
@@ -1219,10 +1219,10 @@
     "/generated/docs/guide/data/install.json": "c7bb86c37cdba39b7786ea71c74736538231de1a",
     "/generated/docs/guide/data/limitations.json": "fe9d81cbef37ec2437a8280d13a491457215c8a9",
     "/generated/docs/guide/data/save-entities.json": "940a4c15b8489edbf10843fabc14e6894ec608b5",
-    "/generated/docs/guide/effects.json": "9d76535fed18b7f21b29a7355c3fefe0b003f307",
+    "/generated/docs/guide/effects.json": "d30a721fb0f8a91089e28ab67e7414cd6162e7fd",
     "/generated/docs/guide/effects/install.json": "b4835c9644b0356571aaa6ab997b40834ab11cec",
-    "/generated/docs/guide/effects/lifecycle.json": "11a22b5af4e3386abfa9cd235f4695cd04c29a40",
-    "/generated/docs/guide/effects/operators.json": "5fca7baccae4bd36cbac267ee67fd9c4314a7935",
+    "/generated/docs/guide/effects/lifecycle.json": "5b995a25dbb2d30089292f3f61eeb05f42edaee1",
+    "/generated/docs/guide/effects/operators.json": "d725d55daa07d8eaf92a79de396eb6f62060d6c4",
     "/generated/docs/guide/effects/testing.json": "cc6993493184bac92fb61c9e1a6569b80e2352ee",
     "/generated/docs/guide/entity.json": "0a1fae728de3647b81dae7f936b10653b5e93404",
     "/generated/docs/guide/entity/adapter.json": "bd2d1b4911331230020d5bad9b5c5729d9d27829",
@@ -1405,7 +1405,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": "08f514520dd6541d04c2920b92c33c086d824994",
+    "/generated/navigation.json": "dba18ecdbb24c7ba4dffb07e80c1125cf5b27026",
     "/generated/resources.json": "187bbb4f63bac415553db8bc033d822bb0b5a47e",
     "/index.html": "73dd53940c29a42e824ed49572e37e307dc49f5f",
     "/light-theme.css": "af6e8fca0da10e9eed053318ea52c0434ddc7c53",