Skip to content

Commit

Permalink
0e4e84ae docs: add v18 migration guide (#4378)
Browse files Browse the repository at this point in the history
  • Loading branch information
web-flow authored Jun 10, 2024
1 parent d45aab8 commit 563e70c
Show file tree
Hide file tree
Showing 20 changed files with 33 additions and 19 deletions.
2 changes: 1 addition & 1 deletion commit_message
Original file line number Diff line number Diff line change
@@ -1 +1 @@
c002466b feat(eslint-plugin): add signals rules (#4380)
0e4e84ae docs: add v18 migration guide (#4378)
2 changes: 1 addition & 1 deletion generated/docs/api/operators/concatLatestFrom.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion generated/docs/api/operators/tapResponse.json

Large diffs are not rendered by default.

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion generated/docs/api/store/Action.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion generated/docs/api/store/MemoizedSelector.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"id": "api/store/MemoizedSelector",
"title": "MemoizedSelector",
"contents": "\n\n<article>\n <div class=\"github-links\">\n <a href=\"https://github.com/ngrx/platform/edit/main/modules/store/src/selector.ts?message=docs(store)%3A%20describe%20your%20change...#L19-L29\" 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.1/modules/store/src/selector.ts#L19-L29\" 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/store\", \"name\": \"@ngrx/store\" } },\n { \"@type\": \"ListItem\", \"position\": 3, \"item\": { \"@id\": \"https://ngrx.io/api/store/MemoizedSelector\", \"name\": \"MemoizedSelector\" } }\n ]\n }\n </script>\n <a href=\"/api\">API</a> > <a href=\"api/store\">@ngrx/store</a>\n </div>\n \n <header class=\"api-header\">\n <h1 id=\"memoizedselector\">MemoizedSelector<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/store/MemoizedSelector#memoizedselector\"><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 \n \n </section>\n \n \n <section class=\"interface-overview\">\n<code-example language=\"ts\" hidecopy=\"true\">\ninterface <a href=\"api/store/MemoizedSelector\" class=\"code-anchor\">MemoizedSelector</a>&#x3C;<a href=\"api/store/State\" class=\"code-anchor\">State</a>, Result, ProjectorFn = <a href=\"api/store/DefaultProjectorFn\" class=\"code-anchor\">DefaultProjectorFn</a>&#x3C;Result>> extends <a href=\"api/store/Selector\" class=\"code-anchor\">Selector</a>&#x3C;<a href=\"api/store/State\" class=\"code-anchor\">State</a>, Result> {\n <a class=\"code-anchor\" href=\"api/store/MemoizedSelector#projector\"><span class=\"member-name\">projector</span>: ProjectorFn</a>\n <a class=\"code-anchor\" href=\"api/store/MemoizedSelector#setResult\"><span class=\"member-name\">setResult</span>: (result?: Result) => void</a>\n <a class=\"code-anchor\" href=\"api/store/MemoizedSelector#clearResult\"><span class=\"member-name\">clearResult</span>: () => void</a>\n <a class=\"code-anchor\" href=\"api/store/MemoizedSelector#release\"><span class=\"member-name\">release</span>(): void</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/store/MemoizedSelector#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=\"projector\"></a>\n <code><span class=\"member-name\">projector</span>: ProjectorFn</code>\n </td>\n <td>\n \n \n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"setResult\"></a>\n <code><span class=\"member-name\">setResult</span>: (result?: Result) => void</code>\n </td>\n <td>\n \n \n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"clearResult\"></a>\n <code><span class=\"member-name\">clearResult</span>: () => void</code>\n </td>\n <td>\n \n \n \n </td>\n </tr>\n \n </tbody>\n </table>\n</section>\n \n\n<section class=\"instance-methods\">\n <h2 id=\"methods\">Methods<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/store/MemoizedSelector#methods\"><i class=\"material-icons\">link</i></a></h2>\n \n <a id=\"release\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"--------release--------------\">\n release()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/store/MemoizedSelector#--------release--------------\"><i class=\"material-icons\">link</i></a></h3>\n <div class=\"github-links\">\n <a href=\"https://github.com/ngrx/platform/edit/main/modules/store/src/selector.ts?message=docs(store)%3A%20describe%20your%20change...#L25-L25\" 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.1/modules/store/src/selector.ts#L25-L25\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n </div>\n </th></tr></thead>\n <tbody>\n \n \n <tr>\n <td>\n \n\n<code-example language=\"ts\" hidecopy=\"true\" linenums=\"false\" class=\"no-box api-heading\"><span class=\"member-name\">release</span>(): void</code-example>\n\n\n\n<h4 class=\"no-anchor\" id=\"parameters\">Parameters</h4>\n<p>There are no parameters.</p>\n\n\n<h4 class=\"no-anchor\" id=\"returns\">Returns</h4>\n<p><code>void</code></p>\n\n\n\n\n\n\n\n </td>\n </tr>\n \n\n \n\n \n </tbody>\n</table>\n\n \n</section>\n\n\n \n\n\n </div>\n</article>\n\n<!-- links to this doc:\n - api/data/ENTITY_CACHE_SELECTOR_TOKEN\n - api/data/EntityCacheSelector\n - api/data/EntitySelectors\n - api/data/createEntityCacheSelector\n - api/router-store/createRouterSelector\n - api/store\n - api/store/createFeature\n - api/store/createFeatureSelector\n - api/store/createSelector\n - api/store/createSelectorFactory\n - api/store/testing/MockSelector\n - api/store/testing/MockStore\n - guide/eslint-plugin/rules/prefix-selectors-with-select\n - guide/migration/v17\n - guide/migration/v8\n - guide/store/selectors\n - guide/store/testing\n-->\n<!-- links from this doc:\n - /api\n - api/store\n - api/store/DefaultProjectorFn\n - api/store/MemoizedSelector#--------release--------------\n - api/store/MemoizedSelector#clearResult\n - api/store/MemoizedSelector#memoizedselector\n - api/store/MemoizedSelector#methods\n - api/store/MemoizedSelector#projector\n - api/store/MemoizedSelector#properties\n - api/store/MemoizedSelector#release\n - api/store/MemoizedSelector#setResult\n - api/store/Selector\n - api/store/State\n - https://github.com/ngrx/platform/edit/main/modules/store/src/selector.ts?message=docs(store)%3A%20describe%20your%20change...#L19-L29\n - https://github.com/ngrx/platform/edit/main/modules/store/src/selector.ts?message=docs(store)%3A%20describe%20your%20change...#L25-L25\n - https://github.com/ngrx/platform/tree/18.0.0-beta.1/modules/store/src/selector.ts#L19-L29\n - https://github.com/ngrx/platform/tree/18.0.0-beta.1/modules/store/src/selector.ts#L25-L25\n-->"
"contents": "\n\n<article>\n <div class=\"github-links\">\n <a href=\"https://github.com/ngrx/platform/edit/main/modules/store/src/selector.ts?message=docs(store)%3A%20describe%20your%20change...#L19-L29\" 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.1/modules/store/src/selector.ts#L19-L29\" 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/store\", \"name\": \"@ngrx/store\" } },\n { \"@type\": \"ListItem\", \"position\": 3, \"item\": { \"@id\": \"https://ngrx.io/api/store/MemoizedSelector\", \"name\": \"MemoizedSelector\" } }\n ]\n }\n </script>\n <a href=\"/api\">API</a> > <a href=\"api/store\">@ngrx/store</a>\n </div>\n \n <header class=\"api-header\">\n <h1 id=\"memoizedselector\">MemoizedSelector<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/store/MemoizedSelector#memoizedselector\"><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 \n \n </section>\n \n \n <section class=\"interface-overview\">\n<code-example language=\"ts\" hidecopy=\"true\">\ninterface <a href=\"api/store/MemoizedSelector\" class=\"code-anchor\">MemoizedSelector</a>&#x3C;<a href=\"api/store/State\" class=\"code-anchor\">State</a>, Result, ProjectorFn = <a href=\"api/store/DefaultProjectorFn\" class=\"code-anchor\">DefaultProjectorFn</a>&#x3C;Result>> extends <a href=\"api/store/Selector\" class=\"code-anchor\">Selector</a>&#x3C;<a href=\"api/store/State\" class=\"code-anchor\">State</a>, Result> {\n <a class=\"code-anchor\" href=\"api/store/MemoizedSelector#projector\"><span class=\"member-name\">projector</span>: ProjectorFn</a>\n <a class=\"code-anchor\" href=\"api/store/MemoizedSelector#setResult\"><span class=\"member-name\">setResult</span>: (result?: Result) => void</a>\n <a class=\"code-anchor\" href=\"api/store/MemoizedSelector#clearResult\"><span class=\"member-name\">clearResult</span>: () => void</a>\n <a class=\"code-anchor\" href=\"api/store/MemoizedSelector#release\"><span class=\"member-name\">release</span>(): void</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/store/MemoizedSelector#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=\"projector\"></a>\n <code><span class=\"member-name\">projector</span>: ProjectorFn</code>\n </td>\n <td>\n \n \n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"setResult\"></a>\n <code><span class=\"member-name\">setResult</span>: (result?: Result) => void</code>\n </td>\n <td>\n \n \n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"clearResult\"></a>\n <code><span class=\"member-name\">clearResult</span>: () => void</code>\n </td>\n <td>\n \n \n \n </td>\n </tr>\n \n </tbody>\n </table>\n</section>\n \n\n<section class=\"instance-methods\">\n <h2 id=\"methods\">Methods<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/store/MemoizedSelector#methods\"><i class=\"material-icons\">link</i></a></h2>\n \n <a id=\"release\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"--------release--------------\">\n release()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/store/MemoizedSelector#--------release--------------\"><i class=\"material-icons\">link</i></a></h3>\n <div class=\"github-links\">\n <a href=\"https://github.com/ngrx/platform/edit/main/modules/store/src/selector.ts?message=docs(store)%3A%20describe%20your%20change...#L25-L25\" 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.1/modules/store/src/selector.ts#L25-L25\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n </div>\n </th></tr></thead>\n <tbody>\n \n \n <tr>\n <td>\n \n\n<code-example language=\"ts\" hidecopy=\"true\" linenums=\"false\" class=\"no-box api-heading\"><span class=\"member-name\">release</span>(): void</code-example>\n\n\n\n<h4 class=\"no-anchor\" id=\"parameters\">Parameters</h4>\n<p>There are no parameters.</p>\n\n\n<h4 class=\"no-anchor\" id=\"returns\">Returns</h4>\n<p><code>void</code></p>\n\n\n\n\n\n\n\n </td>\n </tr>\n \n\n \n\n \n </tbody>\n</table>\n\n \n</section>\n\n\n \n\n\n </div>\n</article>\n\n<!-- links to this doc:\n - api/data/ENTITY_CACHE_SELECTOR_TOKEN\n - api/data/EntityCacheSelector\n - api/data/EntitySelectors\n - api/data/createEntityCacheSelector\n - api/router-store/createRouterSelector\n - api/store\n - api/store/createFeature\n - api/store/createFeatureSelector\n - api/store/createSelector\n - api/store/createSelectorFactory\n - api/store/testing/MockSelector\n - api/store/testing/MockStore\n - guide/eslint-plugin/rules/prefix-selectors-with-select\n - guide/migration/v17\n - guide/migration/v18\n - guide/migration/v8\n - guide/store/selectors\n - guide/store/testing\n-->\n<!-- links from this doc:\n - /api\n - api/store\n - api/store/DefaultProjectorFn\n - api/store/MemoizedSelector#--------release--------------\n - api/store/MemoizedSelector#clearResult\n - api/store/MemoizedSelector#memoizedselector\n - api/store/MemoizedSelector#methods\n - api/store/MemoizedSelector#projector\n - api/store/MemoizedSelector#properties\n - api/store/MemoizedSelector#release\n - api/store/MemoizedSelector#setResult\n - api/store/Selector\n - api/store/State\n - https://github.com/ngrx/platform/edit/main/modules/store/src/selector.ts?message=docs(store)%3A%20describe%20your%20change...#L19-L29\n - https://github.com/ngrx/platform/edit/main/modules/store/src/selector.ts?message=docs(store)%3A%20describe%20your%20change...#L25-L25\n - https://github.com/ngrx/platform/tree/18.0.0-beta.1/modules/store/src/selector.ts#L19-L29\n - https://github.com/ngrx/platform/tree/18.0.0-beta.1/modules/store/src/selector.ts#L25-L25\n-->"
}
2 changes: 1 addition & 1 deletion generated/docs/app/search-data.json

Large diffs are not rendered by default.

Loading

0 comments on commit 563e70c

Please sign in to comment.