38 lines
1.9 KiB
TypeScript
38 lines
1.9 KiB
TypeScript
|
import type { TransformElement, TransformReturn } from '../../types.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 declare function execute<ReturnValue, InnerArguments extends unknown[]>(this: WebdriverIO.Browser | WebdriverIO.MultiRemoteBrowser, script: string | ((...innerArgs: TransformElement<InnerArguments>) => ReturnValue), ...args: InnerArguments): Promise<TransformReturn<ReturnValue>>;
|
||
|
|
//# sourceMappingURL=execute.d.ts.map
|