Interface EvaluatableExpressionProvider

The evaluatable expression provider interface defines the contract between extensions and the debug hover. In this contract the provider returns an evaluatable expression for a given position in a document and the editor evaluates this expression in the active debug session and shows the result in a debug hover.

interface EvaluatableExpressionProvider {
    provideEvaluatableExpression(document, position, token): ProviderResult<EvaluatableExpression>;
}

Methods

  • Provide an evaluatable expression for the given document and position. The editor will evaluate this expression in the active debug session and will show the result in the debug hover. The expression can be implicitly specified by the range in the underlying document or by explicitly returning an expression.

    Parameters

    • document: TextDocument

      The document for which the debug hover is about to appear.

    • position: Position

      The line and character position in the document where the debug hover is about to appear.

    • token: undefined | CancellationToken

      A cancellation token.

    Returns ProviderResult<EvaluatableExpression>

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