Interface InlineValuesProvider

The inline values provider interface defines the contract between extensions and the editor's debugger inline values feature. In this contract the provider returns inline value information for a given document range and the editor shows this information in the editor at the end of lines.

interface InlineValuesProvider {
    onDidChangeInlineValues?: Event<void>;
    provideInlineValues(document, viewPort, context, token): ProviderResult<InlineValue[]>;
}

Properties

onDidChangeInlineValues?

Methods

provideInlineValues

Properties

Optional onDidChangeInlineValues

onDidChangeInlineValues?: Event<void>

An optional event to signal that inline values have changed.

See

EventEmitter

Methods

provideInlineValues

  • provideInlineValues(document, viewPort, context, token): ProviderResult<InlineValue[]>

  • Provide "inline value" information for a given document and range. The editor calls this method whenever debugging stops in the given document. The returned inline values information is rendered in the editor at the end of lines.

    Parameters

    • document: TextDocument

      The document for which the inline values information is needed.

    • viewPort: Range

      The visible document range for which inline values should be computed.

    • context: InlineValueContext

      A bag containing contextual information like the current location.

    • token: CancellationToken

      A cancellation token.

    Returns ProviderResult<InlineValue[]>

    An array of InlineValueDescriptors or a thenable that resolves to such. The lack of a result can be signaled by returning undefined or null.

Settings

Member Visibility

Theme

On This Page

onDidChangeInlineValuesprovideInlineValues