Lupa

Appearance

Lupa API Reference / @pawel-up/lupa/runner / TestSuite

Interface: TestSuite ​

Defined in: src/runner/types.ts:431

A test suite to register tests under a named suite

Properties ​

disableInWatchMode? ​

optional disableInWatchMode?: boolean

Defined in: src/runner/types.ts:469

When true, this suite is skipped entirely during watch mode. Useful for long-running suites (e.g. benchmarks) that should only run in CI or on an explicit full run.

Default ​

ts
false

excludeFromReporting? ​

optional excludeFromReporting?: boolean

Defined in: src/runner/types.ts:481

When true, files in this suite are excluded from reporter progress tracking. The suite still executes normally, but file:start and file:end events are suppressed from reporters, and the files are not counted toward the progress total.

Useful for non-test suites (e.g. benchmarks) that run alongside tests but should not affect the test summary output.

Default ​

ts
false

files ​

files: TestFiles

Defined in: src/runner/types.ts:441

Collection of files associated with the suite. Files should be defined as a glob or a callback function that returns an array of URLs

name ​

name: string

Defined in: src/runner/types.ts:435

A unique name for the suite

priority? ​

optional priority?: number

Defined in: src/runner/types.ts:460

Execution priority. Suites are executed in descending order — higher values run first. Defaults to 100. Use a lower value (e.g. 50) to ensure this suite runs after all higher-priority suites have fully completed.

Default ​

ts
100

retries? ​

optional retries?: number

Defined in: src/runner/types.ts:451

The retries to apply on all the tests in this suite, unless overwritten explicitly

timeout? ​

optional timeout?: number

Defined in: src/runner/types.ts:446

The timeout to apply on all the tests in this suite, unless overwritten explicitly