wpt-api-client
Version:
Unofficial Node.js client for the WebPageTest REST API
48 lines • 1.33 kB
TypeScript
import type { Browser, Connectivity, Location } from './types';
interface DataTestCompleted {
browser: Browser;
bwDownloadKbps: number;
bwUploadKbps: number;
completeTime: string;
connectivity: Connectivity;
firstViewOnly: boolean;
hasDevToolsTimeline: boolean;
hasVideo: boolean;
ignoreSSL: boolean;
label: string;
latencyMs: number;
location: Location;
mobile: boolean;
netlog: boolean;
noscript: boolean;
packetLossRate: string;
runs: number;
status: Status.COMPLETED;
tcpdump: boolean;
trace: boolean;
url: string;
}
export declare enum Status {
'COMPLETED' = "COMPLETED",
'QUEUED' = "QUEUED",
'STARTED' = "STARTED"
}
interface DataTestStarted {
startTime: string;
status: Status.STARTED;
}
interface DataTestQueued {
behindCount: number;
status: Status.QUEUED;
}
export declare type Data = DataTestQueued | DataTestStarted | DataTestCompleted;
export declare type TestStatus = (id: string) => Promise<Data>;
declare type MakeTestStatus = (wptServer?: string) => TestStatus;
/**
* Create function to call the /testStatus.php endpoint.
*
* https://docs.webpagetest.org/api/reference/#check-test-status
*/
export declare const makeTestStatus: MakeTestStatus;
export {};
//# sourceMappingURL=test-status.d.ts.map