The document highlight provider interface defines the contract between extensions and the word-highlight-feature.
The document highlight provider interface defines the contract between extensions and the word-highlight-feature.
(provide-document-highlights document-highlight-provider
document
position
token)Provide a set of document highlights, like all occurrences of a variable or all exit-points of a function.
Parameters:
document: TextDocument - The document in which the command was invoked.position: Position - The position at which the command was invoked.token: CancellationToken - A cancellation token.Returns: ProviderResult<DocumentHighlight[]> - An array of document highlights or a thenable that resolves to such. The lack of a result can be
signaled by returning undefined, null, or an empty array.
Provide a set of document highlights, like all occurrences of a variable or all exit-points of a function. **Parameters:** - `document`: `TextDocument` - The document in which the command was invoked. - `position`: `Position` - The position at which the command was invoked. - `token`: `CancellationToken` - A cancellation token. **Returns:** `ProviderResult<DocumentHighlight[]>` - An array of document highlights or a thenable that resolves to such. The lack of a result can be signaled by returning `undefined`, `null`, or an empty array.
cljdoc builds & hosts documentation for Clojure/Script libraries
| Ctrl+k | Jump to recent docs |
| ← | Move to previous article |
| → | Move to next article |
| Ctrl+/ | Jump to the search field |