Class Uri

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.
  • Optionalquery: Convertible

    Any query information included in the specified URI.
  • Optionalfragment: string

    The escaped URI fragment.

  Returns Uri

absoluteUri

Readonlyauthority

ReadonlybaseUri

Readonlyfragment

Readonlyhost

Readonlypath

ReadonlypathAndQuery

Readonlyport

Readonlyquery

ReadonlyqueryParams

Readonlyscheme

ReadonlyuserInfo

pathSegments

• get pathSegments(): string[]

  The segments that represent a path.
  https://msdn.microsoft.com/en-us/library/system.uri.segments(v=vs.110).aspx

  Example:

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

  Returns string[]

copyTo

• copyTo(map: UriValues): UriValues

  Parameters

  • map: UriValues

  Returns UriValues

equals

• equals(other: UriValues): boolean

  Compares the values of another IUri via toString comparison.

  Parameters

  • other: UriValues

  Returns boolean

toString

• toString(): string

  Returns string

  The full absolute uri.

toValues

• toValues(): UriValues

  Creates a writable copy.

  Returns UriValues

updateQuery

• updateQuery(query: Convertible): Uri

  Parameters

  • query: Convertible

  Returns Uri

StaticcopyOf

• copyOf(map: UriValues): UriValues

  Returns a copy of the specified Uri.

  Parameters

  • map: UriValues

  Returns UriValues

Staticfrom

• from(uri: undefined | null | string | UriValues, defaults?: UriValues): Uri

  Parses or clones values from existing Uri values.

  Parameters

  • uri: undefined | null | string | UriValues
  • Optionaldefaults: UriValues

  Returns Uri

StaticgetAuthority

• getAuthority(uri: UriValues): string

  Returns the authority segment of an URI.

  Parameters

  • uri: UriValues

  Returns string

Staticparse

• parse(url: string): UriValues

  Parses a URL into it's components.

  Parameters

  • url: string

    The url to parse.

  Returns UriValues

  Will throw an exception if not able to parse.
• parse(url: string, throwIfInvalid: true): UriValues

  Parses a URL into it's components.

  Parameters

  • url: string

    The url to parse.
  • throwIfInvalid: true

  Returns UriValues

  Will throw an exception if not able to parse.
• parse(url: string, throwIfInvalid: boolean): null | UriValues

  Parses a URL into it's components.

  Parameters

  • url: string

    The url to parse.
  • throwIfInvalid: boolean

    Defaults to true.

  Returns null | UriValues

  Returns a map of the values or null if invalid and throwIfInvalid is false.

StatictoString

• toString(uri: UriValues): string

  Properly converts an existing URI to a string.

  Parameters

  • uri: UriValues

  Returns string

StatictryParse

• tryParse(url: string, out: (result: UriValues) => void): boolean

  Parses a URL into it's components.

  Parameters

  • url: string

    The url to parse.
  • out: (result: UriValues) => void

    A delegate to capture the value.

  Returns boolean

  True if valid. False if invalid.