Interface DocumentHighlightProvider

Expand description

The document highlight provider interface defines the contract between extensions and the word-highlight-feature.

interface DocumentHighlightProvider {
    provideDocumentHighlights(
        model: ITextModel,
        position: Position,
        token: CancellationToken,
    ): ProviderResult<DocumentHighlight[]>;
}

Methods§

provideDocumentHighlights(
    model: ITextModel,
    position: Position,
    token: CancellationToken,
): ProviderResult<DocumentHighlight[]>

Provide a set of document highlights, like all occurrences of a variable or all exit-points of a function.