website/versioned_docs/version-24.40.0/api/index.md
Class
</th><th>Description
</th></tr></thead> <tbody><tr><td><span id="accessibility">Accessibility</span>
</td><td>The Accessibility class provides methods for inspecting the browser's accessibility tree. The accessibility tree is used by assistive technology such as screen readers or switches.
Remarks:
Accessibility is a very platform-specific thing. On different platforms, there are different screen readers that might have wildly different output.
Blink - Chrome's rendering engine - has a concept of "accessibility tree", which is then translated into different platform-specific APIs. Accessibility namespace gives users access to the Blink Accessibility Tree.
Most of the accessibility tree gets filtered out when converting from Blink AX Tree to Platform-specific AX-Tree or by assistive technologies themselves. By default, Puppeteer tries to approximate this filtering, exposing only the "interesting" nodes of the tree.
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the Accessibility class.
<span id="browser">Browser</span>
</td><td>Browser represents a browser instance that is either:
Browser emits various events which are documented in the BrowserEvent enum.
Remarks:
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the Browser class.
<span id="browsercontext">BrowserContext</span>
</td><td>BrowserContext represents individual user contexts within a browser.
When a browser is launched, it has at least one default browser context. Others can be created using Browser.createBrowserContext(). Each context has isolated storage (cookies/localStorage/etc.)
BrowserContext emits various events which are documented in the BrowserContextEvent enum.
If a page opens another page, e.g. using window.open, the popup will belong to the parent page's browser context.
Remarks:
In Chrome all non-default contexts are incognito, and default browser context might be incognito if you provide the --incognito argument when launching the browser.
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the BrowserContext class.
<span id="browserlauncher">BrowserLauncher</span>
</td><td>Describes a launcher - a class that is able to create and launch a browser instance.
Remarks:
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the BrowserLauncher class.
<span id="cdpsession">CDPSession</span>
</td><td>The CDPSession instances are used to talk raw Chrome Devtools Protocol.
Remarks:
Protocol methods can be called with CDPSession.send() method and protocol events can be subscribed to with CDPSession.on method.
Useful links: DevTools Protocol Viewer and Getting Started with DevTools Protocol.
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the CDPSession class.
<span id="connection">Connection</span>
</td><td> </td></tr> <tr><td><span id="connectionclosederror">ConnectionClosedError</span>
</td><td>Thrown if underlying protocol connection has been closed.
</td></tr> <tr><td><span id="consolemessage">ConsoleMessage</span>
</td><td>ConsoleMessage objects are dispatched by page via the 'console' event.
Remarks:
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the ConsoleMessage class.
<span id="coverage">Coverage</span>
</td><td>The Coverage class provides methods to gather information about parts of JavaScript and CSS that were used by the page.
Remarks:
To output coverage in a form consumable by Istanbul, see puppeteer-to-istanbul.
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the Coverage class.
<span id="csscoverage">CSSCoverage</span>
</td><td> </td></tr> <tr><td><span id="devicerequestprompt">DeviceRequestPrompt</span>
</td><td>Device request prompts let you respond to the page requesting for a device through an API like WebBluetooth.
Remarks:
DeviceRequestPrompt instances are returned via the Page.waitForDevicePrompt() method.
<span id="dialog">Dialog</span>
</td><td>Dialog instances are dispatched by the Page via the dialog event.
Remarks:
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the Dialog class.
<span id="elementhandle">ElementHandle</span>
</td><td>ElementHandle represents an in-page DOM element.
Remarks:
ElementHandles can be created with the Page.$() method.
import puppeteer from 'puppeteer';
const browser = await puppeteer.launch();
const page = await browser.newPage();
await page.goto('https://example.com');
const hrefElement = await page.$('a');
await hrefElement.click();
// ...
ElementHandle prevents the DOM element from being garbage-collected unless the handle is disposed. ElementHandles are auto-disposed when their associated frame is navigated away or the parent context gets destroyed.
ElementHandle instances can be used as arguments in Page.$eval() and Page.evaluate() methods.
If you're using TypeScript, ElementHandle takes a generic argument that denotes the type of element the handle is holding within. For example, if you have a handle to a <select> element, you can type it as ElementHandle<HTMLSelectElement> and you get some nicer type checks.
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the ElementHandle class.
<span id="eventemitter">EventEmitter</span>
</td><td>The EventEmitter class that many Puppeteer classes extend.
Remarks:
This allows you to listen to events that Puppeteer classes fire and act accordingly. Therefore you'll mostly use on and off to bind and unbind to event listeners.
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the EventEmitter class.
<span id="extensiontransport">ExtensionTransport</span>
</td><td>(Experimental) Experimental ExtensionTransport allows establishing a connection via chrome.debugger API if Puppeteer runs in an extension. Since Chrome DevTools Protocol is restricted for extensions, the transport implements missing commands and events.
Remarks:
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the ExtensionTransport class.
<span id="filechooser">FileChooser</span>
</td><td>File choosers let you react to the page requesting for a file.
Remarks:
FileChooser instances are returned via the Page.waitForFileChooser() method.
In browsers, only one file chooser can be opened at a time. All file choosers must be accepted or canceled. Not doing so will prevent subsequent file choosers from appearing.
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the FileChooser class.
<span id="frame">Frame</span>
</td><td>Represents a DOM frame.
To understand frames, you can think of frames as <iframe> elements. Just like iframes, frames can be nested, and when JavaScript is executed in a frame, the JavaScript does not affect frames inside the ambient frame the JavaScript executes in.
Remarks:
Frame lifecycles are controlled by three events that are all dispatched on the parent page:
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the Frame class.
<span id="httprequest">HTTPRequest</span>
</td><td>Represents an HTTP request sent by a page.
Remarks:
Whenever the page sends a request, such as for a network resource, the following events are emitted by Puppeteer's page:
request: emitted when the request is issued by the page.
requestfinished - emitted when the response body is downloaded and the request is complete.
If request fails at some point, then instead of requestfinished event the requestfailed event is emitted.
All of these events provide an instance of HTTPRequest representing the request that occurred:
page.on('request', request => ...)
NOTE: HTTP Error responses, such as 404 or 503, are still successful responses from HTTP standpoint, so request will complete with requestfinished event.
If request gets a 'redirect' response, the request is successfully finished with the requestfinished event, and a new request is issued to a redirected url.
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the HTTPRequest class.
<span id="httpresponse">HTTPResponse</span>
</td><td>The HTTPResponse class represents responses which are received by the Page class.
Remarks:
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the HTTPResponse class.
<span id="jscoverage">JSCoverage</span>
</td><td>Remarks:
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the JSCoverage class.
<span id="jshandle">JSHandle</span>
</td><td>Represents a reference to a JavaScript object. Instances can be created using Page.evaluateHandle().
Handles prevent the referenced JavaScript object from being garbage-collected unless the handle is purposely disposed. JSHandles are auto-disposed when their associated frame is navigated away or the parent context gets destroyed.
Handles can be used as arguments for any evaluation function such as Page.$eval(), Page.evaluate(), and Page.evaluateHandle(). They are resolved to their referenced object.
Remarks:
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the JSHandle class.
<span id="keyboard">Keyboard</span>
</td><td>Keyboard provides an api for managing a virtual keyboard. The high level api is Keyboard.type(), which takes raw characters and generates proper keydown, keypress/input, and keyup events on your page.
Remarks:
For finer control, you can use Keyboard.down(), Keyboard.up(), and Keyboard.sendCharacter() to manually fire events as if they were generated from a real keyboard.
On macOS, keyboard shortcuts like ⌘ A -> Select All do not work. See #1313.
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the Keyboard class.
<span id="locator">Locator</span>
</td><td>Locators describe a strategy of locating objects and performing an action on them. If the action fails because the object is not ready for the action, the whole operation is retried. Various preconditions for a successful action are checked automatically.
See https://pptr.dev/guides/page-interactions#locators for details.
</td></tr> <tr><td><span id="mouse">Mouse</span>
</td><td>The Mouse class operates in main-frame CSS pixels relative to the top-left corner of the viewport.
Remarks:
Every page object has its own Mouse, accessible with Page.mouse.
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the Mouse class.
<span id="page">Page</span>
</td><td>Page provides methods to interact with a single tab or extension background page in the browser.
:::note
One Browser instance might have multiple Page instances.
:::
Remarks:
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the Page class.
<span id="protocolerror">ProtocolError</span>
</td><td>ProtocolError is emitted whenever there is an error from the protocol.
</td></tr> <tr><td><span id="puppeteer">Puppeteer</span>
</td><td>The main Puppeteer class.
IMPORTANT: if you are using Puppeteer in a Node environment, you will get an instance of PuppeteerNode when you import or require puppeteer. That class extends Puppeteer, so has all the methods documented below as well as all that are defined on PuppeteerNode.
Remarks:
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the Puppeteer class.
<span id="puppeteererror">PuppeteerError</span>
</td><td>The base class for all Puppeteer-specific errors
Remarks:
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the PuppeteerError class.
<span id="puppeteernode">PuppeteerNode</span>
</td><td>Extends the main Puppeteer class with Node specific behaviour for fetching and downloading browsers.
If you're using Puppeteer in a Node environment, this is the class you'll get when you run require('puppeteer') (or the equivalent ES import).
Remarks:
The most common method to use is launch, which is used to launch and connect to a new browser instance.
See the main Puppeteer class for methods common to all environments, such as Puppeteer.connect().
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the PuppeteerNode class.
<span id="screenrecorder">ScreenRecorder</span>
</td><td>Remarks:
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the ScreenRecorder class.
<span id="securitydetails">SecurityDetails</span>
</td><td>The SecurityDetails class represents the security details of a response that was received over a secure connection.
Remarks:
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the SecurityDetails class.
<span id="target">Target</span>
</td><td>Target represents a CDP target. In CDP a target is something that can be debugged such a frame, a page or a worker.
Remarks:
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the Target class.
<span id="timeouterror">TimeoutError</span>
</td><td>TimeoutError is emitted whenever certain operations are terminated due to timeout.
Remarks:
Example operations are page.waitForSelector or puppeteer.launch.
</td></tr> <tr><td><span id="toucherror">TouchError</span>
</td><td>TouchError is thrown when an attempt is made to move or end a touch that does not exist.
</td></tr> <tr><td><span id="touchscreen">Touchscreen</span>
</td><td>The Touchscreen class exposes touchscreen events.
Remarks:
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the Touchscreen class.
<span id="tracing">Tracing</span>
</td><td>The Tracing class exposes the tracing audit interface.
Remarks:
You can use tracing.start and tracing.stop to create a trace file which can be opened in Chrome DevTools or timeline viewer.
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the Tracing class.
<span id="unsupportedoperation">UnsupportedOperation</span>
</td><td>Puppeteer will throw this error if a method is not supported by the currently used protocol
</td></tr> <tr><td><span id="webworker">WebWorker</span>
</td><td>This class represents a WebWorker.
Remarks:
The events workercreated and workerdestroyed are emitted on the page object to signal the worker lifecycle.
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the WebWorker class.
Enumeration
</th><th>Description
</th></tr></thead> <tbody><tr><td><span id="browsercontextevent">BrowserContextEvent</span>
</td><td> </td></tr> <tr><td><span id="browserevent">BrowserEvent</span>
</td><td>All the events a browser instance may emit.
</td></tr> <tr><td><span id="interceptresolutionaction">InterceptResolutionAction</span>
</td><td> </td></tr> <tr><td><span id="locatorevent">LocatorEvent</span>
</td><td>All the events that a locator instance may emit.
</td></tr> <tr><td><span id="pageevent">PageEvent</span>
</td><td>All the events that a page instance may emit.
</td></tr> <tr><td><span id="targettype">TargetType</span>
</td><td> </td></tr> </tbody></table>Function
</th><th>Description
</th></tr></thead> <tbody><tr><td><span id="connect">connect(options)</span>
</td><td> </td></tr> <tr><td><span id="defaultargs">defaultArgs(options)</span>
</td><td> </td></tr> <tr><td><span id="launch">launch(options)</span>
</td><td> </td></tr> <tr><td><span id="trimcache">trimCache()</span>
</td><td> </td></tr> </tbody></table>Interface
</th><th>Description
</th></tr></thead> <tbody><tr><td><span id="actionoptions">ActionOptions</span>
</td><td> </td></tr> <tr><td><span id="addscreenparams">AddScreenParams</span>
</td><td> </td></tr> <tr><td><span id="autofilldata">AutofillData</span>
</td><td> </td></tr> <tr><td><span id="bluetoothemulation">BluetoothEmulation</span>
</td><td>(Experimental) Exposes the bluetooth emulation abilities.
Remarks:
Web Bluetooth specification requires the emulated adapters should be isolated per top-level navigable. However, at the moment Chromium's bluetooth emulation implementation is tight to the browser context, not the page. This means the bluetooth emulation exposed from different pages of the same browser context would interfere their states.
</td></tr> <tr><td><span id="bluetoothmanufacturerdata">BluetoothManufacturerData</span>
</td><td>Represents the simulated bluetooth peripheral's manufacturer data.
</td></tr> <tr><td><span id="boundingbox">BoundingBox</span>
</td><td> </td></tr> <tr><td><span id="boxmodel">BoxModel</span>
</td><td> </td></tr> <tr><td><span id="browsercontextevents">BrowserContextEvents</span>
</td><td> </td></tr> <tr><td><span id="browsercontextoptions">BrowserContextOptions</span>
</td><td> </td></tr> <tr><td><span id="browserevents">BrowserEvents</span>
</td><td> </td></tr> <tr><td><span id="cdpsessionevents">CDPSessionEvents</span>
</td><td> </td></tr> <tr><td><span id="chromeheadlessshellsettings">ChromeHeadlessShellSettings</span>
</td><td> </td></tr> <tr><td><span id="chromesettings">ChromeSettings</span>
</td><td> </td></tr> <tr><td><span id="clickoptions">ClickOptions</span>
</td><td> </td></tr> <tr><td><span id="commandoptions">CommandOptions</span>
</td><td> </td></tr> <tr><td><span id="commoneventemitter">CommonEventEmitter</span>
</td><td> </td></tr> <tr><td><span id="configuration">Configuration</span>
</td><td>Defines options to configure Puppeteer's behavior during installation and runtime.
See individual properties for more information.
</td></tr> <tr><td><span id="connectiontransport">ConnectionTransport</span>
</td><td> </td></tr> <tr><td><span id="connectoptions">ConnectOptions</span>
</td><td>Generic browser options that can be passed when launching any browser or when connecting to an existing browser instance.
</td></tr> <tr><td><span id="consolemessagelocation">ConsoleMessageLocation</span>
</td><td> </td></tr> <tr><td><span id="continuerequestoverrides">ContinueRequestOverrides</span>
</td><td> </td></tr> <tr><td><span id="cookie">Cookie</span>
</td><td>Represents a cookie object.
</td></tr> <tr><td><span id="cookiedata">CookieData</span>
</td><td>Cookie parameter object used to set cookies in the browser-level cookies API.
</td></tr> <tr><td><span id="cookieparam">CookieParam</span>
</td><td>Cookie parameter object used to set cookies in the page-level cookies API.
</td></tr> <tr><td><span id="cookiepartitionkey">CookiePartitionKey</span>
</td><td>Represents a cookie partition key in Chrome.
</td></tr> <tr><td><span id="coverageentry">CoverageEntry</span>
</td><td>The CoverageEntry class represents one entry of the coverage report.
</td></tr> <tr><td><span id="credentials">Credentials</span>
</td><td> </td></tr> <tr><td><span id="csscoverageoptions">CSSCoverageOptions</span>
</td><td>Set of configurable options for CSS coverage.
</td></tr> <tr><td><span id="customqueryhandler">CustomQueryHandler</span>
</td><td> </td></tr> <tr><td><span id="debuginfo">DebugInfo</span>
</td><td>(Experimental)
</td></tr> <tr><td><span id="deletecookiesrequest">DeleteCookiesRequest</span>
</td><td> </td></tr> <tr><td><span id="device">Device</span>
</td><td> </td></tr> <tr><td><span id="devicerequestpromptdevice">DeviceRequestPromptDevice</span>
</td><td>Device in a request prompt.
</td></tr> <tr><td><span id="downloadbehavior">DownloadBehavior</span>
</td><td> </td></tr> <tr><td><span id="elementscreenshotoptions">ElementScreenshotOptions</span>
</td><td> </td></tr> <tr><td><span id="firefoxsettings">FirefoxSettings</span>
</td><td> </td></tr> <tr><td><span id="frameaddscripttagoptions">FrameAddScriptTagOptions</span>
</td><td> </td></tr> <tr><td><span id="frameaddstyletagoptions">FrameAddStyleTagOptions</span>
</td><td> </td></tr> <tr><td><span id="frameevents">FrameEvents</span>
</td><td> </td></tr> <tr><td><span id="framewaitforfunctionoptions">FrameWaitForFunctionOptions</span>
</td><td> </td></tr> <tr><td><span id="geolocationoptions">GeolocationOptions</span>
</td><td> </td></tr> <tr><td><span id="gotooptions">GoToOptions</span>
</td><td> </td></tr> <tr><td><span id="heapsnapshotoptions">HeapSnapshotOptions</span>
</td><td>Options for Page.captureHeapSnapshot().
</td></tr> <tr><td><span id="interceptresolutionstate">InterceptResolutionState</span>
</td><td> </td></tr> <tr><td><span id="internalnetworkconditions">InternalNetworkConditions</span>
</td><td> </td></tr> <tr><td><span id="jscoverageentry">JSCoverageEntry</span>
</td><td>The CoverageEntry class for JavaScript
</td></tr> <tr><td><span id="jscoverageoptions">JSCoverageOptions</span>
</td><td>Set of configurable options for JS coverage.
</td></tr> <tr><td><span id="keyboardtypeoptions">KeyboardTypeOptions</span>
</td><td> </td></tr> <tr><td><span id="keydownoptions">KeyDownOptions</span>
</td><td> </td></tr> <tr><td><span id="launchoptions">LaunchOptions</span>
</td><td>Generic launch options that can be passed when launching any browser.
</td></tr> <tr><td><span id="locatorevents">LocatorEvents</span>
</td><td> </td></tr> <tr><td><span id="locatorfilloptions">LocatorFillOptions</span>
</td><td> </td></tr> <tr><td><span id="locatorscrolloptions">LocatorScrollOptions</span>
</td><td> </td></tr> <tr><td><span id="mediafeature">MediaFeature</span>
</td><td>A media feature to emulate.
</td></tr> <tr><td><span id="metrics">Metrics</span>
</td><td> </td></tr> <tr><td><span id="mouseclickoptions">MouseClickOptions</span>
</td><td> </td></tr> <tr><td><span id="mousemoveoptions">MouseMoveOptions</span>
</td><td> </td></tr> <tr><td><span id="mouseoptions">MouseOptions</span>
</td><td> </td></tr> <tr><td><span id="mousewheeloptions">MouseWheelOptions</span>
</td><td> </td></tr> <tr><td><span id="moveable">Moveable</span>
</td><td> </td></tr> <tr><td><span id="networkconditions">NetworkConditions</span>
</td><td> </td></tr> <tr><td><span id="newdocumentscriptevaluation">NewDocumentScriptEvaluation</span>
</td><td> </td></tr> <tr><td><span id="offset">Offset</span>
</td><td> </td></tr> <tr><td><span id="pageevents">PageEvents</span>
</td><td>Denotes the objects received by callback functions for page events.
See PageEvent for more detail on the events and when they are emitted.
</td></tr> <tr><td><span id="pdfmargin">PDFMargin</span>
</td><td> </td></tr> <tr><td><span id="pdfoptions">PDFOptions</span>
</td><td>Valid options to configure PDF generation via Page.pdf().
</td></tr> <tr><td><span id="permissiondescriptor_2">PermissionDescriptor_2</span>
</td><td> </td></tr> <tr><td><span id="point">Point</span>
</td><td> </td></tr> <tr><td><span id="preconnectedperipheral">PreconnectedPeripheral</span>
</td><td>A bluetooth peripheral to be simulated.
</td></tr> <tr><td><span id="queryoptions">QueryOptions</span>
</td><td> </td></tr> <tr><td><span id="reloadoptions">ReloadOptions</span>
</td><td> </td></tr> <tr><td><span id="remoteaddress">RemoteAddress</span>
</td><td> </td></tr> <tr><td><span id="responseforrequest">ResponseForRequest</span>
</td><td>Required response data to fulfill a request with.
</td></tr> <tr><td><span id="screencastoptions">ScreencastOptions</span>
</td><td>(Experimental)
</td></tr> <tr><td><span id="screeninfo">ScreenInfo</span>
</td><td> </td></tr> <tr><td><span id="screenorientation_2">ScreenOrientation_2</span>
</td><td> </td></tr> <tr><td><span id="screenshotclip">ScreenshotClip</span>
</td><td> </td></tr> <tr><td><span id="screenshotoptions">ScreenshotOptions</span>
</td><td> </td></tr> <tr><td><span id="serializedaxnode">SerializedAXNode</span>
</td><td>Represents a Node and the properties of it that are relevant to Accessibility.
</td></tr> <tr><td><span id="snapshotoptions">SnapshotOptions</span>
</td><td> </td></tr> <tr><td><span id="supportedwebdrivercapabilities">SupportedWebDriverCapabilities</span>
</td><td>WebDriver BiDi capabilities that are not set by Puppeteer itself.
</td></tr> <tr><td><span id="touchhandle">TouchHandle</span>
</td><td>The TouchHandle interface exposes methods to manipulate touches that have been started
</td></tr> <tr><td><span id="tracingoptions">TracingOptions</span>
</td><td> </td></tr> <tr><td><span id="viewport">Viewport</span>
</td><td> </td></tr> <tr><td><span id="waitfornetworkidleoptions">WaitForNetworkIdleOptions</span>
</td><td> </td></tr> <tr><td><span id="waitforoptions">WaitForOptions</span>
</td><td> </td></tr> <tr><td><span id="waitforselectoroptions">WaitForSelectorOptions</span>
</td><td> </td></tr> <tr><td><span id="waitfortargetoptions">WaitForTargetOptions</span>
</td><td> </td></tr> <tr><td><span id="waittimeoutoptions">WaitTimeoutOptions</span>
</td><td> </td></tr> <tr><td><span id="windowbounds">WindowBounds</span>
</td><td> </td></tr> <tr><td><span id="workareainsets">WorkAreaInsets</span>
</td><td> </td></tr> </tbody></table>Namespace
</th><th>Description
</th></tr></thead> <tbody><tr><td><span id="cdpsessionevent">CDPSessionEvent</span>
</td><td>Events that the CDPSession class emits.
</td></tr> </tbody></table>Variable
</th><th>Description
</th></tr></thead> <tbody><tr><td><span id="default_intercept_resolution_priority">DEFAULT_INTERCEPT_RESOLUTION_PRIORITY</span>
</td><td>The default cooperative request interception resolution priority
</td></tr> <tr><td><span id="executablepath">executablePath</span>
</td><td> </td></tr> <tr><td><span id="knowndevices">KnownDevices</span>
</td><td>A list of devices to be used with Page.emulate().
</td></tr> <tr><td><span id="mousebutton">MouseButton</span>
</td><td>Enum of valid mouse buttons.
</td></tr> <tr><td><span id="predefinednetworkconditions">PredefinedNetworkConditions</span>
</td><td>A list of pre-defined network conditions to be used with Page.emulateNetworkConditions().
</td></tr> <tr><td><span id="puppeteer">puppeteer</span>
</td><td> </td></tr> </tbody></table>Type Alias
</th><th>Description
</th></tr></thead> <tbody><tr><td><span id="actionresult">ActionResult</span>
</td><td> </td></tr> <tr><td><span id="adapterstate">AdapterState</span>
</td><td>Emulated bluetooth adapter state.
</td></tr> <tr><td><span id="awaitable">Awaitable</span>
</td><td> </td></tr> <tr><td><span id="awaitableiterable">AwaitableIterable</span>
</td><td> </td></tr> <tr><td><span id="awaitablepredicate">AwaitablePredicate</span>
</td><td> </td></tr> <tr><td><span id="awaitedlocator">AwaitedLocator</span>
</td><td> </td></tr> <tr><td><span id="cdpevents">CDPEvents</span>
</td><td> </td></tr> <tr><td><span id="chromereleasechannel">ChromeReleaseChannel</span>
</td><td> </td></tr> <tr><td><span id="consolemessagetype">ConsoleMessageType</span>
</td><td>The supported types for console messages.
</td></tr> <tr><td><span id="cookiepriority">CookiePriority</span>
</td><td>Represents the cookie's 'Priority' status: https://tools.ietf.org/html/draft-west-cookie-priority-00
</td></tr> <tr><td><span id="cookiesamesite">CookieSameSite</span>
</td><td>Represents the cookie's 'SameSite' status: https://tools.ietf.org/html/draft-west-first-party-cookies
</td></tr> <tr><td><span id="cookiesourcescheme">CookieSourceScheme</span>
</td><td>Represents the source scheme of the origin that originally set the cookie. A value of "Unset" allows protocol clients to emulate legacy cookie scope for the scheme. This is a temporary ability and it will be removed in the future.
</td></tr> <tr><td><span id="createpageoptions">CreatePageOptions</span>
</td><td> </td></tr> <tr><td><span id="downloadpolicy">DownloadPolicy</span>
</td><td> </td></tr> <tr><td><span id="elementfor">ElementFor</span>
</td><td> </td></tr> <tr><td><span id="errorcode">ErrorCode</span>
</td><td> </td></tr> <tr><td><span id="evaluatefunc">EvaluateFunc</span>
</td><td> </td></tr> <tr><td><span id="evaluatefuncwith">EvaluateFuncWith</span>
</td><td> </td></tr> <tr><td><span id="eventswithwildcard">EventsWithWildcard</span>
</td><td> </td></tr> <tr><td><span id="eventtype">EventType</span>
</td><td> </td></tr> <tr><td><span id="experimentsconfiguration">ExperimentsConfiguration</span>
</td><td>Defines experiment options for Puppeteer.
See individual properties for more information.
</td></tr> <tr><td><span id="flattenhandle">FlattenHandle</span>
</td><td> </td></tr> <tr><td><span id="handlefor">HandleFor</span>
</td><td> </td></tr> <tr><td><span id="handleor">HandleOr</span>
</td><td> </td></tr> <tr><td><span id="handler">Handler</span>
</td><td> </td></tr> <tr><td><span id="imageformat">ImageFormat</span>
</td><td> </td></tr> <tr><td><span id="innerparams">InnerParams</span>
</td><td> </td></tr> <tr><td><span id="keyinput">KeyInput</span>
</td><td>All the valid keys that can be passed to functions that take user input, such as keyboard.press
</td></tr> <tr><td><span id="keypressoptions">KeyPressOptions</span>
</td><td> </td></tr> <tr><td><span id="locatorclickoptions">LocatorClickOptions</span>
</td><td> </td></tr> <tr><td><span id="lowercasepaperformat">LowerCasePaperFormat</span>
</td><td> </td></tr> <tr><td><span id="mapper">Mapper</span>
</td><td> </td></tr> <tr><td><span id="mousebutton">MouseButton</span>
</td><td> </td></tr> <tr><td><span id="nodefor">NodeFor</span>
</td><td> </td></tr> <tr><td><span id="paperformat">PaperFormat</span>
</td><td>All the valid paper format types when printing a PDF.
Remarks:
The sizes of each format are as follows:
Letter: 8.5in x 11in / 21.59cm x 27.94cm
Legal: 8.5in x 14in / 21.59cm x 35.56cm
Tabloid: 11in x 17in / 27.94cm x 43.18cm
Ledger: 17in x 11in / 43.18cm x 27.94cm
A0: 33.1102in x 46.811in / 84.1cm x 118.9cm
A1: 23.3858in x 33.1102in / 59.4cm x 84.1cm
A2: 16.5354in x 23.3858in / 42cm x 59.4cm
A3: 11.6929in x 16.5354in / 29.7cm x 42cm
A4: 8.2677in x 11.6929in / 21cm x 29.7cm
A5: 5.8268in x 8.2677in / 14.8cm x 21cm
A6: 4.1339in x 5.8268in / 10.5cm x 14.8cm
<span id="permission">Permission</span>
</td><td>Deprecated:
in favor of .
</td></tr> <tr><td><span id="permissionstate_2">PermissionState_2</span>
</td><td> </td></tr> <tr><td><span id="predicate">Predicate</span>
</td><td> </td></tr> <tr><td><span id="protocollifecycleevent">ProtocolLifeCycleEvent</span>
</td><td> </td></tr> <tr><td><span id="protocoltype">ProtocolType</span>
</td><td> </td></tr> <tr><td><span id="puppeteerlifecycleevent">PuppeteerLifeCycleEvent</span>
</td><td> </td></tr> <tr><td><span id="quad">Quad</span>
</td><td> </td></tr> <tr><td><span id="resourcetype">ResourceType</span>
</td><td>Resource types for HTTPRequests as perceived by the rendering engine.
</td></tr> <tr><td><span id="supportedbrowser">SupportedBrowser</span>
</td><td>Browsers supported by Puppeteer.
</td></tr> <tr><td><span id="supportedwebdrivercapability">SupportedWebDriverCapability</span>
</td><td> </td></tr> <tr><td><span id="targetfiltercallback">TargetFilterCallback</span>
</td><td> </td></tr> <tr><td><span id="videoformat">VideoFormat</span>
</td><td> </td></tr> <tr><td><span id="visibilityoption">VisibilityOption</span>
</td><td>Whether to wait for the element to be visible or hidden. null to disable visibility checks.
<span id="windowid">WindowId</span>
</td><td> </td></tr> <tr><td><span id="windowstate">WindowState</span>
</td><td> </td></tr> </tbody></table>