Functions

f
abort(config: ResolvedConfig): RunResult

The result of a run that was cancelled before it began: no browser, no tests, aborted: true.

f
buildResult(
config: ResolvedConfig,
outcome: RunOutcome
): RunResult

Assembles the run's result from the config's accumulated state, the run's outcome, and the APIReporter that watched it.

f
test(
input?: UserRunOptions | string | string[],
extra?: UserRunOptions
): Task<RunResult, RunFailure>
2 overloads

Runs the suite once in a real browser and resolves with everything it produced.

Interfaces

I
CoverageSummary

The run's line coverage: one entry per source file, plus the totals across all of them.

I
FileCoverageSummary

Per-file line coverage, when coverage was requested.

I
ResolvedRun

What the run actually resolved to, after package.json, the defaults and the options were merged — the answers a caller cannot otherwise recover from what it passed in.

I
RunGroup

One concurrent group of a run: the files bundled into a single page, and where that page's artifacts were written.

  • files: string[]

    Absolute paths of the test files this group bundled and ran together.

  • index: number

    Position in the run's group list, and the group-<index> suffix on output.

  • output: string

    Absolute path of this group's build output directory.

I
RunResult

Everything a finished run produced.

I
TestResult

One finished test.

Type Aliases

T
RunCounts = Counter

Outcome totals for a run. total is the sum of the four buckets; assertionsFailed counts individual assertions rather than tests, so one test can contribute several.

T
RunFailure = ConfigFailure | InvalidOptionFailure

Every way a run can fail to happen: an option the runner will not accept, an unreadable input, a directory with no package.json above it, an esbuild plugin that will not load.