allwright

API ReferenceTypeScriptConfig

Config

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.

resolveConfig

FunctionSince v0.0.27 – v0.0.30

Finds/loads the config (unless configFile is given), applies an optional suite override, and merges web/mobile/desktop sections into a flat resolved shape.

function resolveConfig(options?: ResolveConfigOptions): ResolvedAllwrightConfig

findConfigFile / loadConfigFile

FunctionSince v0.0.27 – v0.0.30

Walks up from a directory looking for allwright.config.{yaml,yml,json}, then parses one into an AllwrightConfig.

function findConfigFile(startDir?: string): string | null
function loadConfigFile(configFile: string): AllwrightConfig

launchConfiguredBrowser

FunctionSince v0.0.27 – v0.0.30

Launches whichever browser a resolved config names, applying its server address and launch options first.

function launchConfiguredBrowser(config: ResolvedAllwrightConfig): Promise<Browser>

CommandOptions

TypeSince v0.0.14

Generic per-call timeout accepted by most Page/Locator/Mobile methods.

type CommandOptions = {
  timeoutMs?: number;
}