WebDriver client for JavaScript

Zero dependency minimal JavaScript bindings that conform to the W3C WebDriver standard, which specifies a remote control protocol for web browsers.

Tested on major browsers

✅	✅		✅	✅

Tested on most popular Node.js versions

🚧 Work in progress...

API

newSession

• See: WebDriver spec

This function creates a new WebDriver session.

Parameters

• url string WebDriver server URL
• options object configuration object for creating the session

Examples

const session = await webdriver.newSession('http://localhost:4444', {
    desiredCapabilities: {
        browserName: 'Chrome'
    }
});

Returns Promise<Session> session

status

• See: WebDriver spec

This function queries the WebDriver server's current status.

Parameters

• url string WebDriver server URL

Examples

await webdriver.status('http://localhost:4444');
// {
//   build: { version: '1.2.0' },
//   os: { name: 'mac', version: 'unknown', arch: '64bit' }
// }

Returns Promise<Object> status

Session

This object represents a WebDriver session.

Type: Object

Properties

• delete Session.delete Delete the session.
• go Session.go Navigate to a new URL.
• getTitle Session.getTitle Get the current page title.
• findElement Session.findElement Search for an element on the page, starting from the document root.

Session.delete

• See: WebDriver spec

Delete the session.

Examples

await session.delete();

Returns Promise

Session.go

• See: WebDriver spec

Navigate to a new URL.

Parameters

• targetUrl string The URL to navigate to.

Examples

await session.go('http://localhost:8087');

Returns Promise

Session.getTitle

• See: WebDriver spec

Get the current page title.

Examples

const title = await session.getTitle();

Returns Promise<string> The current page title.

Session.findElement

• See: WebDriver spec

Search for an element on the page, starting from the document root.

Parameters

• strategy string Locator strategy ("css selector", "link text", "partial link text", "tag name", "xpath").
• selector string Selector string.

Examples

const element = await session.findElement('css', 'h2');

Returns Promise<Element>

Session.getTimeout

• See: WebDriver spec

Gets timeout durations associated with the current session.

Examples

const timeout = await session.getTimeout();
// {
//  script: 30000,
//  pageLoad: 60000,
//  implicit: 40000
// }

Returns Promise<object> Timeout durations associated with the current session in milliseconds.

Session.setTimeout

• See: WebDriver spec

Configure the amount of time that a particular type of operation can execute for before they are aborted and a |Timeout| error is returned to the client.

Parameters

• timeouts object Timout configuration object with values in milliseconds.
  • timeouts.script number Session script timeout - Determines when to interrupt a script that is being evaluated.
  • timeouts.pageLoad number Session page load timeout - Provides the timeout limit used to interrupt navigation of the browsing context.
  • timeouts.implicit number Session implicit wait timeout -Gives the timeout of when to abort locating an element.

Examples

await session.setTimeout({
  script: 30000,
  pageLoad: 60000,
  implicit: 40000
});

Returns Promise

Element

This object represents a WebDriver element.

Type: Object

Properties

• sendKeys Element.sendKeys Send a sequence of key strokes to an element.
• click Element.click Click on an element.
• getText Element.getText Returns the visible text for the element.
• getCss Element.getCss Returns the computed value of the given CSS property for the element.

Element.sendKeys

• See: WebDriver spec

Send a sequence of key strokes to an element.

Parameters

• text string The sequence of keys to type.

Examples

const input = await session.findElement('css', '[name="first-name"]');
await a.sendKeys('Hello World');

Returns Promise

Element.click

• See: WebDriver spec

Click on an element.

Examples

const submitButton = await session.findElement('css', 'button[type="submit"]');
await submitButton.click();

Returns Promise

Element.getText

• See: WebDriver spec

Returns the visible text for the element.

Examples

const result = await session.findElement('css', '#result');
const text = await result.getText();

Returns Promise<string> Visible text for the element.

Element.getCss

• See: WebDriver spec

Returns the computed value of the given CSS property for the element.

Parameters

• propertyName string CSS property.

Examples

const button = await session.findElement('css', '#red-button');
const backgroundColor = await button.getCss('background-color');

Returns Promise<string> Computed CSS property value for the element.

Contributors

Thanks goes to these wonderful people :

Igor Muchychka	Gabor Szalay	Adam Graf	Roland Orosz

This project follows the all-contributors specification. Contributions of any kind welcome!