Interface HoverProvider

provideHover

• provideHover(document: TextDocument, position: Position, token: CancellationToken): ProviderResult<Hover>

• 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

  • 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<Hover>

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