webdriverio 5.11.11 → 5.11.12

package/build/commands/browser/$$.js

@@ -9,48 +9,6 @@ var _utils = require("../../utils");
 
 var _getElementObject = require("../../utils/getElementObject");
 
-/**
- * The `$$` command is a short way to call the [`findElements`](/docs/api/webdriver.html#findelements) command in order
- * to fetch multiple elements on the page. It returns an array with element results that will have an
- * extended prototype to call action commands without passing in a selector. However if you still pass
- * in a selector it will look for that element first and call the action on that element.
- *
- * Using the wdio testrunner this command is a global variable else it will be located on the browser object instead.
- *
- * You can chain `$` or `$$` together in order to walk down the DOM tree. For more information on how
- * to select specific elements, see [`Selectors`](/docs/selectors.html).
- *
- * <example>
-    :index.html
-    <ul id="menu">
-        <li><a href="/">Home</a></li>
-        <li><a href="/">Developer Guide</a></li>
-        <li><a href="/">API</a></li>
-        <li><a href="/">Contribute</a></li>
-    </ul>
-    :$.js
-    it('should get text a menu link', () => {
-        const text = $$('#menu')[0];
-        console.log(text.$$('li')[2].$('a').getText()); // outputs: "API"
-    });
-
-    it('should get text a menu link - JS Function', () => {
-        const text = $$(function() { // Arrow function is not allowed here.
-            // this is Window https://developer.mozilla.org/en-US/docs/Web/API/Window
-            // TypeScript users may do something like this
-            // return (this as Window).document.querySelectorAll('#menu')
-            return this.document.querySelectorAll('#menu'); // Element[]
-        })[0];
-        console.log(text.$$('li')[2].$('a').getText()); // outputs: "API"
-    });
- * </example>
- *
- * @alias $$
- * @param {String|Function} selector  selector or JS Function to fetch multiple elements
- * @return {Element[]}
- * @type utility
- *
- */
 async function $$(selector) {
   const res = await _utils.findElements.call(this, selector);
   return _getElementObject.getElements.call(this, selector, res);

package/build/commands/browser/$.js

@@ -9,48 +9,6 @@ var _utils = require("../../utils");
 
 var _getElementObject = require("../../utils/getElementObject");
 
-/**
- * The `$` command is a short way to call the [`findElement`](/docs/api/webdriver.html#findelement) command in order
- * to fetch a single element on the page. It returns an object that with an extended prototype to call
- * action commands without passing in a selector. However if you still pass in a selector it will look
- * for that element first and call the action on that element.
- *
- * Using the wdio testrunner this command is a global variable else it will be located on the browser object instead.
- *
- * You can chain `$` or `$$` together in order to walk down the DOM tree. For more information on how
- * to select specific elements, see [`Selectors`](/docs/selectors.html).
- *
- * <example>
-    :index.html
-    <ul id="menu">
-        <li><a href="/">Home</a></li>
-        <li><a href="/">Developer Guide</a></li>
-        <li><a href="/">API</a></li>
-        <li><a href="/">Contribute</a></li>
-    </ul>
-    :$.js
-    it('should get text a menu link', () => {
-        const text = $('#menu');
-        console.log(text.$$('li')[2].$('a').getText()); // outputs: "API"
-    });
-
-    it('should get text a menu link - JS Function', () => {
-        const text = $(function() { // Arrow function is not allowed here.
-            // this is Window https://developer.mozilla.org/en-US/docs/Web/API/Window
-            // TypeScript users may do something like this
-            // return (this as Window).document.querySelector('#menu')
-            return this.document.querySelector('#menu'); // Element
-        });
-        console.log(text.$$('li')[2].$('a').getText()); // outputs: "API"
-    });
- * </example>
- *
- * @alias $
- * @param {String|Function} selector  selector or JS Function to fetch a certain element
- * @return {Element}
- * @type utility
- *
- */
 async function $(selector) {
   const res = await _utils.findElement.call(this, selector);
   return _getElementObject.getElement.call(this, selector, res);

package/build/commands/browser/call.js

@@ -5,44 +5,6 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = call;
 
-/**
- * You can use `call` to execute any async action within your test spec. The command itself
- * is treated like a synchronous function. It accepts promises and stops the execution until
- * the promise has resolved.
- *
- * <example>
-    :call.js
-    it('some testing here', () => {
-        browser.url('http://google.com')
-        // make an asynchronous call using any 3rd party library supporting promises
-        // e.g. call to backend or db to inject fixture data
-        browser.call(() => {
-            return somePromiseLibrary.someMethod().then(() => {
-                // ...
-            })
-        })
-        // example for async call to 3rd party library that doesn't support promises
-        browser.call(() => {
-            return new Promise((resolve, reject) => {
-                someOtherNodeLibrary.someMethod(param1, (err, res) => {
-                    if (err) {
-                        return reject(err)
-                    }
-                    resolve(res)
-                })
-            })
-        })
-        // continue synchronously
-        $('#elemA').click()
-        $('.firstname').setValue('webdriverbot')
-    });
- * </example>
- *
- * @alias browser.call
- * @param {Function} callback  function to be called
- * @type utility
- *
- */
 function call(fn = () => {}) {
   return fn();
 }

package/build/commands/browser/debug.js

@@ -22,12 +22,8 @@ function debug(commandTimeout = 5000) {
   const {
     introMessage
   } = _repl.default;
-  /**
-   * run repl in standalone mode
-   */
 
   if (!process.env.WDIO_WORKER) {
-    // eslint-disable-next-line
     console.log(_repl.default.introMessage);
     const context = {
       browser: this,
@@ -37,16 +33,8 @@ function debug(commandTimeout = 5000) {
     };
     return repl.start(context);
   }
-  /**
-   * register worker process as debugger target
-   */
-
 
   process._debugProcess(process.pid);
-  /**
-   * initialise repl in testrunner
-   */
-
 
   process.send({
     origin: 'debugger',
@@ -57,9 +45,7 @@ function debug(commandTimeout = 5000) {
     }
   });
 
-  let commandResolve =
-  /* istanbul ignore next */
-  () => {};
+  let commandResolve = () => {};
 
   process.on('message', m => {
     if (m.origin !== 'debugger') {
@@ -71,8 +57,6 @@ function debug(commandTimeout = 5000) {
 
       return commandResolve();
     }
-    /* istanbul ignore if */
-
 
     if (m.name === 'eval') {
       repl.eval(m.content.cmd, global, null, (e, result) => {
@@ -85,10 +69,6 @@ function debug(commandTimeout = 5000) {
             }, (0, _serializeError.default)(e))
           });
         }
-        /**
-         * try to do some smart serializations
-         */
-
 
         if (typeof result === 'function') {
           result = `[Function: ${result.name}]`;

package/build/commands/browser/deleteCookies.js

@@ -5,49 +5,6 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = deleteCookies;
 
-/**
- *
- * Delete cookies visible to the current page. By providing a cookie name it just removes the single cookie or more when multiple names are passed.
- *
- * <example>
-    :deleteCookie.js
-    it('should delete cookies', () => {
-        browser.setCookies([
-            {name: 'test', value: '123'},
-            {name: 'test2', value: '456'},
-            {name: 'test3', value: '789'}
-        ])
-
-        let cookies = browser.getCookies()
-        console.log(cookies)
-        // outputs:
-        // [
-        //     { name: 'test', value: '123' },
-        //     { name: 'test2', value: '456' }
-        //     { name: 'test3', value: '789' }
-        // ]
-
-        browser.deleteCookies(['test3'])
-        cookies = browser.getCookies()
-        console.log(cookies)
-        // outputs:
-        // [
-        //     { name: 'test', value: '123' },
-        //     { name: 'test2', value: '456' }
-        // ]
-
-        browser.deleteCookies()
-        cookies = browser.getCookies()
-        console.log(cookies) // outputs: []
-    })
- * </example>
- *
- * @alias browser.deleteCookies
- * @param {String[]=} names  names of cookies to be deleted
- * @uses webdriver/deleteAllCookies,webdriver/deleteCookie
- * @type cookie
- *
- */
 function deleteCookies(names) {
   const namesList = typeof names !== 'undefined' && !Array.isArray(names) ? [names] : names;
 

package/build/commands/browser/execute.js

@@ -7,55 +7,12 @@ exports.default = execute;
 
 var _utils = require("../../utils");
 
-/**
- *
- * Inject a snippet of JavaScript into the page for execution in the context of the currently selected frame.
- * The executed script is assumed to be synchronous and the result of evaluating the script is returned to
- * the client.
- *
- * The script argument defines the script to execute in the form of a function body. The value returned by
- * that function will be returned to the client. The function will be invoked with the provided args array
- * and the values may be accessed via the arguments object in the order specified.
- *
- * Arguments may be any JSON-primitive, array, or JSON object. JSON objects that define a WebElement
- * reference will be converted to the corresponding DOM element. Likewise, any WebElements in the script
- * result will be returned to the client as WebElement JSON objects.
- *
- * <example>
-    :execute.js
-    it('should inject javascript on the page', () => {
-        const result = browser.execute((a, b, c, d) => {
-            // browser context - you may not access client or console
-            return a + b + c + d
-        }, 1, 2, 3, 4)
-        // node.js context - client and console are available
-        console.log(result) // outputs: 10
-    });
- * </example>
- *
- * @param {String|Function} script                     The script to execute.
- * @param {*=}               arguments  script arguments
- *
- * @return {*}             The script result.
- *
- * @see  https://w3c.github.io/webdriver/webdriver-spec.html#dfn-execute-script
- * @type protocol
- *
- */
 function execute(...args) {
   let script = args.shift();
-  /*!
-   * parameter check
-   */
 
   if (typeof script !== 'string' && typeof script !== 'function') {
     throw new Error('number or type of arguments don\'t agree with execute protocol command');
   }
-  /*!
-   * instances started as multibrowserinstance can't getting called with
-   * a function parameter, therefor we need to check if it starts with "function () {"
-   */
-
 
   if (typeof script === 'function') {
     script = `return (${script}).apply(null, arguments)`;

package/build/commands/browser/executeAsync.js

@@ -7,63 +7,12 @@ exports.default = executeAsync;
 
 var _utils = require("../../utils");
 
-/**
- *
- * Inject a snippet of JavaScript into the page for execution in the context of the currently selected
- * frame. The executed script is assumed to be asynchronous and must signal that is done by invoking
- * the provided callback, which is always provided as the final argument to the function. The value
- * to this callback will be returned to the client.
- *
- * Asynchronous script commands may not span page loads. If an unload event is fired while waiting
- * for a script result, an error should be returned to the client.
- *
- * The script argument defines the script to execute in the form of a function body. The function will
- * be invoked with the provided args array and the values may be accessed via the arguments object
- * in the order specified. The final argument will always be a callback function that must be invoked
- * to signal that the script has finished.
- *
- * Arguments may be any JSON-primitive, array, or JSON object. JSON objects that define a WebElement
- * reference will be converted to the corresponding DOM element. Likewise, any WebElements in the script
- * result will be returned to the client as WebElement JSON objects.
- *
- * <example>
-    :executeAsync.js
-    it('should execute async JavaScript on the page', () => {
-        browser.setTimeout({ script: 5000 })
-        const result = browser.executeAsync(function(a, b, c, d, done) {
-            // browser context - you may not access client or console
-            setTimeout(() => {
-                done(a + b + c + d)
-            }, 3000);
-        }, 1, 2, 3, 4)
-        // node.js context - client and console are available
-        console.log(result) // outputs: 10
-    });
- * </example>
- *
- * @param {String|Function} script     The script to execute.
- * @param {*=}               arguments  script arguments
- *
- * @return {*}             The script result.
- *
- * @see  https://w3c.github.io/webdriver/webdriver-spec.html#dfn-execute-async-script
- * @type protocol
- *
- */
 function executeAsync(...args) {
   let script = args.shift();
-  /*!
-   * parameter check
-   */
 
   if (typeof script !== 'string' && typeof script !== 'function') {
     throw new Error('number or type of arguments don\'t agree with execute protocol command');
   }
-  /*!
-   * instances started as multibrowserinstance can't getting called with
-   * a function parameter, therefor we need to check if it starts with "function () {"
-   */
-
 
   if (typeof script === 'function') {
     script = `return (${script}).apply(null, arguments)`;

package/build/commands/browser/getCookies.js

@@ -5,38 +5,6 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = getCookies;
 
-/**
- *
- * Retrieve a [cookie](https://w3c.github.io/webdriver/webdriver-spec.html#cookies)
- * visible to the current page. You can query a specific cookie by providing the cookie name or
- * retrieve all.
- *
- * <example>
-    :getCookies.js
-    it('should return a cookie for me', () => {
-        browser.setCookies([
-            {name: 'test', value: '123'},
-            {name: 'test2', value: '456'}
-        ])
-        const testCookie = browser.getCookies(['test'])
-        console.log(testCookie); // outputs: [{ name: 'test', value: '123' }]
-
-        const allCookies = browser.getCookies()
-        console.log(allCookies);
-        // outputs:
-        // [
-        //    { name: 'test', value: '123' },
-        //    { name: 'test2', value: '456' }
-        // ]
-    })
- * </example>
- *
- * @alias browser.getCookies
- * @param {String[]=} names  names of requested cookies
- * @return {Object[]}        requested cookies if existing
- * @uses webdriver/getAllCookies
- *
- */
 async function getCookies(names) {
   const namesList = typeof names !== 'undefined' && !Array.isArray(names) ? [names] : names;
 

package/build/commands/browser/getWindowSize.js

@@ -7,26 +7,6 @@ exports.default = getWindowSize;
 
 var _utils = require("../../utils");
 
-/**
- *
- * Returns browser window size (and position for drivers with W3C support).
- *
- * <example>
- * :getWindowSize.js
-    it('should return browser window size', function () {
-        const windowSize = browser.getWindowSize(500, 600);
-        console.log(windowSize);
-        // outputs
-        // Firefox: { x: 4, y: 23, width: 1280, height: 767 }
-        // Chrome: { width: 1280, height: 767 }
-    });
- * </example>
- *
- * @alias browser.getWindowSize
- * @return {Object} { x, y, width, height } for W3C or { width, height } for non W3C browser
- * @type window
- *
- */
 function getWindowSize() {
   const browser = (0, _utils.getBrowserObject)(this);
 

package/build/commands/browser/keys.js

@@ -7,36 +7,8 @@ exports.default = keys;
 
 var _utils = require("../../utils");
 
-/**
- *
- * Send a sequence of key strokes to the active element. You can also use 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.
- *
- * Modifier like Ctrl, Shift, Alt and Meta will stay pressed so you need to trigger them again to release them.
- *
- * <example>
-    :keys.js
-    it('copies text out of active element', () => {
-        // copies text from an input element
-        const input = $('#username')
-        input.setValue('anonymous')
-
-        browser.keys(['Meta', 'a'])
-        browser.keys(['Meta', 'c'])
-    });
- * </example>
- *
- * @param {String|String[]} value  The sequence of keys to type. An array or string must be provided.
- * @see https://w3c.github.io/webdriver/#dispatching-actions
- *
- */
 function keys(value) {
   let keySequence = [];
-  /**
-   * replace key with corresponding unicode character
-   */
 
   if (typeof value === 'string') {
     keySequence = (0, _utils.checkUnicode)(value);
@@ -47,18 +19,10 @@ function keys(value) {
   } else {
     throw new Error('"keys" command requires a string or array of strings as parameter');
   }
-  /**
-   * JsonWireProtocol action
-   */
-
 
   if (!this.isW3C) {
     return this.sendKeys(keySequence);
   }
-  /**
-   * W3C way of handle it key actions
-   */
-
 
   const keyDownActions = keySequence.map(value => ({
     type: 'keyDown',

package/build/commands/browser/newWindow.js

@@ -9,47 +9,10 @@ var _newWindow = _interopRequireDefault(require("../../scripts/newWindow"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
-/**
- *
- * Open new window in browser. This command is the equivalent function to `window.open()`. This command does not
- * work in mobile environments.
- *
- * __Note:__ When calling this command you automatically switch to the new window.
- *
- * <example>
-    :newWindowSync.js
-    it('should open a new tab', () => {
-        browser.url('http://google.com')
-        console.log(browser.getTitle()) // outputs: "Google"
-
-        browser.newWindow('https://webdriver.io', 'WebdriverIO window', 'width=420,height=230,resizable,scrollbars=yes,status=1')
-        console.log(browser.getTitle()) // outputs: "WebdriverIO · Next-gen WebDriver test framework for Node.js"
-
-        browser.closeWindow()
-        console.log(browser.getTitle()) // outputs: "Google"
-    });
- * </example>
- *
- * @param {String} url            website URL to open
- * @param {String=} windowName     name of the new window
- * @param {String=} windowFeatures features of opened window (e.g. size, position, scrollbars, etc.)
- * @return {String}                id of window handle of new tab
- *
- * @uses browser/execute, protocol/getWindowHandles, protocol/switchToWindow
- * @alias browser.newWindow
- * @type window
- */
 async function newWindow(url, windowName = 'New Window', windowFeatures = '') {
-  /*!
-   * parameter check
-   */
   if (typeof url !== 'string') {
     throw new Error('number or type of arguments don\'t agree with newWindow command');
   }
-  /*!
-   * mobile check
-   */
-
 
   if (this.isMobile) {
     throw new Error('newWindow command is not supported on mobile platforms');

package/build/commands/browser/pause.js

@@ -5,27 +5,6 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = pause;
 
-/**
- *
- * Pauses execution for a specific amount of time. It is recommended to not use this command to wait for an
- * element to show up. In order to avoid flaky test results it is better to use commands like
- * [`waitforExist`](/docs/api/element/waitForExist.html) or other waitFor* commands.
- *
- * <example>
-    :pause.js
-    it('should pause the execution', () => {
-        const starttime = new Date().getTime()
-        browser.pause(3000)
-        const endtime = new Date().getTime()
-        console.log(endtime - starttime) // outputs: 3000
-    });
- * </example>
- *
- * @alias browser.pause
- * @param {Number} milliseconds time in ms
- * @type utility
- *
- */
 function pause(milliseconds = 1000) {
   return new Promise(resolve => setTimeout(resolve, milliseconds));
 }

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

@@ -13,30 +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 orangeButtons = browser.react$$('t', { orange: true })
-        console.log(orangeButtons.map((btn) => btn.getText())); // prints "[ '÷', 'x', '-', '+', '=' ]"
-    });
- * </example>
- *
- * @alias browser.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/browser/react$.js

@@ -13,34 +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/');
-
-        browser.react$('t', { name: '7' }).click()
-        browser.react$('t', { name: 'x' }).click()
-        browser.react$('t', { name: '6' }).click()
-        browser.react$('t', { name: '=' }).click()
-
-        console.log($('.component-display').getText()); // prints "42"
-    });
- * </example>
- *
- * @alias browser.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 = {}) {