External module "extension"

Variables

Const WORKSPACE_QUEUE

WORKSPACE_QUEUE: PQueue<PriorityQueue, DefaultAddOptions> = ego_helpers.createQueue()

Let currentContext

currentContext: ExtensionContext

Let isDeactivating

isDeactivating: boolean = false

Let nextWorkspaceId

nextWorkspaceId: number = Number.MAX_SAFE_INTEGER

Let outputChannel

outputChannel: OutputChannel

Let packageFile

packageFile: PackageFile

Let workspaceWatcher

workspaceWatcher: WorkspaceWatcherContext<Workspace>

Functions

activate

activate(context: ExtensionContext): Promise<void>

- Defined in src/extension.ts:423
Parameters
- context: ExtensionContext
Returns Promise<void>

createNewWorkspace

createNewWorkspace(folder: WorkspaceFolder): Promise<Workspace>

- Defined in src/extension.ts:52
Parameters
- folder: WorkspaceFolder
Returns Promise<Workspace>

deactivate

deactivate(): Promise<void>

- Defined in src/extension.ts:752
Returns Promise<void>

executeCode

executeCode(code: string, values?: Value | Value[]): any

- Defined in src/extension.ts:132
Executes code (globally).

Parameters
- code: string
  
  The code to execute.
- Optional values: Value | Value[]
Returns any

The result of the execution.

executeScript

executeScript<TArgs, TSettings>(settings: TSettings, argsFactory: function): Promise<any>

- Defined in src/extension.ts:158
Executes a script (globally).

Type parameters
- TArgs: WorkspaceScriptArguments
- TSettings: WithScript
Parameters
- settings: TSettings
  
  The object with the settings.
- argsFactory: function
  
  The function that produces the argument object for the execution.
  - - (args: TArgs, settings: TSettings): TArgs | PromiseLike<TArgs>
    - Parameters
      - args: TArgs
      - settings: TSettings
      Returns TArgs | PromiseLike<TArgs>
Returns Promise<any>

The promise with the result of the execution.

getContext

getContext(): ExtensionContext

- Defined in src/extension.ts:233
Returns the current extension context.

Returns ExtensionContext

The current extension context.

importValues

importValues<TObj>(obj: TObj, clone?: boolean): TObj

- Defined in src/extension.ts:245
Imports values to an object.

Type parameters
- TObj: CanImportValues
Parameters
- obj: TObj
  
  The object where to import the values in.
- Optional clone: boolean
Returns TObj

The object that contains the imported values.

onDidChangeConfiguration

onDidChangeConfiguration(e: ConfigurationChangeEvent): Promise<void>

- Defined in src/extension.ts:256
Parameters
- e: ConfigurationChangeEvent
Returns Promise<void>

onDidOpenTextDocument

onDidOpenTextDocument(doc: TextDocument): Promise<void>

- Defined in src/extension.ts:269
Parameters
- doc: TextDocument
Returns Promise<void>

onDidSaveTextDocument

onDidSaveTextDocument(doc: TextDocument): Promise<void>

- Defined in src/extension.ts:275
Parameters
- doc: TextDocument
Returns Promise<void>

onWillSaveTextDocument

onWillSaveTextDocument(e: TextDocumentWillSaveEvent): Promise<void>

- Defined in src/extension.ts:281
Parameters
- e: TextDocumentWillSaveEvent
Returns Promise<void>

runShellCommand

runShellCommand(settings: WithShellCommand, opts?: RunShellCommandOptions): Promise<void>

- Defined in src/extension.ts:293
Runs a shell command and shows it progress in the GUI (globally).

Parameters
- settings: WithShellCommand
  
  Settings with the command to run.
- Optional opts: RunShellCommandOptions
Returns Promise<void>

withTextDocument

withTextDocument(doc: TextDocument, action: function): Promise<void>

- Defined in src/extension.ts:400
Parameters
- doc: TextDocument
- action: function
  - - (ws: Workspace, d: TextDocument): void | PromiseLike<void>
    - Parameters
      - ws: Workspace
      - d: TextDocument
      Returns void | PromiseLike<void>
Returns Promise<void>

Generated using TypeDoc