Class Uri

Readonlyauthority

Readonlyfragment

ReadonlyfsPath

Readonlypath

Readonlyquery

Readonlyscheme

toJSON

• toJSON(): any

  Returns a JSON representation of this Uri.

  Returns any

  An object.

toString

• toString(skipEncoding?: boolean): string

  Returns a string representation of this Uri. The representation and normalization of a URI depends on the scheme. The resulting string can be safely used with Uri.parse.

  Parameters

  • OptionalskipEncoding: boolean

    Do not percentage-encode the result, defaults to false. Note that the # and ? characters occurring in the path will always be encoded.

  Returns string

  A string representation of this Uri.

with

• with(
      change: {
          authority?: string;
          fragment?: string;
          path?: string;
          query?: string;
          scheme?: string;
      },
  ): Uri

  Derive a new Uri from this Uri.

  let file = Uri.parse('before:some/file/path');
  let other = file.with({ scheme: 'after' });
  assert.ok(other.toString() === 'after:some/file/path');
  Copy

  Parameters

  • change: {
        authority?: string;
        fragment?: string;
        path?: string;
        query?: string;
        scheme?: string;
    }

    An object that describes a change to this Uri. To unset components use null or the empty string.

  Returns Uri

  A new Uri that reflects the given change. Will return this Uri if the change is not changing anything.

Staticfile

• file(path: string): Uri

  Create an URI from a file system path. The scheme will be file.

  Parameters

  • path: string

    A file system or UNC path.

  Returns Uri

  A new Uri instance.

Staticfrom

• from(
      components: {
          authority?: string;
          fragment?: string;
          path?: string;
          query?: string;
          scheme: string;
      },
  ): Uri

  Create an URI from its component parts

  Parameters

  • components: {
        authority?: string;
        fragment?: string;
        path?: string;
        query?: string;
        scheme: string;
    }

    The component parts of an Uri.

  Returns Uri

  A new Uri instance.

  See

  Uri.toString

StaticjoinPath

• joinPath(uri: Uri, ...pathSegments: string[]): Uri

  Create a new uri which path is the result of joining the path of the base uri with the provided path segments.

  • Note 1: joinPath only affects the path component and all other components (scheme, authority, query, and fragment) are left as they are.
  • Note 2: The base uri must have a path; an error is thrown otherwise.

  The path segments are normalized in the following ways:

  • sequences of path separators (/ or \) are replaced with a single separator
  • for file-uris on windows, the backslash-character (``) is considered a path-separator
  • the ..-segment denotes the parent segment, the . denotes the current segment
  • paths have a root which always remains, for instance on windows drive-letters are roots so that is true: joinPath(Uri.file('file:///c:/root'), '../../other').fsPath === 'c:/other'

  Parameters

  • uri: Uri
  • ...pathSegments: string[]

    One more more path fragments

  Returns Uri

  A new uri which path is joined with the given fragments

Staticparse

• parse(value: string): Uri

  Create an URI from a string. Will throw if the given value is not valid.

  Parameters

  • value: string

    The string value of an Uri.

  Returns Uri

  A new Uri instance.