index.js 1.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. // Used to provide better protractor documentation for methods given by
  2. // `webdriver-js-extender`.
  3. /**
  4. * @fileoverview Extra methods provided by webdriver-js-extender.
  5. */
  6. goog.provide('webdriver_extensions');
  7. // /////////////////////////////////////////////////////////////////////////////
  8. // //
  9. // // webdriver_extensions.ExtendedWebDriver
  10. // //
  11. // /////////////////////////////////////////////////////////////////////////////
  12. /**
  13. * Protractor's `browser` object is a wrapper for an instance of
  14. * `ExtendedWebDriver`, provided by `webdriver-js-extender`, which itself is
  15. * just an instance of `selenium-webdriver`'s WebDriver with some extra methods
  16. * added in. The `browser` object inherits all of WebDriver's and
  17. * ExtendedWebDriver's methods, but only the methods most useful to Protractor
  18. * users are documented here.
  19. *
  20. * ***If you are not using an appium server, `browser` may sometimes inherit
  21. * directly from a normal `WebDriver` instance, and thus not inherit any of
  22. * the extra methods defined by `webdriver-js-extender`. Even when `browser`
  23. * does inherit from `ExtendedWebDriver`, these extra methods will only work if
  24. * your server implements the Appium API.***
  25. *
  26. * More information about `webdriver-js-extender` can be found on the [GitHub
  27. * repo](https://github.com/angular/webdriver-js-extender).
  28. * @alias ExtendedWebDriver
  29. * @constructor
  30. * @extends {webdriver.WebDriver}
  31. */
  32. webdriver_extensions.ExtendedWebDriver = function() {};
  33. /**
  34. * Various appium commands, including the commands implemented by `wd`. The
  35. * names may be different however, and commands which are implemented already by
  36. * `selenium-webdriver` are not re-implemented by `webdriver-js-extender`.
  37. *
  38. * See the [GitHub repo](https://github.com/angular/webdriver-js-extender) for
  39. * details.
  40. *
  41. * @returns {!webdriver.promise.Promise.<*>}
  42. */
  43. webdriver_extensions.ExtendedWebDriver.prototype.Appium_Commands = function() {};