allwright

TypeScript API reference

Every type and method @allwright.dev/core ships today, with a Since badge on every entry matching the changelog release it first shipped in.

npm install @allwright.dev/core

Browser

6

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.

View Browser

Page

14

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

View Page

Locator

7

Every action and query method on Page (click, fill, hover, press, focus, highlight, count, textContent, innerText, 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.

View Locator

Hooks

3

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.

View Hooks

Mobile

11

Android automation over adb — no Appium, no separate driver server. Reached through the mobile namespace; iOS has no runtime yet.

View Mobile

Config

4

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.

View Config

Vitest

4

@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.

View Vitest