Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LinkPreviewProvider

Called to obtain a preview of the information available at a URL.

Hierarchy

  • LinkPreviewProvider

Index

Methods

Methods

provideLinkPreview

  • Provides a preview of the information available at the URL of a link in a document.

    todo

    Add a context parameter so that the provider knows what document contains the link (so that it can handle links in code files differently from rendered Markdown documents, for example).

    Parameters

    • url: URL

      The URL of the link to preview.

    Returns ProviderResult<LinkPreview>

Generated using TypeDoc