This site uses cookies from Google to deliver its services and to analyze traffic.
Learn more
Skip to main content
Say hello to Angular's future home!Check out Angular.devHome
/
API > @angular/common > @angular/common/upgrade

UrlCodec

A codec for encoding and decoding URL parts.

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

Subclasses

Methods

encodePath()

Encodes the path from the provided string

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

The path string
Returns

string

decodePath()

Decodes the path from the provided string

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

The path string
Returns

string

encodeSearch()

Encodes the search string from the provided string or object

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

string

decodeSearch()

Decodes the search objects from the provided string

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

`{

}`

encodeHash()

Encodes the hash from the provided string

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

string

decodeHash()

Decodes the hash from the provided string

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

string

normalize()

Normalizes the URL from the provided string

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

string

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

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

The URL path
search object

The search object
hash string

The has string
baseUrl string

The base URL for the URL

Optional. Default is undefined.
Returns

string

areEqual()

Checks whether the two strings are equal

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

First string for comparison
valB string

Second string for comparison
Returns

boolean

parse()

Parses the URL string based on the base URL

 
      
      abstract parse(url: string, base?: string): {
    href: string;
    protocol: string;
    host: string;
    search: string;
    hash: string;
    hostname: string;
    port: string;
    pathname: string;
}
Parameters
url string

The full URL string
base string

The base for the URL

Optional. Default is undefined.
Returns

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