@applitools/eyes.selenium/lib/fluent/Target.js

Applitools Eyes SDK for Selenium WebDriver

'use strict';

const { SeleniumCheckSettings } = require('./SeleniumCheckSettings');

class Target {
  /**
   * Validate current window
   *
   * @return {SeleniumCheckSettings}
   * @constructor
   */
  static window() {
    return new SeleniumCheckSettings();
  }

  /**
   * Validate region (in current window or frame) using region's rect, element or element's locator
   *
   * @param {Region|RegionObject|By|WebElement|EyesWebElement} region The region to validate.
   * @param {Integer|string|By|WebElement|EyesWebElement} [frame] The element which is the frame to switch to.
   * @return {SeleniumCheckSettings}
   * @constructor
   */
  static region(region, frame) {
    return new SeleniumCheckSettings(region, frame);
  }

  /**
   * Validate frame
   *
   * @param {Integer|string|By|WebElement|EyesWebElement} frame The element which is the frame to switch to.
   * @return {SeleniumCheckSettings}
   * @constructor
   */
  static frame(frame) {
    return new SeleniumCheckSettings(null, frame);
  }
}

exports.Target = Target;