BrowseTheWeb

Used to access the Actor's ability to BrowseTheWeb from within the Interaction classes, such as Navigate.

Ability to interact with web front-ends using a given protractor browser instance.

Interface for defining sequences of complex user interactions. Each sequence will not be executed until perform is called.

If set to false, Protractor will not wait for Angular $http and $timeout tasks to complete before interacting with the browser.

This can be useful when:

• you need to switch to a non-Angular app during your tests (i.e. SSO login gateway)
• your app continuously polls an API with $timeout

If you're not testing an Angular app, it's better to disable Angular synchronisation completely in protractor configuration:

Examples:

exports.config = {
    onPrepare: function () {
        return browser.waitForAngularEnabled(false);
    },

    // ... other config
};

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 WebElement 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 BrowseTheWeb#executeScript, 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].

The following steps will be taken for resolving this functions return value against the first argument to the script's callback function:

• For a HTML element, the value will resolve to a WebElement
• Null and undefined return values will resolve to null
• Booleans, numbers, and strings will resolve as is
• Functions will resolve to their string representation
• For arrays and objects, each member item will be converted according to the rules above

Examples:

BrowseTheWeb.as(actor).executeAsyncScript(`
  var delay    = arguments[0];
  var callback = arguments[arguments.length - 1];

  window.setTimeout(callback, delay);
`, 500)

BrowseTheWeb.as(actor).executeAsyncScript(`
  var callback = arguments[arguments.length - 1];

  callback('some return value')
`).then(value => doSomethingWithThe(value))

See:

• https://www.protractortest.org/#/api?view=webdriver.WebDriver.prototype.executeAsyncScript
• https://seleniumhq.github.io/selenium/docs/api/java/org/openqa/selenium/JavascriptExecutor.html#executeAsyncScript-java.lang.String-java.lang.Object...-

Schedules a command to execute 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 WebElement. Arrays and objects may also be used as script arguments as long as each item adheres to the types previously mentioned.

The script may refer to any variables accessible from the current window. Furthermore, the script will execute in the window's context, thus document may be used to refer to the current document. Any local variables will not be available once the script has finished executing, though global variables will persist.

If the script has a return value (i.e. if the script contains a return statement), then the following steps will be taken for resolving this functions return value:

For a HTML element, the value will resolve to a WebElement

• Null and undefined return values will resolve to null
• Booleans, numbers, and strings will resolve as is
• Functions will resolve to their string representation
• For arrays and objects, each member item will be converted according to the rules above

Examples:

BrowseTheWeb.as(actor).executeAsyncScript(`
  return arguments[0].tagName;
`, Target.the('header').located(by.css(h1))

See:

• https://www.protractortest.org/#/api?view=webdriver.WebDriver.prototype.executeScript
• https://seleniumhq.github.io/selenium/docs/api/java/org/openqa/selenium/JavascriptExecutor.html#executeScript-java.lang.String-java.lang.Object...-

Navigate to the given destination and loads mock modules before Angular. Assumes that the page being loaded uses Angular.

Returns the capabilities of the browser used in the current session.

By default, the session capabilities specified in the protractor.conf.js indicate the desired properties of the remote browser. However, if the remote cannot satisfy all the requirements, it will still create a session.

Returns the url of the current page.

Returns the title of the current page.

See:

• https://developer.mozilla.org/en-US/docs/Web/HTML/Element/title

Locates a single element identified by the locator

Locates all elements identified by the locator

Interface for managing browser and driver state.

Interface for navigating back and forth in the browser history.

Pause the actor flow for a specified number of milliseconds.

Schedule a command to take a screenshot. The driver makes a best effort to return a base64-encoded screenshot of the following, in order of preference:

1. Entire page
2. Current window
3. Visible portion of the current frame
4. The entire display containing the browser

Pause the actor flow until the condition is met or the timeout expires.