KC's Workspace
    Preparing search index...

    Interface SequenceOptions

    interface SequenceOptions {
        concurrent?: boolean;
        groupOrder?: number;
        hooks?: SequenceHooks;
        seed?: number;
        sequencer?: TestSequencerConstructor;
        setupFiles?: SequenceSetupFiles;
        shuffle?: boolean | { files?: boolean; tests?: boolean };
    }
    Index

    Properties

    concurrent? groupOrder? hooks? seed? sequencer? setupFiles? shuffle?

    Properties

    concurrent?: boolean

    Should tests run in parallel.

    false
    groupOrder?: number

    Controls the order in which this project runs its tests when using multiple projects.

    • Projects with the same group order number will run together, and groups are run from lowest to highest.
    • If you don’t set this option, all projects run in parallel.
    • If several projects use the same group order, they will run at the same time.
    0
    hooks?: SequenceHooks

    Defines how hooks should be ordered

    • stack will order "after" hooks in reverse order, "before" hooks will run sequentially
    • list will order hooks in the order they are defined
    • parallel will run hooks in a single group in parallel
    'stack'
    seed?: number

    Seed for the random number generator.

    Date.now()
    sequencer?: TestSequencerConstructor

    Class that handles sorting and sharding algorithm. If you only need to change sorting, you can extend your custom sequencer from BaseSequencer from vitest/node.

    BaseSequencer
    setupFiles?: SequenceSetupFiles

    Defines how setup files should be ordered

    • 'parallel' will run all setup files in parallel
    • 'list' will run all setup files in the order they are defined in the config file
    'parallel'
    shuffle?: boolean | { files?: boolean; tests?: boolean }

    Should files and tests run in random order.

    Type Declaration

    • boolean
    • { files?: boolean; tests?: boolean }
      • Optionalfiles?: boolean

        Should files run in random order. Long running tests will not start earlier if you enable this option.

        false
      • Optionaltests?: boolean

        Should tests run in random order.

        false

    false

    Settings

    Member Visibility

    On This Page

    Properties