dots.vscode.l-10n.uri

Liking cljdoc? Tell your friends :D

ClojureScript only.

authority
fragment
fs-path
path
query
scheme
to-json
to-string
with

The URI of the localization bundle that has been loaded for the extension. It's undefined if no bundle has been loaded. The bundle is typically not loaded if there was no bundle found or when we are running with the default language.

The URI of the localization bundle that has been loaded for the extension.
It's undefined if no bundle has been loaded. The bundle is typically not loaded if
there was no bundle found or when we are running with the default language.

raw docstring

authority^cljs

(authority)

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.

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.

source raw docstring

fragment^cljs

(fragment)

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

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

source raw docstring

fs-path^cljs

(fs-path)

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'

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:
```ts
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'
```

source raw docstring

path^cljs

(path)

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

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

source raw docstring

query^cljs

(query)

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

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

source raw docstring

scheme^cljs

(scheme)

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

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

source raw docstring

to-json^cljs

(to-json)

Returns a JSON representation of this Uri.

Returns: any - An object.

Returns a JSON representation of this Uri.

**Returns:** `any` - An object.

source raw docstring

to-string^cljs

(to-string)

(to-string 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.

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.

source raw docstring

with^cljs

(with 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.

Derive a new Uri from this Uri.

```ts
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.

source raw docstring