Interface EnvironmentVariableCollection

A collection of mutations that an extension can apply to a process environment.

interface EnvironmentVariableCollection {
    description: undefined | string | MarkdownString;
    persistent: boolean;
    append(variable, value, options?): void;
    clear(): void;
    delete(variable): void;
    forEach(callback, thisArg?): void;
    get(variable): undefined | EnvironmentVariableMutator;
    prepend(variable, value, options?): void;
    replace(variable, value, options?): void;
}

Hierarchy (view full)

Properties

description persistent

Methods

append clear delete forEach get prepend replace

Properties

description

description: undefined | string | MarkdownString

A description for the environment variable collection, this will be used to describe the changes in the UI.

persistent

persistent: boolean

Whether the collection should be cached for the workspace and applied to the terminal across window reloads. When true the collection will be active immediately such when the window reloads. Additionally, this API will return the cached version if it exists. The collection will be invalidated when the extension is uninstalled or when the collection is cleared. Defaults to true.

Methods

append

  • append(variable, value, options?): void

  • Append a value to an environment variable.

    Note that an extension can only make a single change to any one variable, so this will overwrite any previous calls to replace, append or prepend.

    Parameters

    Returns void

clear

delete

  • delete(variable): void

  • Deletes this collection's mutator for a variable.

    Parameters

    • variable: string

      The variable to delete the mutator for.

    Returns void

forEach

  • forEach(callback, thisArg?): void

  • Iterate over each mutator in this collection.

    Parameters

    • callback: ((variable, mutator, collection) => any)

      Function to execute for each entry.

    • Optional thisArg: any

      The this context used when invoking the handler function.

    Returns void

get

prepend

  • prepend(variable, value, options?): void

  • Prepend a value to an environment variable.

    Note that an extension can only make a single change to any one variable, so this will overwrite any previous calls to replace, append or prepend.

    Parameters

    Returns void

replace

  • replace(variable, value, options?): void

  • Replace an environment variable with a value.

    Note that an extension can only make a single change to any one variable, so this will overwrite any previous calls to replace, append or prepend.

    Parameters

    Returns void

Settings

Member Visibility

Theme

On This Page

descriptionpersistentappendcleardeleteforEachgetprependreplace