Class EnvironmentVariableCollectionImpl

constructor

• new EnvironmentVariableCollectionImpl(
      persistent: boolean,
      serialized?: SerializableEnvironmentVariableCollection,
  ): EnvironmentVariableCollectionImpl

  Parameters

  • persistent: boolean
  • Optionalserialized: SerializableEnvironmentVariableCollection

  Returns EnvironmentVariableCollectionImpl

Readonlymap

onDidChangeCollection

description

• get description(): undefined | string | MarkdownString

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

  Returns undefined | string | MarkdownString

• set description(value: undefined | string | MarkdownString): void

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

  Parameters

  • value: undefined | string | MarkdownString

  Returns void

persistent

• get 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.

  Returns boolean

• set persistent(value: boolean): void

  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.

  Parameters

  • value: boolean

  Returns void

size

• get size(): number

  Returns number

append

• append(
      variable: string,
      value: string,
      options?: EnvironmentVariableMutatorOptions,
  ): 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: string

    The variable to append to.

  • value: string

    The value to append to the variable.

  • Optionaloptions: EnvironmentVariableMutatorOptions

  Returns void

clear

• clear(): void

  Clears all mutators from this collection.

  Returns void

delete

• delete(variable: string): void

  Deletes this collection's mutator for a variable.

  Parameters

  • variable: string

    The variable to delete the mutator for.

  Returns void

forEach

• forEach(
      callback: (
          variable: string,
          mutator: EnvironmentVariableMutator,
          collection: EnvironmentVariableCollection,
      ) => any,
      thisArg?: any,
  ): void

  eslint-disable-next-line @typescript-eslint/no-explicit-any

  Parameters

  • callback: (
        variable: string,
        mutator: EnvironmentVariableMutator,
        collection: EnvironmentVariableCollection,
    ) => any
  • OptionalthisArg: any

  Returns void

get

• get(variable: string): undefined | EnvironmentVariableMutator

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

  Parameters

  • variable: string

    The variable to get the mutator for.

  Returns undefined | EnvironmentVariableMutator

getScoped

• 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.

  Each object obtained through this method is isolated and does not impact objects for other scopes, including the global collection.

  Parameters

  • scope: EnvironmentVariableScope

    The scope to which the environment variable collection applies to.

    If a scope parameter is omitted, collection applicable to all relevant scopes for that parameter is returned. For instance, if the 'workspaceFolder' parameter is not specified, the collection that applies across all workspace folders will be returned.

  Returns EnvironmentVariableCollection

  Environment variable collection for the passed in scope.

prepend

• prepend(
      variable: string,
      value: string,
      options?: EnvironmentVariableMutatorOptions,
  ): 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: string

    The variable to prepend.

  • value: string

    The value to prepend to the variable.

  • Optionaloptions: EnvironmentVariableMutatorOptions

  Returns void

replace

• replace(
      variable: string,
      value: string,
      options?: EnvironmentVariableMutatorOptions,
  ): 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: string

    The variable to replace.

  • value: string

    The value to replace the variable with.

  • Optionaloptions: EnvironmentVariableMutatorOptions

  Returns void