Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IVariable

An interface for a variable.

Hierarchy

  • Variable
    • IVariable

Index

Properties

Optional evaluateName

evaluateName: string

Optional evaluatable name of this variable which can be passed to the 'EvaluateRequest' to fetch the variable's value.

Optional expanded

expanded: boolean

Whether the variable is expanded.

Optional indexedVariables

indexedVariables: number

The number of indexed child variables. The client can use this optional information to present the children in a paged UI and fetch them in chunks.

Optional memoryReference

memoryReference: string

Optional memory reference for the variable if the variable represents executable code, such as a function pointer. This attribute is only required if the client has passed the value true for the 'supportsMemoryReferences' capability of the 'initialize' request.

name

name: string

The variable's name.

Optional namedVariables

namedVariables: number

The number of named child variables. The client can use this optional information to present the children in a paged UI and fetch them in chunks.

Optional presentationHint

presentationHint: VariablePresentationHint

Properties of a variable that can be used to determine how to render the variable in the UI.

Optional type

type: string

The type of the variable's value. Typically shown in the UI when hovering over the value. This attribute should only be returned by a debug adapter if the client has passed the value true for the 'supportsVariableType' capability of the 'initialize' request.

value

value: string

The variable's value. This can be a multi-line text, e.g. for a function the body of a function.

variablesReference

variablesReference: number

If variablesReference is > 0, the variable is structured and its children can be retrieved by passing variablesReference to the VariablesRequest.

Generated using TypeDoc