W3cubDocs

/Angular

AngularJSUrlCodec

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

API

class AngularJSUrlCodec implements UrlCodec {
  encodePath(path: string): string;
  encodeSearch(search: string | { [k: string]: unknown; }): string;
  encodeHash(hash: string): string;
  decodePath(path: string, html5Mode?: boolean): string;
  decodeSearch(search: string): { [k: string]: unknown; };
  decodeHash(hash: string): string;
  normalize(href: string): string;
  normalize(path: string, search: { [k: string]: unknown; }, hash: string, baseUrl?: string | undefined): string;
  areEqual(valA: string, valB: string): boolean;
  parse(url: string, base?: string | undefined): { href: string; protocol: string; host: string; search: string; hash: string; hostname: string; port: string; pathname: string; };
}

encodePath

string
@parampathstring
@returnsstring

encodeSearch

string
@paramsearchstring | { [k: string]: unknown; }
@returnsstring

encodeHash

string
@paramhashstring
@returnsstring

decodePath

string
@parampathstring
@paramhtml5Modeboolean
@returnsstring

decodeSearch

{ [k: string]: unknown; }
@paramsearchstring
@returns{ [k: string]: unknown; }

decodeHash

string
@paramhashstring
@returnsstring

normalize

2 overloads
@paramhrefstring
@returnsstring
@parampathstring
@paramsearch{ [k: string]: unknown; }
@paramhashstring
@parambaseUrlstring | undefined
@returnsstring

areEqual

boolean
@paramvalAstring
@paramvalBstring
@returnsboolean

parse

{ href: string; protocol: string; host: string; search: string; hash: string; hostname: string; port: string; pathname: string; }
@paramurlstring
@parambasestring | undefined
@returns{ href: string; protocol: string; host: string; search: string; hash: string; hostname: string; port: string; pathname: string; }

Super-powered by Google ©2010–2025.
Code licensed under an MIT-style License. Documentation licensed under CC BY 4.0.
https://angular.dev/api/common/upgrade/AngularJSUrlCodec