Options

import type {Options} from 'cabbie-async';

Properties

base: string

You can proivde a baseUrl so that tests can navigate relative to that url. e.g.

Instead of:

const driver = cabbie(remote, {});
await driver.activeWindow.navigateTo('http://example.com/my/path');

You can write:

const driver = cabbie(remote, {base: 'http://example.com'});
await driver.activeWindow.navigateTo('/my/path');

This makes it easier to port tests between development/staging/production

browser: Browser

Selected browser, if using Browser Stack, Sauce Labs or Testing Bot. See Available Browsers for usage.

capabilities: {}

Desired capabilities are passed to selenium when setting up the session

requiredCapabilities: {}

Required capabilities are passed to selenium when setting up the session

session: Session

Optionally provide a session if you have already started the selenium session.

debug: boolean

Log method calls to the console

httpDebug: boolean

Log all requests and responses in great detail. Use this when you are really struggling to debug something.

onCall: (event: Object) => any

A hook for you to provide custom logging

onRequest: (req: Object) => any

A hook for you to provide custom logging

onResponse: (res: Object) => any

A hook for you to provide custom logging

mode: Mode

This field is ignored unless you are using the combined async/sync cabbie

sauceUsername: string

Sauce Labs username (normally you should just set the SAUCE_USERNAME environment variable)

sauceAccessKey: string

Sauce Labs access key (normally you should just set the SAUCE_ACCESS_KEY environment variable)

browserStackUsername: string

Browser stack username (normally you should just set the BROWSER_STACK_USERNAME environment variable)

browserStackAccessKey: string

Browser stack access key (normally you should just set the BROWSER_STACK_ACCESS_KEY environment variable)

testingBotKey: string

Testing bot key (normally you should just set the TESTING_BOT_KEY environment variable)

testingBotSecret: string

Testing bot secret (normally you should just set the TESTING_BOT_SECRET environment variable)