Interface Variable

Variable can be used inside of strings using ${variableName} syntax.

interface Variable {
    description?: string;
    name: string;
    resolve(context?, argument?, configurationSection?, commandIdVariables?, configuration?): any;
}

Properties

description? name

Methods

resolve

Properties

Optional Readonly description

description?: string

A human-readable description of this variable.

Readonly name

name: string

A unique name of this variable.

Methods

resolve

  • resolve(context?, argument?, configurationSection?, commandIdVariables?, configuration?): any

  • Resolve to a string value of this variable or undefined if variable cannot be resolved. Never reject.

    Parameters

    • Optional context: URI
    • Optional argument: string
    • Optional configurationSection: string
    • Optional commandIdVariables: CommandIdVariables
    • Optional configuration: unknown

    Returns any

Settings

Member Visibility

Theme

On This Page

descriptionnameresolve