wpt-api-client/lib/es2015/types.d.ts

Unofficial Node.js client for the WebPageTest REST API

export declare type Browser = 'Brave' | 'Chrome' | 'Chrome Beta' | 'Chrome Canary' | 'Firefox' | 'Firefox ESR' | 'Firefox Nightly';
/**
 * Network connectivity
 * https://docs.webpagetest.org/api/reference/#specifying-connectivity
 */
export declare type Connectivity = 'DSL' | 'Cable' | 'FIOS' | 'Dial' | 'Edge' | '2G' | '3GSlow' | '3G' | '3GFast' | '4G' | 'LTE' | 'Native' | 'custom';
declare type LocationIdNorthAmerica = 'Dulles' | 'Dulles_Edge' | 'Dulles_IE11' | 'Dulles_MotoG4' | 'Dulles_MotoG6' | 'Dulles_MotoG' | 'Dulles_MotoE' | 'Dulles_iPhone8' | 'Dulles_iPhone7plus' | 'Dulles_iPhone6' | 'Dulles_iPhone5c' | 'Dulles_iPad' | 'Dulles_iPadMini2' | 'Dulles_Thinkpad' | 'Dulles_Aspire17' | 'Dulles_M1MacMini' | 'Dulles_Pi3' | 'Dulles_Pi4' | 'ec2-us-east-1' | 'gce-us-west3' | 'ec2-us-west-1' | 'ec2-ca-central-1';
declare type LocationIdSouthAmerica = 'ec2-sa-east-1';
declare type LocationIdEurope = 'ec2-eu-west-1' | 'London_EC2' | 'ec2-eu-west-3' | 'gce-europe-west4' | 'ec2-eu-central-1' | 'ec2-eu-south-1' | 'ec2-eu-north-1';
declare type LocationIdAsia = 'ec2-me-south-1' | 'azure-uae-north' | 'ap-south-1' | 'tencent-bangkok' | 'ec2-ap-southeast-1' | 'gce-asia-southeast2' | 'ec2-ap-east-1' | 'tencent-shanghai' | 'ec2-cn-north-1' | 'tencent-beijing' | 'ec2-cn-northwest-1' | 'gce-asia-east1' | 'ec2-ap-northeast-2' | 'ec2-ap-northeast-1' | 'ec2-ap-northeast-3';
declare type LocationIdOceania = 'ec2-ap-southeast-2' | 'azure-australia-southeast';
declare type LocationIdAfrica = 'ec2-af-south-1';
/**
 * All locations available for an API call.
 * https://www.webpagetest.org/getLocations.php?f=html
 * https://docs.webpagetest.org/api/reference/#available-locations-for-api-calls
 */
export declare type LocationId = LocationIdAfrica | LocationIdAsia | LocationIdEurope | LocationIdNorthAmerica | LocationIdOceania | LocationIdSouthAmerica;
export declare type Endpoint = 'cancelTest.php' | 'getLocations.php' | 'runtest.php' | 'testStatus.php';
export declare type Group = 'Asia' | 'Oceania' | 'Europe' | 'North America' | 'South America';
export interface PendingTests {
    p1: number;
    p2: number;
    p3: number;
    p4: number;
    p5: number;
    p6: number;
    p7: number;
    p8: number;
    p9: number;
    Blocking: number;
    HighPriority: number;
    Idle: number;
    LowPriority: number;
    TestAgentRatio: number;
    Testing: number;
    Total: number;
}
export interface Location {
    Browsers: string;
    group: Group;
    Label: string;
    labelShort: string;
    location: string;
    node: string;
    PendingTests: PendingTests;
    status: string;
}
/**
 * Status codes returned by the WebPageTest API.
 *
 * https://docs.webpagetest.org/api/reference/#status-codes
 */
export declare type StatusCode = 100 | 101 | 102 | 200 | 400 | 401 | 402;
export {};
//# sourceMappingURL=types.d.ts.map