Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DocumentLinkProvider<T>

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

Type parameters

Hierarchy

  • DocumentLinkProvider

Index

Methods(2)

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<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.

Optional resolveDocumentLink

  • 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>

Generated by TypeDoc. Maintained by 紫升

Links: 搜外友链, 69中文网