Skip to main content

Chromium

isAlertOpen

Whether a simple dialog is currently open.

Non official and undocumented Chromium command. More about this command can be found here.

Usage
browser.isAlertOpen()
Example
console.log(browser.isAlertOpen()); // outputs: false
browser.execute('window.alert()');
console.log(browser.isAlertOpen()); // outputs: true
Returns
  • <Boolean> isAlertOpen: true or false based on whether simple dialog is present or not.

isAutoReporting

Whether it should automatically raises errors on browser logs.

Non official and undocumented Chromium command. More about this command can be found here.

Usage
browser.isAutoReporting()
Returns
  • <Boolean> isAutoReporting: true or false based on whether auto reporting is enabled.

setAutoReporting

Toggle whether to return response with unknown error with first browser error (e.g. failed to load resource due to 403/404 response) for all subsequent commands (once enabled).

Non official and undocumented Chromium command. More about this command can be found here.

Usage
browser.setAutoReporting(enabled)
Parameters
NameTypeDetails
enabledbooleantrue if auto reporting should be enabled, use false to disable previously enabled auto reporting.
Examples
// Enable auto reporting first thing after session was initiated with empty browser logs
console.log(browser.setAutoReporting(true)); // outputs: null
// Upon requesting an non-existing resource it will abort execution due to thrown unknown error
browser.url('https://webdriver.io/img/404-does-not-exist.png');
// During the session do some operations which populate the browser logs
browser.url('https://webdriver.io/img/404-does-not-exist.png');
browser.url('https://webdriver.io/403/no-access');
// Enable auto reporting which throws an unknown error for first browser log (404 response)
browser.setAutoReporting(true);
Returns
  • <Object|Null> firstBrowserError: In case first browser error already occured prior to executing this command it will throw unknown error as response, which is an object with 'message' key describing first browser error. Otherwise it returns null on success.

isLoading

Determines load status for active window handle.

Non official and undocumented Chromium command. More about this command can be found here.

Usage
browser.isLoading()
Example
console.log(browser.isLoading()); // outputs: false
browser.newWindow('https://webdriver.io');
console.log(browser.isLoading()); // outputs: true
Returns
  • <Boolean> isLoading: true or false based on whether active window handle is loading or not.

takeHeapSnapshot

Takes a heap snapshot of the current execution context.

Non official and undocumented Chromium command. More about this command can be found here.

Usage
browser.takeHeapSnapshot()
Returns
  • <Object> heapSnapshot: A JSON representation of the heap snapshot. Which can be inspected by loading as file into Chrome DevTools.

getNetworkConnection

Get the connection type for network emulation. This command is only applicable when remote end replies with networkConnectionEnabled capability set to true.

Non official and undocumented Chromium command. More about this command can be found here.

Usage
browser.getNetworkConnection()
Example
const browser = remote({
    capabilities: {
        browserName: 'chrome',
        'goog:chromeOptions': {
            // Network emulation requires device mode, which is only enabled when mobile emulation is on
            mobileEmulation: { deviceName: 'iPad' },
        },
    }
});
console.log(browser.getNetworkConnection()); // outputs: 6 (Both Wi-Fi and data)
Returns
  • <Number> connectionType: A bitmask to represent the network connection type. Airplane Mode (1), Wi-Fi only (2), Wi-Fi and data (6), 4G (8), 3G (10), 2G (20). By default Wi-Fi and data are enabled.

setNetworkConnection

Change connection type for network connection. This command is only applicable when remote end replies with networkConnectionEnabled capability set to true.

Non official and undocumented Chromium command. More about this command can be found here.

Usage
browser.setNetworkConnection(parameters)
Parameters
NameTypeDetails
parametersobjectObject containing ConnectionType, set bitmask as value for type key in object. Airplane Mode (1), Wi-Fi only (2), Wi-Fi and data (6), 4G (8), 3G (10), 2G (20).
Example
const browser = remote({
    capabilities: {
        browserName: 'chrome',
        'goog:chromeOptions': {
            // Network emulation requires device mode, which is only enabled when mobile emulation is on
            mobileEmulation: { deviceName: 'iPad' },
        },
    }
});
console.log(browser.setNetworkConnection({ type: 1 })); // outputs: 1 (Airplane Mode)
Returns
  • <Number> connectionType: A bitmask to represent the network connection type. Value should match specified type in object, however device might not be capable of the network connection type requested.

getNetworkConditions

Get current network conditions used for emulation.

Non official and undocumented Chromium command. More about this command can be found here.

Usage
browser.getNetworkConditions()
Returns
  • <Object> networkConditions: Object containing network conditions for offline, latency, download_throughput and upload_throughput. Network conditions must be set before it can be retrieved.

setNetworkConditions

Set network conditions used for emulation by throttling connection.

Non official and undocumented Chromium command. More about this command can be found here.

Usage
browser.setNetworkConditions(network_conditions, network_name)
Parameters
NameTypeDetails
network_conditionsobjectObject containing network conditions which are latency, throughput (or download_throughput/upload_throughput) and offline (optional).
network_name
optional		stringName of network throttling preset. GPRS, Regular 2G, Good 2G, Regular 3G, Good 3G, Regular 4G, DSL, WiFi or No throttling to disable. When preset is specified values passed in first argument are not respected.
Examples
// Use different download (25kb/s) and upload (50kb/s) throughput values for throttling with a latency of 1000ms
browser.setNetworkConditions({ latency: 1000, download_throughput: 25600, upload_throughput: 51200 });
// Force disconnected from network by setting 'offline' to true
browser.setNetworkConditions({ latency: 0, throughput: 0, offline: true });
// When preset name (e.g. 'DSL') is specified it does not respect values in object (e.g. 'offline')
browser.setNetworkConditions({ latency: 0, throughput: 0, offline: true }, 'DSL');
// Best practice for specifying network throttling preset is to use an empty object
browser.setNetworkConditions({}, 'Good 3G');

deleteNetworkConditions

Disable any network throttling which might have been set. Equivalent of setting the No throttling preset.

Non official and undocumented Chromium command. More about this command can be found here.

Usage
browser.deleteNetworkConditions()

sendCommand

Send a command to the DevTools debugger.
For a list of available commands and their parameters refer to the Chrome DevTools Protocol Viewer.

Non official and undocumented Chromium command. More about this command can be found here.

Usage
browser.sendCommand(cmd, params)
Parameters
NameTypeDetails
cmdstringName of the command (e.g. Browser.close).
paramsobjectParameters to the command. In case no parameters for command, specify an empty object.

sendCommandAndGetResult

Send a command to the DevTools debugger and wait for the result.
For a list of available commands and their parameters refer to the Chrome DevTools Protocol Viewer.

Non official and undocumented Chromium command. More about this command can be found here.

Usage
browser.sendCommandAndGetResult(cmd, params)
Parameters
NameTypeDetails
cmdstringName of the command which returns a result (e.g. Network.getAllCookies).
paramsobjectParameters to the command. In case no parameters for command, specify an empty object.
Returns
  • <*> result: Either the return value of your command, or the error which was the reason for your command's failure.

file

Upload a file to remote machine on which the browser is running.

Non official and undocumented Chromium command. More about this command can be found here.

Usage
browser.file(file)
Parameters
NameTypeDetails
filestringBase64-encoded zip archive containing single file which to upload. In case base64-encoded data does not represent a zip archive or archive contains more than one file it will throw an unknown error.
Returns
  • <String> path: Absolute path of uploaded file on remote machine.

launchChromeApp

Launches a Chrome app by specified id.

Non official and undocumented Chromium command. More about this command can be found here.

Usage
browser.launchChromeApp(id)
Parameters
NameTypeDetails
idstringExtension id of app to be launched, as defined in chrome://extensions.
Example
const browser = remote({
    capabilities: {
        browserName: 'chrome',
        'goog:chromeOptions': {
            // Install upon starting browser in order to launch it
            extensions: [
              // Entry should be a base64-encoded packed Chrome app (.crx)
              require('fs').readFileSync('/absolute/path/app.crx').toString('base64')
            ]
        }
    }
});
browser.launchChromeApp('aohghmighlieiainnegkcijnfilokake')); // Google Docs (https://chrome.google.com/webstore/detail/docs/aohghmighlieiainnegkcijnfilokake)

getElementValue

Retrieves the value of a given form control element.

Non official and undocumented Chromium command. More about this command can be found here.

Usage
browser.getElementValue(elementId)
Parameters
NameTypeDetails
elementIdStringid of element to get value from
Returns
  • <String|Null> value: Current value of the element. In case specified element is not a form control element, it will return null.

elementHover

Enable hover state for an element, which is reset upon next interaction.

Non official and undocumented Chromium command. More about this command can be found here.

Usage
browser.elementHover(elementId)
Parameters
NameTypeDetails
elementIdStringid of element to hover over to

touchPinch

Trigger a pinch zoom effect.

Non official and undocumented Chromium command. More about this command can be found here.

Usage
browser.touchPinch(x, y, scale)
Parameters
NameTypeDetails
xnumberx position to pinch on
ynumbery position to pinch on
scalenumberpinch zoom scale

freeze

Freeze the current page. Extension for Page Lifecycle API.

Non official and undocumented Chromium command. More about this command can be found here.

Usage
browser.freeze()

resume

Resume the current page. Extension for Page Lifecycle API.

Non official and undocumented Chromium command. More about this command can be found here.

Usage
browser.resume()

getCastSinks

Returns the list of cast sinks (Cast devices) available to the Chrome media router.

Non official and undocumented Chromium command. More about this command can be found here.

Usage
browser.getCastSinks()
Returns
  • <string[]> sinks: List of available sinks.

selectCastSink

Selects a cast sink (Cast device) as the recipient of media router intents (connect or play).

Non official and undocumented Chromium command. More about this command can be found here.

Usage
browser.selectCastSink(sinkName)
Parameters
NameTypeDetails
sinkNamestringThe name of the target device.

startCastTabMirroring

Initiates tab mirroring for the current browser tab on the specified device.

Non official and undocumented Chromium command. More about this command can be found here.

Usage
browser.startCastTabMirroring(sinkName)
Parameters
NameTypeDetails
sinkNamestringThe name of the target device.

getCastIssueMessage

Returns error message if there is any issue in a Cast session.

Non official and undocumented Chromium command. More about this command can be found here.

Usage
browser.getCastIssueMessage()
Returns
  • <String> message: Error message, if any.

stopCasting

Stops casting from media router to the specified device, if connected.

Non official and undocumented Chromium command. More about this command can be found here.

Usage
browser.stopCasting(sinkName)
Parameters
NameTypeDetails
sinkNamestringThe name of the target device.

shutdown

Shutdown ChromeDriver process and consequently terminating all active sessions.

Non official and undocumented Chromium command. More about this command can be found here.

Usage
browser.shutdown()

takeElementScreenshot

The Take Element Screenshot command takes a screenshot of the visible region encompassed by the bounding rectangle of an element.

Non official and undocumented Chromium command. More about this command can be found here.

Usage
browser.takeElementScreenshot(elementId, scroll)
Parameters
NameTypeDetails
elementIdStringthe id of an element returned in a previous call to Find Element(s)
scroll
optional		booleanscroll into view the element. Default: true
Returns
  • <String> screenshot: The base64-encoded PNG image data comprising the screenshot of the visible region of an element’s bounding rectangle after it has been scrolled into view.

getLogTypes

Get available log types.

Non official and undocumented Chromium command. More about this command can be found here.

Usage
browser.getLogTypes()
Returns
  • <String[]> logTypes: The list of available log types, example: browser, driver.

getLogs

Get the log for a given log type. Log buffer is reset after each request.

Non official and undocumented Chromium command. More about this command can be found here.

Usage
browser.getLogs(type)
Parameters
NameTypeDetails
typestringthe log type
Returns
  • <Object[]> logs: The list of log entries.