Interface: SessionEventMap

@termwright/driver

---

@termwright/driver / SessionEventMap

Interface: SessionEventMap

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

@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

action

action: ActionEvent

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

One harness or locator action, reported after it finished.

---

action-start

action-start: ActionStartedEvent

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

One harness or locator action, reported immediately before it begins.

---

app-log

app-log: AppLogEvent

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

A line or record from the application own log.

---

crash

crash: CrashReport

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

The child died unexpectedly. Emitted before exit, so a listener reacting to the exit can already read TerminalHarness.crashReport.

---

diagnostic

diagnostic: SessionDiagnostic

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

---

exit

exit: ExitStatus & object

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

Type Declaration

timeMs

readonly timeMs: number

---

input

input: object

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

data

readonly data: Uint8Array

kind

readonly kind: "key" | "mouse" | "paste" | "raw"

timeMs

readonly timeMs: number

---

output

output: object

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

data

readonly data: Uint8Array

timeMs

readonly timeMs: number

---

resize

resize: object

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

columns

readonly columns: number

rows

readonly rows: number

timeMs

readonly timeMs: number

---

screen-revision

screen-revision: object

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

revision

readonly revision: number

timeMs

readonly timeMs: number

---

semantic-revision

semantic-revision: object

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

revision

readonly revision: number

snapshot

readonly snapshot: SemanticSnapshot

The exact committed tree for this event; never read back from newer state.

timeMs

readonly timeMs: number