Skip to content

Commit

Permalink
3850a98b docs: add breaking changes to v19 migration (#4620)
Browse files Browse the repository at this point in the history
  • Loading branch information
web-flow authored Dec 10, 2024
1 parent cd495c8 commit f3ad00e
Show file tree
Hide file tree
Showing 28 changed files with 39 additions and 39 deletions.
2 changes: 1 addition & 1 deletion commit_message
Original file line number Diff line number Diff line change
@@ -1 +1 @@
2ac43720 feat(eslint-plugin): add new rule require-super-ondestroy (#4611)
3850a98b docs: add breaking changes to v19 migration (#4620)

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion generated/docs/api/data/RequestData.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"id": "api/data/RequestData",
"title": "RequestData",
"contents": "\n\n<article>\n <div class=\"github-links\">\n <a href=\"https://github.com/ngrx/platform/edit/main/modules/data/src/dataservices/interfaces.ts?message=docs(data)%3A%20describe%20your%20change...#L23-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/19.0.0-beta.0/modules/data/src/dataservices/interfaces.ts#L23-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/data\", \"name\": \"@ngrx/data\" } },\n { \"@type\": \"ListItem\", \"position\": 3, \"item\": { \"@id\": \"https://ngrx.io/api/data/RequestData\", \"name\": \"RequestData\" } }\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=\"requestdata\">RequestData<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/data/RequestData#requestdata\"><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/data/RequestData\" class=\"code-anchor\">RequestData</a> {\n <a class=\"code-anchor\" href=\"api/data/RequestData#method\"><span class=\"member-name\">method</span>: HttpMethods</a>\n <a class=\"code-anchor\" href=\"api/data/RequestData#url\"><span class=\"member-name\">url</span>: string</a>\n <a class=\"code-anchor\" href=\"api/data/RequestData#data\"><span class=\"member-name\">data</span>?: any</a>\n <a class=\"code-anchor\" href=\"api/data/RequestData#options\"><span class=\"member-name\">options</span>?: any</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/RequestData#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=\"method\"></a>\n <code><span class=\"member-name\"><a href=\"api/data/RequestData#method\" class=\"code-anchor\">method</a></span>: <a href=\"api/data/HttpMethods\" class=\"code-anchor\">HttpMethods</a></code>\n </td>\n <td>\n \n \n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"url\"></a>\n <code><span class=\"member-name\">url</span>: string</code>\n </td>\n <td>\n \n \n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"data\"></a>\n <code><span class=\"member-name\">data</span>?: any</code>\n </td>\n <td>\n \n \n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"options\"></a>\n <code><span class=\"member-name\"><a href=\"api/data/RequestData#options\" class=\"code-anchor\">options</a></span>?: any</code>\n </td>\n <td>\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/component-store/ComponentStore\n - api/data\n - api/data/DataServiceError\n - api/data/DefaultDataService\n - api/data/EntityActionFactory\n - api/data/EntityCacheCommands\n - api/data/EntityCacheDataService\n - api/data/EntityCacheDispatcher\n - api/data/EntityCollectionReducerMethodMap\n - api/data/EntityCollectionService\n - api/data/EntityCollectionServiceBase\n - api/data/EntityDispatcher\n - api/data/EntityDispatcherBase\n - api/data/EntityServerCommands\n - api/data/SaveEntities\n - api/data/SaveEntitiesSuccess\n - api/entity/createEntityAdapter\n - api/store-devtools/StoreDevtoolsModule\n - api/store-devtools/provideStoreDevtools\n - api/store/Store\n - api/store/createSelectorFactory\n - guide/component-store/usage\n - guide/data/entity-change-tracker\n - guide/data/save-entities\n - guide/effects/testing\n - guide/eslint-plugin/rules/select-style\n - guide/schematics/action\n - guide/schematics/container\n - guide/schematics/data\n - guide/schematics/effect\n - guide/schematics/entity\n - guide/schematics/feature\n - guide/schematics/reducer\n - guide/schematics/selector\n - guide/schematics/store\n - guide/signals/rxjs-integration\n - guide/signals/signal-method\n - guide/signals/signal-store\n - guide/signals/signal-store/private-store-members\n-->\n<!-- links from this doc:\n - /api\n - api/data\n - api/data/HttpMethods\n - api/data/RequestData#data\n - api/data/RequestData#method\n - api/data/RequestData#options\n - api/data/RequestData#properties\n - api/data/RequestData#requestdata\n - api/data/RequestData#url\n - https://github.com/ngrx/platform/edit/main/modules/data/src/dataservices/interfaces.ts?message=docs(data)%3A%20describe%20your%20change...#L23-L29\n - https://github.com/ngrx/platform/tree/19.0.0-beta.0/modules/data/src/dataservices/interfaces.ts#L23-L29\n-->"
"contents": "\n\n<article>\n <div class=\"github-links\">\n <a href=\"https://github.com/ngrx/platform/edit/main/modules/data/src/dataservices/interfaces.ts?message=docs(data)%3A%20describe%20your%20change...#L23-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/19.0.0-beta.0/modules/data/src/dataservices/interfaces.ts#L23-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/data\", \"name\": \"@ngrx/data\" } },\n { \"@type\": \"ListItem\", \"position\": 3, \"item\": { \"@id\": \"https://ngrx.io/api/data/RequestData\", \"name\": \"RequestData\" } }\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=\"requestdata\">RequestData<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/data/RequestData#requestdata\"><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/data/RequestData\" class=\"code-anchor\">RequestData</a> {\n <a class=\"code-anchor\" href=\"api/data/RequestData#method\"><span class=\"member-name\">method</span>: HttpMethods</a>\n <a class=\"code-anchor\" href=\"api/data/RequestData#url\"><span class=\"member-name\">url</span>: string</a>\n <a class=\"code-anchor\" href=\"api/data/RequestData#data\"><span class=\"member-name\">data</span>?: any</a>\n <a class=\"code-anchor\" href=\"api/data/RequestData#options\"><span class=\"member-name\">options</span>?: any</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/RequestData#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=\"method\"></a>\n <code><span class=\"member-name\"><a href=\"api/data/RequestData#method\" class=\"code-anchor\">method</a></span>: <a href=\"api/data/HttpMethods\" class=\"code-anchor\">HttpMethods</a></code>\n </td>\n <td>\n \n \n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"url\"></a>\n <code><span class=\"member-name\">url</span>: string</code>\n </td>\n <td>\n \n \n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"data\"></a>\n <code><span class=\"member-name\">data</span>?: any</code>\n </td>\n <td>\n \n \n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"options\"></a>\n <code><span class=\"member-name\"><a href=\"api/data/RequestData#options\" class=\"code-anchor\">options</a></span>?: any</code>\n </td>\n <td>\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/component-store/ComponentStore\n - api/data\n - api/data/DataServiceError\n - api/data/DefaultDataService\n - api/data/EntityActionFactory\n - api/data/EntityCacheCommands\n - api/data/EntityCacheDataService\n - api/data/EntityCacheDispatcher\n - api/data/EntityCollectionReducerMethodMap\n - api/data/EntityCollectionService\n - api/data/EntityCollectionServiceBase\n - api/data/EntityDispatcher\n - api/data/EntityDispatcherBase\n - api/data/EntityServerCommands\n - api/data/SaveEntities\n - api/data/SaveEntitiesSuccess\n - api/entity/createEntityAdapter\n - api/store-devtools/StoreDevtoolsModule\n - api/store-devtools/provideStoreDevtools\n - api/store/Store\n - api/store/createSelectorFactory\n - guide/component-store/usage\n - guide/data/entity-change-tracker\n - guide/data/save-entities\n - guide/effects/testing\n - guide/eslint-plugin/rules/select-style\n - guide/migration/v19\n - guide/schematics/action\n - guide/schematics/container\n - guide/schematics/data\n - guide/schematics/effect\n - guide/schematics/entity\n - guide/schematics/feature\n - guide/schematics/reducer\n - guide/schematics/selector\n - guide/schematics/store\n - guide/signals/rxjs-integration\n - guide/signals/signal-method\n - guide/signals/signal-store\n - guide/signals/signal-store/private-store-members\n-->\n<!-- links from this doc:\n - /api\n - api/data\n - api/data/HttpMethods\n - api/data/RequestData#data\n - api/data/RequestData#method\n - api/data/RequestData#options\n - api/data/RequestData#properties\n - api/data/RequestData#requestdata\n - api/data/RequestData#url\n - https://github.com/ngrx/platform/edit/main/modules/data/src/dataservices/interfaces.ts?message=docs(data)%3A%20describe%20your%20change...#L23-L29\n - https://github.com/ngrx/platform/tree/19.0.0-beta.0/modules/data/src/dataservices/interfaces.ts#L23-L29\n-->"
}
Loading

0 comments on commit f3ad00e

Please sign in to comment.