TypeScript API reference

Launch a Chromium or Firefox session and hold the handle every other call goes through. Everything in the client is Promise-based — there's no sync/callback surface.

Page.locator(selector) returns a Locator scoped to a selector; every getByRole/getByText/etc. builder documented under Locator is also callable straight on page.

Every action and query method on Page (click, dblclick, fill, hover, press, focus, highlight, count, textContent, innerText, inputValue, selectedOptions, selectedText, isChecked, getAttribute, boundingBox, waitFor) is also available directly on a Locator, scoped to whatever it resolves to. What's below is what a Locator adds: building one semantically instead of by raw selector, and narrowing it once built.

A hook coordinates a browser-native event that fires asynchronously outside any direct call — a new tab, a native file picker, a download. registerHook before the triggering action, then wait for it, so the event can't be missed between the two.

Android automation over adb — no Appium, no separate driver server. Reached through the mobile namespace, for both Android and iOS.

Native macOS (XCUITest) and Windows (UI Automation) application automation through the installable desktop-mac and desktop-windows plugins. Linux is not available yet.

allwright.config.yaml (or .json) drives browser choice, timeouts, and named profiles without writing it in code. Every client picks the file up the same way.

@allwright.dev/vitest layers Playwright-style test fixtures and retrying, negatable assertions on top of @allwright.dev/core, so a spec file never touches launch/config plumbing directly.