Top-Level

The top-level @qawolf/flows entry point exposes cross-platform helpers and types.

Primary exports

platform.target
configureTarget(...)
getCurrentScope()
resetTarget()
FailWithoutRetryError

It also re-exports:

type Target
type TargetScope

Target literals

The target string must exactly match one of the supported values or your flow will fail to initialize.

type Target =
  | "Basic"
  | "Web - Chrome"
  | "Web - Chrome (GPU)"
  | "Web - Firefox"
  | "Web - Firefox (GPU)"
  | "Web - Safari"
  | "Web - Safari (GPU)"
  | "Android - Any Phone (Android 16 | Emulator)"
  | "Android - Any Phone (Android 17 | Emulator)"
  | "Android - Any Phone (Latest | Emulator)"
  | "Android - Any Tablet (Android 17 | Emulator)"
  | "Android - Any Tablet (Latest | Emulator)"
  | "Android - Google Pixel 2 (Android 14 | Emulator)"
  | "Android - Google Pixel 9 (Android 14 | Emulator)"
  | "Android - Google Pixel 9 (Android 15 | Emulator)"
  | "Android - Google Pixel 9 (Android 16 | Emulator)"
  | "Android - Google Pixel 9 (Android 17 | Emulator)"
  | "Android - Google Pixel Tablet (Android 14 | Emulator)"
  | "Android - Google Pixel Tablet (Android 17 | Emulator)"
  | "Android - Samsung Galaxy A37 (Android 16)"
  | "iOS - Any iPad (iOS 26)"
  | "iOS - Any iPad (Latest)"
  | "iOS - Any iPhone (iOS 18)"
  | "iOS - Any iPhone (iOS 26)"
  | "iOS - Any iPhone (iOS 27)"
  | "iOS - Any iPhone (Latest)"
  | "iOS - iPad 11 (iOS 18)"
  | "iOS - iPad 11 (iOS 18 | Apple ID)"
  | "iOS - iPad 11 (iOS 26)"
  | "iOS - iPhone 15 (iOS 18)"
  | "iOS - iPhone 15 (iOS 26)"
  | "iOS - iPhone 15 (iOS 26 | Allowlisted)"
  | "iOS - iPhone 15 (iOS 26 | Apple ID)"
  | "iOS - iPhone 15 (iOS 26 | Private)"
  | "iOS - iPhone 16 (iOS 26)"
  | "iOS - iPhone 16 (iOS 27)"
  | "iOS - iPhone 17 (iOS 26)"
  | "iOS - iPhone 17 (iOS 27)"
  | "Windows 11 - Desktop"
  | "Windows 11 - Desktop (private)";

See Target names for how to read a target name. Example:

import {
  FailWithoutRetryError,
  configureTarget,
  getCurrentScope,
  platform,
  resetTarget,
} from "@qawolf/flows";
import type { Target } from "@qawolf/flows";

declare const target: Target;

configureTarget({ target });

const currentTarget = platform.target;
const currentScope = getCurrentScope();

if (!currentScope) {
  throw new FailWithoutRetryError();
}

resetTarget();

Target names

Android and iOS target names follow the pattern <Platform> - <Model> (<Version> | <Qualifier>). The qualifier is optional.

Model — a device model, such as Google Pixel 9 or iPhone 15. Any Phone, Any Tablet, Any iPhone and Any iPad accept any model of that kind.
Version — the OS marketing version, such as Android 16 or iOS 26. Latest points to a version that QA Wolf chooses and moves forward over time. Flows that use Latest follow it with no edit.
Emulator — the flow runs on an Android emulator. An Android target without it runs on a real phone. iOS targets always run on real devices.
Allowlisted and Private — the flow runs on allowlisted or private iOS devices. See iOS Device Pools for when to use them and how to set them up. For dedicated Android phones, see Dedicated phones.
Apple ID — the flow runs on an iOS device that is signed in to an Apple ID.

Windows has two targets. Windows 11 - Desktop runs on the shared pool of Windows VMs, and Windows 11 - Desktop (private) on a pool for your workspace alone. See Windows.

`platform.target`

platform.target is a getter on a frozen object. Every access reads the currently configured target.

import { platform } from "@qawolf/flows";

const target = platform.target;

Example with setup:

import { configureTarget, platform } from "@qawolf/flows";
import type { Target } from "@qawolf/flows";

declare const target: Target;

configureTarget({ target });

console.log(platform.target);

It throws if no target has been configured. It always reflects the latest value set through configureTarget(...).

`configureTarget(...)`

Use this to set the active target in local execution or tests.

import { configureTarget } from "@qawolf/flows";
import type { Target } from "@qawolf/flows";

declare const target: Target;

configureTarget({ target });

The input shape is:

type TargetScope = {
  target: Target;
};

`getCurrentScope()`

Returns the current configured target scope, or undefined when no target has been configured yet. Example:

import { getCurrentScope } from "@qawolf/flows";

const scope = getCurrentScope();

if (scope) {
  console.log(scope.target);
}

`resetTarget()`

Clears the configured target scope. Use this in tests to avoid leaking target state across cases. Example:

import { configureTarget, getCurrentScope, resetTarget } from "@qawolf/flows";
import type { Target } from "@qawolf/flows";

declare const target: Target;

configureTarget({ target });
resetTarget();

console.log(getCurrentScope()); // undefined

`FailWithoutRetryError`

This is a dedicated error class whose message is "failWithoutRetry". Use it when flow execution should fail immediately rather than being treated as retryable by the surrounding runtime. Example:

import { FailWithoutRetryError } from "@qawolf/flows";

throw new FailWithoutRetryError();

Flow conventions

@qawolf/flows

@qawolf/pom

@qawolf/testkit

@qawolf/emails

@qawolf/cli

Local execution

@qawolf/ci-sdk

Triggers

REST

Primary exports

Target literals

Target names

`platform.target`

`configureTarget(...)`

`getCurrentScope()`

`resetTarget()`

`FailWithoutRetryError`

​Primary exports

​Target literals

​Target names

​platform.target

​configureTarget(...)

​getCurrentScope()

​resetTarget()

​FailWithoutRetryError

Primary exports

Target literals

Target names

`platform.target`

`configureTarget(...)`

`getCurrentScope()`

`resetTarget()`

`FailWithoutRetryError`