KC's Workspace
    Preparing search index...

    Construct a type with the properties of T except for those in type K.

    interface TestTagDefinition {
        concurrent?: boolean;
        description?: string;
        fails?: boolean;
        meta?: Partial<TaskMeta>;
        name: string;
        only?: boolean;
        priority?: number;
        repeats?: number;
        retry?: Retry;
        sequential?: boolean;
        skip?: boolean;
        timeout?: number;
        todo?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    concurrent?: boolean

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

    description?: string

    A description for the tag. This will be shown in the CLI help and UI.

    fails?: boolean

    Whether the test is expected to fail. If it does, the test will pass, otherwise it will fail.

    Custom test metadata available to reporters.

    name: string

    The name of the tag. This is what you use in the tags array in tests.

    only?: boolean

    Should this test be the only one running in a suite.

    priority?: number

    Priority for merging options when multiple tags with the same options are applied to a test.

    Lower number means higher priority. E.g., priority 1 takes precedence over priority 3.

    repeats?: number

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

    0
    
    retry?: Retry

    Retry configuration for the test.

    • If a number, specifies how many times to retry
    • If an object, allows fine-grained retry control
    0
    
    sequential?: boolean

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

    skip?: boolean

    Whether the test should be skipped.

    timeout?: number

    Test timeout.

    todo?: boolean

    Whether the test should be skipped and marked as a todo.