cabbie-sync/lib/time-out.js.flow

A synchronous webdriver client

/**
* @flow
* This file is generated automatically, run npm run build to re-generate.
**/

import type { TimeOutType } from './enums/time-out-types';
import type Driver from './driver';
import addDebugging from './add-debugging';
import ms from 'ms';
import BaseClass from './base-class';
import TimeOutTypes from './enums/time-out-types';

export type TimeoutValue = number | string;

export type TimeOutsConfig = {
  'script'?: TimeoutValue;
  'async'?: TimeoutValue;
  'page load'?: TimeoutValue;
  'implicit'?: TimeoutValue;
};

/*
 * Managing time-out
 */
class TimeOut extends BaseClass {
  constructor(driver: Driver) {
    super(driver, '/timeouts');
  }

  /*
   * Set a time-out
   */
  setTimeOut(timeOutType: TimeOutType, ms: TimeoutValue): void {
    switch (timeOutType) {
      case TimeOutTypes.SCRIPT:
        this.setScriptTimeOut(ms);
        break;
      case TimeOutTypes.ASYNC_SCRIPT:
        this.setAsyncScriptTimeOut(ms);
        break;
      case TimeOutTypes.PAGE_LOAD:
        this.setPageLoadTimeOut(ms);
        break;
      case TimeOutTypes.IMPLICIT:
        this.setImplicitTimeOut(ms);
        break;
      default:
        throw new Error('Invalid timeout type ' + JSON.stringify(timeOutType) + ', expected "script", "page load", "implicit" or "async"');
    }
  }

  /*
   * Set multiple time-outs at once
   */
  setTimeOuts(timeOuts: TimeOutsConfig): void {
    if (timeOuts['script'] != null) {
      this.setTimeOut('script', timeOuts['script']);
    }
    if (timeOuts['implicit'] != null) {
      this.setTimeOut('implicit', timeOuts['implicit']);
    }
    if (timeOuts['async'] != null) {
      this.setTimeOut('async', timeOuts['async']);
    }
    if (timeOuts['page load'] != null) {
      this.setTimeOut('page load', timeOuts['page load']);
    }
  }

  /*
   * Set the amount of time, in milliseconds, that scripts are permitted
   * to run before they are aborted and a "Timeout" error is returned to the client.
   */
  setScriptTimeOut(timeout: TimeoutValue): void {
    timeout = ms(timeout.toString());
    this.requestJSON('POST', '', { type: TimeOutTypes.SCRIPT, ms: timeout });
  }

  /*
   * Set the amount of time, in milliseconds, that asynchronous scripts are permitted
   * to run before they are aborted and a "Timeout" error is returned to the client.
   */
  setAsyncScriptTimeOut(timeout: TimeoutValue): void {
    timeout = ms(timeout.toString());
    this.requestJSON('POST', '/async_script', { ms: timeout });
  }

  /*
   * Set the amount of time, in milliseconds, that a page is permitted to be loaded
   * before they it is aborted and a "Timeout" error is returned to the client.
   */
  setPageLoadTimeOut(timeout: TimeoutValue): void {
    timeout = ms(timeout.toString());
    this.requestJSON('POST', '', { type: TimeOutTypes.PAGE_LOAD, ms: timeout });
  }

  /*
   * Set the amount of time, in milliseconds, that scripts executed are permitted
   * to run before they are aborted and a "Timeout" error is returned to the client.
   */
  setImplicitTimeOut(timeout: TimeoutValue): void {
    timeout = ms(timeout.toString());
    this.requestJSON('POST', '', { type: TimeOutTypes.IMPLICIT, ms: timeout });
  }
}
addDebugging(TimeOut);
export default TimeOut;