5 lines
127 KiB
JSON
5 lines
127 KiB
JSON
{
|
|
"id": "api/common/upgrade/UrlCodec",
|
|
"title": "UrlCodec",
|
|
"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/common\", \"name\": \"@angular/common\" } },\n { \"@type\": \"ListItem\", \"position\": 3, \"item\": { \"@id\": \"https://angular.io/api/common/upgrade\", \"name\": \"@angular/common/upgrade\" } },\n { \"@type\": \"ListItem\", \"position\": 4, \"item\": { \"@id\": \"https://angular.io/api/common/upgrade/UrlCodec\", \"name\": \"UrlCodec\" } }\n ]\n }\n </script>\n <a href=\"/api\">API</a> > <a href=\"api/common\">@angular/common</a> > <a href=\"api/common/upgrade\">@angular/common/upgrade</a>\n </div>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/common/upgrade/src/params.ts?message=docs(common)%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 <a href=\"https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/upgrade/src/params.ts\" 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=\"urlcodec\">UrlCodec<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/upgrade/UrlCodec#urlcodec\"><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>A codec for encoding and decoding URL parts.</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/common/upgrade/UrlCodec\" class=\"code-anchor\">UrlCodec</a> {\n <a class=\"code-anchor\" href=\"api/common/upgrade/UrlCodec#encodePath\">abstract <span class=\"member-name\">encodePath</span>(path: string): string</a>\n <a class=\"code-anchor\" href=\"api/common/upgrade/UrlCodec#decodePath\">abstract <span class=\"member-name\">decodePath</span>(path: string): string</a>\n <a class=\"code-anchor\" href=\"api/common/upgrade/UrlCodec#encodeSearch\">abstract <span class=\"member-name\">encodeSearch</span>(search: string | { [k: string]: unknown; }): string</a>\n <a class=\"code-anchor\" href=\"api/common/upgrade/UrlCodec#decodeSearch\">abstract <span class=\"member-name\">decodeSearch</span>(search: string): {...}</a>\n <a class=\"code-anchor\" href=\"api/common/upgrade/UrlCodec#encodeHash\">abstract <span class=\"member-name\">encodeHash</span>(hash: string): string</a>\n <a class=\"code-anchor\" href=\"api/common/upgrade/UrlCodec#decodeHash\">abstract <span class=\"member-name\">decodeHash</span>(hash: string): string</a>\n <a class=\"code-anchor\" href=\"api/common/upgrade/UrlCodec#normalize\">abstract <span class=\"member-name\">normalize</span>(href: string): string</a>\n <a class=\"code-anchor\" href=\"api/common/upgrade/UrlCodec#areEqual\">abstract <span class=\"member-name\">areEqual</span>(valA: string, valB: string): boolean</a>\n <a class=\"code-anchor\" href=\"api/common/upgrade/UrlCodec#parse\">abstract <span class=\"member-name\">parse</span>(url: string, base?: 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/common/upgrade/UrlCodec#subclasses\"><i class=\"material-icons\">link</i></a></h2>\n \n\n<ul>\n \n <li>\n <code><a href=\"api/common/upgrade/AngularJSUrlCodec\" class=\"code-anchor\">AngularJSUrlCodec</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 \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/common/upgrade/UrlCodec#methods\"><i class=\"material-icons\">link</i></a></h2>\n \n <a id=\"encodePath\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"encodepath\">\n encodePath()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/upgrade/UrlCodec#encodepath\"><i class=\"material-icons\">link</i></a></h3>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/common/upgrade/src/params.ts?message=docs(common)%3A%20describe%20your%20change...#L15-L20\" 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/common/upgrade/src/params.ts#L15-L20\" 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>Encodes the path from the provided string</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\">encodePath</span>(path: string): string</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>path</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The path string</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns\">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 <a id=\"decodePath\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"decodepath\">\n decodePath()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/upgrade/UrlCodec#decodepath\"><i class=\"material-icons\">link</i></a></h3>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/common/upgrade/src/params.ts?message=docs(common)%3A%20describe%20your%20change...#L21-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/common/upgrade/src/params.ts#L21-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>Decodes the path from the provided string</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\">decodePath</span>(path: string): 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>path</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The path string</p>\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 <a id=\"encodeSearch\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"encodesearch\">\n encodeSearch()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/upgrade/UrlCodec#encodesearch\"><i class=\"material-icons\">link</i></a></h3>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/common/upgrade/src/params.ts?message=docs(common)%3A%20describe%20your%20change...#L28-L34\" 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/common/upgrade/src/params.ts#L28-L34\" 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>Encodes the search string from the provided string or object</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\">encodeSearch</span>(search: string | { [k: string]: unknown; }): string</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>search</code>\n </td>\n <td class=\"param-type\"><code>string | { [k: string]: unknown; }</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>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 <a id=\"decodeSearch\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"decodesearch\">\n decodeSearch()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/upgrade/UrlCodec#decodesearch\"><i class=\"material-icons\">link</i></a></h3>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/common/upgrade/src/params.ts?message=docs(common)%3A%20describe%20your%20change...#L35-L41\" 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/common/upgrade/src/params.ts#L35-L41\" 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>Decodes the search objects from the provided string</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\">decodeSearch</span>(search: string): {\n [k: string]: unknown;\n}</code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-3\">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>search</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-3\">Returns</h6>\n <p>`{</p>\n<p>}`</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=\"encodeHash\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"encodehash\">\n encodeHash()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/upgrade/UrlCodec#encodehash\"><i class=\"material-icons\">link</i></a></h3>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/common/upgrade/src/params.ts?message=docs(common)%3A%20describe%20your%20change...#L42-L48\" 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/common/upgrade/src/params.ts#L42-L48\" 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>Encodes the hash from the provided string</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\">encodeHash</span>(hash: string): string</code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-4\">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>hash</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-4\">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 <a id=\"decodeHash\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"decodehash\">\n decodeHash()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/upgrade/UrlCodec#decodehash\"><i class=\"material-icons\">link</i></a></h3>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/common/upgrade/src/params.ts?message=docs(common)%3A%20describe%20your%20change...#L49-L55\" 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/common/upgrade/src/params.ts#L49-L55\" 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>Decodes the hash from the provided string</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\">decodeHash</span>(hash: string): string</code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-5\">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>hash</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-5\">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 <a id=\"normalize\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"normalize\">\n normalize()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/upgrade/UrlCodec#normalize\"><i class=\"material-icons\">link</i></a></h3>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/common/upgrade/src/params.ts?message=docs(common)%3A%20describe%20your%20change...#L56-L62\" 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/common/upgrade/src/params.ts#L56-L62\" 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>Normalizes the URL from the provided string</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\">normalize</span>(href: string): string</code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-6\">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>href</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-6\">Returns</h6>\n <p><code>string</code></p>\n\n \n\n\n \n\n \n</div>\n </td>\n </tr>\n \n <tr>\n <td>\n <div class=\"overload-info\">\n \n <div class=\"short-description\">\n <p>Normalizes the URL from the provided string, search, hash, and base URL parameters</p>\n\n </div>\n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\">abstract <span class=\"member-name\">normalize</span>(path: string, search: { [k: string]: unknown; }, hash: string, baseUrl?: string): string</code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-7\">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>path</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The URL path</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>search</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>The search object</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>hash</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The has string</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>baseUrl</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The base URL for the URL</p>\n<p> Optional. Default is <code>undefined</code>.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-7\">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 <a id=\"areEqual\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"areequal\">\n areEqual()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/upgrade/UrlCodec#areequal\"><i class=\"material-icons\">link</i></a></h3>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/common/upgrade/src/params.ts?message=docs(common)%3A%20describe%20your%20change...#L75-L81\" 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/common/upgrade/src/params.ts#L75-L81\" 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>Checks whether the two strings are equal</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\">areEqual</span>(valA: string, valB: string): boolean</code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-8\">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>valA</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>First string for comparison</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>valB</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>Second string for comparison</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-8\">Returns</h6>\n <p><code>boolean</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=\"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/common/upgrade/UrlCodec#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/common/upgrade/src/params.ts?message=docs(common)%3A%20describe%20your%20change...#L82-L98\" 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/common/upgrade/src/params.ts#L82-L98\" 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>Parses the URL string based on the base 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\">parse</span>(url: string, base?: string): {\n href: string;\n protocol: string;\n host: string;\n search: string;\n hash: string;\n hostname: string;\n port: string;\n pathname: string;\n}</code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-9\">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 <p>The full URL string</p>\n\n </td>\n </tr>\n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>base</code>\n </td>\n <td class=\"param-type\"><code>string</code></td>\n <td class=\"param-description\">\n <p>The base for the URL</p>\n<p> Optional. Default is <code>undefined</code>.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-9\">Returns</h6>\n <p><code>{ href: string; protocol: string; host: string; search: string; hash: string; hostname: string; port: string; pathname: 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/common/upgrade\n - api/common/upgrade/$locationShim\n - api/common/upgrade/$locationShimProvider\n - api/common/upgrade/AngularJSUrlCodec\n - api/common/upgrade/LocationUpgradeConfig\n-->\n<!-- links from this doc:\n - /api\n - api/common\n - api/common/upgrade\n - api/common/upgrade/AngularJSUrlCodec\n - api/common/upgrade/UrlCodec#areEqual\n - api/common/upgrade/UrlCodec#areequal\n - api/common/upgrade/UrlCodec#decodeHash\n - api/common/upgrade/UrlCodec#decodePath\n - api/common/upgrade/UrlCodec#decodeSearch\n - api/common/upgrade/UrlCodec#decodehash\n - api/common/upgrade/UrlCodec#decodepath\n - api/common/upgrade/UrlCodec#decodesearch\n - api/common/upgrade/UrlCodec#encodeHash\n - api/common/upgrade/UrlCodec#encodePath\n - api/common/upgrade/UrlCodec#encodeSearch\n - api/common/upgrade/UrlCodec#encodehash\n - api/common/upgrade/UrlCodec#encodepath\n - api/common/upgrade/UrlCodec#encodesearch\n - api/common/upgrade/UrlCodec#methods\n - api/common/upgrade/UrlCodec#normalize\n - api/common/upgrade/UrlCodec#parse\n - api/common/upgrade/UrlCodec#subclasses\n - api/common/upgrade/UrlCodec#urlcodec\n - https://github.com/angular/angular/edit/master/packages/common/upgrade/src/params.ts?message=docs(common)%3A%20describe%20your%20change...\n - https://github.com/angular/angular/edit/master/packages/common/upgrade/src/params.ts?message=docs(common)%3A%20describe%20your%20change...#L15-L20\n - https://github.com/angular/angular/edit/master/packages/common/upgrade/src/params.ts?message=docs(common)%3A%20describe%20your%20change...#L21-L27\n - https://github.com/angular/angular/edit/master/packages/common/upgrade/src/params.ts?message=docs(common)%3A%20describe%20your%20change...#L28-L34\n - https://github.com/angular/angular/edit/master/packages/common/upgrade/src/params.ts?message=docs(common)%3A%20describe%20your%20change...#L35-L41\n - https://github.com/angular/angular/edit/master/packages/common/upgrade/src/params.ts?message=docs(common)%3A%20describe%20your%20change...#L42-L48\n - https://github.com/angular/angular/edit/master/packages/common/upgrade/src/params.ts?message=docs(common)%3A%20describe%20your%20change...#L49-L55\n - https://github.com/angular/angular/edit/master/packages/common/upgrade/src/params.ts?message=docs(common)%3A%20describe%20your%20change...#L56-L62\n - https://github.com/angular/angular/edit/master/packages/common/upgrade/src/params.ts?message=docs(common)%3A%20describe%20your%20change...#L75-L81\n - https://github.com/angular/angular/edit/master/packages/common/upgrade/src/params.ts?message=docs(common)%3A%20describe%20your%20change...#L82-L98\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/upgrade/src/params.ts\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/upgrade/src/params.ts#L15-L20\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/upgrade/src/params.ts#L21-L27\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/upgrade/src/params.ts#L28-L34\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/upgrade/src/params.ts#L35-L41\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/upgrade/src/params.ts#L42-L48\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/upgrade/src/params.ts#L49-L55\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/upgrade/src/params.ts#L56-L62\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/upgrade/src/params.ts#L75-L81\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/upgrade/src/params.ts#L82-L98\n-->"
|
|
} |