Liking cljdoc? Tell your friends :D

dots.vscode.relative-pattern

A relative pattern is a helper to construct glob patterns that are matched relatively to a base file path. The base path can either be an absolute file path as string or uri or a {@link WorkspaceFolder workspace folder}, which is the preferred way of creating the relative pattern.

A relative pattern is a helper to construct glob patterns that are matched
relatively to a base file path. The base path can either be an absolute file
path as string or uri or a {@link WorkspaceFolder workspace folder}, which is the
preferred way of creating the relative pattern.
raw docstring

basecljs

(base relative-pattern)

A base file path to which this pattern will be matched against relatively.

This matches the fsPath value of {@link RelativePattern.baseUri }.

Note: updating this value will update {@link RelativePattern.baseUri } to be a uri with file scheme.

Returns: string

A base file path to which this pattern will be matched against relatively.

This matches the `fsPath` value of {@link RelativePattern.baseUri }.

*Note:* updating this value will update {@link RelativePattern.baseUri } to
be a uri with `file` scheme.

**Returns:** `string`
sourceraw docstring

base-uricljs

(base-uri relative-pattern)

A base file path to which this pattern will be matched against relatively. The file path must be absolute, should not have any trailing path separators and not include any relative segments (. or ..).

Returns: Uri

A base file path to which this pattern will be matched against relatively. The
file path must be absolute, should not have any trailing path separators and
not include any relative segments (`.` or `..`).

**Returns:** `Uri`
sourceraw docstring

patterncljs

(pattern relative-pattern)

A file glob pattern like *.{ts,js} that will be matched on file paths relative to the base path.

Example: Given a base of /home/work/folder and a file path of /home/work/folder/index.js, the file glob pattern will match on index.js.

Returns: string

A file glob pattern like `*.{ts,js}` that will be matched on file paths
relative to the base path.

Example: Given a base of `/home/work/folder` and a file path of `/home/work/folder/index.js`,
the file glob pattern will match on `index.js`.

**Returns:** `string`
sourceraw docstring

set-base!cljs

(set-base! relative-pattern value)

A base file path to which this pattern will be matched against relatively.

This matches the fsPath value of {@link RelativePattern.baseUri }.

Note: updating this value will update {@link RelativePattern.baseUri } to be a uri with file scheme.

A base file path to which this pattern will be matched against relatively.

This matches the `fsPath` value of {@link RelativePattern.baseUri }.

*Note:* updating this value will update {@link RelativePattern.baseUri } to
be a uri with `file` scheme.
sourceraw docstring

set-base-uri!cljs

(set-base-uri! relative-pattern value)

A base file path to which this pattern will be matched against relatively. The file path must be absolute, should not have any trailing path separators and not include any relative segments (. or ..).

A base file path to which this pattern will be matched against relatively. The
file path must be absolute, should not have any trailing path separators and
not include any relative segments (`.` or `..`).
sourceraw docstring

set-pattern!cljs

(set-pattern! relative-pattern value)

A file glob pattern like *.{ts,js} that will be matched on file paths relative to the base path.

Example: Given a base of /home/work/folder and a file path of /home/work/folder/index.js, the file glob pattern will match on index.js.

A file glob pattern like `*.{ts,js}` that will be matched on file paths
relative to the base path.

Example: Given a base of `/home/work/folder` and a file path of `/home/work/folder/index.js`,
the file glob pattern will match on `index.js`.
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close