Skip to main content
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
Example:

platform.target

platform.target is a getter on a frozen object. Every access reads the currently configured target.
Example with setup:
Current behavior from the implementation:
  • 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.
The input shape is:

getCurrentScope()

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

resetTarget()

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

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:
Last modified on April 24, 2026