Interface: ScreenLocator

@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();

Extends

LocatorBase<"screen">

Properties

description

readonly description: string

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

Human-readable form of the query, as it appears in error messages.

Inherited from

LocatorBase.description

domain

readonly domain: "screen"

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

Inherited from

LocatorBase.domain

Methods

actionability()

actionability(action, opts?): Promise<ActionabilityExplanation>

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

Parameters

action

"click" | "double-click" | "hover"

opts?

PointerOptions

Returns

Promise<ActionabilityExplanation>

and()

and(other): ScreenLocator

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

Parameters

other

ScreenLocator

Returns

ScreenLocator

Inherited from

LocatorBase.and

cellSnapshot()

cellSnapshot(opts?): Promise<LocatorCellSnapshot>

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

Atomic cells inside this locator’s qualified rectangle.

Parameters

opts?

LocatorCellSnapshotOptions

Returns

Promise<LocatorCellSnapshot>

Inherited from

LocatorBase.cellSnapshot

checkpoint()

checkpoint(): ObservationStamp

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

Current committed observation used to arm race-free custom waits.

Returns

ObservationStamp

Inherited from

LocatorBase.checkpoint

click()

click(opts?): Promise<ActionReceipt>

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

Parameters

opts?

PointerOptions

Returns

Promise<ActionReceipt>

Inherited from

LocatorBase.click

count()

count(): Promise<number>

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

Returns

Promise<number>

Inherited from

LocatorBase.count

doubleClick()

doubleClick(opts?): Promise<ActionReceipt>

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

Parameters

opts?

PointerOptions

Returns

Promise<ActionReceipt>

Inherited from

LocatorBase.doubleClick

dragTo()

dragTo(target, opts?): Promise<ActionReceipt>

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

Parameters

target

ScreenLocator

opts?

LocatorDragOptions

Returns

Promise<ActionReceipt>

Inherited from

LocatorBase.dragTo

evaluateCondition()

evaluateCondition(condition, opts?): Promise<ConditionResult>

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

Parameters

filter()

filter(options): ScreenLocator

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

Parameters

options

ScreenLocatorFilterOptions

Returns

ScreenLocator

first()

first(): ScreenLocator

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

Returns

ScreenLocator

Inherited from

LocatorBase.first

geometry()

geometry(): Promise<LocatorGeometry>

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

Atomic, evidence-qualified geometry. Never invents a rectangle.

Returns

Promise<LocatorGeometry>

Inherited from

LocatorBase.geometry

getByScreenText()

getByScreenText(text, opts?): ScreenLocator

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

Parameters

text

string | RegExp

opts?

ScreenTextLocatorOptions

Returns

ScreenLocator

hitTest()

hitTest(opts?): Promise<PointerHitTest>

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

Whether pointer input at the chosen cell reaches this exact target.

Parameters

opts?

position?

{ columnOffset: number; rowOffset: number; }

position.columnOffset

number

position.rowOffset

number

Returns

Promise<PointerHitTest>

Inherited from

LocatorBase.hitTest

hover()

hover(opts?): Promise<ActionReceipt>

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

Parameters

opts?

PointerOptions

Returns

Promise<ActionReceipt>

Inherited from

LocatorBase.hover

last()

last(): ScreenLocator

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

Returns

ScreenLocator

Inherited from

LocatorBase.last

nth()

nth(index): ScreenLocator

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

Parameters

index

number

Returns

ScreenLocator

Inherited from

LocatorBase.nth

or()

or(other): ScreenLocator

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

Parameters

other

ScreenLocator

Returns

ScreenLocator

Inherited from

LocatorBase.or

resolve()

resolve(opts?): Promise<ResolvedTarget<"screen">>

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

Parameters

opts?

WaitOptions

Returns

Promise<ResolvedTarget<"screen">>

Inherited from

LocatorBase.resolve

textContent()

textContent(): Promise<string>

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

Returns

Promise<string>

Inherited from

LocatorBase.textContent

visibility()

visibility(): Promise<LocatorVisibility>

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

Attached/displayed/viewport facts without collapsing unknown to false.

Returns

Promise<LocatorVisibility>

Inherited from

LocatorBase.visibility

waitFor()

waitFor(opts?): Promise<void>

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

Parameters

opts?

object & WaitOptions

Returns

Promise<void>

waitForCheckpointChange()

waitForCheckpointChange(options): Promise<ObservationStamp>

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

Waits for a newer committed observation without a check/subscribe gap.

Parameters

options

object & WaitOptions

Returns

Promise<ObservationStamp>

Inherited from

LocatorBase.waitForCheckpointChange

wheel()

wheel(opts): Promise<ActionReceipt>

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

Parameters

opts

LocatorWheelOptions

Returns

Promise<ActionReceipt>

Inherited from

LocatorBase.wheel

within()

within(parent): ScreenLocator

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

Parameters

parent

ScreenLocator

Returns

ScreenLocator