Interface: Mouse
@termwright/driver / Mouse
Interface: Mouse
Section titled “Interface: Mouse”Defined in: driver/src/api.ts:310
@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
Section titled “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();Methods
Section titled “Methods”click()
Section titled “click()”click(
point):Promise<void>
Defined in: driver/src/api.ts:318
Parameters
Section titled “Parameters”MousePoint & MouseModifierOptions & object
Returns
Section titled “Returns”Promise<void>
down()
Section titled “down()”down(
point):Promise<void>
Defined in: driver/src/api.ts:312
Parameters
Section titled “Parameters”MousePoint & MouseModifierOptions & object
Returns
Section titled “Returns”Promise<void>
drag()
Section titled “drag()”drag(
options):Promise<void>
Defined in: driver/src/api.ts:332
Parameters
Section titled “Parameters”options
Section titled “options”MouseModifierOptions & object
Returns
Section titled “Returns”Promise<void>
move()
Section titled “move()”move(
point):Promise<void>
Defined in: driver/src/api.ts:311
Parameters
Section titled “Parameters”MousePoint & MouseModifierOptions
Returns
Section titled “Returns”Promise<void>
up(
point):Promise<void>
Defined in: driver/src/api.ts:315
Parameters
Section titled “Parameters”MousePoint & MouseModifierOptions & object
Returns
Section titled “Returns”Promise<void>
wheel()
Section titled “wheel()”wheel(
options):Promise<void>
Defined in: driver/src/api.ts:325
Parameters
Section titled “Parameters”options
Section titled “options”MousePoint & MouseModifierOptions & object
Returns
Section titled “Returns”Promise<void>