puppeteer/api/puppeteer.pageevent/index.html

20 lines
98 KiB
HTML
Raw Normal View History

<!doctype html>
<html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-21.6.1 docs-doc-page docs-doc-id-api/puppeteer.pageevent" data-has-hydrated="false">
<head>
<meta charset="UTF-8">
<meta name="generator" content="Docusaurus v3.0.0">
<title data-rh="true">PageEvent enum | 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/puppeteer.pageevent"><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="PageEvent enum | Puppeteer"><meta data-rh="true" name="description" content="All the events that a page instance may emit."><meta data-rh="true" property="og:description" content="All the events that a page instance may emit."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pptr.dev/api/puppeteer.pageevent"><link data-rh="true" rel="alternate" href="https://pptr.dev/api/puppeteer.pageevent" hreflang="en"><link data-rh="true" rel="alternate" href="https://pptr.dev/api/puppeteer.pageevent" 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">
<script src="/fix-location.js"></script><link rel="stylesheet" href="/assets/css/styles.c5c7e4fc.css">
<script src="/assets/js/runtime~main.09103481.js" defer="defer"></script>
<script src="/assets/js/main.b132352e.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
<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 aria-current="page" class="navbar__item navbar__link navbar__link--active" 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="/">21.6.1</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/next/api/puppeteer.pageevent">Next</a></li><li><a aria-current="page" class="dropdown__link dropdown__link--active" href="/api/puppeteer.pageevent">21.6.1</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-v21.6.0/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">21.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-v21.5.2/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">21.5.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-v21.5.1/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">21.5.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-v21.5.0/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">21.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.0
<p>All the events that a page instance may emit.</p>
<h4 class="anchor anchorWithStickyNavbar_LWe7" id="signature">Signature:<a href="#signature" class="hash-link" aria-label="Direct link to Signature:" title="Direct link to Signature:"></a></h4>
<div class="language-typescript codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-typescript codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">export</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">declare</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">const</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">enum</span><span class="token plain"> PageEvent</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_y97N"><path fill="currentColor" d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg viewBox="0 0 24 24" class="copyButtonSuccessIcon_LjdS"><path fill="currentColor" d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div>
<h2 class="anchor anchorWithStickyNavbar_LWe7" id="enumeration-members">Enumeration Members<a href="#enumeration-members" class="hash-link" aria-label="Direct link to Enumeration Members" title="Direct link to Enumeration Members"></a></h2>
<table><thead><tr><th>Member</th><th>Value</th><th>Description</th></tr></thead><tbody><tr><td>Close</td><td><code>&quot;close&quot;</code></td><td>Emitted when the page closes.</td></tr><tr><td>Console</td><td><code>&quot;console&quot;</code></td><td>Emitted when JavaScript within the page calls one of console API methods, e.g. <code>console.log</code> or <code>console.dir</code>. Also emitted if the page throws an error or a warning.</td></tr><tr><td>Dialog</td><td><code>&quot;dialog&quot;</code></td><td>Emitted when a JavaScript dialog appears, such as <code>alert</code>, <code>prompt</code>, <code>confirm</code> or <code>beforeunload</code>. Puppeteer can respond to the dialog via <a href="/api/puppeteer.dialog.accept">Dialog.accept()</a> or <a href="/api/puppeteer.dialog.dismiss">Dialog.dismiss()</a>.</td></tr><tr><td>DOMContentLoaded</td><td><code>&quot;domcontentloaded&quot;</code></td><td>Emitted when the JavaScript <a href="https://developer.mozilla.org/en-US/docs/Web/Events/DOMContentLoaded" target="_blank" rel="noopener noreferrer">DOMContentLoaded</a> event is dispatched.</td></tr><tr><td>Error</td><td><code>&quot;error&quot;</code></td><td>Emitted when the page crashes. Will contain an <code>Error</code>.</td></tr><tr><td>FrameAttached</td><td><code>&quot;frameattached&quot;</code></td><td>Emitted when a frame is attached. Will contain a <a href="/api/puppeteer.frame">Frame</a>.</td></tr><tr><td>FrameDetached</td><td><code>&quot;framedetached&quot;</code></td><td>Emitted when a frame is detached. Will contain a <a href="/api/puppeteer.frame">Frame</a>.</td></tr><tr><td>FrameNavigated</td><td><code>&quot;framenavigated&quot;</code></td><td>Emitted when a frame is navigated to a new URL. Will contain a <a href="/api/puppeteer.frame">Frame</a>.</td></tr><tr><td>Load</td><td><code>&quot;load&quot;</code></td><td>Emitted when the JavaScript <a href="https://developer.mozilla.org/en-US/docs/Web/Events/load" target="_blank" rel="noopener noreferrer">load</a> event is dispatched.</td></tr><tr><td>Metrics</td><td><code>&quot;metrics&quot;</code></td><td>Emitted when the JavaScript code makes a call to <code>console.timeStamp</code>. For the list of metrics see <a href="/api/puppeteer.page.metrics">page.metrics</a>.</td></tr><tr><td>PageError</td><td><code>&quot;pageerror&quot;</code></td><td>Emitted when an uncaught exception happens within the page. Contains an <code>Error</code>.</td></tr><tr><td>Popup</td><td><code>&quot;popup&quot;</code></td><td><p>Emitted when the page opens a new tab or window.</p><p>Contains a <a href="/api/puppeteer.page">Page</a> corresponding to the popup window.</p></td></tr><tr><td>Request</td><td><code>&quot;request&quot;</code></td><td>Emitted when a page issues a request and contains a <a href="/api/puppeteer.httprequest">HTTPRequest</a>.</td></tr><tr><td>RequestFailed</td><td><code>&quot;requestfailed&quot;</code></td><td><p>Emitted when a request fails, for example by timing out.</p><p>Contains a <a href="/api/puppeteer.httprequest">HTTPRequest</a>.</p></td></tr><tr><td>RequestFinished</td><td><code>&quot;requestfinished&quot;</code></td><td>Emitted when a request finishes successfully. Contains a <a href="/api/puppeteer.httprequest">HTTPRequest</a>.</td></tr><tr><td>RequestServedFromCache</td><td><code>&quot;requestservedfromcache&quot;</code></td><td>Emitted when a request ended up loading from cache. Contains a <a href="/api/puppeteer.httprequest">HTTPRequest</a>.</td></tr><tr><td>Response</td><td><code>&quot;response&quot;</code></td><td>Emitted when a response is received. Contains a <a href="/api/puppeteer.httpresponse">HTTPResponse</a>.</td></tr><tr><td>WorkerCreated</td><td><code>&quot;workercreated&quot;</code></td><td>Emitted when a dedicated <a href="https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API" target="_blank" rel="noopener noreferrer">WebWorker</a> is spawned by the page.</td></tr><tr><td>WorkerDestroyed</td><td><code>&quot;workerdestroyed&quot;</code></td><td>Emitted when a dedicated <a href="https://developer.mozilla.org/en-US/docs/Web/API/Web_Wor
</body>
</html>