Interface TerminalConnection

Active connection between terminal input/output and a transport.

interface TerminalConnection {
    closed: Promise<void>;
    error: Error | undefined;
    status: TerminalConnectionStatus;
    close(reason?: string): Promise<void>;
    dispose(): void;
    onStatusChange(
        listener: (status: TerminalConnectionStatus) => void,
    ): Disposable;
}

Hierarchy (View Summary)

Disposable
- TerminalConnection

Index

Properties

closed error status

Methods

close dispose onStatusChange

Properties

`Readonly`closed

closed: Promise<void>

Settles after both transport directions finish.

`Readonly`error

error: Error | undefined

Terminal connection failure, when status is error.

`Readonly`status

status: TerminalConnectionStatus

Current connection lifecycle state.

Methods

close

close(reason?: string): Promise<void>
Gracefully closes both transport directions.
Parameters
- Optionalreason: string
Returns Promise<void>
- Defined in packages/core/src/types.ts:150

dispose

dispose(): void
Releases the resource. Safe implementations should be idempotent.

Returns void
Inherited from Disposable.dispose
- Defined in packages/core/src/core/types.ts:632

onStatusChange

onStatusChange(listener: (status: TerminalConnectionStatus) => void): Disposable
Subscribes to lifecycle state changes.
Parameters
- listener: (status: TerminalConnectionStatus) => void
Returns Disposable
- Defined in packages/core/src/types.ts:152