@testim/testim-cli/webdriverio/lib/commands/getHTML.js

Command line interface for running Testing on you CI

/**
 *
 * Get source code of specified DOM element by selector.
 *
 * <example>
    :index.html
    <div id="test">
        <span>Lorem ipsum dolor amet</span>
    </div>

    :getHTML.js
    client
        .getHTML('#test', function(err, html) {
            console.log(html);
            // outputs the following:
            // "<div id="test"><span>Lorem ipsum dolor amet</span></div>"
        })
        .getHTML('#test', false, function(err, html) {
            console.log(html);
            // outputs the following:
            // "<span>Lorem ipsum dolor amet</span>"
        });
 * </example>
 *
 * @param {String}   selector           element to get the current DOM structure from
 * @param {Boolean=} includeSelectorTag if true it includes the selector element tag (default: true)
 *
 * @uses action/selectorExecute
 * @type property
 *
 */

var getHTMLHelper = require('../helpers/_getHTML'),
    ErrorHandler = require('../utils/ErrorHandler');

module.exports = function getHTML(selector, includeSelectorTag) {

    /*!
     * parameter check
     */
    if (typeof selector !== 'string') {
        throw new ErrorHandler.CommandError('number or type of arguments don\'t agree with getHTML command');
    }

    if (typeof includeSelectorTag !== 'boolean') {
        includeSelectorTag = true;
    }

    return this.selectorExecute(selector, getHTMLHelper, includeSelectorTag).then(function(html) {

        // throw NoSuchElement error if no element was found
        if (!html) {
            throw new ErrorHandler(7);
        }

        return html && html.length === 1 ? html[0] : html;

    });

};