echidna-coverage-parser/lib/esm/parsing/index.d.ts

Echidna log parser package

import { FileDataWithCoverage } from "../types/types";
/**
 * The function `readFileAndProcess` reads a file, processes its content, and
 * returns an array of `FileDataWithCoverage` objects.
 * @param {string} filePath - The `filePath` parameter is a string that represents
 * the path to the file that you want to read and process.
 * @param {boolean} allFunctions - The `allFunctions` parameter is a boolean flag
 * that indicates whether all functions in the file should be processed or not. If
 * `allFunctions` is set to `true`, then all functions in the file will be
 * processed. If it is set to `false`, only specific functions may be processed
 * based
 * @returns The function `readFileAndProcess` is returning an array of
 * `FileDataWithCoverage` objects.
 */
export declare function readFileAndProcess(filePath: string, allFunctions: boolean): FileDataWithCoverage[];
/**
 * The function `readCoverageFileAndProcess` reads a coverage file and processes
 * its content to return an array of `FileDataWithCoverage` objects.
 * @param {string} coverageText - The `coverageText` parameter is a string that contains the
 * content of the coverage file that needs to be read and processed.
 * @param {boolean} allFunctions - The `allFunctions` parameter is a boolean flag
 * that indicates whether all functions should be processed or not. If
 * `allFunctions` is set to `true`, then all functions in the file will be
 * processed. If it is set to `false`, only specific functions may be processed
 * based on certain conditions
 * @returns The function `readCoverageFileAndProcess` is returning an array of
 * `FileDataWithCoverage` objects.
 */
export declare function readCoverageFileAndProcess(coverageText: string, allFunctions: boolean): FileDataWithCoverage[];