Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DocumentLinkProvider

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

Hierarchy

  • DocumentLinkProvider

Index

Methods

provideDocumentLinks

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

    Parameters

    Returns ProviderResult<DocumentLink[]>

    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.

Optional resolveDocumentLink