kotlin-vscode/vscode/DocumentLinkProvider

DocumentLinkProvider

interface DocumentLinkProvider<T : DocumentLink>(source)

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

Online Documentation

Properties

Link copied to clipboard
abstract var 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 {@linkcode DocumentLinkProvider.provideDocumentLinks provideDocumentLinks} method which often helps to improve performance.

Functions

Link copied to clipboard
abstract fun provideDocumentLinks(document: TextDocument, token: CancellationToken): ProviderResult<ReadonlyArray<T>>

Provide links for the given document. Note that the editor ships with a default provider that detects http(s) and file links.