Window
Window represents an OS window and provides methods to interact with it,
such as moving, resizing, focusing, and searching for UI elements within it.
class Window extends AccessibilityEventEmitter implements WindowInterfaceMethods
find
find(searchInput: object | Promise<object>): Promise<WindowElement>find will search for a single occurrence of a given search input in the current window.
Parameters
searchInputobject | Promise<object>A WindowedFindInput instanceReturns
Promise<WindowElement>findAll
findAll(searchInput: object | Promise<object>): Promise<WindowElement[]>findAll will search for multiple occurrence of a given search input in the current window.
Parameters
searchInputobject | Promise<object>A WindowedFindInput instanceReturns
Promise<WindowElement[]>focus
focus(): Promise<boolean>focus brings the window to the foreground and gives it focus
Returns
Promise<boolean>getElements
getElements(maxElements?: number): Promise<WindowElement>getElements retrieves the UI element tree of the window
Parameters
maxElements?numberOptional maximum number of elements to retrieveReturns
Promise<WindowElement>getRegion
getRegion(): Promise<Region>getRegion returns the Region occupied by the window, clamped to screen boundaries
Returns
Promise<Region>getTitle
getTitle(): Promise<string>getTitle returns the title of the window
Returns
Promise<string>minimize
minimize(): Promise<boolean>minimize minimizes the window
Returns
Promise<boolean>move
move(newOrigin: Point): Promise<boolean>move moves the window to a new origin Point
Parameters
Returns
Promise<boolean>off
off(event: E, listener: unknown[unknown]): thisParameters
eventElistenerunknown[unknown]Returns
thison
on(event: E, listener: unknown[unknown]): thison registers either:
- An event listener for accessibility events (from TypedEmitter)
- A find-hook callback triggered when a WindowElementQuery is matched
Parameters
eventElistenerunknown[unknown]Returns
thisonce
once(event: E, listener: unknown[unknown]): thisParameters
eventElistenerunknown[unknown]Returns
thisremoveAllListeners
removeAllListeners(event?: E): thisParameters
event?EReturns
thisremoveListener
removeListener(event: E, listener: unknown[unknown]): thisParameters
eventElistenerunknown[unknown]Returns
thisresize
resize(newSize: Size): Promise<boolean>resize resizes the window to a new Size
Parameters
Returns
Promise<boolean>restore
restore(): Promise<boolean>restore restores a minimized window
Returns
Promise<boolean>waitFor
waitFor(descriptor: SettledDescriptor): Promise<void>waitFor waits until accessibility events for this window settle
(no events fire for the configured quiet period).
Attach the listener before the triggering action:
``ts
const p = window.waitFor(settled());
await button.click();
await p;
Parameters
Returns
Promise<void>Was this page helpful?