@types/karma-json-to-file-reporter v1.0.4

Installation

npm install --save @types/karma-json-to-file-reporter

Summary

This package contains type definitions for karma-json-to-file-reporter (https://github.com/HarryBurns/karma-json-to-file-reporter#readme).

Details

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

index.d.ts

// Type definitions for karma-json-to-file-reporter 1.0
// Project: https://github.com/HarryBurns/karma-json-to-file-reporter#readme
// Definitions by: Piotr Błażejewicz (Peter Blazejewicz) <https://github.com/peterblazejewicz>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 3.2

import 'karma';

declare module 'karma' {
    interface ConfigOptions {
        /**
         * see {@link https://www.npmjs.com/package/karma-json-to-file-reporter#config}
         */
        jsonToFileReporter?: JsonToFileReporterOptions | undefined;
    }

    /**
     * JSON messages logged via console.log(_) will be filtered
     * and saved to local json file you specified in config.
     */
    interface JsonToFileReporterOptions {
        /** Path for your json output file. By default it will save your files in the root of your project. */
        outputPath?: string | undefined;
        /**
         * File name pattern. You can use wildcards:
         * `*timestamp*` - for current karma run timestamp.
         * `*index*` - for log entry index: 1, 2, 3, etc.
         * @default 'logFile_start-timestamp.json'
         */
        fileName?: string | undefined;
        /**
         * Set it true to overwrite files if it already exists. If false, log entries will be added to the end
         */
        overwrite?: boolean | undefined;
        /**
         * Filter for json objects. This option can be:
         * - string - filter JSONs by field on the root level
         * - predicate function
         */
        filter?: string | ((obj: object) => boolean) | undefined;
    }
}

Additional Details

• Last updated: Thu, 08 Jul 2021 16:23:07 GMT
• Dependencies: @types/karma
• Global values: none

Credits

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