5 lines
48 KiB
JSON
5 lines
48 KiB
JSON
{
|
|
"id": "api/router/UrlSerializer",
|
|
"title": "UrlSerializer",
|
|
"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/UrlSerializer\", \"name\": \"UrlSerializer\" } }\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_tree.ts?message=docs(router)%3A%20describe%20your%20change...#L333-L353\" 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_tree.ts#L333-L353\" 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=\"urlserializer\">UrlSerializer<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/router/UrlSerializer#urlserializer\"><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>Serializes and deserializes a URL string into a URL tree.</p>\n\n <p><a href=\"api/router/UrlSerializer#description\">See more...</a></p>\n </section>\n \n \n \n <section class=\"class-overview\">\n<code-example language=\"ts\" hidecopy=\"true\">\nabstract class <a href=\"api/router/UrlSerializer\" class=\"code-anchor\">UrlSerializer</a> {\n <a class=\"code-anchor\" href=\"api/router/UrlSerializer#parse\">abstract <span class=\"member-name\">parse</span>(url: string): UrlTree</a>\n <a class=\"code-anchor\" href=\"api/router/UrlSerializer#serialize\">abstract <span class=\"member-name\">serialize</span>(tree: UrlTree): string</a>\n}\n</code-example>\n\n \n \n <div class=\"descendants class\">\n <h2 id=\"subclasses\">Subclasses<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/router/UrlSerializer#subclasses\"><i class=\"material-icons\">link</i></a></h2>\n \n\n<ul>\n \n <li>\n <code><a href=\"api/router/DefaultUrlSerializer\" class=\"code-anchor\">DefaultUrlSerializer</a></code>\n \n\n\n </li>\n \n</ul>\n\n\n </div>\n \n\n</section>\n\n\n \n\n \n \n<section class=\"description\">\n <h2 id=\"description\">Description<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/router/UrlSerializer#description\"><i class=\"material-icons\">link</i></a></h2>\n <p>The url serialization strategy is customizable. You can\nmake all URLs case insensitive by providing a custom UrlSerializer.</p>\n<p>See <code><a href=\"api/router/DefaultUrlSerializer\" class=\"code-anchor\">DefaultUrlSerializer</a></code> for an example of a URL serializer.</p>\n\n \n</section>\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/UrlSerializer#methods\"><i class=\"material-icons\">link</i></a></h2>\n \n <a id=\"parse\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"parse\">\n parse()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/router/UrlSerializer#parse\"><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_tree.ts?message=docs(router)%3A%20describe%20your%20change...#L348-L349\" 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_tree.ts#L348-L349\" 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>Parse a url into a <code><a href=\"api/router/UrlTree\" class=\"code-anchor\">UrlTree</a></code></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\">parse</span>(url: string): UrlTree</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>string</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><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=\"serialize\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"serialize\">\n serialize()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/router/UrlSerializer#serialize\"><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_tree.ts?message=docs(router)%3A%20describe%20your%20change...#L350-L352\" 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_tree.ts#L350-L352\" 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>Converts a <code><a href=\"api/router/UrlTree\" class=\"code-anchor\">UrlTree</a></code> into a 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\">serialize</span>(tree: UrlTree): string</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>tree</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>string</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/DefaultUrlSerializer\n - api/router/ExtraOptions\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/DefaultUrlSerializer\n - api/router/UrlSerializer#description\n - api/router/UrlSerializer#methods\n - api/router/UrlSerializer#parse\n - api/router/UrlSerializer#serialize\n - api/router/UrlSerializer#subclasses\n - api/router/UrlSerializer#urlserializer\n - api/router/UrlTree\n - https://github.com/angular/angular/edit/master/packages/router/src/url_tree.ts?message=docs(router)%3A%20describe%20your%20change...#L333-L353\n - https://github.com/angular/angular/edit/master/packages/router/src/url_tree.ts?message=docs(router)%3A%20describe%20your%20change...#L348-L349\n - https://github.com/angular/angular/edit/master/packages/router/src/url_tree.ts?message=docs(router)%3A%20describe%20your%20change...#L350-L352\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/router/src/url_tree.ts#L333-L353\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/router/src/url_tree.ts#L348-L349\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/router/src/url_tree.ts#L350-L352\n-->"
|
|
} |