Wondering what’s next for npm?Check out our public roadmap! »

    devtools
    TypeScript icon, indicating that this package has built-in type declarations

    7.4.6 • 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

    $ npm i 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',
                'wdio:devtoolsOptions': {
                    headless: true
                }
            }
        })
    
        await browser.url('https://webdriver.io')
    
        /**
         * run Puppeteer code
         */
        await browser.call(async () => {
            const page = (await browser.puppeteer.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()
    })

    wdio:devtoolsOptions Capability

    In order to set Puppeteer specific configurations you can use the wdio:devtoolsOptions capability which is a custom property (compliant to the WebDriver protocol), e.g.:

    {
        browserName: 'chrome',
        'wdio:devtoolsOptions': {
            headless: true,
            defaultViewport: {
                width: 800,
                height: 600,
                deviceScaleFactor: 1,
                isMobile: false
            }
        }
    }

    Commands

    The following commands are already supported:

    Selector Strategies

    Browser

    • [x] Chrome
    • [x] Firefox (nightly only)
    • [x] Edge
    • [ ] Safari

    Install

    npm i devtools

    DownloadsWeekly Downloads

    378,321

    Version

    7.4.6

    License

    MIT

    Unpacked Size

    215 kB

    Total Files

    240

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar