webdriverio-workflo/lib/commands/getText.js

This is a customized version of webdriverio for use with workflo framework.

/**
 *
 * Get the text content from a DOM-element found by given selector. Make sure the element
 * you want to request the text from [is interactable](https://www.w3.org/TR/webdriver/#element-interactability)
 * otherwise you will get an empty string as return value. If the element is disabled or not
 * visible and you still want to receive the text content use [getHTML](http://webdriver.io/api/property/getHTML.html)
 * as a workaround.
 *
 * <example>
    :index.html
    <div id="elem">
        Lorem ipsum <strong>dolor</strong> sit amet,<br>
        consetetur sadipscing elitr
    </div>
    <span style="display: none">I am invisible</span>

    :getText.js
    it('should get text of an element or elements', function () {
        var text = browser.getText('#elem');
        console.log(text);
        // outputs the following:
        // "Lorem ipsum dolor sit amet,consetetur sadipscing elitr"

        var spanText = browser.getText('span');
        console.log(spanText);
        // outputs "" (empty string) since element is not interactable
    });

    it('get content from table cell', function () {
        browser.url('http://the-internet.herokuapp.com/tables');
        var rows = $$('#table1 tr');
        var columns = rows[1].$$('td'); // get columns of 2nd row
        console.log(columns[2].getText()); // get text of 3rd column
    });
 * </example>
 *
 * @alias browser.getText
 * @param   {String}           selector   element with requested text
 * @return {String|String[]}             content of selected element (all HTML tags are removed)
 * @uses protocol/elements, protocol/elementIdText
 * @type property
 *
 */

import { CommandError } from '../utils/ErrorHandler'

let getText = function (selector) {
    return this.elements(selector).then((res) => {
        /**
         * throw NoSuchElement error if no element was found
         */
        if (!res.value || res.value.length === 0) {
            throw new CommandError(7, selector || this.lastResult.selector)
        }

        let elementIdTextCommands = []
        for (let elem of res.value) {
            elementIdTextCommands.push(this.elementIdText(elem.ELEMENT))
        }

        return this.unify(elementIdTextCommands, {
            extractValue: true
        })
    })
}

export default getText