Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ScriptArguments

Arguments for a script.

Hierarchy

Index

Properties

Properties

Readonly extension

extension: ExtensionContext

The underlying extension (context).

Readonly globalState

globalState: KeyValuePairs<any>

Gets the global state object.

Readonly globalStore

globalStore: Store

The global store.

Optional Readonly globals

globals: any

Global data which are available for all scripts.

Readonly logger

logger: Logger

The logger.

Readonly options

options: any

Options for running the script.

Readonly output

output: OutputChannel

The output channel.

Readonly replaceValues

replaceValues: (val: any) => string

Handles a value as string and replaces placeholders.

param

The input value.

returns

The output value.

Type declaration

    • (val: any): string

    • Parameters

      • val: any

      Returns string

Readonly require

require: (id: string) => any

Imports a module from the extension's context.

param

The ID of the module.

returns

The module.

Type declaration

    • (id: string): any

    • Parameters

      • id: string

      Returns any

state

state: any

Provides a property to save data permanently while the current (extension) session.

Readonly store

store: Store

The user store for the underlying script.

Generated using TypeDoc