@wdio/devtools-service/build/auditor.d.ts

A WebdriverIO service that allows you to run Chrome DevTools commands in your tests

import type { CustomInstanceCommands } from 'webdriverio';
import type { FormFactor, Audit, AuditResult, LHAuditResult, ErrorAudit, PWAAudits } from './types.js';
import type { Trace } from './gatherer/trace.js';
import type { CDPSessionOnMessageObject } from './gatherer/devtools.js';
export default class Auditor {
    private _traceLogs?;
    private _devtoolsLogs?;
    private _formFactor?;
    private _url?;
    constructor(_traceLogs?: Trace | undefined, _devtoolsLogs?: CDPSessionOnMessageObject[] | undefined, _formFactor?: FormFactor | undefined);
    _audit(AUDIT: Audit, params?: {}): Promise<LHAuditResult> | ErrorAudit;
    /**
     * an Auditor instance is created for every trace so provide an updateCommands
     * function to receive the latest performance metrics with the browser instance
     */
    updateCommands(browser: WebdriverIO.Browser, customFn?: CustomInstanceCommands<WebdriverIO.Browser>['addCommand']): void;
    /**
     * Returns a list with a breakdown of all main thread task and their total duration
     */
    getMainThreadWorkBreakdown(): Promise<{
        group: string;
        duration: number;
    }[]>;
    /**
     * Get some useful diagnostics about the page load
     */
    getDiagnostics(): Promise<any>;
    /**
     * Get most common used performance metrics
     */
    getMetrics(): Promise<{
        timeToFirstByte: number;
        serverResponseTime: number;
        domContentLoaded: number;
        firstVisualChange: number;
        firstPaint: number;
        firstContentfulPaint: number;
        firstMeaningfulPaint: number;
        largestContentfulPaint: number;
        lastVisualChange: number;
        interactive: number;
        load: number;
        speedIndex: number;
        totalBlockingTime: number;
        maxPotentialFID: number;
        cumulativeLayoutShift: number;
    }>;
    /**
     * Returns the Lighthouse Performance Score which is a weighted mean of the following metrics: firstMeaningfulPaint, interactive, speedIndex
     */
    getPerformanceScore(): Promise<any>;
    _auditPWA(params: any, auditsToBeRun?: PWAAudits[]): Promise<AuditResult>;
}
//# sourceMappingURL=auditor.d.ts.map