Skip to main content

termisModule

MS Code Extension API

MS Code Extension API / core/extensionAPI/modules/termisModule

core/extensionAPI/modules/termisModule

Type Aliases​

TermisModule​

TermisModule = ReturnType<typeof createTermisModule>

Defined in: core/extensionAPI/modules/termisModule.ts:95

Functions​

createTermisModule()​

createTermisModule(_extId): object

Defined in: core/extensionAPI/modules/termisModule.ts:28

Parameters​

_extId​

string

Returns​

closePanel​

closePanel: () => void

Close / hide the Termis panel.

Returns​

void

onDidChangeTermisActiveView​

onDidChangeTermisActiveView: (handler) => object

Fired when the active view inside the Termis panel changes.

Parameters​
handler​

(view) => void

Callback receiving the new view name ('terminal' | 'output' | 'problems').

Returns​

object

dispose​

dispose: () => void

Returns​

void

onDidCloseTermisPanel​

onDidCloseTermisPanel: (handler) => object

Fired when the Termis panel is closed or hidden.

Parameters​
handler​

() => void

Returns​

object

dispose​

dispose: () => void

Returns​

void

onDidOpenTermisPanel​

onDidOpenTermisPanel: (handler) => object

Fired when the Termis panel is opened or becomes visible.

Parameters​
handler​

() => void

Returns​

object

dispose​

dispose: () => void

Returns​

void

openPanel​

openPanel: () => void

Open the Termis panel and show the terminal view. Creates a default terminal instance if none exist.

Returns​

void

setActiveView​

setActiveView: (view) => void

Switch the active view inside the Termis panel.

Parameters​
view​

TermisView

Returns​

void

Example​
mscode.termis.setActiveView('output');  // show Output tab
activeView​
Get Signature​

get activeView(): TermisView

  • Returns the currently active view ('terminal' | 'output' | 'problems').
Returns​

TermisView

isVisible​
Get Signature​

get isVisible(): boolean

  • Returns true if the Termis panel is currently visible.
Returns​

boolean

ensureTermisTabOpen()​

ensureTermisTabOpen(): void

Defined in: core/extensionAPI/modules/termisModule.ts:11

Returns​

void