/** * This module contains the CircleCI v8 coverage collector, used to gather * coverage data for CircleCI's Smarter Testing JavaScript plugins. * * The coverage collector can be used to collect precise coverage during the * test run lifecycles. * * @example * ```ts * import { V8CoverageCollector } from '@circleci/v8-coverage-collector'; * * export default class TestHookExample { * private inspector: V8CoverageCollector; * * constructor() { * this.inspector = new V8CoverageCollector(); * } * * async onBeforeAll(): Promise { * await this.inspector.connect() * } * * async onBeforeTest(): Promise { * await this.inspector.resetCoverage(); * } * * async onAfterTest(test: ExampleTest): Promise { * await this.inspector * .collectCoverage(process.cwd(), test.file, test.class, test.name) * .then((result) => { * test.meta.testKey = result.testKey; * test.meta.coveredFiles = result.coveredFiles; * }); * } * * async onAfterAll(): Promise { * await this.inspector.disconnect() * } * } * ``` * * @module */ /** * TestCoverage is the response from {@link collectCoverage} * for a given test file and name. */ export interface TestCoverage { /** * testKey is unique identifier for a given test. * * @example `{test file}::{test name}|{phase}` * * */ testKey: string; /** * coveredFiles is a list of found covered files, relative * to the given working directory. */ coveredFiles: string[]; } /** * V8CoverageCollector provides APIs for collecting coverage using the * v8 Profile APIs. */ export declare class V8CoverageCollector { private readonly session; private readonly post; constructor(); /** * connect connects and enables the v8 Profiler APIs. * * @returns {Promise} */ connect(): Promise; /** * disconnect disconnects and disables the v8 Profiler APIs. * * @returns {Promise} */ disconnect(): Promise; /** * resetCoverage resets the execution counts of the coverage. * * @returns {Promise} */ resetCoverage(): Promise; /** * collectCoverage collects coverage data since the last time * {@link resetCoverage} was called. * * @param {string} wd * @param {string} testFile * @param {...string} scopes - one or more additional scope segments e.g. testClass, testName * @returns {Promise} */ collectCoverage(wd: string, testFile: string, ...scopes: string[]): Promise; private testKey; private coveredFiles; private enable; private disable; private startPreciseCoverage; private stopPreciseCoverage; private takePreciseCoverage; } //# sourceMappingURL=index.d.ts.map