interface

test.TestWithContext

interface TestWithContext<Context, Row extends ReadonlyArray<unknown> = []>

A test whose callbacks receive the TestContext instead of a done callback.

afterAll: SuiteHook<Context>
afterEach: ContextHook<Context>
aroundAll: AroundHook<Context>
Like aroundAll. The callback receives the scope: "file" or "worker" fixtures that it destructures.
aroundEach: AroundHook<Context & TestContext>
Like aroundEach. A fixture the callback destructures is torn down after the callback finishes.
beforeAll: SuiteHook<Context>
The callback receives the scope: "file" or "worker" fixtures that it destructures, and the suite.
beforeEach: ContextHook<Context>
If the callback returns a function, that function runs after the afterEach hooks.
concurrent: TestWithContext<Context, Row>
describe: Describe<[]>
extend: ExtendTest<Context>
failing: TestWithContext<Context, Row>
fails: TestWithContext<Context, Row>
only: TestWithContext<Context, Row>
sequential: TestWithContext<Context, Row>
serial: TestWithContext<Context, Row>
skip: (label: string) => void & TestWithContext<Context, Row>
suite: Describe<[]>
todo: (label: string) => void & TestWithContext<Context, Row>
concurrentIf(
condition: boolean
): TestWithContext<Context, Row>;
each<T extends readonly unknown[]>(
table: readonly T[]
): TestOfRows<T>;
each<T>(
table: readonly T[]
): TestOfRows<[row: T]>;
each(
headings: TemplateStringsArray,
...values: any[]
): TestOfRows<[row: any]>;
failingIf(
condition: boolean
): TestWithContext<Context, Row>;
for<T>(
table: readonly T[]
): TestWithContext<Context, [row: T]>;
for(
headings: TemplateStringsArray,
...values: any[]
): TestWithContext<Context, [row: any]>;
if(
condition: boolean
): TestWithContext<Context, Row>;
override(
fixtures: Partial<Fixtures<Context, object>>
): this;
Replaces fixtures for the tests in the describe() block it's called in, or in the file when called outside one.
runIf(
condition: boolean
): TestWithContext<Context, Row>;
serialIf(
condition: boolean
): TestWithContext<Context, Row>;
skipIf(
condition: boolean
): TestWithContext<Context, Row>;
todoIf(
condition: boolean
): TestWithContext<Context, Row>;

Referenced types

interface TestOptions

repeats?: number
Sets the number of times to repeat the test, regardless of whether it passed or failed.
retry?: number
Sets the number of times to retry the test if it fails.
timeout?: number
Sets the timeout for the test in milliseconds.
If the test does not complete within this time, it fails with:
'Timeout: test {name} timed out after 5000ms'