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

AngularJSUrlCodeclink

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

A UrlCodec that uses logic from AngularJS to serialize and parse URLs\nand URL parameters.

\n\n \n
\n \n \n \n
\n\nclass AngularJSUrlCodec implements UrlCodec {\n encodePath(path: string): string\n encodeSearch(search: string | { [k: string]: unknown; }): string\n encodeHash(hash: string)\n decodePath(path: string, html5Mode: boolean = true): string\n decodeSearch(search: string)\n decodeHash(hash: string)\n normalize(pathOrHref: string, search?: { [k: string]: unknown; }, hash?: string, baseUrl?: string): string\n areEqual(valA: string, valB: string)\n parse(url: string, base?: 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

Methodslink

\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
\n
\n
\n \n\n 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 \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 encodeSearch()\n \n link

\n \n
\n
\n
\n \n\n 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 encodeHash()\n \n link

\n \n
\n
\n
\n \n\n encodeHash(hash: 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\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
\n
\n
\n \n\n decodePath(path: string, html5Mode: boolean = true): string\n\n \n\n
Parameters
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n \n path\n string\n \n \n
\n \n html5Mode\n boolean\n

Optional. Default is true.

\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 decodeSearch()\n \n link

\n \n
\n
\n
\n \n\n decodeSearch(search: string)\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\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
\n
\n
\n \n\n decodeHash(hash: 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\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
\n
\n
\n \n\n 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 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 \n \n
\n \n search\n object\n \n \n
\n \n hash\n string\n \n \n
\n \n baseUrl\n string\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 areEqual()\n \n link

\n \n
\n
\n
\n \n\n areEqual(valA: string, valB: string)\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 \n \n
\n \n valB\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 parse()\n \n link

\n \n
\n
\n
\n \n\n parse(url: string, base?: string)\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 \n \n
\n \n base\n string\n

Optional. Default is undefined.

\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" }