Class: VscodeIDE

ide/vscode/VscodeIDE.VscodeIDE

Implements

• IDE

Constructors

constructor

• new VscodeIDE(extensionContext)

Parameters

Name	Type
extensionContext	ExtensionContext

Defined in

ide/vscode/VscodeIDE.ts:27

Properties

clipboard

• clipboard: VscodeClipboard

Implementation of

IDE.clipboard

Defined in

ide/vscode/VscodeIDE.ts:24

---

configuration

• configuration: VscodeConfiguration

Implementation of

IDE.configuration

Defined in

ide/vscode/VscodeIDE.ts:21

---

editorMap

• Private editorMap: WeakMap<TextEditor, VscodeTextEditorImpl>

Defined in

ide/vscode/VscodeIDE.ts:25

---

globalState

• globalState: VscodeGlobalState

Implementation of

IDE.globalState

Defined in

ide/vscode/VscodeIDE.ts:22

---

messages

• messages: VscodeMessages

Implementation of

IDE.messages

Defined in

ide/vscode/VscodeIDE.ts:23

Accessors

activeEditableTextEditor

• get activeEditableTextEditor(): undefined | EditableTextEditor

Same as activeTextEditor but editable

Returns

undefined | EditableTextEditor

Implementation of

IDE.activeEditableTextEditor

Defined in

ide/vscode/VscodeIDE.ts:51

---

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

ide/vscode/VscodeIDE.ts:47

---

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

ide/vscode/VscodeIDE.ts:35

---

runMode

• get runMode(): RunMode

Whether we are running in development, test, or production

Returns

RunMode

Implementation of

IDE.runMode

Defined in

ide/vscode/VscodeIDE.ts:39

---

visibleTextEditors

• get visibleTextEditors(): TextEditor[]

The currently visible editors or an empty array.

Returns

TextEditor[]

Implementation of

IDE.visibleTextEditors

Defined in

ide/vscode/VscodeIDE.ts:61

---

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

ide/vscode/VscodeIDE.ts:43

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

ide/vscode/VscodeIDE.ts:85

---

fromVscodeEditor

▸ fromVscodeEditor(editor): VscodeTextEditorImpl

Parameters

Name	Type
editor	TextEditor

Returns

VscodeTextEditorImpl

Defined in

ide/vscode/VscodeIDE.ts:75

---

getActiveTextEditor

▸ Private getActiveTextEditor(): undefined | VscodeTextEditorImpl

Returns

undefined | VscodeTextEditorImpl

Defined in

ide/vscode/VscodeIDE.ts:55

---

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

ide/vscode/VscodeIDE.ts:65

---

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

ide/vscode/VscodeIDE.ts:69