web-component-tester/runner/browserrunner.d.ts

web-component-tester makes testing your web components a breeze!

/**
 * @license
 * Copyright (c) 2014 The Polymer Project Authors. All rights reserved.
 * This code may only be used under the BSD style license found at
 * http://polymer.github.io/LICENSE.txt
 * The complete set of authors may be found at
 * http://polymer.github.io/AUTHORS.txt
 * The complete set of contributors may be found at
 * http://polymer.github.io/CONTRIBUTORS.txt
 * Code distributed by Google as part of the polymer project is also
 * subject to an additional IP rights grant found at
 * http://polymer.github.io/PATENTS.txt
 */
/// <reference types="node" />
/// <reference types="mocha" />
import * as wd from 'wd';
import { Config } from './config';
export interface Stats {
    status: string;
    passing?: number;
    pending?: number;
    failing?: number;
}
export interface BrowserDef extends wd.Capabilities {
    id: number;
    url: string;
    sessionId: string;
    deviceName?: string;
    variant?: string;
}
export declare class BrowserRunner {
    timeout: number;
    browser: wd.Browser;
    stats: Stats;
    sessionId: string;
    timeoutId: NodeJS.Timer;
    emitter: NodeJS.EventEmitter;
    def: BrowserDef;
    options: Config;
    donePromise: Promise<void>;
    /**
     * The url of the initial page to load in the browser when starting tests.
     */
    url: string;
    private _resolve;
    private _reject;
    /**
     * @param emitter The emitter to send updates about test progress to.
     * @param def A BrowserDef describing and defining the browser to be run.
     *     Includes both metadata and a method for connecting/launching the
     *     browser.
     * @param options WCT options.
     * @param url The url of the generated index.html file that the browser should
     *     point at.
     * @param waitFor Optional. If given, we won't try to start/connect to the
     *     browser until this promise resolves. Used for serializing access to
     *     Safari webdriver, which can only have one instance running at once.
     */
    constructor(emitter: NodeJS.EventEmitter, def: BrowserDef, options: Config, url: string, waitFor?: Promise<void>);
    _init(error: any, sessionId: string): void;
    startTest(): void;
    onEvent(event: string, data: any): void;
    done(error: any): void;
    extendTimeout(): void;
    quit(): void;
    static BrowserRunner: typeof BrowserRunner;
}