lighthouse 12.1.0 → 12.2.0

package/core/lib/lantern/simulation/NetworkAnalyzer.d.ts

@@ -1,209 +0,0 @@
-export type Summary = {
-    min: number;
-    max: number;
-    avg: number;
-    median: number;
-};
-export type RTTEstimateOptions = {
-    /**
-     * TCP connection handshake information will be used when available, but in some circumstances this data can be unreliable. This flag exposes an option to ignore the handshake data and use the coarse download/TTFB timing data.
-     */
-    forceCoarseEstimates?: boolean | undefined;
-    /**
-     * Coarse estimates include lots of extra time and noise multiply by some factor to deflate the estimates a bit.
-     */
-    coarseEstimateMultiplier?: number | undefined;
-    /**
-     * Useful for testing to isolate the different methods of estimation.
-     */
-    useDownloadEstimates?: boolean | undefined;
-    /**
-     * Useful for testing to isolate the different methods of estimation.
-     */
-    useSendStartEstimates?: boolean | undefined;
-    /**
-     * Useful for testing to isolate the different methods of estimation.
-     */
-    useHeadersEndEstimates?: boolean | undefined;
-};
-export class NetworkAnalyzer {
-    /**
-     * @return {string}
-     */
-    static get SUMMARY(): string;
-    /**
-     * @param {Lantern.NetworkRequest[]} records
-     * @return {Map<string, Lantern.NetworkRequest[]>}
-     */
-    static groupByOrigin(records: Lantern.NetworkRequest[]): Map<string, Lantern.NetworkRequest[]>;
-    /**
-     * @param {number[]} values
-     * @return {Summary}
-     */
-    static getSummary(values: number[]): Summary;
-    /**
-     * @param {Map<string,number[]>} values
-     * @return {Map<string, Summary>}
-     */
-    static summarize(values: Map<string, number[]>): Map<string, Summary>;
-    /** @typedef {{request: Lantern.NetworkRequest, timing: Lantern.ResourceTiming, connectionReused?: boolean}} RequestInfo */
-    /**
-     * @param {Lantern.NetworkRequest[]} requests
-     * @param {(e: RequestInfo) => number | number[] | undefined} iteratee
-     * @return {Map<string, number[]>}
-     */
-    static _estimateValueByOrigin(requests: Lantern.NetworkRequest[], iteratee: (e: {
-        request: Lantern.NetworkRequest;
-        timing: Lantern.ResourceTiming;
-        connectionReused?: boolean | undefined;
-    }) => number | number[] | undefined): Map<string, number[]>;
-    /**
-     * Estimates the observed RTT to each origin based on how long the connection setup.
-     * For h1 and h2, this could includes two estimates - one for the TCP handshake, another for
-     * SSL negotiation.
-     * For h3, we get only one estimate since QUIC establishes a secure connection in a
-     * single handshake.
-     * This is the most accurate and preferred method of measurement when the data is available.
-     *
-     * @param {RequestInfo} info
-     * @return {number[]|number|undefined}
-     */
-    static _estimateRTTViaConnectionTiming(info: {
-        request: Lantern.NetworkRequest;
-        timing: Lantern.ResourceTiming;
-        connectionReused?: boolean | undefined;
-    }): number[] | number | undefined;
-    /**
-     * Estimates the observed RTT to each origin based on how long a download took on a fresh connection.
-     * NOTE: this will tend to overestimate the actual RTT quite significantly as the download can be
-     * slow for other reasons as well such as bandwidth constraints.
-     *
-     * @param {RequestInfo} info
-     * @return {number|undefined}
-     */
-    static _estimateRTTViaDownloadTiming(info: {
-        request: Lantern.NetworkRequest;
-        timing: Lantern.ResourceTiming;
-        connectionReused?: boolean | undefined;
-    }): number | undefined;
-    /**
-     * Estimates the observed RTT to each origin based on how long it took until Chrome could
-     * start sending the actual request when a new connection was required.
-     * NOTE: this will tend to overestimate the actual RTT as the request can be delayed for other
-     * reasons as well such as more SSL handshakes if TLS False Start is not enabled.
-     *
-     * @param {RequestInfo} info
-     * @return {number|undefined}
-     */
-    static _estimateRTTViaSendStartTiming(info: {
-        request: Lantern.NetworkRequest;
-        timing: Lantern.ResourceTiming;
-        connectionReused?: boolean | undefined;
-    }): number | undefined;
-    /**
-     * Estimates the observed RTT to each origin based on how long it took until Chrome received the
-     * headers of the response (~TTFB).
-     * NOTE: this is the most inaccurate way to estimate the RTT, but in some environments it's all
-     * we have access to :(
-     *
-     * @param {RequestInfo} info
-     * @return {number|undefined}
-     */
-    static _estimateRTTViaHeadersEndTiming(info: {
-        request: Lantern.NetworkRequest;
-        timing: Lantern.ResourceTiming;
-        connectionReused?: boolean | undefined;
-    }): number | undefined;
-    /**
-     * Given the RTT to each origin, estimates the observed server response times.
-     *
-     * @param {Lantern.NetworkRequest[]} records
-     * @param {Map<string, number>} rttByOrigin
-     * @return {Map<string, number[]>}
-     */
-    static _estimateResponseTimeByOrigin(records: Lantern.NetworkRequest[], rttByOrigin: Map<string, number>): Map<string, number[]>;
-    /**
-     * @param {Lantern.NetworkRequest[]} requests
-     * @return {boolean}
-     */
-    static canTrustConnectionInformation(requests: Lantern.NetworkRequest[]): boolean;
-    /**
-     * Returns a map of requestId -> connectionReused, estimating the information if the information
-     * available in the records themselves appears untrustworthy.
-     *
-     * @param {Lantern.NetworkRequest[]} records
-     * @param {{forceCoarseEstimates: boolean}} [options]
-     * @return {Map<string, boolean>}
-     */
-    static estimateIfConnectionWasReused(records: Lantern.NetworkRequest[], options?: {
-        forceCoarseEstimates: boolean;
-    } | undefined): Map<string, boolean>;
-    /**
-     * Estimates the RTT to each origin by examining observed network timing information.
-     * Attempts to use the most accurate information first and falls back to coarser estimates when it
-     * is unavailable.
-     *
-     * @param {Lantern.NetworkRequest[]} records
-     * @param {RTTEstimateOptions} [options]
-     * @return {Map<string, Summary>}
-     */
-    static estimateRTTByOrigin(records: Lantern.NetworkRequest[], options?: RTTEstimateOptions | undefined): Map<string, Summary>;
-    /**
-     * Estimates the server response time of each origin. RTT times can be passed in or will be
-     * estimated automatically if not provided.
-     *
-     * @param {Lantern.NetworkRequest[]} records
-     * @param {RTTEstimateOptions & {rttByOrigin?: Map<string, number>}} [options]
-     * @return {Map<string, Summary>}
-     */
-    static estimateServerResponseTimeByOrigin(records: Lantern.NetworkRequest[], options?: (RTTEstimateOptions & {
-        rttByOrigin?: Map<string, number> | undefined;
-    }) | undefined): Map<string, Summary>;
-    /**
-     * Computes the average throughput for the given requests in bits/second.
-     * Excludes data URI, failed or otherwise incomplete, and cached requests.
-     * Returns Infinity if there were no analyzable network requests.
-     *
-     * @param {Lantern.NetworkRequest[]} records
-     * @return {number}
-     */
-    static estimateThroughput(records: Lantern.NetworkRequest[]): number;
-    /**
-     * @param {Lantern.NetworkRequest[]} records
-     */
-    static computeRTTAndServerResponseTime(records: Lantern.NetworkRequest[]): {
-        rtt: number;
-        additionalRttByOrigin: Map<string, number>;
-        serverResponseTimeByOrigin: Map<string, number>;
-    };
-    /**
-     * @param {Lantern.NetworkRequest[]} records
-     * @return {Lantern.Simulation.Settings['networkAnalysis']}
-     */
-    static analyze(records: Lantern.NetworkRequest[]): Lantern.Simulation.Settings['networkAnalysis'];
-    /**
-     * @template {Lantern.NetworkRequest} T
-     * @param {Array<T>} records
-     * @param {string} resourceUrl
-     * @return {T|undefined}
-     */
-    static findResourceForUrl<T extends Lantern.NetworkRequest<any>>(records: T[], resourceUrl: string): T | undefined;
-    /**
-     * @template {Lantern.NetworkRequest} T
-     * @param {Array<T>} records
-     * @param {string} resourceUrl
-     * @return {T|undefined}
-     */
-    static findLastDocumentForUrl<T_1 extends Lantern.NetworkRequest<any>>(records: T_1[], resourceUrl: string): T_1 | undefined;
-    /**
-     * Resolves redirect chain given a main document.
-     * See: {@link NetworkAnalyzer.findLastDocumentForUrl}) for how to retrieve main document.
-     *
-     * @template {Lantern.NetworkRequest} T
-     * @param {T} request
-     * @return {T}
-     */
-    static resolveRedirects<T_2 extends Lantern.NetworkRequest<any>>(request: T_2): T_2;
-}
-import * as Lantern from '../lantern.js';
-//# sourceMappingURL=NetworkAnalyzer.d.ts.map