dots.vscode.file-decoration-provider
The decoration provider interfaces defines the contract between extensions and file decorations.
The decoration provider interfaces defines the contract between extensions and file decorations.
on-did-change-file-decorationscljs
(on-did-change-file-decorations file-decoration-provider)(on-did-change-file-decorations file-decoration-provider listener)(on-did-change-file-decorations file-decoration-provider listener this-args)(on-did-change-file-decorations file-decoration-provider
listener
this-args
disposables)An optional event to signal that decorations for one or many files have changed.
Note that this event should be used to propagate information about children.
Parameters:
listener:(e: T) => any- The listener function will be called when the event happens.this-args:any- Thethis-argument which will be used when calling the event listener.disposables:Disposable[] | undefined- An array to which a {@link Disposable } will be added.
Returns: Disposable - A disposable which unsubscribes the event listener.
An optional event to signal that decorations for one or many files have changed.
*Note* that this event should be used to propagate information about children.
**Parameters:**
- `listener`: `(e: T) => any` - The listener function will be called when the event happens.
- `this-args`: `any` - The `this`-argument which will be used when calling the event listener.
- `disposables`: `Disposable[] | undefined` - An array to which a {@link Disposable } will be added.
**Returns:** `Disposable` - A disposable which unsubscribes the event listener.provide-file-decorationcljs
(provide-file-decoration file-decoration-provider uri token)Provide decorations for a given uri.
Note that this function is only called when a file gets rendered in the UI. This means a decoration from a descendent that propagates upwards must be signaled to the editor via the {@link FileDecorationProvider.onDidChangeFileDecorations onDidChangeFileDecorations}-event.
Parameters:
uri:Uri- The uri of the file to provide a decoration for.token:CancellationToken- A cancellation token.
Returns: ProviderResult<FileDecoration> - A decoration or a thenable that resolves to such.
Provide decorations for a given uri.
*Note* that this function is only called when a file gets rendered in the UI.
This means a decoration from a descendent that propagates upwards must be signaled
to the editor via the {@link FileDecorationProvider.onDidChangeFileDecorations onDidChangeFileDecorations}-event.
**Parameters:**
- `uri`: `Uri` - The uri of the file to provide a decoration for.
- `token`: `CancellationToken` - A cancellation token.
**Returns:** `ProviderResult<FileDecoration>` - A decoration or a thenable that resolves to such.set-on-did-change-file-decorations!cljs
(set-on-did-change-file-decorations! file-decoration-provider value)An optional event to signal that decorations for one or many files have changed.
Note that this event should be used to propagate information about children.
An optional event to signal that decorations for one or many files have changed. *Note* that this event should be used to propagate information about children.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close