โœ”๏ธTestResult

The result of your hard work.

Test results are pure data classes with some deprecated convenience methods. They have the following supported shape:

export declare class TestResult implements ILogTarget {
    /** The actual test's name or description. */
    name: string;
    
    /** The indicator to see if the test passed. */
    pass: boolean;
    
    /** The indicated to see if a test actually ran. */
    ran: boolean;
    
    /** The reported actual value description, if it failed. */
    actual: ReflectedValue | null;

    /** The reported expected value description, if it failed. */
    expected: ReflectedValue | null;
    
    /** If the test failed, this is the message describing why the test failed. */
    message: string;
 
    /** A set of logged values during the test. */
    logs: ReflectedValue[];

    /** The generated stack trace if the test errored. */
    stack: string | null;

    /** This value is set to true if the test is expected to throw. */
    negated: boolean;

    /** This is the timestamp for when the test started in milliseconds. */
    start: number;

    /** This is the timestamp for when the test ended in milliseconds. */
    end: number;
 
    /** This is the run time for the test in milliseconds. */
    runTime: number;

    /** A set of errors that were reported for this test. */
    errors: IWarning[];

    /** A set of warnings that were reported for this test. */
    warnings: IWarning[];
}

A lot of the public properties on the TestResult class will be deprecated and consolidated by version 4.0.0.

Last updated