dots.vscode.uri — io.github.dots-cljs/dots-vscode 1.89.0-5

A universal resource identifier representing either a file on disk or another resource, like untitled resources.

authority cljs

(authority uri)

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

file cljs

(file path)

Create an URI from a file system path. The {@link Uri.scheme scheme} will be file.

The difference between {@link Uri.parse } and {@link 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 or UNC path.

Returns: Uri - A new Uri instance.

fragment cljs

(fragment uri)

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

from cljs

(from components)

Create an URI from its component parts

Parameters:

• components: { readonly scheme: string; readonly authority?: string | undefined; readonly path?: string | undefined; readonly query?: string | undefined; readonly fragment?: string | undefined; } - The component parts of an Uri.

Returns: Uri - A new Uri instance.

fs-path cljs

(fs-path uri)

The string representing the corresponding file system path of this Uri.

Will handle UNC paths and normalize windows drive letters to lower-case. Also 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 resulting string shall not be used for display purposes but for disk operations, like readFile et al.

The difference to the {@linkcode Uri.path path}-property is the use of the platform specific path separator and the handling of UNC paths. The sample below outlines the difference:

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

join-path cljs

(join-path base & path-segments)

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:

• base: Uri - An uri. Must have a path.
• path-segments: string[] - One more more path fragments

Returns: Uri - A new uri which path is joined with the given fragments

parse cljs

(parse value)

(parse value strict?)

Create an URI from a string, e.g. http://www.example.com/some/path, file:///usr/home, or scheme:with/path.

Note that for a while uris without a scheme were accepted. That is not correct as all uris should have a scheme. To avoid breakage of existing code the optional strict-argument has been added. We strongly advise to use it, e.g. Uri.parse('my:uri', true)

Parameters:

• value: string - The string value of an Uri.
• strict?: boolean | undefined - Throw an error when value is empty or when no scheme can be parsed.

Returns: Uri - A new Uri instance.

path cljs

(path uri)

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

query cljs

(query uri)

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

scheme cljs

(scheme uri)

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

to-json cljs

(to-json uri)

Returns a JSON representation of this Uri.

Returns: any - An object.

to-string cljs

(to-string uri)

(to-string uri skip-encoding?)

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 {@link Uri.parse }.
• The resulting string shall not be used for display purposes.

Note that the implementation will encode aggressive which often leads to unexpected, but not incorrect, results. For instance, colons are encoded to %3A which might be unexpected in file-uri. Also & and = will be encoded which might be unexpected for http-uris. For stability reasons this cannot be changed anymore. If you suffer from too aggressive encoding you should use the skipEncoding-argument: uri.toString(true).

Parameters:

• skip-encoding?: boolean | undefined - 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 cljs

(with uri change)

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');

Parameters:

• change: { scheme?: string | undefined; authority?: string | undefined; path?: string | undefined; query?: string | undefined; fragment?: string | undefined; } - 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.