Interface DeclarationProvider

The declaration provider interface defines the contract between extensions and the go to declaration feature.

Hierarchy

DeclarationProvider

Index

Methods

provideDeclaration

Methods

provideDeclaration

provideDeclaration(document: TextDocument, position: Position, token: undefined | CancellationToken): ProviderResult<Definition | LocationLink[]>

- Defined in packages/plugin/src/theia.d.ts:613
Provide the declaration of the symbol at the given position and document.

Parameters
- document: TextDocument
  
  The document in which the command was invoked.
- position: Position
  
  The position at which the command was invoked.
- token: undefined | CancellationToken
  
  A cancellation token.
Returns ProviderResult<Definition | LocationLink[]>
A declaration or a thenable that resolves to such. The lack of a result can be signaled by returning undefined or null.