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.
Fields
provideInlineValues(document:TextDocument, viewPort:Range, context:InlineValueContext, token:CancellationToken):ProviderResult<Array<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 | The document for which the inline values information is needed. |
---|---|
viewPort | The visible document range for which inline values should be computed. |
context | A bag containing contextual information like the current location. |
token | A cancellation token. |
Returns:
An array of InlineValueDescriptors or a thenable that resolves to such. The lack of a result can be
signaled by returning undefined
or null
.
optionalonDidChangeInlineValues:Null<Event<Void>>
An optional event to signal that inline values have changed. @link EventEmitter}
See also:
{