Uri | monaco-editor

Uniform Resource Identifier (Uri) http://tools.ietf.org/html/rfc3986. This class is a simple parser which creates the basic component parts (http://tools.ietf.org/html/rfc3986#section-3) with minimal validation and encoding.

      foo://example.com:8042/over/there?name=ferret#nose
      \_/   \______________/\_________/ \_________/ \__/
       |           |            |            |        |
    scheme     authority       path        query   fragment
       |   _____________________|__
      / \ /                        \
      urn:example:animal:ferret:nose

Hierarchy

Implements

UriComponents

Index

Properties

Accessors

fsPath

Methods

Properties

Readonly authority

authority: string

authority is the 'www.msft.com' part of 'http://www.msft.com/some/path?query#fragment'. The part between the first double slashes and the next slash.

Readonly fragment

fragment: string

fragment is the 'fragment' part of 'http://www.msft.com/some/path?query#fragment'.

Readonly path

path: string

path is the '/some/path' part of 'http://www.msft.com/some/path?query#fragment'.

Readonly query

query: string

query is the 'query' part of 'http://www.msft.com/some/path?query#fragment'.

Readonly scheme

scheme: string

scheme is the 'http' part of 'http://www.msft.com/some/path?query#fragment'. The part before the first colon.

Accessors

fsPath

get fsPath(): string

- Defined in node_modules/monaco-editor/monaco.d.ts:141
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'
```
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

Methods

toJSON

toJSON(): UriComponents

- Defined in node_modules/monaco-editor/monaco.d.ts:205
Returns UriComponents

toString

toString(skipEncoding?: boolean): string

- Defined in node_modules/monaco-editor/monaco.d.ts:204
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
- Optional skipEncoding: 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

- Defined in node_modules/monaco-editor/monaco.d.ts:142
Parameters
- change: { authority?: string | null; fragment?: string | null; path?: string | null; query?: string | null; scheme?: string }
  - Optional authority?: string | null
  - Optional fragment?: string | null
  - Optional path?: string | null
  - Optional query?: string | null
  - Optional scheme?: string
Returns Uri

Static file

file(path: string): Uri

- Defined in node_modules/monaco-editor/monaco.d.ts:177
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';
```
Parameters
- path: string
  
  A file system path (see Uri#fsPath)
Returns Uri

Static from

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

- Defined in node_modules/monaco-editor/monaco.d.ts:178
Parameters
- components: { authority?: string; fragment?: string; path?: string; query?: string; scheme: string }
  - Optional authority?: string
  - Optional fragment?: string
  - Optional path?: string
  - Optional query?: string
  - scheme: string
Returns Uri

Static isUri

isUri(thing: any): thing is Uri

- Defined in node_modules/monaco-editor/monaco.d.ts:94
Parameters
- thing: any
Returns thing is Uri

Static joinPath

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

- Defined in node_modules/monaco-editor/monaco.d.ts:192
Join a Uri path with path fragments and normalizes the resulting path.

Parameters
- uri: Uri
  
  The input Uri.
- Rest ...pathFragment: string[]
  
  The path fragment to add to the Uri path.
Returns Uri

The resulting Uri.

Static parse

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

- Defined in node_modules/monaco-editor/monaco.d.ts:155
Creates a new Uri from a string, e.g. http://www.msft.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

Static revive

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

- Defined in node_modules/monaco-editor/monaco.d.ts:206
Parameters
- data: UriComponents | Uri
Returns Uri
- Defined in node_modules/monaco-editor/monaco.d.ts:207
Parameters
- data: UriComponents | Uri | undefined
Returns Uri | undefined
- Defined in node_modules/monaco-editor/monaco.d.ts:208
Parameters
- data: UriComponents | Uri | null
Returns Uri | null
- Defined in node_modules/monaco-editor/monaco.d.ts:209
Parameters
- data: UriComponents | Uri | undefined | null
Returns Uri | undefined | null

Hierarchy

Implements

Index

Properties

Accessors

Methods

Properties

Readonly authority

Readonly fragment

Readonly path

Readonly query

Readonly scheme

Accessors

fsPath

Returns string

Methods

toJSON

Returns UriComponents

toString

Parameters

Optional skipEncoding: boolean

Returns string

with

Parameters

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

Optional authority?: string | null

Optional fragment?: string | null

Optional path?: string | null

Optional query?: string | null

Optional scheme?: string

Returns Uri

Static file

Parameters

path: string

Returns Uri

Static from

Parameters

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

Optional authority?: string

Optional fragment?: string

Optional path?: string

Optional query?: string

scheme: string

Returns Uri

Static isUri

Parameters

thing: any

Returns thing is Uri

Static joinPath

Parameters

uri: Uri

Rest ...pathFragment: string[]

Returns Uri

Static parse

Parameters

value: string

Optional _strict: boolean

Returns Uri

Static revive

Parameters

data: UriComponents | Uri

Returns Uri

Parameters

data: UriComponents | Uri | undefined

Returns Uri | undefined

Parameters

data: UriComponents | Uri | null

Returns Uri | null

Parameters

data: UriComponents | Uri | undefined | null

Returns Uri | undefined | null