webdriverio 5.11.11 → 5.11.12

package/build/commands/element/isDisplayedInViewport.js

@@ -13,47 +13,9 @@ var _isDisplayedInViewport = _interopRequireDefault(require("../../scripts/isDis
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
-/**
- *
- * Return true if the selected DOM-element found by given selector is visible and within the viewport.
- *
- * <example>
-    :index.html
-    <div id="notDisplayed" style="display: none"></div>
-    <div id="notVisible" style="visibility: hidden"></div>
-    <div id="notInViewport" style="position:absolute; left: 9999999"></div>
-    <div id="zeroOpacity" style="opacity: 0"></div>
-    :isDisplayedInViewport.js
-    :isDisplayed.js
-    it('should detect if an element is visible', () => {
-        let isDisplayedInViewport = $('#notDisplayed').isDisplayedInViewport();
-        console.log(isDisplayedInViewport); // outputs: false
-
-        isDisplayedInViewport = $('#notVisible').isDisplayedInViewport();
-        console.log(isDisplayedInViewport); // outputs: false
-
-        isDisplayedInViewport = $('#notExisting').isDisplayedInViewport();
-        console.log(isDisplayedInViewport); // outputs: false
-
-        isDisplayedInViewport = $('#notInViewport').isDisplayedInViewport();
-        console.log(isDisplayedInViewport); // outputs: false
-
-        isDisplayedInViewport = $('#zeroOpacity').isDisplayedInViewport();
-        console.log(isDisplayedInViewport); // outputs: false
-    });
- * </example>
- *
- * @alias element.isDisplayedInViewport
- * @return {Boolean}            true if element(s)* [is|are] displayed
- * @uses protocol/selectorExecute, protocol/timeoutsAsyncScript
- * @type state
- *
- */
 function isDisplayedInViewport() {
   return (0, _utils.getBrowserObject)(this).execute(_isDisplayedInViewport.default, {
     [_constants.ELEMENT_KEY]: this.elementId,
-    // w3c compatible
-    ELEMENT: this.elementId // jsonwp compatible
-
+    ELEMENT: this.elementId
   });
 }

package/build/commands/element/isEnabled.js

@@ -5,38 +5,6 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = isEnabled;
 
-/**
- *
- * Return true or false if the selected DOM-element is enabled.
- *
- * <example>
-    :index.html
-    <input type="text" name="inputField" class="input1">
-    <input type="text" name="inputField" class="input2" disabled>
-    <input type="text" name="inputField" class="input3" disabled="disabled">
-
-    :isEnabled.js
-    it('should detect if an element is enabled', () => {
-        let elem = $('.input1')
-        let isEnabled = elem.isEnabled();
-        console.log(isEnabled); // outputs: true
-
-        elem = $('.input2')
-        isEnabled = elem.isEnabled();
-        console.log(isEnabled2); // outputs: false
-
-        elem = $('.input3')
-        isEnabled = elem.isEnabled();
-        console.log(isEnabled3); // outputs: false
-    });
- * </example>
- *
- * @alias element.isEnabled
- * @return {Boolean} true if element(s)* (is|are) enabled
- * @uses protocol/elements, protocol/elementIdEnabled
- * @type state
- *
- */
 function isEnabled() {
   return this.isElementEnabled(this.elementId);
 }

package/build/commands/element/isExisting.js

@@ -5,46 +5,6 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = isExisting;
 
-/**
- *
- * Returns true if element exists in the DOM
- *
- * <example>
-    :index.html
-    <div id="notDisplayed" style="display: none"></div>
-    <div id="notVisible" style="visibility: hidden"></div>
-    <div id="notInViewport" style="position:absolute; left: 9999999"></div>
-    <div id="zeroOpacity" style="opacity: 0"></div>
-    :isExisting.js
-    it('should detect if elements are existing', () => {
-        let elem = $('#someRandomNonExistingElement')
-        let isExisting = elem.isExisting()
-        console.log(isExisting); // outputs: false
-
-        elem = $('#notDisplayed')
-        isExisting = elem.isExisting()
-        console.log(isExisting); // outputs: true
-
-        elem = $('#notVisible')
-        isExisting = elem.isExisting()
-        console.log(isExisting); // outputs: true
-
-        elem = $('#notInViewport')
-        isExisting = elem.isExisting()
-        console.log(isExisting); // outputs: true
-
-        elem = $('#zeroOpacity')
-        isExisting = elem.isExisting()
-        console.log(isExisting); // outputs: true
-    });
- * </example>
- *
- * @alias element.isExisting
- * @return {Boolean}            true if element(s)* [is|are] existing
- * @uses protocol/elements
- * @type state
- *
- */
 function isExisting() {
   return this.parent.$$(this.selector).then(res => res.length > 0);
 }

package/build/commands/element/isFocused.js

@@ -13,37 +13,9 @@ var _isFocused = _interopRequireDefault(require("../../scripts/isFocused"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
-/**
- *
- * Return true or false if the selected DOM-element currently has focus. If the selector matches
- * multiple elements, it will return true if one of the elements has focus.
- *
- * <example>
-    :index.html
-    <input name="login" autofocus="" />
-    :hasFocus.js
-    it('should detect the focus of an element', () => {
-        browser.url('/');
-        const loginInput = $('[name="login"]');
-        console.log(loginInput.isFocused()); // outputs: false
-
-        loginInput.click();
-        console.log(loginInput.isFocused()); // outputs: true
-    })
- * </example>
- *
- * @alias element.isFocused
- * @return {Boolean}         true if one of the matching elements has focus
- *
- * @uses protocol/execute
- * @type state
- *
- */
 function isFocused() {
   return (0, _utils.getBrowserObject)(this).execute(_isFocused.default, {
     [_constants.ELEMENT_KEY]: this.elementId,
-    // w3c compatible
-    ELEMENT: this.elementId // jsonwp compatible
-
+    ELEMENT: this.elementId
   });
 }

package/build/commands/element/isSelected.js

@@ -5,35 +5,6 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = isSelected;
 
-/**
- *
- * Will return true or false whether or not an `<option>` or `<input>` element of type
- * checkbox or radio is currently selected.
- *
- * <example>
-    :index.html
-    <select name="selectbox" id="selectbox">
-        <option value="John Doe">John Doe</option>
-        <option value="Layla Terry" selected="selected">Layla Terry</option>
-        <option value="Bill Gilbert">Bill Gilbert"</option>
-    </select>
-
-    :isSelected.js
-    it('should detect if an element is selected', () => {
-        let element = $('[value="Layla Terry"]');
-        console.log(element.isSelected()); // outputs: true
-
-        element = $('[value="Bill Gilbert"]')
-        console.log(element.isSelected()); // outputs: false
-    });
- * </example>
- *
- * @alias element.isSelected
- * @return {Boolean} true if element is selected
- * @uses protocol/elements, protocol/elementIdSelected
- * @type state
- *
- */
 function isSelected() {
   return this.isElementSelected(this.elementId);
 }

package/build/commands/element/moveTo.js

@@ -7,27 +7,10 @@ exports.default = moveTo;
 
 var _utils = require("../../utils");
 
-/**
- *
- * Move the mouse by an offset of the specified element. If no element is specified,
- * the move is relative to the current mouse cursor. If an element is provided but
- * no offset, the mouse will be moved to the center of the element. If the element
- * is not visible, it will be scrolled into view.
- *
- * @param {Number=} xoffset  X offset to move to, relative to the top-left corner of the element. If not specified, the mouse will move to the middle of the element.
- * @param {Number=} yoffset  Y offset to move to, relative to the top-left corner of the element. If not specified, the mouse will move to the middle of the element.
- *
- * @see  https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidmoveto
- * @type protocol
- */
 async function moveTo(xoffset, yoffset) {
   if (!this.isW3C) {
     return this.moveToElement(this.elementId, xoffset, yoffset);
   }
-  /**
-   * get rect of element
-   */
-
 
   const {
     x,
@@ -37,10 +20,6 @@ async function moveTo(xoffset, yoffset) {
   } = await (0, _utils.getElementRect)(this);
   const newXoffset = parseInt(x + (typeof xoffset === 'number' ? xoffset : width / 2), 10);
   const newYoffset = parseInt(y + (typeof yoffset === 'number' ? yoffset : height / 2), 10);
-  /**
-   * W3C way of handle the mouse move actions
-   */
-
   return this.performActions([{
     type: 'pointer',
     id: 'finger1',

package/build/commands/element/react$$.js

@@ -13,31 +13,6 @@ var _resq = require("../../scripts/resq");
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
-/**
- *
- * The `react$$` command is a useful command to query multiple React Components
- * by their actual name and filter them by props and state.
- *
- * **NOTE:** the command only works with applications using React v16.x
- *
- * <example>
-    :pause.js
-    it('should calculate 7 * 6', () => {
-        browser.url('https://ahfarmer.github.io/calculator/');
-        const appWrapper = browser.$('div#root')
-
-        const orangeButtons = appWrapper.react$$('t', { orange: true })
-        console.log(orangeButtons.map((btn) => btn.getText())); // prints "[ '÷', 'x', '-', '+', '=' ]"
-    });
- * </example>
- *
- * @alias react$$
- * @param {String} selector of React component
- * @param {Object=} props  React props the element should contain
- * @param {Array<any>|number|string|object|boolean=} state  React state the element should be in
- * @return {Element[]}
- *
- */
 const resqScript = _fs.default.readFileSync(require.resolve('resq'));
 
 async function react$$(selector, props = {}, state = {}) {

package/build/commands/element/react$.js

@@ -13,35 +13,6 @@ var _resq = require("../../scripts/resq");
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
-/**
- *
- * The `react$` command is a useful command to query React Components by their
- * actual name and filter them by props and state.
- *
- * **NOTE:** the command only works with applications using React v16.x
- *
- * <example>
-    :pause.js
-    it('should calculate 7 * 6', () => {
-        browser.url('https://ahfarmer.github.io/calculator/');
-        const appWrapper = browser.$('div#root')
-
-        appWrapper.react$('t', { name: '7' }).click()
-        appWrapper.react$('t', { name: 'x' }).click()
-        appWrapper.react$('t', { name: '6' }).click()
-        appWrapper.react$('t', { name: '=' }).click()
-
-        console.log($('.component-display').getText()); // prints "42"
-    });
- * </example>
- *
- * @alias react$
- * @param {String} selector of React component
- * @param {Object=} props  React props the element should contain
- * @param {Array<any>|number|string|object|boolean=} state  React state the element should be in
- * @return {Element}
- *
- */
 const resqScript = _fs.default.readFileSync(require.resolve('resq'));
 
 async function react$(selector, props = {}, state = {}) {

package/build/commands/element/saveScreenshot.js

@@ -11,28 +11,7 @@ var _utils = require("../../utils");
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
-/**
- *
- * Save a screenshot of an element to a PNG file on your OS.
- *
- * <example>
-    :saveScreenshot.js
-    it('should save a screenshot of the browser view', function () {
-        const elem = $('#someElem');
-        elem.saveScreenshot('./some/path/elemScreenshot.png');
-    });
- * </example>
- *
- * @alias element.saveScreenshot
- * @param   {String}  filename  path to the generated image (`.png` suffix is required) relative to the execution directory
- * @return  {Buffer}            screenshot buffer
- * @type utility
- *
- */
 async function saveScreenshot(filepath) {
-  /**
-   * type check
-   */
   if (typeof filepath !== 'string' || !filepath.endsWith('.png')) {
     throw new Error('saveScreenshot expects a filepath of type string and ".png" file ending');
   }

package/build/commands/element/scrollIntoView.js

@@ -7,35 +7,11 @@ exports.default = scrollIntoView;
 
 var _constants = require("../../constants");
 
-/**
- *
- * Scroll element into viewport.
- * https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView
- *
- * <example>
-    :scrollIntoView.js
-    it('should demonstrate the scrollIntoView command', () => {
-        const elem = $('#myElement');
-        // scroll to specific element
-        elem.scrollIntoView();
-    });
- * </example>
- *
- * @alias element.scrollIntoView
- * @param {object|boolean=} scrollIntoViewOptions  boolean alignToTop or scrollIntoViewOptions object
- * @uses protocol/execute
- * @type utility
- *
- */
 function scrollIntoView(scrollIntoViewOptions = true) {
-  return this.parent.execute(
-  /* istanbul ignore next */
-  function (elem, options) {
+  return this.parent.execute(function (elem, options) {
     elem.scrollIntoView(options);
   }, {
     [_constants.ELEMENT_KEY]: this.elementId,
-    // w3c compatible
-    ELEMENT: this.elementId // jsonwp compatible
-
+    ELEMENT: this.elementId
   }, scrollIntoViewOptions);
 }

package/build/commands/element/selectByAttribute.js

@@ -7,55 +7,9 @@ exports.default = selectByAttribute;
 
 var _utils = require("../../utils");
 
-/**
- *
- * Select option with a specific value.
- *
- * <example>
-    :example.html
-    <select id="selectbox">
-        <option value="someValue0">uno</option>
-        <option value="someValue1">dos</option>
-        <option value="someValue2">tres</option>
-        <option value="someValue3">cuatro</option>
-        <option value="someValue4">cinco</option>
-        <option name="someName5" value="someValue5">seis</option>
-    </select>
-    :selectByAttribute.js
-    it('Should demonstrate the selectByAttribute command', () => {
-        const selectBox = $('#selectbox');
-        const value = selectBox.getValue();
-        console.log(value); // returns "someValue0"
-
-        selectBox.selectByAttribute('value', 'someValue3');
-        console.log(selectBox.getValue()); // returns "someValue3"
-
-        selectBox.selectByAttribute('name', 'someName5');
-        console.log(selectBox.getValue()); // returns "someValue5"
-    });
- * </example>
- *
- * @alias element.selectByAttribute
- * @param {String} attribute  attribute of option element to get selected
- * @param {String} value      value of option element to get selected
- * @uses protocol/findElementFromElement, protocol/elementClick
- * @type action
- *
- */
 async function selectByAttribute(attribute, value) {
-  /**
-   * convert value into string
-   */
   value = typeof value === 'number' ? value.toString() : value;
-  /**
-  * find option elememnt using xpath
-  */
-
   const normalized = `[normalize-space(@${attribute.trim()}) = "${value.trim()}"]`;
   const optionElement = await this.findElementFromElement(this.elementId, 'xpath', `./option${normalized}|./optgroup/option${normalized}`);
-  /**
-  * select option
-  */
-
   return this.elementClick((0, _utils.getElementFromResponse)(optionElement));
 }

package/build/commands/element/selectByIndex.js

@@ -7,46 +7,10 @@ exports.default = selectByIndex;
 
 var _utils = require("../../utils");
 
-/**
- *
- * Select option with a specific index.
- *
- * <example>
-    :example.html
-    <select id="selectbox">
-        <option value="someValue0">uno</option>
-        <option value="someValue1">dos</option>
-        <option value="someValue2">tres</option>
-        <option value="someValue3">cuatro</option>
-        <option value="someValue4">cinco</option>
-        <option value="someValue5">seis</option>
-    </select>
-    :selectByIndex.js
-    it('Should demonstrate the selectByIndex command', () => {
-        const selectBox = $('#selectbox');
-        console.log(selectBox.getValue()); // returns "someValue0"
-        selectBox.selectByIndex(4);
-        console.log(selectBox.getValue()); // returns "someValue4"
-    });
- * </example>
- *
- * @alias element.selectByIndexs
- * @param {Number} index      option index
- * @uses protocol/findElementsFromElement, protocol/elementClick
- * @type action
- *
- */
 async function selectByIndex(index) {
-  /**
-   * negative index check
-   */
   if (index < 0) {
     throw new Error('Index needs to be 0 or any other positive number');
   }
-  /**
-  * get option elememnts using css
-  */
-
 
   const optionElements = await this.findElementsFromElement(this.elementId, 'css selector', 'option');
 
@@ -57,10 +21,6 @@ async function selectByIndex(index) {
   if (optionElements.length - 1 < index) {
     throw new Error(`Option with index "${index}" not found. Select element only contains ${optionElements.length} option elements`);
   }
-  /**
-  * select option
-  */
-
 
   return this.elementClick((0, _utils.getElementFromResponse)(optionElements[index]));
 }

package/build/commands/element/selectByVisibleText.js

@@ -7,55 +7,13 @@ exports.default = selectByVisibleText;
 
 var _utils = require("../../utils");
 
-/**
- *
- * Select option with displayed text matching the argument.
- *
- * <example>
-    :example.html
-    <select id="selectbox">
-        <option value="someValue0">uno</option>
-        <option value="someValue1">dos</option>
-        <option value="someValue2">tres</option>
-        <option value="someValue3">cuatro</option>
-        <option value="someValue4">cinco</option>
-        <option value="someValue5">seis</option>
-    </select>
-    :selectByVisibleText.js
-    it('demonstrate the selectByVisibleText command', () => {
-        const selectBox = $('#selectbox');
-        console.log(selectBox.getText('option:checked')); // returns "uno"
-        selectBox.selectByVisibleText('cuatro');
-        console.log(selectBox.getText('option:checked')); // returns "cuatro"
-    })
- * </example>
- *
- * @alias element.selectByVisibleText
- * @param {String} text       text of option element to get selected
- * @uses protocol/findElementsFromElement, protocol/elementClick
- * @type action
- *
- */
 async function selectByVisibleText(text) {
-  /**
-   * convert value into string
-   */
   text = typeof text === 'number' ? text.toString() : text;
-  const normalized = text.trim() // strip leading and trailing white-space characters
-  .replace(/\s+/, ' '); // replace sequences of whitespace characters by a single space
-
-  /**
-  * find option element using xpath
-  */
-
+  const normalized = text.trim().replace(/\s+/, ' ');
   const formatted = /"/.test(normalized) ? 'concat("' + normalized.split('"').join('", \'"\', "') + '")' : `"${normalized}"`;
   const dotFormat = `[. = ${formatted}]`;
   const spaceFormat = `[normalize-space(text()) = ${formatted}]`;
   const selections = [`./option${dotFormat}`, `./option${spaceFormat}`, `./optgroup/option${dotFormat}`, `./optgroup/option${spaceFormat}`];
   const optionElement = await this.findElementFromElement(this.elementId, 'xpath', selections.join('|'));
-  /**
-  * select option
-  */
-
   return this.elementClick((0, _utils.getElementFromResponse)(optionElement));
 }

package/build/commands/element/setValue.js

@@ -5,31 +5,6 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = setValue;
 
-/**
- *
- * Send a sequence of key strokes to an element (clears value before). If the element
- * doesn't need to be cleared first then use addValue. You can also use
- * unicode characters like Left arrow or Back space. WebdriverIO will take care of
- * translating them into unicode characters. You’ll find all supported characters
- * [here](https://w3c.github.io/webdriver/webdriver-spec.html#keyboard-actions).
- * To do that, the value has to correspond to a key from the table.
- *
- * <example>
-    :setValue.js
-    it('should set value for a certain element', () => {
-        const input = $('.input');
-        input.setValue('test123');
-
-        console.log(input.getValue()); // outputs: 'test123'
-    });
- * </example>
- *
- * @alias element.setValue
- * @param {string | number | boolean | object | Array<any>}      value    Value to be added
- * @uses protocol/elements, protocol/elementIdClear, protocol/elementIdValue
- * @type action
- *
- */
 async function setValue(value) {
   await this.clearValue();
   return this.addValue(value);

package/build/commands/element/shadow$$.js

@@ -7,24 +7,6 @@ exports.default = shadowRoot;
 
 var _shadowFnFactory = require("../../scripts/shadowFnFactory");
 
-/**
- *
- * Access elements inside a given element's shadowRoot
- *
- * <example>
-    :shadow$$.js
-    it('should return elements inside a shadowRoot', () => {
-        const innerEl = $('.input').shadow$$('#innerEl');
-        console.log(innerEl.getValue()); // outputs: 'test123'
-    });
- * </example>
- *
- * @alias element.shadow$$
- * @param {String|Function} selector  selector or JS Function to fetch a certain element
- * @return {Element[]}
- * @type utility
- *
- */
 async function shadowRoot(selector) {
   return await this.$$((0, _shadowFnFactory.shadowFnFactory)(selector, true));
 }

package/build/commands/element/shadow$.js

@@ -7,24 +7,6 @@ exports.default = shadowRoot;
 
 var _shadowFnFactory = require("../../scripts/shadowFnFactory");
 
-/**
- *
- * Access an element inside a given element's shadowRoot
- *
- * <example>
-    :shadow$$.js
-    it('should return an element inside a shadowRoot', () => {
-        const innerEl = $('.input').shadow$('#innerEl');
-        console.log(innerEl.getValue()); // outputs: 'test123'
-    });
- * </example>
- *
- * @alias element.shadow$
- * @param {String|Function} selector  selector or JS Function to fetch a certain element
- * @return {Element}
- * @type utility
- *
- */
 async function shadowRoot(selector) {
   return await this.$((0, _shadowFnFactory.shadowFnFactory)(selector));
 }