Interface DocumentLinkProvider<T>

The document link provider defines the contract between extensions and feature of showing links in the editor.

interface DocumentLinkProvider<T extends DocumentLink = DocumentLink> {
    provideDocumentLinks(
        document: TextDocument,
        token: CancellationToken,
    ): ProviderResult<T[]>;
    resolveDocumentLink?(link: T, token: CancellationToken): ProviderResult<T>;
}

Type Parameters

T extends DocumentLink = DocumentLink

Index

Methods

provideDocumentLinks resolveDocumentLink?

Methods

provideDocumentLinks

provideDocumentLinks(
document: TextDocument,
token: CancellationToken,
): ProviderResult<T[]>
Provide links for the given document. Note that the editor ships with a default provider that detects http(s) and file links.
Parameters
- document: TextDocument
  The document in which the command was invoked.
- token: CancellationToken
  A cancellation token.
Returns ProviderResult<T[]>
An array of document links or a thenable that resolves to such. The lack of a result can be signaled by returning undefined, null, or an empty array.
- Defined in packages/plugin/src/theia.d.ts:11209

`Optional`resolveDocumentLink

resolveDocumentLink?(link: T, token: CancellationToken): ProviderResult<T>
Given a link fill in its target. This method is called when an incomplete link is selected in the UI. Providers can implement this method and return incomplete links (without target) from the provideDocumentLinks method which often helps to improve performance.
Parameters
- link: T
  The link that is to be resolved.
- token: CancellationToken
  A cancellation token.
Returns ProviderResult<T>
- Defined in packages/plugin/src/theia.d.ts:11220