Theia API Documentation v1.65.0
    Preparing search index...

    Interface Variable

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

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

    Properties

    description? name

    Methods

    resolve

    Properties

    description?: string

    A human-readable description of this variable.

    name: string

    A unique name of this variable.

    Methods

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

      Parameters

      • Optionalcontext: URI
      • Optionalargument: string
      • OptionalconfigurationSection: string
      • OptionalcommandIdVariables: CommandIdVariables
      • Optionalconfiguration: unknown

      Returns any

    Settings

    Member Visibility

    On This Page

    Properties
    Methods