github/puppeteer
0
0
Fork 0
mirror of https://github.com/puppeteer/puppeteer synced 2024-06-14 14:02:48 +00:00
Code Issues Packages Projects Releases Wiki Activity
4531a76b3e
puppeteer/api/index.html

31 lines
88 KiB
HTML
Raw Normal View History

Deploy website - based on 7c3e51c22cbef937d4d01d32da8463095e0ca015
2022-06-28 11:21:17 +00:00
<!doctype html>
deploy: a63b8305acfd79ff73a6a316fc2e819f41613766
2024-04-05 13:15:22 +00:00
<html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-22.6.3 docs-doc-page docs-doc-id-api/index" data-has-hydrated="false">
Deploy website - based on 7c3e51c22cbef937d4d01d32da8463095e0ca015
2022-06-28 11:21:17 +00:00
<head>
<meta charset="UTF-8">
deploy: 60699da691da3f6544c3fcdad68dcabdca35cd57
2024-04-11 12:01:20 +00:00
<meta name="generator" content="Docusaurus v3.2.1">
deploy: 1014abc087e8bc549697fbc688dd332af4ec6959
2023-11-29 13:34:30 +00:00
<title data-rh="true">API Reference | Puppeteer</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://pptr.dev/api/"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docsearch:counter" content="2"><meta data-rh="true" property="og:title" content="API Reference | Puppeteer"><meta data-rh="true" name="description" content="Classes"><meta data-rh="true" property="og:description" content="Classes"><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pptr.dev/api/"><link data-rh="true" rel="alternate" href="https://pptr.dev/api/" hreflang="en"><link data-rh="true" rel="alternate" href="https://pptr.dev/api/" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://DVKY664LG7-dsn.algolia.net" crossorigin="anonymous"><link rel="search" type="application/opensearchdescription+xml" title="Puppeteer" href="/opensearch.xml">
deploy: 29b948197d5222e900817f201cb29abc65027343
2023-01-11 15:09:01 +00:00
deploy: 60699da691da3f6544c3fcdad68dcabdca35cd57
2024-04-11 12:01:20 +00:00
<script src="/fix-location.js"></script><link rel="stylesheet" href="/assets/css/styles.76d942d0.css">
deploy: efc74a73666a4d4a948742117456da5b733c3874
2024-04-11 15:49:43 +00:00
<script src="/assets/js/runtime~main.620fd3db.js" defer="defer"></script>
<script src="/assets/js/main.eedc3260.js" defer="defer"></script>
Deploy website - based on 7c3e51c22cbef937d4d01d32da8463095e0ca015
2022-06-28 11:21:17 +00:00
</head>
<body class="navigation-with-keyboard">
deploy: a63b8305acfd79ff73a6a316fc2e819f41613766
2024-04-05 13:15:22 +00:00
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return localStorage.getItem("theme")}catch(t){}}();t(null!==e?e:"light")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="https://user-images.githubusercontent.com/10379601/29446482-04f7036a-841f-11e7-9872-91d1fc2ea683.png" alt="Puppeteer Logo" class="themedComponent_mlkZ themedComponent--light_NVdE"><img src="https://user-images.githubusercontent.com/10379601/29446482-04f7036a-841f-11e7-9872-91d1fc2ea683.png" alt="Puppeteer Logo" class="themedComponent_mlkZ themedComponent--dark_xIcU"></div><b class="navbar__title text--truncate">Puppeteer</b></a><a class="navbar__item navbar__link" href="/">Docs</a><a class="navbar__item navbar__link" href="/api/puppeteer.puppeteernode">Puppeteer API</a><a class="navbar__item navbar__link" href="/browsers-api/">@puppeteer/browsers API</a></div><div class="navbar__items navbar__items--right"><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a class="navbar__link" aria-haspopup="true" aria-expanded="false" role="button" href="/">22.6.3</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/next/api/">Next</a></li><li><a aria-current="page" class="dropdown__link dropdown__link--active" href="/api/">22.6.3</a></li><li><hr class="dropdown-separator"></li><li class="dropdown-archived-versions"><b>Archived versions</b></li><li><a href="https://github.com/puppeteer/puppeteer/blob/puppeteer-v22.6.2/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">22.6.2<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="https://github.com/puppeteer/puppeteer/blob/puppeteer-v22.6.1/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">22.6.1<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="https://github.com/puppeteer/puppeteer/blob/puppeteer-v22.6.0/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">22.6.0<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li><a href="https://github.com/puppeteer/puppeteer/blob/puppeteer-v22.5.0/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">22.5.0<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li>
deploy: 1014abc087e8bc549697fbc688dd332af4ec6959
2023-11-29 13:34:30 +00:00
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="classes">Classes<a href="#classes" class="hash-link" aria-label="Direct link to Classes" title="Direct link to Classes">​</a></h2>
deploy: bf1fd1e8287a835b2306d8b3260e753e83a496a6
2024-03-25 13:06:32 +00:00
<table><thead><tr><th><p>Class</p></th><th><p>Description</p></th></tr></thead><tbody><tr><td><p><a href="/api/puppeteer.accessibility">Accessibility</a></p></td><td><p>The Accessibility class provides methods for inspecting the browser&#x27;s accessibility tree. The accessibility tree is used by assistive technology such as <a href="https://en.wikipedia.org/wiki/Screen_reader" target="_blank" rel="noopener noreferrer">screen readers</a> or <a href="https://en.wikipedia.org/wiki/Switch_access" target="_blank" rel="noopener noreferrer">switches</a>.</p></td></tr><tr><td><p><a href="/api/puppeteer.browser">Browser</a></p></td><td><p><a href="/api/puppeteer.browser">Browser</a> represents a browser instance that is either:</p><ul>
<li>connected to via <a href="/api/puppeteer.puppeteer.connect">Puppeteer.connect()</a> or - launched by <a href="/api/puppeteer.puppeteernode.launch">PuppeteerNode.launch()</a>.</li>
</ul><p><a href="/api/puppeteer.browser">Browser</a> <a href="/api/puppeteer.eventemitter">emits</a> various events which are documented in the <a href="/api/puppeteer.browserevent">BrowserEvent</a> enum.</p></td></tr><tr><td><p><a href="/api/puppeteer.browsercontext">BrowserContext</a></p></td><td><p><a href="/api/puppeteer.browsercontext">BrowserContext</a> represents individual user contexts within a <a href="/api/puppeteer.browser">browser</a>.</p><p>When a <a href="/api/puppeteer.browser">browser</a> is launched, it has a single <a href="/api/puppeteer.browsercontext">browser context</a> by default. Others can be created using <a href="/api/puppeteer.browser.createbrowsercontext">Browser.createBrowserContext()</a>. Each context has isolated storage (cookies/localStorage/etc.)</p><p><a href="/api/puppeteer.browsercontext">BrowserContext</a> <a href="/api/puppeteer.eventemitter">emits</a> various events which are documented in the <a href="/api/puppeteer.browsercontextevent">BrowserContextEvent</a> enum.</p><p>If a <a href="/api/puppeteer.page">page</a> opens another <a href="/api/puppeteer.page">page</a>, e.g. using <code>window.open</code>, the popup will belong to the parent <a href="/api/puppeteer.page.browsercontext">page&#x27;s browser context</a>.</p></td></tr><tr><td><p><a href="/api/puppeteer.cdpsession">CDPSession</a></p></td><td><p>The <code>CDPSession</code> instances are used to talk raw Chrome Devtools Protocol.</p></td></tr><tr><td><p><a href="/api/puppeteer.connection">Connection</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.consolemessage">ConsoleMessage</a></p></td><td><p>ConsoleMessage objects are dispatched by page via the &#x27;console&#x27; event.</p></td></tr><tr><td><p><a href="/api/puppeteer.coverage">Coverage</a></p></td><td><p>The Coverage class provides methods to gather information about parts of JavaScript and CSS that were used by the page.</p></td></tr><tr><td><p><a href="/api/puppeteer.csscoverage">CSSCoverage</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.devicerequestprompt">DeviceRequestPrompt</a></p></td><td><p>Device request prompts let you respond to the page requesting for a device through an API like WebBluetooth.</p></td></tr><tr><td><p><a href="/api/puppeteer.devicerequestpromptdevice">DeviceRequestPromptDevice</a></p></td><td><p>Device in a request prompt.</p></td></tr><tr><td><p><a href="/api/puppeteer.dialog">Dialog</a></p></td><td><p>Dialog instances are dispatched by the <a href="/api/puppeteer.page">Page</a> via the <code>dialog</code> event.</p></td></tr><tr><td><p><a href="/api/puppeteer.elementhandle">ElementHandle</a></p></td><td><p>ElementHandle represents an in-page DOM element.</p></td></tr><tr><td><p><a href="/api/puppeteer.eventemitter">EventEmitter</a></p></td><td><p>The EventEmitter class that many Puppeteer classes extend.</p></td></tr><tr><td><p><a href="/api/puppeteer.filechooser">FileChooser</a></p></td><td><p>File choosers let you react to the page requesting for a file.</p></td></tr><tr><td><p><a href="/api/puppeteer.frame">Frame</a></p></td><td><p>Represents a DOM frame.</p><p>To understand frames, you can think of frames as <code>&lt;iframe&gt;</code> elements. Just like iframes, frames can be nested, and when JavaScript is executed in a frame, the JavaScript does not effect frames inside the ambient frame the JavaScript executes in.</p></td></tr><tr><td><p><a href="/api/puppeteer.httprequest">HTTPRequest</a></p></td><td><p>Represents an HTTP request sent by a page.</p></td></tr><tr><td><p><a href="/api/puppeteer.httpresponse">HTTPResponse</a></p></td><td><p>The HTTPResponse class represents responses which are received by the <a href="/api/puppeteer.page">Page</a> class.</p></td></tr><tr><td><p><a href="/api/puppeteer.jscoverage">JSCoverage</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.jshandle">JSHandle</a></p></td><td><p>Represents a reference to a JavaScript object. Instances can be created using <a href="/api/puppeteer.page.evaluatehandle">Page.evaluateHandle()</a>.</p><p>Handles prevent the referenced
deploy: 1014abc087e8bc549697fbc688dd332af4ec6959
2023-11-29 13:34:30 +00:00
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="enumerations">Enumerations<a href="#enumerations" class="hash-link" aria-label="Direct link to Enumerations" title="Direct link to Enumerations">​</a></h2>
deploy: bf1fd1e8287a835b2306d8b3260e753e83a496a6
2024-03-25 13:06:32 +00:00
<table><thead><tr><th><p>Enumeration</p></th><th><p>Description</p></th></tr></thead><tbody><tr><td><p><a href="/api/puppeteer.browsercontextevent">BrowserContextEvent</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.browserevent">BrowserEvent</a></p></td><td><p>All the events a <a href="/api/puppeteer.browser">browser instance</a> may emit.</p></td></tr><tr><td><p><a href="/api/puppeteer.interceptresolutionaction">InterceptResolutionAction</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.locatorevent">LocatorEvent</a></p></td><td><p>All the events that a locator instance may emit.</p></td></tr><tr><td><p><a href="/api/puppeteer.pageevent">PageEvent</a></p></td><td><p>All the events that a page instance may emit.</p></td></tr><tr><td><p><a href="/api/puppeteer.targettype">TargetType</a></p></td><td></td></tr></tbody></table>
deploy: 1014abc087e8bc549697fbc688dd332af4ec6959
2023-11-29 13:34:30 +00:00
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="functions">Functions<a href="#functions" class="hash-link" aria-label="Direct link to Functions" title="Direct link to Functions">​</a></h2>
deploy: a63b8305acfd79ff73a6a316fc2e819f41613766
2024-04-05 13:15:22 +00:00
<table><thead><tr><th><p>Function</p></th><th><p>Description</p></th></tr></thead><tbody><tr><td><p><a href="/api/puppeteer.clearcustomqueryhandlers">clearCustomQueryHandlers()</a></p></td><td><p><strong>Deprecated:</strong></p><p>Import <a href="/api/puppeteer.puppeteer">Puppeteer</a> and use the static method <a href="/api/puppeteer.puppeteer.clearcustomqueryhandlers">Puppeteer.clearCustomQueryHandlers()</a></p></td></tr><tr><td><p><a href="/api/puppeteer.connect">connect(options)</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.customqueryhandlernames">customQueryHandlerNames()</a></p></td><td><p><strong>Deprecated:</strong></p><p>Import <a href="/api/puppeteer.puppeteer">Puppeteer</a> and use the static method <a href="/api/puppeteer.puppeteer.customqueryhandlernames">Puppeteer.customQueryHandlerNames()</a></p></td></tr><tr><td><p><a href="/api/puppeteer.defaultargs">defaultArgs(options)</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.executablepath">executablePath(channel)</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.launch">launch(options)</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.registercustomqueryhandler">registerCustomQueryHandler(name, handler)</a></p></td><td><p><strong>Deprecated:</strong></p><p>Import <a href="/api/puppeteer.puppeteer">Puppeteer</a> and use the static method <a href="/api/puppeteer.puppeteer.registercustomqueryhandler">Puppeteer.registerCustomQueryHandler()</a></p></td></tr><tr><td><p><a href="/api/puppeteer.trimcache">trimCache()</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.unregistercustomqueryhandler">unregisterCustomQueryHandler(name)</a></p></td><td><p><strong>Deprecated:</strong></p><p>Import <a href="/api/puppeteer.puppeteer">Puppeteer</a> and use the static method <a href="/api/puppeteer.puppeteer.unregistercustomqueryhandler">Puppeteer.unregisterCustomQueryHandler()</a></p></td></tr></tbody></table>
deploy: 1014abc087e8bc549697fbc688dd332af4ec6959
2023-11-29 13:34:30 +00:00
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="interfaces">Interfaces<a href="#interfaces" class="hash-link" aria-label="Direct link to Interfaces" title="Direct link to Interfaces">​</a></h2>
deploy: bf1fd1e8287a835b2306d8b3260e753e83a496a6
2024-03-25 13:06:32 +00:00
<table><thead><tr><th><p>Interface</p></th><th><p>Description</p></th></tr></thead><tbody><tr><td><p><a href="/api/puppeteer.actionoptions">ActionOptions</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.autofilldata">AutofillData</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.boundingbox">BoundingBox</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.boxmodel">BoxModel</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.browserconnectoptions">BrowserConnectOptions</a></p></td><td><p>Generic browser options that can be passed when launching any browser or when connecting to an existing browser instance.</p></td></tr><tr><td><p><a href="/api/puppeteer.browsercontextevents">BrowserContextEvents</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.browsercontextoptions">BrowserContextOptions</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.browserevents">BrowserEvents</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.browserlaunchargumentoptions">BrowserLaunchArgumentOptions</a></p></td><td><p>Launcher options that only apply to Chrome.</p></td></tr><tr><td><p><a href="/api/puppeteer.cdpsessionevents">CDPSessionEvents</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.clickoptions">ClickOptions</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.commandoptions">CommandOptions</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.commoneventemitter">CommonEventEmitter</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.configuration">Configuration</a></p></td><td><p>Defines options to configure Puppeteer&#x27;s behavior during installation and runtime.</p><p>See individual properties for more information.</p></td></tr><tr><td><p><a href="/api/puppeteer.connectiontransport">ConnectionTransport</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.connectoptions">ConnectOptions</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.consolemessagelocation">ConsoleMessageLocation</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.continuerequestoverrides">ContinueRequestOverrides</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.cookie">Cookie</a></p></td><td><p>Represents a cookie object.</p></td></tr><tr><td><p><a href="/api/puppeteer.cookieparam">CookieParam</a></p></td><td><p>Cookie parameter object</p></td></tr><tr><td><p><a href="/api/puppeteer.coverageentry">CoverageEntry</a></p></td><td><p>The CoverageEntry class represents one entry of the coverage report.</p></td></tr><tr><td><p><a href="/api/puppeteer.credentials">Credentials</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.csscoverageoptions">CSSCoverageOptions</a></p></td><td><p>Set of configurable options for CSS coverage.</p></td></tr><tr><td><p><a href="/api/puppeteer.customqueryhandler">CustomQueryHandler</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.debuginfo">DebugInfo</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.deletecookiesrequest">DeleteCookiesRequest</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.device">Device</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.elementscreenshotoptions">ElementScreenshotOptions</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.frameaddscripttagoptions">FrameAddScriptTagOptions</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.frameaddstyletagoptions">FrameAddStyleTagOptions</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.frameevents">FrameEvents</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.framewaitforfunctionoptions">FrameWaitForFunctionOptions</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.geolocationoptions">GeolocationOptions</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.gotooptions">GoToOptions</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.interceptresolutionstate">InterceptResolutionState</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.internalnetworkconditions">InternalNetworkConditions</a></p></td><t
deploy: 1014abc087e8bc549697fbc688dd332af4ec6959
2023-11-29 13:34:30 +00:00
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="namespaces">Namespaces<a href="#namespaces" class="hash-link" aria-label="Direct link to Namespaces" title="Direct link to Namespaces">​</a></h2>
deploy: bf1fd1e8287a835b2306d8b3260e753e83a496a6
2024-03-25 13:06:32 +00:00
<table><thead><tr><th><p>Namespace</p></th><th><p>Description</p></th></tr></thead><tbody><tr><td><p><a href="/api/puppeteer.cdpsessionevent">CDPSessionEvent</a></p></td><td><p>Events that the CDPSession class emits.</p></td></tr></tbody></table>
deploy: 1014abc087e8bc549697fbc688dd332af4ec6959
2023-11-29 13:34:30 +00:00
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="variables">Variables<a href="#variables" class="hash-link" aria-label="Direct link to Variables" title="Direct link to Variables">​</a></h2>
deploy: bf1fd1e8287a835b2306d8b3260e753e83a496a6
2024-03-25 13:06:32 +00:00
<table><thead><tr><th><p>Variable</p></th><th><p>Description</p></th></tr></thead><tbody><tr><td><p><a href="/api/puppeteer.default_intercept_resolution_priority">DEFAULT_INTERCEPT_RESOLUTION_PRIORITY</a></p></td><td><p>The default cooperative request interception resolution priority</p></td></tr><tr><td><p><a href="/api/puppeteer.knowndevices">KnownDevices</a></p></td><td><p>A list of devices to be used with <a href="/api/puppeteer.page.emulate">Page.emulate()</a>.</p></td></tr><tr><td><p><a href="/api/puppeteer.mousebutton">MouseButton</a></p></td><td><p>Enum of valid mouse buttons.</p></td></tr><tr><td><p><a href="/api/puppeteer.predefinednetworkconditions">PredefinedNetworkConditions</a></p></td><td><p>A list of network conditions to be used with <a href="/api/puppeteer.page.emulatenetworkconditions">Page.emulateNetworkConditions()</a>.</p></td></tr><tr><td><p><a href="/api/puppeteer.puppeteer">puppeteer</a></p></td><td></td></tr></tbody></table>
deploy: 1014abc087e8bc549697fbc688dd332af4ec6959
2023-11-29 13:34:30 +00:00
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="type-aliases">Type Aliases<a href="#type-aliases" class="hash-link" aria-label="Direct link to Type Aliases" title="Direct link to Type Aliases">​</a></h2>
deploy: bf1fd1e8287a835b2306d8b3260e753e83a496a6
2024-03-25 13:06:32 +00:00
<table><thead><tr><th><p>Type Alias</p></th><th><p>Description</p></th></tr></thead><tbody><tr><td><p><a href="/api/puppeteer.actionresult">ActionResult</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.awaitable">Awaitable</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.awaitableiterable">AwaitableIterable</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.awaitablepredicate">AwaitablePredicate</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.awaitedlocator">AwaitedLocator</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.cdpevents">CDPEvents</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.chromereleasechannel">ChromeReleaseChannel</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.consolemessagetype">ConsoleMessageType</a></p></td><td><p>The supported types for console messages.</p></td></tr><tr><td><p><a href="/api/puppeteer.cookiepriority">CookiePriority</a></p></td><td><p>Represents the cookie&#x27;s &#x27;Priority&#x27; status: <a href="https://tools.ietf.org/html/draft-west-cookie-priority-00" target="_blank" rel="noopener noreferrer">https://tools.ietf.org/html/draft-west-cookie-priority-00</a></p></td></tr><tr><td><p><a href="/api/puppeteer.cookiesamesite">CookieSameSite</a></p></td><td><p>Represents the cookie&#x27;s &#x27;SameSite&#x27; status: <a href="https://tools.ietf.org/html/draft-west-first-party-cookies" target="_blank" rel="noopener noreferrer">https://tools.ietf.org/html/draft-west-first-party-cookies</a></p></td></tr><tr><td><p><a href="/api/puppeteer.cookiesourcescheme">CookieSourceScheme</a></p></td><td><p>Represents the source scheme of the origin that originally set the cookie. A value of &quot;Unset&quot; allows protocol clients to emulate legacy cookie scope for the scheme. This is a temporary ability and it will be removed in the future.</p></td></tr><tr><td><p><a href="/api/puppeteer.elementfor">ElementFor</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.errorcode">ErrorCode</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.evaluatefunc">EvaluateFunc</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.evaluatefuncwith">EvaluateFuncWith</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.eventswithwildcard">EventsWithWildcard</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.eventtype">EventType</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.experimentsconfiguration">ExperimentsConfiguration</a></p></td><td><p>Defines experiment options for Puppeteer.</p><p>See individual properties for more information.</p></td></tr><tr><td><p><a href="/api/puppeteer.flattenhandle">FlattenHandle</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.handlefor">HandleFor</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.handleor">HandleOr</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.handler">Handler</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.innerparams">InnerParams</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.keyinput">KeyInput</a></p></td><td><p>All the valid keys that can be passed to functions that take user input, such as <a href="/api/puppeteer.keyboard.press">keyboard.press</a></p></td></tr><tr><td><p><a href="/api/puppeteer.keypressoptions">KeyPressOptions</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.locatorclickoptions">LocatorClickOptions</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.lowercasepaperformat">LowerCasePaperFormat</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.mapper">Mapper</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.mousebutton">MouseButton</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.nodefor">NodeFor</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.paperformat">PaperFormat</a></p></td><td><p>All the valid paper format types when printing a PDF.</p></td></tr><tr><td><p><a href="/api/puppeteer.permission">Permission</a></p></td><td></td></tr><tr><td><p><a href="/api/puppeteer.predicate">P
Deploy website - based on 7c3e51c22cbef937d4d01d32da8463095e0ca015
2022-06-28 11:21:17 +00:00
</body>
</html>
Reference in New Issue Copy Permalink