Interface InlayHintsProvider<T>

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

interface InlayHintsProvider<T extends InlayHint = InlayHint> {
    onDidChangeInlayHints?: Event<void>;
    provideInlayHints(
        document: TextDocument,
        range: Range,
        token: CancellationToken,
    ): ProviderResult<T[]>;
    resolveInlayHint?(hint: T, token: CancellationToken): ProviderResult<T>;
}

Type Parameters

T extends InlayHint = InlayHint

Index

Properties

onDidChangeInlayHints?

Methods

provideInlayHints resolveInlayHint?

Properties

`Optional`onDidChangeInlayHints

onDidChangeInlayHints?: Event<void>

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

Methods

provideInlayHints

provideInlayHints(
    document: TextDocument,
    range: Range,
    token: CancellationToken,
): ProviderResult<T[]>
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.
- Defined in packages/plugin/src/theia.d.ts:9539

`Optional`resolveInlayHint

resolveInlayHint?(hint: T, token: CancellationToken): ProviderResult<T>
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
- hint: T
  An inlay hint.
- token: CancellationToken
  A cancellation token.
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.
- Defined in packages/plugin/src/theia.d.ts:9551