dots.vscode.diagnostic-collection

Liking cljdoc? Tell your friends :D

ClojureScript only.

clear
delete
dispose
for-each
get
has?
name
set

A diagnostics collection is a container that manages a set of {@link Diagnostic diagnostics}. Diagnostics are always scopes to a diagnostics collection and a resource.

To get an instance of a DiagnosticCollection use {@link languages.createDiagnosticCollection createDiagnosticCollection}.

A diagnostics collection is a container that manages a set of
{@link Diagnostic diagnostics}. Diagnostics are always scopes to a
diagnostics collection and a resource.

To get an instance of a `DiagnosticCollection` use
{@link languages.createDiagnosticCollection createDiagnosticCollection}.

raw docstring

clear^cljs

(clear diagnostic-collection)

Remove all diagnostics from this collection. The same as calling #set(undefined);

Returns: void

Remove all diagnostics from this collection. The same
as calling `#set(undefined)`;

**Returns:** `void`

source raw docstring

delete^cljs

(delete diagnostic-collection uri)

Remove all diagnostics from this collection that belong to the provided uri. The same as #set(uri, undefined).

Parameters:

uri: Uri - A resource identifier.

Returns: void

Remove all diagnostics from this collection that belong
to the provided `uri`. The same as `#set(uri, undefined)`.

**Parameters:**
- `uri`: `Uri` - A resource identifier.

**Returns:** `void`

source raw docstring

dispose^cljs

(dispose diagnostic-collection)

Dispose and free associated resources. Calls {@link DiagnosticCollection.clear clear}.

Returns: void

Dispose and free associated resources. Calls
{@link DiagnosticCollection.clear clear}.

**Returns:** `void`

source raw docstring

for-each^cljs

(for-each diagnostic-collection callback)

(for-each diagnostic-collection callback this-arg)

Iterate over each entry in this collection.

Parameters:

callback: (uri: Uri, diagnostics: readonly Diagnostic[], collection: DiagnosticCollection) => any - Function to execute for each entry.
this-arg: any - The this context used when invoking the handler function.

Returns: void

Iterate over each entry in this collection.

**Parameters:**
- `callback`: `(uri: Uri, diagnostics: readonly Diagnostic[], collection: DiagnosticCollection) => any` - Function to execute for each entry.
- `this-arg`: `any` - The `this` context used when invoking the handler function.

**Returns:** `void`

source raw docstring

get^cljs

(get diagnostic-collection uri)

Get the diagnostics for a given resource. Note that you cannot modify the diagnostics-array returned from this call.

Parameters:

uri: Uri - A resource identifier.

Returns: readonly Diagnostic[] | undefined - An immutable array of {@link Diagnosticdiagnostics} or undefined.

Get the diagnostics for a given resource. *Note* that you cannot
modify the diagnostics-array returned from this call.

**Parameters:**
- `uri`: `Uri` - A resource identifier.

**Returns:** `readonly Diagnostic[] | undefined` - An immutable array of {@link Diagnosticdiagnostics} or `undefined`.

source raw docstring

has?^cljs

(has? diagnostic-collection uri)

Check if this collection contains diagnostics for a given resource.

Parameters:

uri: Uri - A resource identifier.

Returns: boolean - true if this collection has diagnostic for the given resource.

Check if this collection contains diagnostics for a
given resource.

**Parameters:**
- `uri`: `Uri` - A resource identifier.

**Returns:** `boolean` - `true` if this collection has diagnostic for the given resource.

source raw docstring

name^cljs

(name diagnostic-collection)

The name of this diagnostic collection, for instance typescript. Every diagnostic from this collection will be associated with this name. Also, the task framework uses this name when defining problem matchers.

Returns: string

The name of this diagnostic collection, for instance `typescript`. Every diagnostic
from this collection will be associated with this name. Also, the task framework uses this
name when defining [problem matchers](https://code.visualstudio.com/docs/editor/tasks#_defining-a-problem-matcher).

**Returns:** `string`

source raw docstring

set^cljs

(set diagnostic-collection entries)

(set diagnostic-collection uri)

(set diagnostic-collection uri diagnostics)

Assign diagnostics for given resource. Will replace existing diagnostics for that resource. Replace diagnostics for multiple resources in this collection.

Note that multiple tuples of the same uri will be merged, e.g [[file1, [d1]], [file1, [d2]]] is equivalent to [[file1, [d1, d2]]]. If a diagnostics item is undefined as in [file1, undefined] all previous but not subsequent diagnostics are removed.

Parameters:

entries: readonly [Uri, readonly Diagnostic[] | undefined][] - An array of tuples, like [[file1, [d1, d2]], [file2, [d3, d4, d5]]], or undefined.
uri: Uri - A resource identifier.
diagnostics: readonly Diagnostic[] | undefined - Array of diagnostics or undefined

Returns: void

Assign diagnostics for given resource. Will replace
existing diagnostics for that resource.
Replace diagnostics for multiple resources in this collection.

 _Note_ that multiple tuples of the same uri will be merged, e.g
`[[file1, [d1]], [file1, [d2]]]` is equivalent to `[[file1, [d1, d2]]]`.
If a diagnostics item is `undefined` as in `[file1, undefined]`
all previous but not subsequent diagnostics are removed.

**Parameters:**
- `entries`: `readonly [Uri, readonly Diagnostic[] | undefined][]` - An array of tuples, like `[[file1, [d1, d2]], [file2, [d3, d4, d5]]]`, or `undefined`.
- `uri`: `Uri` - A resource identifier.
- `diagnostics`: `readonly Diagnostic[] | undefined` - Array of diagnostics or `undefined`

**Returns:** `void`

source raw docstring