API Reference

adapter

summary
public

I Config

Protractor configuration object with an additional section to configure the Serenity/JS framework.

public

F run(runner: Runner, specs: string[]): Promise<ProtractorReport>

adapter/runner

summary
public

Detects the TestRunnerAdapter to use, based on Protractor configuration.

public

Loads a TestRunnerAdapter, needed to invoke the chosen test runner programmatically.

public

expectations

summary
public

Expectation that the element is active.

public

Expectation that the element is visible and enabled, and therefore clickable

public

Expectation that the element is enabled.

public

Expectation that the element is present in the DOM of a page.

public

Expectation that the element is present and selected

public

Expectation that the element is present in the DOM of the page and visible.

screenplay/abilities

summary
public

An Ability that enables the Actor to interact with web front-ends using protractor.

screenplay/interactions

summary
public

C Accept

Instructs the Actor to accept a ModalDialog.

public

C Clear

Instructs the Actor to clear the value of a form input.

public

C Click

Instructs the Actor to click on a given Web element.

public

C Close

Instructs the Actor to close browser tabs or windows.

public

Instructs the Actor to remove cookies from the browser.

public

Instructs the Actor to dismiss a ModalDialog.

public

Instructs the Actor to perform a double-click on a given Web element.

public

C Enter

Instructs the Actor to enter a value into a form input field.

public

Instructs the Actor to execute a script within the context of the current browser window.

public abstract

Allows for a script to be executed to be parametrised.

public

C Hover

Instructs the Actor to hover the mouse pointer over a given Web element.

public

Allows the Actor to navigate to a specific destination, as well as back and forth in the browser history, or reload the current page.

public

C Press

Instructs the Actor to send a key press or a sequence of keys to a Web element.

public

Instructs the Actor to resize the browser window.

public

C Scroll

Instructs the Actor to scroll until a given Web element comes into view.

public

C Select

Instructs the Actor to select an option from a HTML <select> element, either by its display name, or by value.

public

C Switch

Instructs the Actor to switch to a different frame, inline frame, or browser window/tab.

public

Instructs the Actor to take a screenshot and emit an Artifact, which can then be persisted by ArtifactArchiver and reported by Serenity BDD reporter.

public

Instructs the Actor to enable or disable automated synchronisation between Protractor and Angular.

public

C Wait

Instructs the Actor to wait before proceeding either for a set @serenity-js/core~Duration or until a given Expectation is met.

public

Fluent interface to make the instantiation of the Interaction to Enter more readable.

public

Fluent interface to make the instantiation of the Interaction to Press more readable.

public

Configures the Target representing a HTML <select> element for the Actor to interact with.

public

Fluent interface to make the instantiation of the Interaction to Wait more readable.

screenplay/questions

summary
public
public
public
public

C Cookie

public

Returns the result of last script executed via ExecuteScript

public

Represents a modal dialog window created using Window.alert(), Window.prompt() or Window.confirm().

public

C Pick

this class is experimental.
public

Returns a Protractor configuration parameter specified in protractor.conf.js.

public

Represents options and values selected in a HTML <select> element.

public

C Value

public
public

C Window

public

screenplay/questions/targets

summary
public

C Target

Provides a convenient way to retrieve a single web element or multiple web elements, so that they can be used with Serenity/JS Interactions.

public

Locates a single web element.

public

Locates a group of web element.

public

Locates a single web element located within another web element.

public

Locates a group of web element located within another web element.

screenplay/questions/text

summary
public

C Text

stage/crew/photographer

summary
public

The Photographer is a StageCrewMember who takes screenshots of the web browser the Actor in the spotlight is using.

stage/crew/photographer/strategies

summary
public abstract

Configures the Photographer to take photos (a.k.a.

public

Configures the Photographer to take photos (a.k.a.

public

Configures the Photographer to take photos (a.k.a.

public

Configures the Photographer to take photos (a.k.a.

public

Configures the Photographer to take photos (a.k.a.