{ "id": "api/common/upgrade/UrlCodec", "title": "UrlCodec", "contents": "\n\n
\n
\n
\n \n API > @angular/common > @angular/common/upgrade\n
\n
\n mode_edit\n code\n
\n
\n \n
\n

UrlCodeclink

\n \n \n \n \n \n
\n \n \n\n
\n \n
\n

A codec for encoding and decoding URL parts.

\n\n \n
\n \n \n \n
\n\nabstract class UrlCodec {\n abstract encodePath(path: string): string\n abstract decodePath(path: string): string\n abstract encodeSearch(search: string | { [k: string]: unknown; }): string\n abstract decodeSearch(search: string): {...}\n abstract encodeHash(hash: string): string\n abstract decodeHash(hash: string): string\n abstract normalize(href: string): string\n abstract areEqual(valA: string, valB: string): boolean\n abstract parse(url: string, base?: string): {...}\n}\n\n\n \n \n
\n

Subclasseslink

\n \n\n\n\n\n
\n \n\n
\n\n\n \n\n \n \n \n\n\n\n\n\n\n\n\n\n\n\n\n
\n

Methodslink

\n \n \n\n \n \n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n encodePath()\n \n link

\n
\n mode_edit\n code\n
\n
\n
\n

Encodes the path from the provided string

\n\n
\n
\n \n\n abstract encodePath(path: string): string\n\n \n\n
Parameters
\n \n \n \n \n \n \n \n \n \n
\n \n path\n string\n

The path string

\n\n
\n\n \n
Returns
\n

string

\n\n \n\n\n \n\n \n
\n
\n\n \n \n\n \n \n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n decodePath()\n \n link

\n
\n mode_edit\n code\n
\n
\n
\n

Decodes the path from the provided string

\n\n
\n
\n \n\n abstract decodePath(path: string): string\n\n \n\n
Parameters
\n \n \n \n \n \n \n \n \n \n
\n \n path\n string\n

The path string

\n\n
\n\n \n
Returns
\n

string

\n\n \n\n\n \n\n \n
\n
\n\n \n \n\n \n \n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n encodeSearch()\n \n link

\n
\n mode_edit\n code\n
\n
\n
\n

Encodes the search string from the provided string or object

\n\n
\n
\n \n\n abstract encodeSearch(search: string | { [k: string]: unknown; }): string\n\n \n\n
Parameters
\n \n \n \n \n \n \n \n \n \n
\n \n search\n string | { [k: string]: unknown; }\n \n \n
\n\n \n
Returns
\n

string

\n\n \n\n\n \n\n \n
\n
\n\n \n \n\n \n \n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n decodeSearch()\n \n link

\n
\n mode_edit\n code\n
\n
\n
\n

Decodes the search objects from the provided string

\n\n
\n
\n \n\n abstract decodeSearch(search: string): {\n [k: string]: unknown;\n}\n\n \n\n
Parameters
\n \n \n \n \n \n \n \n \n \n
\n \n search\n string\n \n \n
\n\n \n
Returns
\n

`{

\n

}`

\n\n \n\n\n \n\n \n
\n
\n\n \n \n\n \n \n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n encodeHash()\n \n link

\n
\n mode_edit\n code\n
\n
\n
\n

Encodes the hash from the provided string

\n\n
\n
\n \n\n abstract encodeHash(hash: string): string\n\n \n\n
Parameters
\n \n \n \n \n \n \n \n \n \n
\n \n hash\n string\n \n \n
\n\n \n
Returns
\n

string

\n\n \n\n\n \n\n \n
\n
\n\n \n \n\n \n \n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n decodeHash()\n \n link

\n
\n mode_edit\n code\n
\n
\n
\n

Decodes the hash from the provided string

\n\n
\n
\n \n\n abstract decodeHash(hash: string): string\n\n \n\n
Parameters
\n \n \n \n \n \n \n \n \n \n
\n \n hash\n string\n \n \n
\n\n \n
Returns
\n

string

\n\n \n\n\n \n\n \n
\n
\n\n \n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n normalize()\n \n link

\n
\n mode_edit\n code\n
\n
\n
\n

Normalizes the URL from the provided string

\n\n
\n
\n \n\n abstract normalize(href: string): string\n\n \n\n
Parameters
\n \n \n \n \n \n \n \n \n \n
\n \n href\n string\n \n \n
\n\n \n
Returns
\n

string

\n\n \n\n\n \n\n \n
\n
\n
\n \n
\n

Normalizes the URL from the provided string, search, hash, and base URL parameters

\n\n
\n\n abstract normalize(path: string, search: { [k: string]: unknown; }, hash: string, baseUrl?: string): string\n\n \n\n
Parameters
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n \n path\n string\n

The URL path

\n\n
\n \n search\n object\n

The search object

\n\n
\n \n hash\n string\n

The has string

\n\n
\n \n baseUrl\n string\n

The base URL for the URL

\n

Optional. Default is undefined.

\n\n
\n\n \n
Returns
\n

string

\n\n \n\n\n \n\n \n
\n
\n\n \n \n\n \n \n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n areEqual()\n \n link

\n
\n mode_edit\n code\n
\n
\n
\n

Checks whether the two strings are equal

\n\n
\n
\n \n\n abstract areEqual(valA: string, valB: string): boolean\n\n \n\n
Parameters
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n \n valA\n string\n

First string for comparison

\n\n
\n \n valB\n string\n

Second string for comparison

\n\n
\n\n \n
Returns
\n

boolean

\n\n \n\n\n \n\n \n
\n
\n\n \n \n\n \n \n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n parse()\n \n link

\n
\n mode_edit\n code\n
\n
\n
\n

Parses the URL string based on the base URL

\n\n
\n
\n \n\n abstract parse(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}\n\n \n\n
Parameters
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n \n url\n string\n

The full URL string

\n\n
\n \n base\n string\n

The base for the URL

\n

Optional. Default is undefined.

\n\n
\n\n \n
Returns
\n

{ href: string; protocol: string; host: string; search: string; hash: string; hostname: string; port: string; pathname: string; }

\n\n \n\n\n \n\n \n
\n
\n\n \n
\n\n\n\n \n\n\n
\n
\n\n\n" }