Page Commands
page.emulate
Emulates given device metrics and user agent
page.setViewport
Defines browser viewport, where the viewport is the user's visible area of a web page
page.goto
Navigates to a given URL and waits until the page loaded
page.screenshot
Makes a screenshot of the page
page.click
Emulates mouse click according to given options
page.moveMouse
Moves mouse to given position
page.tap
Emulates tap according to given options
page.press
Emulates pressing on a key, optionally with modifiers such as ⇧, ⌥, alt, control, ⌘
page.scroll
Scrolls the document in the window by the given amount
page.reload
Refreshes the page
page.setUserAgent
Sets custom user agent
While running test on < 3.0.1 this method requires adding "--no-sandbox --disable-setuid-sandbox" Chromium arguments in Browser options
page.setCookie
Sets cookies on the page
page.mockRequest
Intercepts to a given URL and replaces it according to provided data
As soon as a matching request intercepted the session gets detached, meaning Puppetry stop listening for mocking. You have to set page.mockRequest before every request that you want to mock.
page.waitFor
Waits for a given time before proceeding to the next command
page.waitForSelector
Waits for an element matching a provided CSS selector
page.waitForNavigation
Waits until a given event before proceeding to the next command
page.waitForResponse
Waits for HTTP(S) response
page.waitForRequest
Waits for HTTP(S) request
page.authenticate
Provide credentials for HTTP authentication.
page.evaluate
Evaluates JavaScript code in the page context
page.runjs
Runs custom JavaScript code in the test suite with use of Puppeteer API and Puppetry API. You can access dynamic environment variables via ENV map (e.g. ENV[VAR_NAME])
page.debug
Stops execution of JavaScript, and calls (if available) the debugging function. During test scenarios may happen many things - DOM changes, pages load. It makes hard to figure out why some test assertions fail in some particular moment. You can use this tool to set a breakpoint. Test flow will stop as soon as it reaches this point. So you will be able to examine the page state with DevTools.
page.closeDialog
Listen to dialog events and dismiss or accept dialogs (alert, beforeunload, confirm or prompt) as they are called
The step must be defined before the expected dialog event
page.assignVar
Assigns template variable dynamically
page.assignVarRemotely
Polls URL with a given intervals until a response satisfying parserFn function received or a specified timeout exceeded. It can be used, for example, to retrieve a value from an email sent by the application under test
Last updated
