VS Code API
    Preparing search index...

    Interface HoverProvider

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

    interface HoverProvider {
        provideHover(
            document: TextDocument,
            position: Position,
            token: CancellationToken,
        ): ProviderResult<Hover>;
    }
    Index

    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>

      A hover or a thenable that resolves to such. The lack of a result can be signaled by returning undefined or null.