Execute Async Script

Inject a snippet of JavaScript into the page for execution in the context of the currently selected frame (Web context only)

Example Usage

((JavascriptExecutor) driver).executeAsyncScript("window.setTimeout(arguments[arguments.length - 1], 500);");

self.driver.execute_async_script(‘document.title’)

// webdriver.io example
browser.timeoutsAsyncScript(5000);
var result = browser.executeAsync(function(a, b, c, d, done) {
    // browser context - you may access neither client nor console
    setTimeout(function() {
        done(a + b + c + d);
    }, 3000);
}, 1, 2, 3, 4)

// node.js context - client and console are available
console.log(result.value); // outputs: 10



// wd example
await driver.safeExecuteAsync('document.title');

@driver.execute_async_script("document.title")

// TODO C# sample

// TODO PHP sample

Description

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 teh 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.

Support

Appium Server

Platform Driver Platform Versions Appium Version Driver Version
iOS XCUITest None None None
UIAutomation None None None
Android UiAutomator2 None None None
UiAutomator None None None
Mac Mac None None None
Windows Windows None None None

Appium Clients

Language Support Documentation
Java None seleniumhq.github.io
Python None selenium-python.readthedocs.io
Javascript (WebdriverIO) None
Javascript (WD) None github.com
Ruby None www.rubydoc.info
PHP None github.com
C# None github.com

HTTP API Specifications

Endpoint

GET /wd/hub/session/:session_id/execute_async

URL Parameters

name description
session_id ID of the session to route the command to

JSON Parameters

name type description
script string The script to execute
args array The script arguments

Response

The script result (any)

See Also