@types/karma-summary-reporter

Installation

npm install --save @types/karma-summary-reporter

Summary

This package contains type definitions for karma-summary-reporter (https://github.com/sth/karma-summary-reporter#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/karma-summary-reporter.

index.d.ts

import "karma";

declare module "karma" {
    interface ConfigOptions {
        /**
         * Show a table detailing the test results for all connected browsers at the end of a test run.
         * This gives a better overview which browsers are broken than the output of other reporters.
         * see {@link https://github.com/sth/karma-summary-reporter#config}
         */
        readonly summaryReporter?: SummaryReporterConfig | undefined;
    }

    interface SummaryReporterConfig {
        /**
         * Select which tests are displayed in the summary:
         * * 'failed': Only show tests that failed in some browser (default)
         * * 'skipped': Additionally show tests that got skipped in some browser
         * * 'all': Show all test, also ones that didn't fail specLength
         */
        show?: "failed" | "skipped" | "all" | undefined;
        /**
         * Space reserved to display the spec label (width of the first column in the results table).
         */
        specLength?: number | undefined;
        /**
         * Shows a overview column in the results table, showing the total result of a test over all browsers
         * ("failed" if the test failed anywhere, ...)
         */
        overviewColumn?: boolean | undefined;
        /**
         * Show the list of connected browsers before the result table:
         * * 'always': Show always (default)
         * * 'never': Show never
         * * 'ifneeded': Show only if there are test results shown from multiple browsers
         */
        browserList?: "always" | "never" | "ifneeded" | undefined;

        /**
         * Use custom symbols to indicate success and failure:
         * * success: used for successful test results
         * * failure: used for failed test results
         */
        symbols?: {
            success?: string | undefined;
            failure?: string | undefined;
        } | undefined;
    }
}

Additional Details

• Last updated: Tue, 07 Nov 2023 09:09:38 GMT
• Dependencies: @types/karma

Credits

These definitions were written by Piotr Błażejewicz (Peter Blazejewicz), and Stephan Hohe.