puppeteer library

Classes

Accessibility
The Accessibility class provides methods for inspecting Chromium's accessibility tree. The accessibility tree is used by assistive technology such as screen readers or switches.
AXNode
An Accessibility Node
BoxModel
Box model.
Browser
A Browser is created when Puppeteer connects to a Chromium instance, either through puppeteer.launch or puppeteer.connect.
BrowserContext
BrowserContexts provide a way to operate multiple independent browser sessions. When a browser is launched, it has a single BrowserContext used by default. The method Browser.newPage creates a page in the default browser context.
BrowserPath
ConsoleMessage
ConsoleMessage objects are dispatched by page via the console event.
ConsoleMessageType
CookieParam
Cookie parameter object
Coverage
Coverage gathers information about parts of JavaScript and CSS that were used by the page.
CoverageEntry
Device
DeviceViewport
Dialog
Dialog objects are dispatched by page via the 'onDialog' event.
ElementHandle
ElementHandle represents an in-page DOM element. ElementHandles can be created with the page.$ method.
ExecutionContext
The class represents a context for JavaScript execution. A Page might have many execution contexts:
FileChooser
FileChooser objects are returned via the 'page.waitForFileChooser' method.
Frame
At every point of time, page exposes its current frame tree via the page.mainFrame and frame.childFrames methods.
JsHandle
JSHandle represents an in-page JavaScript object. JSHandles can be created with the page.evaluateHandle method.
Key
MediaFeature
MediaType
Metrics
MetricsEvent
Page
Page provides methods to interact with a single tab or extension background page in Chromium. One Browser instance might have multiple Page instances.
PaperFormat
PdfMargins
Point<T extends num>
A utility class for representing two-dimensional positions.
Polling
Puppeteer
Launch or connect to a chrome instance
Range
Rectangle<T extends num>
A class for representing two-dimensional rectangles whose properties are immutable.
Request
Whenever the page sends a request, such as for a network resource, the following events are emitted by puppeteer's page:
Response
Response class represents responses which are received by page.
RevisionInfo
ScreenshotFormat
Target
Tracing
You can use tracing.start and tracing.stop to create a trace file which can be opened in Chrome DevTools or timeline viewer.
Until
Worker
The Worker class represents a WebWorker. The events workercreated and workerdestroyed are emitted on the page object to signal the worker lifecycle.

Enums

DialogType
Javascript dialog type.
ErrorReason
Network level fetch failure reason.
MouseButton
PermissionType
ResourceType
Resource type as it was perceived by the rendering engine.

Properties

puppeteer Puppeteer
final

Functions

downloadChrome({int? revision, String? cachePath, void onDownloadProgress(int received, int total)?}) Future<RevisionInfo>
Downloads the chrome revision specified by revision to the cachePath directory.

Exceptions / Errors

ClientError
NodeIsNotVisibleException
An exception throws when we try to interact (ie: click) on an invisible node.
ServerException
TargetClosedException