wpt-api-client
Version:
Unofficial Node.js client for the WebPageTest REST API
47 lines • 1.46 kB
TypeScript
import type { Browser, Connectivity, LocationId } from './types';
/**
* Optional parameters for the /runtest.php WebPageTest API endpoint.
*
* TODO: add all parameters (rename them for clarity)
* https://docs.webpagetest.org/api/reference/#running-a-test
*
* TODO: harmonize with test-status.ts
*/
interface OptionalParameters {
blockUrls: string[];
browser: Browser;
captureTcpPackets: boolean;
connectivity: Connectivity;
disableJavaScript: boolean;
emulateMobile: boolean;
firstViewOnly: boolean;
isPrivate: boolean;
label: string;
locationId: LocationId;
pingback: string;
runs: number;
video: boolean;
}
export declare type Options = Partial<OptionalParameters>;
interface Data {
browser: Browser;
connectivity: Connectivity;
detailCSV: string;
jsonUrl: string;
location: LocationId;
summaryCSV: string;
testId: string;
userUrl: string;
xmlUrl: string;
}
export declare type RunTest = (testUrl: string, options?: Options) => Promise<Data>;
declare type MakeRunTest = (apiKey?: string, wptServer?: string) => RunTest;
/**
* Create function to call the /runtest.php endpoint.
*
* https://docs.webpagetest.org/api/reference/#running-a-test
* https://github.com/marcelduran/webpagetest-api/blob/1b6c221708ade50282799feacce5345de674150d/lib/webpagetest.js#L318
*/
export declare const makeRunTest: MakeRunTest;
export {};
//# sourceMappingURL=run-test.d.ts.map