@luminati-io/webdriverio8
Version:
Next-gen browser and mobile automation test framework for Node.js
53 lines • 3.03 kB
JavaScript
import { verifyArgsAndStripIfElement } from '../../utils/index.js';
/**
*
* 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', async () => {
const result = await 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
*
*/
export function execute(script, ...args) {
/**
* 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, therefore we need to check if it starts with "function () {"
*/
if (typeof script === 'function') {
script = `return (${script}).apply(null, arguments)`;
}
return this.executeScript(script, verifyArgsAndStripIfElement(args));
}
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZXhlY3V0ZS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9jb21tYW5kcy9icm93c2VyL2V4ZWN1dGUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLDJCQUEyQixFQUFFLE1BQU0sc0JBQXNCLENBQUE7QUFFbEU7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7R0FrQ0c7QUFDSCxNQUFNLFVBQVUsT0FBTyxDQUVuQixNQUFnRSxFQUNoRSxHQUFHLElBQW9CO0lBRXZCOztPQUVHO0lBQ0gsSUFBSSxDQUFDLE9BQU8sTUFBTSxLQUFLLFFBQVEsSUFBSSxPQUFPLE1BQU0sS0FBSyxVQUFVLENBQUMsRUFBRSxDQUFDO1FBQy9ELE1BQU0sSUFBSSxLQUFLLENBQUMsd0VBQXdFLENBQUMsQ0FBQTtJQUM3RixDQUFDO0lBRUQ7OztPQUdHO0lBQ0gsSUFBSSxPQUFPLE1BQU0sS0FBSyxVQUFVLEVBQUUsQ0FBQztRQUMvQixNQUFNLEdBQUcsV0FBVyxNQUFNLDBCQUEwQixDQUFBO0lBQ3hELENBQUM7SUFFRCxPQUFPLElBQUksQ0FBQyxhQUFhLENBQUMsTUFBTSxFQUFFLDJCQUEyQixDQUFDLElBQUksQ0FBQyxDQUFDLENBQUE7QUFDeEUsQ0FBQyJ9