ExecuteScript

Schedules a command to execute asynchronous JavaScript in the context of the currently selected frame or window. The script fragment will be executed as the body of an anonymous function. If the script is provided as a function object, that function will be converted to a string for injection into the target window.

Any arguments provided in addition to the script will be included as script arguments and may be referenced using the arguments object. Arguments may be a boolean, number, string or Target (Question<ElementFinder>). Arrays and objects may also be used as script arguments as long as each item adheres to the types previously mentioned.

Unlike executing synchronous JavaScript with ExecuteScript#sync, scripts executed with this function must explicitly signal they are finished by invoking the provided callback.

This callback will always be injected into the executed function as the last argument, and thus may be referenced with arguments[arguments.length - 1].

If the script invokes the callback with a return value, this will be made available via the LastScriptExecution.result.

Please note that in order to signal an error in the script you need to throw an Error instead of passing it to the callback function.

Examples:

 actor.attemptsTo(ExecuteScript.async(
   var callback = arguments[arguments.length - 1];

   // do stuff

   callback(result)
 ));

 actor.attemptsTo(ExecuteScript.async(
   var name = arguments[0];
   var age = arguments[1];
   var callback = arguments[arguments.length - 1];

   // do stuff

   callback(result)
 ).withArguments('Bob', 24));

 actor.attemptsTo(ExecuteScript.async(
    var header = arguments[0];    // Target gets converted to a WebElement
    var callback = arguments[arguments.length - 1];

    callback(header.innerText)
  ).withArguments(Target.the('header').located(by.css('h1'))));

See:

• LastScriptExecution.result

Instantiates a version of this Interaction configured to load a script from sourceUrl.

Instructs the Actor to execute a synchronous script in the context of the currently selected frame or window.

If the script returns a value, it will be made available via LastScriptExecution.result.

Examples:

 import { actorCalled } from '@serenity-js/core';
 import { BrowseTheWeb, ExecuteScript, LastScriptExecution } from '@serenity-js/protractor';
 import { Ensure, includes } from '@serenity-js/assertions';
 import { protractor } from 'protractor';

 actorCalled('Joseph')
     .whoCan(BrowseTheWeb.using(protractor.browser))
     .attemptsTo(
         ExecuteScript.sync('return navigator.userAgent'),
         Ensure.that(LastScriptExecution.result<string>(), includes('Chrome')),
     );

See:

• LastScriptExecution.result