Class Uri

constructor

• new Uri(): Uri

  Returns Uri

Readonlyauthority

Readonlyfragment

Readonlypath

Readonlyquery

Readonlyscheme

fsPath

• get fsPath(): string

  Returns a string representing the corresponding file system path of this Uri. Will handle UNC paths, normalizes windows drive letters to lower-case, and uses the platform specific path separator.

  • Will not validate the path for invalid characters and semantics.
  • Will not look at the scheme of this Uri.
  • The result shall not be used for display purposes but for accessing a file on disk.

  The difference to Uri#path is the use of the platform specific separator and the handling of UNC paths. See the below sample of a file-uri with an authority (UNC path).

     const u = Uri.parse('file://server/c$/folder/file.txt')
     u.authority === 'server'
     u.path === '/shares/c$/file.txt'
     u.fsPath === '\\server\c$\folder\file.txt'
  Copy

  Using Uri#path to read a file (using fs-apis) would not be enough because parts of the path, namely the server name, would be missing. Therefore Uri#fsPath exists - it's sugar to ease working with URIs that represent files on disk (file scheme).

  Returns string

toJSON

• toJSON(): UriComponents

  Returns UriComponents

toString

• toString(skipEncoding?: boolean): string

  Creates a string representation for this Uri. It's guaranteed that calling Uri.parse with the result of this function creates an Uri which is equal to this Uri.

  • The result shall not be used for display purposes but for externalization or transport.
  • The result will be encoded using the percentage encoding and encoding happens mostly ignore the scheme-specific encoding rules.

  Parameters

  • OptionalskipEncoding: boolean

    Do not encode the result, default is false

  Returns string

with

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

  Parameters

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

  Returns Uri

Staticfile

• file(path: string): Uri

  Creates a new Uri from a file system path, e.g. c:\my\files, /usr/home, or \\server\share\some\path.

  The difference between Uri#parse and Uri#file is that the latter treats the argument as path, not as stringified-uri. E.g. Uri.file(path) is not the same as Uri.parse('file://' + path) because the path might contain characters that are interpreted (# and ?). See the following sample:

  const good = Uri.file('/coding/c#/project1');
  good.scheme === 'file';
  good.path === '/coding/c#/project1';
  good.fragment === '';
  const bad = Uri.parse('file://' + '/coding/c#/project1');
  bad.scheme === 'file';
  bad.path === '/coding/c'; // path is now broken
  bad.fragment === '/project1';
  Copy

  Parameters

  • path: string

    A file system path (see Uri#fsPath)

  Returns Uri

Staticfrom

• from(components: UriComponents, strict?: boolean): Uri

  Creates new Uri from uri components.

  Unless strict is true the scheme is defaults to be file. This function performs validation and should be used for untrusted uri components retrieved from storage, user input, command arguments etc

  Parameters

  • components: UriComponents
  • Optionalstrict: boolean

  Returns Uri

StaticisUri

• isUri(thing: any): thing is Uri

  Parameters

  • thing: any

  Returns thing is Uri

StaticjoinPath

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

  Join a Uri path with path fragments and normalizes the resulting path.

  Parameters

  • uri: Uri

    The input Uri.

  • ...pathFragment: string[]

    The path fragment to add to the Uri path.

  Returns Uri

  The resulting Uri.

Staticparse

• parse(value: string, _strict?: boolean): Uri

  Creates a new Uri from a string, e.g. http://www.example.com/some/path, file:///usr/home, or scheme:with/path.

  Parameters

  • value: string

    A string which represents an Uri (see Uri#toString).

  • Optional_strict: boolean

  Returns Uri

Staticrevive

• revive(data: Uri | UriComponents): Uri

  A helper function to revive URIs.

  Note that this function should only be used when receiving Uri#toJSON generated data and that it doesn't do any validation. Use Uri.from when received "untrusted" uri components such as command arguments or data from storage.

  Parameters

  • data: Uri | UriComponents

    The Uri components or Uri to revive.

  Returns Uri

  The revived Uri or undefined or null.

• revive(data: Uri | UriComponents | undefined): Uri | undefined

  A helper function to revive URIs.

  Note that this function should only be used when receiving Uri#toJSON generated data and that it doesn't do any validation. Use Uri.from when received "untrusted" uri components such as command arguments or data from storage.

  Parameters

  • data: Uri | UriComponents | undefined

    The Uri components or Uri to revive.

  Returns Uri | undefined

  The revived Uri or undefined or null.

• revive(data: Uri | UriComponents | null): Uri | null

  A helper function to revive URIs.

  Note that this function should only be used when receiving Uri#toJSON generated data and that it doesn't do any validation. Use Uri.from when received "untrusted" uri components such as command arguments or data from storage.

  Parameters

  • data: Uri | UriComponents | null

    The Uri components or Uri to revive.

  Returns Uri | null

  The revived Uri or undefined or null.

• revive(data: Uri | UriComponents | null | undefined): Uri | null | undefined

  A helper function to revive URIs.

  Note that this function should only be used when receiving Uri#toJSON generated data and that it doesn't do any validation. Use Uri.from when received "untrusted" uri components such as command arguments or data from storage.

  Parameters

  • data: Uri | UriComponents | null | undefined

    The Uri components or Uri to revive.

  Returns Uri | null | undefined

  The revived Uri or undefined or null.