An interface for a variable.

interface IVariable {
    evaluateName?: string;
    expanded?: boolean;
    indexedVariables?: number;
    memoryReference?: string;
    name: string;
    namedVariables?: number;
    presentationHint?: VariablePresentationHint;
    type?: string;
    value: string;
    variablesReference: number;
}

Hierarchy

  • Variable
    • IVariable

Properties

evaluateName?: string

The evaluatable name of this variable which can be passed to the evaluate request to fetch the variable's value.

expanded?: boolean

Whether the variable is expanded.

indexedVariables?: number

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

memoryReference?: string

The memory reference for the variable if the variable represents executable code, such as a function pointer. This attribute is only required if the corresponding capability supportsMemoryReferences is true.

name: string

The variable's name.

namedVariables?: number

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

presentationHint?: VariablePresentationHint

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

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 corresponding capability supportsVariableType is true.

value: string

The variable's value. This can be a multi-line text, e.g. for a function the body of a function. For structured variables (which do not have a simple value), it is recommended to provide a one-line representation of the structured object. This helps to identify the structured object in the collapsed state when its children are not yet visible. An empty string can be used if no value should be shown in the UI.

variablesReference: number

If variablesReference is > 0, the variable is structured and its children can be retrieved by passing variablesReference to the variables request as long as execution remains suspended. See 'Lifetime of Object References' in the Overview section for details.