Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface InlayHintsProvider<T>

The inlay hints provider interface defines the contract between extensions and the inlay hints feature.

Type parameters

Hierarchy

  • InlayHintsProvider

Index

Properties(1)

Methods(2)

Properties(1)

Optional onDidChangeInlayHints

onDidChangeInlayHints: Event<void>

An optional event to signal that inlay hints from this provider have changed.

Methods(2)

provideInlayHints

  • Provide inlay hints for the given range and document.

    Note that inlay hints that are not contained by the given range are ignored.

    Parameters

    • document: TextDocument

      The document in which the command was invoked.

    • range: Range

      The range for which inlay hints should be computed.

    • token: CancellationToken

      A cancellation token.

    Returns ProviderResult<T[]>

    An array of inlay hints or a thenable that resolves to such.

Optional resolveInlayHint

  • Given an inlay hint fill in tooltip, text edits, or complete label parts.

    Note that the editor will resolve an inlay hint at most once.

    Parameters

    Returns ProviderResult<T>

    The resolved inlay hint or a thenable that resolves to such. It is OK to return the given item. When no result is returned, the given item will be used.

Generated by TypeDoc. Maintained by 紫升

Links: 搜外友链, 69中文网