Skip to content

Interface: TerminalService

Defined in: packages/sdk/src/terminal-service.ts:32

Consumer API for the terminal domain, exposed as ExtensionContext.terminals. The terminal is a core feature — a built-in DockKind like the editor — so this mirrors EditorService: create opens a terminal tab in a workspace, and closeWorkspace reaps a workspace's terminals (used when a workspace is deleted). The tab itself is rendered by the core dock from the workspace's terminal records.

Methods

create()

ts
create(input?): TerminalRecord | undefined;

Defined in: packages/sdk/src/terminal-service.ts:38

Open a new terminal in a workspace (defaults to the active one). Returns the created TerminalRecord; the PTY session spawns lazily when its tab mounts.

Parameters

input?

CreateTerminalInput

Returns

TerminalRecord | undefined


closeWorkspace()

ts
closeWorkspace(workspaceId): void;

Defined in: packages/sdk/src/terminal-service.ts:40

Close and kill every terminal in a workspace (e.g. on workspace delete).

Parameters

workspaceId

string

Returns

void