Class Uri

Provides an read-only model representation of a uniform resource identifier (URI) and easy access to the parts of the URI.

The read-only model (frozen) is easier for debugging than exposing accessors for each property.

Hierarchy

Implements

UriValues

Index

Constructors

constructor

new Uri(scheme: null | Any, userInfo: null | string, host: null | string, port: null | number, path: null | string, query?: Convertible, fragment?: string): Uri
Parameters
- scheme: null | Any
  
  The user name, password, or other user-specific information associated with the specified URI.
- userInfo: null | string
  
  The host component of this instance.
- host: null | string
  
  The port number of this URI.
- port: null | number
  
  The absolute path of the URI.
- path: null | string
  
  The absolute path of the URI.
- Optional query: Convertible
  
  Any query information included in the specified URI.
- Optional fragment: string
  
  The escaped URI fragment.
Returns Uri
- Defined in Uri.ts:63

Properties

absoluteUri

absoluteUri: string

The absolute URI.

`Readonly` authority

authority: null | string

Gets the Domain Name System (DNS) host name or IP address and the port number for a server.

`Readonly` baseUri

baseUri: string

Gets the full path without the query or fragment.

`Readonly` fragment

fragment: null | string

The escaped URI fragment.

`Readonly` host

host: null | string

The host component of this instance.

`Readonly` path

path: null | string

The absolute path of the URI.

`Readonly` pathAndQuery

pathAndQuery: null | string

Gets the path and Query properties separated by a question mark (?).

`Readonly` port

port: null | number

The port number of this URI.

`Readonly` query

query: null | string

Gets any query information included in the specified URI.

`Readonly` queryParams

queryParams: Readonly<{
[key: string]: Primitive | Primitive[];
}>

`Readonly` scheme

scheme: null | Any

The scheme name for this URI.

`Readonly` userInfo

userInfo: null | string

The user name, password, or other user-specific information associated with the specified URI.

Accessors

pathSegments

get pathSegments(): string[]
The segments that represent a path.
https://msdn.microsoft.com/en-us/library/system.uri.segments%28v=vs.110%29.aspx

Example:
If the path value equals: ```/tree/node/index.html```
The result will be: ```['/','tree/','node/','index.html']```
Returns

Returns string[]
- Defined in Uri.ts:113

Methods

copyTo

copyTo(map: UriValues): UriValues
Parameters
- map: UriValues
Returns UriValues
- Defined in Uri.ts:223

equals

equals(other: UriValues): boolean
Compares the values of another IUri via toString comparison.

Returns
Parameters
- other: UriValues
Returns boolean
- Defined in Uri.ts:218

`Protected` getAbsoluteUri

getAbsoluteUri(): string
Is provided for sub classes to override this value.

Returns string
- Defined in Uri.ts:255

`Protected` getAuthority

getAuthority(): string
Is provided for sub classes to override this value.

Returns string
- Defined in Uri.ts:263

`Protected` getPathAndQuery

getPathAndQuery(): string
Is provided for sub classes to override this value.

Returns string
- Defined in Uri.ts:271

toString

toString(): string
Returns
The full absolute uri.

Returns string
- Defined in Uri.ts:247

toValues

toValues(): UriValues
Creates a writable copy.

Returns

Returns UriValues
- Defined in Uri.ts:239

updateQuery

updateQuery(query: Convertible): Uri
Parameters
- query: Convertible
Returns Uri
- Defined in Uri.ts:228

`Static` copyOf

copyOf(map: UriValues): UriValues
Returns a copy of the specified Uri.

Returns
Parameters
- map: UriValues
Returns UriValues
- Defined in Uri.ts:186

`Static` from

from(uri: undefined | null | string | UriValues, defaults?: UriValues): Uri
Parses or clones values from existing Uri values.

Returns
Parameters
- uri: undefined | null | string | UriValues
- Optional defaults: UriValues
Returns Uri
- Defined in Uri.ts:126

`Static` getAuthority

getAuthority(uri: UriValues): string
Returns the authority segment of an URI.

Returns
Parameters
- uri: UriValues
Returns string
- Defined in Uri.ts:208

`Static` parse

parse(url: string): UriValues
Parses a URL into it's components.

Returns
Will throw an exception if not able to parse.
Parameters
- url: string
  
  The url to parse.
Returns UriValues
- Defined in Uri.ts:150
parse(url: string, throwIfInvalid: true): UriValues
Parameters
- url: string
- throwIfInvalid: true
Returns UriValues
- Defined in Uri.ts:152
parse(url: string, throwIfInvalid: boolean): null | UriValues
Parses a URL into it's components.

Returns
Returns a map of the values or null if invalid and throwIfInvalid is false.
Parameters
- url: string
  
  The url to parse.
- throwIfInvalid: boolean
  
  Defaults to true.
Returns null | UriValues
- Defined in Uri.ts:160

`Static` toString

toString(uri: UriValues): string
Properly converts an existing URI to a string.

Returns
Parameters
- uri: UriValues
Returns string
- Defined in Uri.ts:196

`Static` tryParse

tryParse(url: string, out: ((result: UriValues) => void)): boolean
Parses a URL into it's components.

Returns
True if valid. False if invalid.
Parameters
- url: string
  
  The url to parse.
- out: ((result: UriValues) => void)
  
  A delegate to capture the value.
  - - (result: UriValues): void
    - Parameters
      
      result: UriValues
      
      Returns void
Returns boolean
- Defined in Uri.ts:176

Class Uri

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

scheme: null | Any

userInfo: null | string

host: null | string

port: null | number

path: null | string

Optional query: Convertible

Optional fragment: string

Returns Uri

Properties

absoluteUri

Readonly authority

Readonly baseUri

Readonly fragment

Readonly host

Readonly path

Readonly pathAndQuery

Readonly port

Readonly query

Readonly queryParams

Readonly scheme

Readonly userInfo

Accessors

pathSegments

Example:

Returns

Returns string[]

Methods

copyTo

Parameters

map: UriValues

Returns UriValues

equals

Returns

Parameters

other: UriValues

Returns boolean

Protected getAbsoluteUri

Returns string

Protected getAuthority

Returns string

Protected getPathAndQuery

Returns string

toString

Returns

Returns string

toValues

Returns

Returns UriValues

updateQuery

Parameters

query: Convertible

Returns Uri

Static copyOf

Returns

Parameters

map: UriValues

Returns UriValues

Static from

Returns

Parameters

uri: undefined | null | string | UriValues

Optional defaults: UriValues

Returns Uri

Static getAuthority

Returns

Parameters

uri: UriValues

Returns string

Static parse

`Optional` query: Convertible

`Optional` fragment: string

`Readonly` authority

`Readonly` baseUri

`Readonly` fragment

`Readonly` host

`Readonly` path

`Readonly` pathAndQuery

`Readonly` port

`Readonly` query

`Readonly` queryParams

`Readonly` scheme

`Readonly` userInfo

`Protected` getAbsoluteUri

`Protected` getAuthority

`Protected` getPathAndQuery

`Static` copyOf

`Static` from

`Optional` defaults: UriValues

`Static` getAuthority

`Static` parse

`Static` toString

`Static` tryParse