Skip to content

Interface: ActionEvent

@termwright/driver


@termwright/driver / ActionEvent

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

One action the harness or a locator performed, reported after it finished — successfully or not.

This is what turns a recording into a story: the raw stream shows bytes going into the terminal, while these events say which call sent them, at what, and whether it worked.

readonly optional actionability?: ActionabilityExplanation

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

Exact failed planner evaluation, bound to the checkpoint that rejected the action.


readonly actionId: string

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

Correlates this completion with the preceding ActionStartedEvent.


readonly api: string

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

Method that ran, e.g. 'click', 'press', 'resize'.


readonly optional error?: string

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

Failure reason: the TermwrightErrorCode when the action failed with a driver error, otherwise the error’s name. Never the full message — the message belongs to the thrown error, this field is for grouping.


readonly optional observation?: ObservationStamp

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

Atomic screen/tree identity at completion; trace consumers must not guess.


readonly ok: boolean

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


readonly optional receipt?: ActionReceipt

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

The exact plan and physical operations executed for a successful semantic action. This is the same receipt returned to the caller, not a diagnostic reconstruction performed after the action.


readonly optional ref?: LocatorRef

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

Ref of the target the action resolved, when it resolved one.


readonly optional selector?: string

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

The locator’s description, for actions that had one.


readonly timeMs: number

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