Class: PassthroughIDEBase

libs/common/ide/PassthroughIDEBase.PassthroughIDEBase

Hierarchy

• PassthroughIDEBase

  ↳ NormalizedIDE

  ↳ SpyIDE

Implements

• IDE

Constructors

constructor

• new PassthroughIDEBase(original)

Parameters

Name	Type
original	IDE

Defined in

libs/common/ide/PassthroughIDEBase.ts:17

Properties

capabilities

• capabilities: Capabilities

The capabilities of the IDE

Implementation of

IDE.capabilities

Defined in

libs/common/ide/PassthroughIDEBase.ts:15

---

clipboard

• clipboard: Clipboard

Implementation of

IDE.clipboard

Defined in

libs/common/ide/PassthroughIDEBase.ts:13

---

configuration

• configuration: Configuration

Implementation of

IDE.configuration

Defined in

libs/common/ide/PassthroughIDEBase.ts:11

---

globalState

• globalState: State

Implementation of

IDE.globalState

Defined in

libs/common/ide/PassthroughIDEBase.ts:12

---

messages

• messages: Messages

Implementation of

IDE.messages

Defined in

libs/common/ide/PassthroughIDEBase.ts:14

Accessors

activeEditableTextEditor

• get activeEditableTextEditor(): undefined | EditableTextEditor

Same as activeTextEditor but editable

Returns

undefined | EditableTextEditor

Implementation of

IDE.activeEditableTextEditor

Defined in

libs/common/ide/PassthroughIDEBase.ts:29

---

activeTextEditor

• get activeTextEditor(): undefined | TextEditor

The currently active editor or undefined. The active editor is the one that currently has focus or, when none has focus, the one that has changed input most recently.

Returns

undefined | TextEditor

Implementation of

IDE.activeTextEditor

Defined in

libs/common/ide/PassthroughIDEBase.ts:25

---

assetsRoot

• get assetsRoot(): string

The root directory of this shipped code. Can be used to access bundled assets.

Returns

string

Implementation of

IDE.assetsRoot

Defined in

libs/common/ide/PassthroughIDEBase.ts:37

---

runMode

• get runMode(): RunMode

Whether we are running in development, test, or production

Returns

RunMode

Implementation of

IDE.runMode

Defined in

libs/common/ide/PassthroughIDEBase.ts:41

---

visibleTextEditors

• get visibleTextEditors(): TextEditor[]

The currently visible editors or an empty array.

Returns

TextEditor[]

Implementation of

IDE.visibleTextEditors

Defined in

libs/common/ide/PassthroughIDEBase.ts:33

---

workspaceFolders

• get workspaceFolders(): undefined | readonly WorkspaceFolder[]

A list of workspace folders for the currently active workspace

Returns

undefined | readonly WorkspaceFolder[]

Implementation of

IDE.workspaceFolders

Defined in

libs/common/ide/PassthroughIDEBase.ts:45

Methods

disposeOnExit

▸ disposeOnExit(...disposables): () => void

Register disposables to be disposed of on IDE exit.

Parameters

Name	Type
...disposables	Disposable[]

Returns

fn

▸ (): void

Returns

void

Implementation of

IDE.disposeOnExit

Defined in

libs/common/ide/PassthroughIDEBase.ts:75

---

executeCommand

▸ executeCommand<T>(command, ...args): Promise<undefined | T>

Executes the built-in ide command denoted by the given command identifier.

Type parameters

Name
T

Parameters

Name	Type
command	string
...args	any[]

Returns

Promise<undefined | T>

Implementation of

IDE.executeCommand

Defined in

libs/common/ide/PassthroughIDEBase.ts:65

---

findInWorkspace

▸ findInWorkspace(query): Promise<void>

Find occurrences of query string in all files in the workspace

Parameters

Name	Type
query	string

Returns

Promise<void>

Implementation of

IDE.findInWorkspace

Defined in

libs/common/ide/PassthroughIDEBase.ts:49

---

getEditableTextEditor

▸ getEditableTextEditor(editor): EditableTextEditor

Get an editable version of the text editor.

Parameters

Name	Type
editor	TextEditor

Returns

EditableTextEditor

Implementation of

IDE.getEditableTextEditor

Defined in

libs/common/ide/PassthroughIDEBase.ts:61

---

onDidChangeTextDocument

▸ onDidChangeTextDocument(listener): Disposable

An event that is emitted when a text document is changed. This usually happens when the contents changes but also when other things like the {@link TextDocument.isDirty dirty}-state changes.

Parameters

Name	Type
listener	(event: TextDocumentChangeEvent) => void

Returns

Disposable

Implementation of

IDE.onDidChangeTextDocument

Defined in

libs/common/ide/PassthroughIDEBase.ts:69

---

openTextDocument

▸ openTextDocument(path): Promise<TextEditor>

Opens a document.

Parameters

Name	Type
path	string

Returns

Promise<TextEditor>

Implementation of

IDE.openTextDocument

Defined in

libs/common/ide/PassthroughIDEBase.ts:53

---

showInputBox

▸ showInputBox(options?): Promise<undefined | string>

Opens an input box to ask the user for input.

The returned value will be undefined if the input box was canceled (e.g. pressing ESC). Otherwise the returned value will be the string typed by the user or an empty string if the user did not type anything but dismissed the input box with OK.

Parameters

Name	Type
options?	any

Returns

Promise<undefined | string>

Implementation of

IDE.showInputBox

Defined in

libs/common/ide/PassthroughIDEBase.ts:57