dockerfile-ast/lib/variable.d.ts

Parse a Dockerfile into an array of instructions and comments.

import { Range } from 'vscode-languageserver-types';
export declare class Variable {
    private readonly name;
    private readonly nameRange;
    private readonly range;
    private readonly modifier;
    private readonly modifierRange;
    private readonly substitutionParameter;
    private readonly substitutionRange;
    private readonly defined;
    private readonly buildVariable;
    private readonly stringValue;
    constructor(name: string, nameRange: Range, range: Range, modifier: string | null, modifierRange: Range | null, substitutionParameter: string | null, substitutionRange: Range | null, defined: boolean, buildVariable: boolean, stringValue: string);
    toString(): string;
    getName(): string;
    getNameRange(): Range;
    /**
     * Returns the range of the entire variable. This includes the symbols for
     * the declaration of the variable such as the $, {, and } symbols.
     *
     * @return the range in the document that this variable encompasses in its
     *         entirety
     */
    getRange(): Range;
    /**
     * Returns the modifier character that has been set for
     * specifying how this variable should be expanded and resolved.
     * If this variable is ${variable:+value} then the modifier
     * character is '+'. Will be the empty string if the variable is
     * declared as ${variable:}. Otherwise, will be null if this
     * variable will not use variable substitution at all (such as
     * ${variable} or $variable).
     *
     * @return this variable's modifier character, or the empty
     *         string if it does not have one, or null if this
     *         variable will not use variable substitution
     */
    getModifier(): string | null;
    getModifierRange(): Range | null;
    /**
     * Returns the parameter that will be used for substitution if
     * this variable uses modifiers to define how its value should be
     * resolved. If this variable is ${variable:+value} then the
     * substitution value will be 'value'. Will be the empty string
     * if the variable is declared as ${variable:+} or some other
     * variant where the only thing that follows the modifier
     * character (excluding considerations of escape characters and
     * so on) is the variable's closing bracket. May be null if this
     * variable does not have a modifier character defined (such as
     * ${variable} or $variable).
     *
     * @return this variable's substitution parameter, or the empty
     *         string if it does not have one, or null if there is
     *         not one defined
     */
    getSubstitutionParameter(): string | null;
    getSubstitutionRange(): Range | null;
    /**
     * Returns whether this variable has been defined or not.
     *
     * @return true if this variable has been defined, false otherwise
     */
    isDefined(): boolean;
    isBuildVariable(): boolean;
    isEnvironmentVariable(): boolean;
}