5 lines
90 KiB
JSON
5 lines
90 KiB
JSON
{
|
|
"id": "api/router/UrlHandlingStrategy",
|
|
"title": "UrlHandlingStrategy",
|
|
"contents": "\n\n<article>\n <div class=\"breadcrumb-container\">\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://angular.io//api\", \"name\": \"API\" } },\n { \"@type\": \"ListItem\", \"position\": 2, \"item\": { \"@id\": \"https://angular.io/api/router\", \"name\": \"@angular/router\" } },\n { \"@type\": \"ListItem\", \"position\": 3, \"item\": { \"@id\": \"https://angular.io/api/router/UrlHandlingStrategy\", \"name\": \"UrlHandlingStrategy\" } }\n ]\n }\n </script>\n <a href=\"/api\">API</a> > <a href=\"api/router\">@angular/router</a>\n </div>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/router/src/url_handling_strategy.ts?message=docs(router)%3A%20describe%20your%20change...#L10-L39\" 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/angular/angular/tree/12.0.0-next.7/packages/router/src/url_handling_strategy.ts#L10-L39\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n </div>\n \n <header class=\"api-header\">\n <h1 id=\"urlhandlingstrategy\">UrlHandlingStrategy<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/router/UrlHandlingStrategy#urlhandlingstrategy\"><i class=\"material-icons\">link</i></a></h1>\n \n <label class=\"api-type-label class\">class</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 <p>Provides a way to migrate AngularJS applications to Angular.</p>\n\n \n </section>\n \n \n \n <section class=\"class-overview\">\n<code-example language=\"ts\" hidecopy=\"true\">\nabstract class <a href=\"api/router/UrlHandlingStrategy\" class=\"code-anchor\">UrlHandlingStrategy</a> {\n <a class=\"code-anchor\" href=\"api/router/UrlHandlingStrategy#shouldProcessUrl\">abstract <span class=\"member-name\">shouldProcessUrl</span>(url: UrlTree): boolean</a>\n <a class=\"code-anchor\" href=\"api/router/UrlHandlingStrategy#extract\">abstract <span class=\"member-name\">extract</span>(url: UrlTree): UrlTree</a>\n <a class=\"code-anchor\" href=\"api/router/UrlHandlingStrategy#merge\">abstract <span class=\"member-name\">merge</span>(newUrlPart: UrlTree, rawUrl: UrlTree): UrlTree</a>\n}\n</code-example>\n\n \n \n\n</section>\n\n\n \n\n \n \n \n\n\n\n\n\n\n\n\n\n\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/router/UrlHandlingStrategy#methods\"><i class=\"material-icons\">link</i></a></h2>\n \n <a id=\"shouldProcessUrl\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"shouldprocessurl\">\n shouldProcessUrl()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/router/UrlHandlingStrategy#shouldprocessurl\"><i class=\"material-icons\">link</i></a></h3>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/router/src/url_handling_strategy.ts?message=docs(router)%3A%20describe%20your%20change...#L19-L27\" 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/angular/angular/tree/12.0.0-next.7/packages/router/src/url_handling_strategy.ts#L19-L27\" 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 <tr>\n <td class=\"short-description\">\n <p>Tells the router if this URL should be processed.</p>\n\n </td>\n </tr>\n \n <tr>\n <td>\n <div class=\"overload-info\">\n \n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\">abstract <span class=\"member-name\">shouldProcessUrl</span>(url: UrlTree): boolean</code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code><a href=\"api/router/UrlTree\" class=\"code-anchor\">UrlTree</a></code></td>\n <td class=\"param-description\">\n \n \n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns\">Returns</h6>\n <p><code>boolean</code></p>\n\n \n\n\n \n\n \n</div>\n </td>\n </tr>\n \n\n <tr>\n <td class=\"description\">\n <p>When it returns true, the router will execute the regular navigation.\nWhen it returns false, the router will set the router state to an empty state.\nAs a result, all the active components will be destroyed.</p>\n\n </td>\n </tr>\n\n \n </tbody>\n</table>\n\n \n <a id=\"extract\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"extract\">\n extract()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/router/UrlHandlingStrategy#extract\"><i class=\"material-icons\">link</i></a></h3>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/router/src/url_handling_strategy.ts?message=docs(router)%3A%20describe%20your%20change...#L28-L33\" 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/angular/angular/tree/12.0.0-next.7/packages/router/src/url_handling_strategy.ts#L28-L33\" 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 <tr>\n <td class=\"short-description\">\n <p>Extracts the part of the URL that should be handled by the router.\nThe rest of the URL will remain untouched.</p>\n\n </td>\n </tr>\n \n <tr>\n <td>\n <div class=\"overload-info\">\n \n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\">abstract <span class=\"member-name\">extract</span>(url: UrlTree): UrlTree</code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-1\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>url</code>\n </td>\n <td class=\"param-type\"><code><a href=\"api/router/UrlTree\" class=\"code-anchor\">UrlTree</a></code></td>\n <td class=\"param-description\">\n \n \n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-1\">Returns</h6>\n <p><code><a href=\"api/router/UrlTree\" class=\"code-anchor\">UrlTree</a></code></p>\n\n \n\n\n \n\n \n</div>\n </td>\n </tr>\n \n\n \n\n \n </tbody>\n</table>\n\n \n <a id=\"merge\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"merge\">\n merge()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/router/UrlHandlingStrategy#merge\"><i class=\"material-icons\">link</i></a></h3>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/router/src/url_handling_strategy.ts?message=docs(router)%3A%20describe%20your%20change...#L34-L38\" 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/angular/angular/tree/12.0.0-next.7/packages/router/src/url_handling_strategy.ts#L34-L38\" 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 <tr>\n <td class=\"short-description\">\n <p>Merges the URL fragment with the rest of the URL.</p>\n\n </td>\n </tr>\n \n <tr>\n <td>\n <div class=\"overload-info\">\n \n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\">abstract <span class=\"member-name\">merge</span>(newUrlPart: UrlTree, rawUrl: UrlTree): UrlTree</code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-2\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>newUrlPart</code>\n </td>\n <td class=\"param-type\"><code><a href=\"api/router/UrlTree\" class=\"code-anchor\">UrlTree</a></code></td>\n <td class=\"param-description\">\n \n \n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>rawUrl</code>\n </td>\n <td class=\"param-type\"><code><a href=\"api/router/UrlTree\" class=\"code-anchor\">UrlTree</a></code></td>\n <td class=\"param-description\">\n \n \n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-2\">Returns</h6>\n <p><code><a href=\"api/router/UrlTree\" class=\"code-anchor\">UrlTree</a></code></p>\n\n \n\n\n \n\n \n</div>\n </td>\n </tr>\n \n\n \n\n \n </tbody>\n</table>\n\n \n</section>\n\n\n\n \n\n\n </div>\n</article>\n\n<!-- links to this doc:\n - api/router\n - api/router/Router\n - api/router/testing/RouterTestingModule\n - api/router/testing/setupTestingRouter\n-->\n<!-- links from this doc:\n - /api\n - api/router\n - api/router/UrlHandlingStrategy#extract\n - api/router/UrlHandlingStrategy#merge\n - api/router/UrlHandlingStrategy#methods\n - api/router/UrlHandlingStrategy#shouldProcessUrl\n - api/router/UrlHandlingStrategy#shouldprocessurl\n - api/router/UrlHandlingStrategy#urlhandlingstrategy\n - api/router/UrlTree\n - https://github.com/angular/angular/edit/master/packages/router/src/url_handling_strategy.ts?message=docs(router)%3A%20describe%20your%20change...#L10-L39\n - https://github.com/angular/angular/edit/master/packages/router/src/url_handling_strategy.ts?message=docs(router)%3A%20describe%20your%20change...#L19-L27\n - https://github.com/angular/angular/edit/master/packages/router/src/url_handling_strategy.ts?message=docs(router)%3A%20describe%20your%20change...#L28-L33\n - https://github.com/angular/angular/edit/master/packages/router/src/url_handling_strategy.ts?message=docs(router)%3A%20describe%20your%20change...#L34-L38\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/router/src/url_handling_strategy.ts#L10-L39\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/router/src/url_handling_strategy.ts#L19-L27\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/router/src/url_handling_strategy.ts#L28-L33\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/router/src/url_handling_strategy.ts#L34-L38\n-->"
|
|
} |