kotlin-vscode/vscode/GlobalEnvironmentVariableCollection

GlobalEnvironmentVariableCollection

interface GlobalEnvironmentVariableCollection : EnvironmentVariableCollection(source)

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

Online Documentation

Properties

description

abstract var description: JsAny?

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

persistent

abstract var 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.

Functions

append

abstract fun append(variable: String, value: String, options: EnvironmentVariableMutatorOptions = definedExternally)

Append a value to an environment variable.

clear

abstract fun clear()

Clears all mutators from this collection.

delete

abstract fun delete(variable: String)

Deletes this collection's mutator for a variable.

forEach

abstract fun forEach(callback: (variable: String, mutator: EnvironmentVariableMutator, collection: EnvironmentVariableCollection) -> Unit, thisArg: JsAny? = definedExternally)

Iterate over each mutator in this collection.

get

open operator fun get(key: Symbol.iterator): () -> JsIterator<Tuple2<JsString, EnvironmentVariableMutator>>

abstract fun get(variable: String): EnvironmentVariableMutator?

Gets the mutator that this collection applies to a variable, if any.

getScoped

abstract fun getScoped(scope: EnvironmentVariableScope): EnvironmentVariableCollection

Gets scope-specific environment variable collection for the extension. This enables alterations to terminal environment variables solely within the designated scope, and is applied in addition to (and after) the global collection.

prepend

abstract fun prepend(variable: String, value: String, options: EnvironmentVariableMutatorOptions = definedExternally)

Prepend a value to an environment variable.

replace

abstract fun replace(variable: String, value: String, options: EnvironmentVariableMutatorOptions = definedExternally)

Replace an environment variable with a value.