Interface: ScreenSnapshot

@termwright/driver

---

@termwright/driver / ScreenSnapshot

Interface: ScreenSnapshot

Defined in: driver/src/api.ts:496

@termwright/driver — PTY + VT sessions, locators, actions and waits.

The normative public API lives in api.ts; this module is the only entry point and re-exports the types from there together with their runtime implementations.

Example

import { launchTerminal } from '@termwright/driver';

const terminal = await launchTerminal({ command: ['node', 'app.js'] });
await terminal.waitForText('Ready');
await terminal.getByRole('button', { name: 'Approve' }).activate();
await terminal.close();

Properties

buffer

readonly buffer: "normal" | "alternate"

Defined in: driver/src/api.ts:500

---

columns

readonly columns: number

Defined in: driver/src/api.ts:498

---

cursor

readonly cursor: CursorInfo

Defined in: driver/src/api.ts:501

---

modes

readonly modes: TerminalModes

Defined in: driver/src/api.ts:502

---

revision

readonly revision: number

Defined in: driver/src/api.ts:497

---

rows

readonly rows: number

Defined in: driver/src/api.ts:499

Methods

ansi()

ansi(): string

Defined in: driver/src/api.ts:508

ANSI-styled serialization of the visible grid (addon-serialize).

Returns

string

---

cell()

cell(row, column): CellSnapshot

Defined in: driver/src/api.ts:506

Parameters

row

number

column

number

Returns

CellSnapshot

---

html()

html(): string

Defined in: driver/src/api.ts:509

Returns

string

---

line()

line(row): string

Defined in: driver/src/api.ts:505

Parameters

row

number

Returns

string

---

text()

text(): string

Defined in: driver/src/api.ts:504

Visible grid text, one string per row (trailing whitespace trimmed).

Returns

string