The hover provider interface defines the contract between extensions and the hover-feature.
Fields
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 | The document in which the command was invoked. |
|---|---|
position | The position at which the command was invoked. |
token | A cancellation token. |
Returns:
A hover or a thenable that resolves to such. The lack of a result can be
signaled by returning undefined or null.