A collection of mutations that an extension can apply to a process environment.
Fields
replace(variable:String, value:String):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:
variable | The variable to replace. |
|---|---|
value | The value to replace the variable with. |
prepend(variable:String, value:String):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:
variable | The variable to prepend. |
|---|---|
value | The value to prepend to the variable. |
persistent:Bool
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.
get(variable:String):Null<EnvironmentVariableMutator>
Gets the mutator that this collection applies to a variable, if any.
Parameters:
variable | The variable to get the mutator for. |
|---|
forEach(callback:(variable:String, mutator:EnvironmentVariableMutator, collection:EnvironmentVariableCollection) ‑> Any, ?thisArg:Any):Void
Iterate over each mutator in this collection.
Parameters:
callback | Function to execute for each entry. |
|---|---|
thisArg | The |
delete(variable:String):Void
Deletes this collection's mutator for a variable.
Parameters:
variable | The variable to delete the mutator for. |
|---|
append(variable:String, value:String):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:
variable | The variable to append to. |
|---|---|
value | The value to append to the variable. |