Interface TaskCustomOptions

interface TaskCustomOptions {
    concurrent?: boolean;
    each?: boolean;
    fails?: boolean;
    fixtures?: FixtureItem[];
    handler?: ((context) => Awaitable<void>);
    meta?: Record<string, unknown>;
    only?: boolean;
    repeats?: number;
    retry?: number;
    sequential?: boolean;
    skip?: boolean;
    timeout?: number;
    todo?: boolean;
}

Hierarchy (view full)

Properties

concurrent? each? fails? fixtures? handler? meta? only? repeats? retry? sequential? skip? timeout? todo?

Properties

Optional concurrent

concurrent?: boolean

Whether tests run concurrently. Tests inherit concurrent from describe() and nested describe() will inherit from parent's concurrent.

Optional each

each?: boolean

Optional fails

fails?: boolean

Optional fixtures

fixtures?: FixtureItem[]

Optional handler

handler?: ((context) => Awaitable<void>)

Type declaration

    • (context): Awaitable<void>

    • Parameters

      Returns Awaitable<void>

Optional meta

meta?: Record<string, unknown>

Optional only

only?: boolean

Optional repeats

repeats?: number

How many times the test will run. Only inner tests will repeat if set on describe(), nested describe() will inherit parent's repeat by default.

Default

0

Optional retry

retry?: number

Times to retry the test if fails. Useful for making flaky tests more stable. When retries is up, the last test error will be thrown.

Default

0

Optional sequential

sequential?: boolean

Whether tests run sequentially. Tests inherit sequential from describe() and nested describe() will inherit from parent's sequential.

Optional skip

skip?: boolean

Optional timeout

timeout?: number

Test timeout.

Optional todo

todo?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc