The hover provider interface defines the contract between extensions and the hover-feature.

interface HoverProvider {
    provideHover(model, position, token): ProviderResult<Hover>;
}

Methods

Methods

  • Provide a hover for the given position and document. Multiple hovers at the same position will be merged by the editor. A hover can have a range which defaults to the word range at the position when omitted.

    Parameters

    Returns ProviderResult<Hover>