@touch4it/puppeteer
v2.0.0
Published
Wrapper around Puppeteer library to make it easier to use.
Downloads
3
Readme
Puppeteer wrapper
Wrapper around Puppeteer library to make it easier to use.
Puppeteer is a Node library which provides a high-level API to control Chrome or Chromium over the DevTools Protocol. Puppeteer runs headless by default, but can be configured to run full (non-headless) Chrome or Chromium.
Installing
Install puppeteer wrapper from npm
npm i puppeteer @touch4it/puppeteer
or
npm i puppeteer-core @touch4it/puppeteer
In order to use it you will need to require it first
const puppeteerT4IT = require('@touch4it/puppeteer');
Documentation
Get Puppeteer instance
Returns Puppeteer library.
const puppeteer = puppeteerT4IT.getPuppeteer();
Change default TIMEOUT and SCREENSHOT_DIRECTORY vars
If you want to use different timeout and screenshot directory, you can use init function to change these variables. You can pass following arguments into this function:
timeout
Default request timeout which will be use in the module (defaults to30000
ms)screenshotDirectory
Name of the directory where screenshots will be stored (defaults toscreenshots/
)
puppeteerT4IT.init(5000, 'some_other_dir/');
Launch new browser instance
You can pass option
object as argument, which can contain all available option for launch() function
Returns new Browser instance.
let browser = await puppeteerT4IT.launch({ headless: false });
Get new page instance
You can pass following arguments into this function:
browser
A Browser instance that you have created with puppeteer.launch()authenticationData
Object containing "username" and "password" authentication keys for basic auth when the page is launched
Returns new Page instance.
let page = await puppeteerT4IT.getPage(browser, { username: 'User', password: '123abc' });
Navigate to web page and test status code
You can pass following arguments into this function:
page
Puppeteer page objecturl
URL to be redirected tostatusCode
awaited HTTP response status code (defaults to200
)
Returns page
await puppeteerT4IT.goto(page, baseUrl);
Timeout execution for specified amount of milliseconds
You can pass following arguments into this function:
ms
time in ms to wait
Returns empty Promise
await puppeteerT4IT.sleep(500);
Make screenshots from web page
You can pass following arguments into this function:
page
Puppeteer page objectwidth
Screen widthheight
Screen heightpageName
Web page name under which a screenshot will be storeddeviceScaleFactor
Specify device scale factor (Defaults to1
)isMobile
isMobile Whether the meta viewport tag is taken into account (defaults tofalse
)delay
Time in ms to wait after reload (defaults to0
)beforeAction
Function to be called before screenshot is made (defaults tonull
)beforeActionParameters
beforeAction parameters (defaults to[]
)
Returns empty Promise
await puppeteerT4IT.screenshotPage(page, 360, 640, 'frontpage', 1, true, delay, clickOnButton, ['.navigation-element--class']);
Make screenshots in most popular screen resolutions
You can pass following arguments into this function:
page
Puppeteer page objectname
Web page name under which screenshots will be storeddelay
Time in ms to wait after reload (defaults to0
)beforeAction
Function to be called before screenshot is made (defaults tonull
)beforeActionParameters
beforeAction parameters (defaults to[]
)
Returns empty Promise
await puppeteerT4IT.screenshotMultipleResolutions(page, 'projects', 4000);
Click on element
You can pass following arguments into this function:
page
Puppeteer page objectquerySelector
Page element selectordelay
Time in ms to wait after reload (defaults to0
)
Returns empty Promise
await puppeteerT4IT.click(page, '.class', 500);
Tap on element
You can pass following arguments into this function:
page
Puppeteer page objectquerySelector
Page element selectordelay
Time in ms to wait after reload (defaults to0
)
Returns empty Promise
await puppeteerT4IT.tapOnElement(page, '.class', 500);
Get href link from element
You can pass following arguments into this function:
page
Puppeteer page objectquerySelector
Page element selector
Returns link href from element
await puppeteerT4IT.getLinkByQuerySelector(page, '.class');
Get href link hostname from element
You can pass following arguments into this function:
page
Puppeteer page objectquerySelector
Page element selector
It returns link hostname from element.
await puppeteerT4IT.getHostnameByQuerySelector(page, '.class');
Get value from element
You can pass following arguments into this function:
page
Puppeteer page objectquerySelector
Page element selector
Returns value of element
await puppeteerT4IT.getValueByQuerySelector(page, '.class');
License
This project is licensed under the MIT License - see the LICENSE file for details.
Changelog
Project updates are tracked in a CHANGELOG file