Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

devtools

6.1.25 • Public • Published

DevTools

A Chrome DevTools protocol binding that maps WebDriver commands into Chrome DevTools commands using Puppeteer

This package provides a low level interface to run browser automation scripts based on the WebDriver protocol. If you are looking for a tool to automate Chrome or Firefox you should look up Puppeteer. This is suppose to be used by the WebdriverIO package in order to run its automation on the Chrome DevTools protocol.

Install

To install this package from NPM run:

$ npm i devtools webdriverio

Example

The following example demonstrates how WebdriverIO can be used with the devtools package as automation binding using the automationProtocol option:

const { remote } = require('webdriverio')
 
let browser;
 
(async () => {
    browser = await remote({
        automationProtocol: 'devtools',
        capabilities: {
            browserName: 'chrome'
        }
    })
 
    await browser.url('https://webdriver.io')
 
    /**
     * run Puppeteer code
     */
    await browser.call(async () => {
        const puppeteerBrowser = browser.getPuppeteer()
        const page = (await puppeteerBrowser.pages())[0]
        await page.setRequestInterception(true)
        page.on('request', interceptedRequest => {
            if (interceptedRequest.url().endsWith('webdriverio.png')) {
                return interceptedRequest.continue({
                    url: 'https://user-images.githubusercontent.com/10379601/29446482-04f7036a-841f-11e7-9872-91d1fc2ea683.png'
                })
            }
 
            interceptedRequest.continue()
        })
    })
 
    // continue with WebDriver commands
    await browser.refresh()
    await browser.pause(2000)
 
    /**
     * now on the https://webdriver.io page you see the Puppeteer logo
     * instead of the WebdriverIO one
     */
 
    await browser.deleteSession()
})().catch(async (e) => {
    console.error(e)
    await browser.deleteSession()
})

Support

This package is work in progress. We are working on extending the support to include all possible commands, selector strategies and browser.

Commands

The following commands are already supported:

Selector Strategies

Browser

  • Chrome
  • Firefox (nightly only)
  • Edge
  • Safari

Install

npm i devtools

DownloadsWeekly Downloads

123,509

Version

6.1.25

License

MIT

Unpacked Size

85.3 kB

Total Files

76

Last publish

Collaborators

  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar