KC's Workspace
    Preparing search index...

    Interface TestContext

    User's custom test context.

    interface TestContext {
        annotate: {
            (
                message: string,
                type?: string,
                attachment?: TestAttachment,
            ): Promise<TestAnnotation>;
            (message: string, attachment?: TestAttachment): Promise<TestAnnotation>;
        };
        onTestFailed: (fn: OnTestFailedHandler, timeout?: number) => void;
        onTestFinished: (fn: OnTestFinishedHandler, timeout?: number) => void;
        signal: AbortSignal;
        skip: { (note?: string): never; (condition: boolean, note?: string): void };
        task: Readonly<Test>;
    }
    Index

    Properties

    annotate onTestFailed onTestFinished signal skip task

    Properties

    annotate: {
        (
            message: string,
            type?: string,
            attachment?: TestAttachment,
        ): Promise<TestAnnotation>;
        (message: string, attachment?: TestAttachment): Promise<TestAnnotation>;
    }

    Add a test annotation that will be displayed by your reporter.

    https://vitest.dev/guide/test-context#annotate

    onTestFailed: (fn: OnTestFailedHandler, timeout?: number) => void

    Register a callback to run when this specific test fails. Useful when tests run concurrently.

    https://vitest.dev/guide/test-context#ontestfailed

    onTestFinished: (fn: OnTestFinishedHandler, timeout?: number) => void

    Register a callback to run when this specific test finishes. Useful when tests run concurrently.

    https://vitest.dev/guide/test-context#ontestfinished

    signal: AbortSignal

    An AbortSignal that will be aborted if the test times out or the test run was cancelled.

    https://vitest.dev/guide/test-context#signal

    skip: { (note?: string): never; (condition: boolean, note?: string): void }

    Mark tests as skipped. All execution after this call will be skipped. This function throws an error, so make sure you are not catching it accidentally.

    https://vitest.dev/guide/test-context#skip

    task: Readonly<Test>

    Metadata of the current test

    Settings

    Member Visibility

    On This Page

    Properties