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
296bb4f3b8
puppeteer/api/index.html
release-please[bot] 296bb4f3b8 deploy: 4815676f21
2023-04-24 11:40:02 +00:00

18 lines
55 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!doctype html>
<html lang="en" dir="ltr" class="docs-wrapper docs-doc-page docs-version-19.11.0 plugin-docs plugin-id-default docs-doc-id-api/index">
<head>
<meta charset="UTF-8">
<meta name="generator" content="Docusaurus v2.4.0">
<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" 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">
<script src="/fix-location.js"></script><link rel="stylesheet" href="/assets/css/styles.3077b280.css">
<link rel="preload" href="/assets/js/runtime~main.21739d7d.js" as="script">
<link rel="preload" href="/assets/js/main.db5a1e29.js" as="script">
</head>
<body class="navigation-with-keyboard">
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}return t}()||function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}()</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="themedImage_ToTc themedImage--light_HNdA"><img src="https://user-images.githubusercontent.com/10379601/29446482-04f7036a-841f-11e7-9872-91d1fc2ea683.png" alt="Puppeteer Logo" class="themedImage_ToTc themedImage--dark_i4oU"></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="/">19.11.0</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/">19.11.0</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-v19.10.1/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">19.10.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-v19.10.0/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">19.10.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-v19.9.1/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">19.9.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-v19.9.0/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">19.9.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-v19.8.5/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">19.8.5<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-v19.8.4/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">19.8.4<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-v19.8.3/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">19.8.3<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-v19.8.2/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">19.8.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-v19.8.1/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">19.8.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-v19.8.0/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">19.8.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-v19.7.5/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">19.7.5<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-v19.7.4/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">19.7.4<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-v19.7.3/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">19.7.3<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-v19.7.2/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">19.7.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-v19.7.1/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">19.7.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-v19.7.0/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">19.7.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-v19.6.3/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">19.6.3<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-v19.6.2/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">19.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-v19.6.1/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">19.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-v19.6.0/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">19.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-v19.5.2/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">19.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-v19.5.1/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">19.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-v19.5.0/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">19.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><li><a href="https://github.com/puppeteer/puppeteer/blob/puppeteer-v19.4.1/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">19.4.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-v19.4.0/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">19.4.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-v19.3.0/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">19.3.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/v19.2.2/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">19.2.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/v19.2.1/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">19.2.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/v19.2.0/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">19.2.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/v19.1.2/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">19.1.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/v19.1.1/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">19.1.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/v19.1.0/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">19.1.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/v19.0.0/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">19.0.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/v18.2.1/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">18.2.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/v18.2.0/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">18.2.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/v18.1.0/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">18.1.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-v18.0.5/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">18.0.5<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-v18.0.4/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">18.0.4<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-v18.0.3/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">18.0.3<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/v18.0.2/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">18.0.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/v18.0.1/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">18.0.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/v18.0.0/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">18.0.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-v17.1.3/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">17.1.3<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/v17.1.2/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">17.1.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/v17.1.1/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">17.1.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/v17.1.0/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">17.1.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/v17.0.0/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">17.0.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/v16.2.0/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">16.2.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/v16.1.1/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">16.1.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/v16.1.0/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">16.1.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/v16.0.0/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">16.0.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-v15.5.0/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">15.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><li><a href="https://github.com/puppeteer/puppeteer/blob/puppeteer-v15.4.2/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">15.4.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-v15.4.1/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">15.4.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-v15.4.0/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">15.4.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-v15.3.2/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">15.3.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-v15.3.1/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">15.3.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-v15.3.0/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">15.3.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></ul></div><a href="https://github.com/puppeteer/puppeteer" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link header-github-link" aria-label="GitHub repository"></a><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type="button" disabled="" title="Switch between dark and light mode (currently light mode)" aria-label="Switch between dark and light mode (currently light mode)" aria-live="polite"><svg viewBox="0 0 24 24" width="24" height="24" class="lightToggleIcon_pyhR"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" class="darkToggleIcon_wfgR"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg></button></div><div class="searchBox_ZlJk"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0 docsWrapper_BCFX"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docPage__5DB"><main class="docMainContainer_gTbr docMainContainerEnhanced_Uz_u"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="docItemContainer_Djhp"><article><span class="theme-doc-version-badge badge badge--secondary">Version: 19.11.0</span><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><h1>API Reference</h1><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><table><thead><tr><th>Class</th><th>Description</th></tr></thead><tbody><tr><td><a href="/api/puppeteer.aborterror">AbortError</a></td><td>AbortError is emitted whenever certain operations are terminated due to an abort request.</td></tr><tr><td><a href="/api/puppeteer.accessibility">Accessibility</a></td><td>The Accessibility class provides methods for inspecting Chromium&#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>.</td></tr><tr><td><a href="/api/puppeteer.browser">Browser</a></td><td>A Browser is created when Puppeteer connects to a Chromium instance, either through <a href="/api/puppeteer.puppeteernode.launch">PuppeteerNode.launch()</a> or <a href="/api/puppeteer.puppeteer.connect">Puppeteer.connect()</a>.</td></tr><tr><td><a href="/api/puppeteer.browsercontext">BrowserContext</a></td><td>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 <a href="/api/puppeteer.browser.newpage">Browser.newPage</a> creates a page in the default browser context.</td></tr><tr><td><a href="/api/puppeteer.browserfetcher">BrowserFetcher</a></td><td>BrowserFetcher can download and manage different versions of Chromium and Firefox.</td></tr><tr><td><a href="/api/puppeteer.cdpsession">CDPSession</a></td><td>The <code>CDPSession</code> instances are used to talk raw Chrome Devtools Protocol.</td></tr><tr><td><a href="/api/puppeteer.connection">Connection</a></td><td></td></tr><tr><td><a href="/api/puppeteer.consolemessage">ConsoleMessage</a></td><td>ConsoleMessage objects are dispatched by page via the &#x27;console&#x27; event.</td></tr><tr><td><a href="/api/puppeteer.coverage">Coverage</a></td><td>The Coverage class provides methods to gather information about parts of JavaScript and CSS that were used by the page.</td></tr><tr><td><a href="/api/puppeteer.csscoverage">CSSCoverage</a></td><td></td></tr><tr><td><a href="/api/puppeteer.customerror">CustomError</a></td><td></td></tr><tr><td><a href="/api/puppeteer.devicerequestprompt">DeviceRequestPrompt</a></td><td>Device request prompts let you respond to the page requesting for a device through an API like WebBluetooth.</td></tr><tr><td><a href="/api/puppeteer.devicerequestpromptdevice">DeviceRequestPromptDevice</a></td><td>Device in a request prompt.</td></tr><tr><td><a href="/api/puppeteer.dialog">Dialog</a></td><td>Dialog instances are dispatched by the <a href="/api/puppeteer.page">Page</a> via the <code>dialog</code> event.</td></tr><tr><td><a href="/api/puppeteer.elementhandle">ElementHandle</a></td><td>ElementHandle represents an in-page DOM element.</td></tr><tr><td><a href="/api/puppeteer.eventemitter">EventEmitter</a></td><td>The EventEmitter class that many Puppeteer classes extend.</td></tr><tr><td><a href="/api/puppeteer.filechooser">FileChooser</a></td><td>File choosers let you react to the page requesting for a file.</td></tr><tr><td><a href="/api/puppeteer.frame">Frame</a></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><a href="/api/puppeteer.httprequest">HTTPRequest</a></td><td>Represents an HTTP request sent by a page.</td></tr><tr><td><a href="/api/puppeteer.httpresponse">HTTPResponse</a></td><td>The HTTPResponse class represents responses which are received by the <a href="/api/puppeteer.page">Page</a> class.</td></tr><tr><td><a href="/api/puppeteer.jscoverage">JSCoverage</a></td><td></td></tr><tr><td><a href="/api/puppeteer.jshandle">JSHandle</a></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 JavaScript object from being garbage-collected unless the handle is purposely <a href="/api/puppeteer.jshandle.dispose">disposed</a>. JSHandles are auto-disposed when their associated frame is navigated away or the parent context gets destroyed.</p><p>Handles can be used as arguments for any evaluation function such as <a href="/api/puppeteer.page._eval">Page.$eval()</a>, <a href="/api/puppeteer.page.evaluate">Page.evaluate()</a>, and <a href="/api/puppeteer.page.evaluatehandle">Page.evaluateHandle()</a>. They are resolved to their referenced object.</p></td></tr><tr><td><a href="/api/puppeteer.keyboard">Keyboard</a></td><td>Keyboard provides an api for managing a virtual keyboard. The high level api is <a href="/api/puppeteer.keyboard.type">Keyboard.type()</a>, which takes raw characters and generates proper keydown, keypress/input, and keyup events on your page.</td></tr><tr><td><a href="/api/puppeteer.mouse">Mouse</a></td><td>The Mouse class operates in main-frame CSS pixels relative to the top-left corner of the viewport.</td></tr><tr><td><a href="/api/puppeteer.page">Page</a></td><td><p>Page provides methods to interact with a single tab or <a href="https://developer.chrome.com/extensions/background_pages" target="_blank" rel="noopener noreferrer">extension background page</a> in Chromium.</p><p>:::note</p><p>One Browser instance might have multiple Page instances.</p><p>:::</p></td></tr><tr><td><a href="/api/puppeteer.productlauncher">ProductLauncher</a></td><td>Describes a launcher - a class that is able to create and launch a browser instance.</td></tr><tr><td><a href="/api/puppeteer.protocolerror">ProtocolError</a></td><td>ProtocolError is emitted whenever there is an error from the protocol.</td></tr><tr><td><a href="/api/puppeteer.puppeteer">Puppeteer</a></td><td><p>The main Puppeteer class.</p><p>IMPORTANT: if you are using Puppeteer in a Node environment, you will get an instance of <a href="/api/puppeteer.puppeteernode">PuppeteerNode</a> when you import or require <code>puppeteer</code>. That class extends <code>Puppeteer</code>, so has all the methods documented below as well as all that are defined on <a href="/api/puppeteer.puppeteernode">PuppeteerNode</a>.</p></td></tr><tr><td><a href="/api/puppeteer.puppeteernode">PuppeteerNode</a></td><td><p>Extends the main <a href="/api/puppeteer.puppeteer">Puppeteer</a> class with Node specific behaviour for fetching and downloading browsers.</p><p>If you&#x27;re using Puppeteer in a Node environment, this is the class you&#x27;ll get when you run <code>require(&#x27;puppeteer&#x27;)</code> (or the equivalent ES <code>import</code>).</p></td></tr><tr><td><a href="/api/puppeteer.securitydetails">SecurityDetails</a></td><td>The SecurityDetails class represents the security details of a response that was received over a secure connection.</td></tr><tr><td><a href="/api/puppeteer.target">Target</a></td><td>Target represents a <a href="https://chromedevtools.github.io/devtools-protocol/tot/Target/" target="_blank" rel="noopener noreferrer">CDP target</a>. In CDP a target is something that can be debugged such a frame, a page or a worker.</td></tr><tr><td><a href="/api/puppeteer.timeouterror">TimeoutError</a></td><td>TimeoutError is emitted whenever certain operations are terminated due to timeout.</td></tr><tr><td><a href="/api/puppeteer.touchscreen">Touchscreen</a></td><td>The Touchscreen class exposes touchscreen events.</td></tr><tr><td><a href="/api/puppeteer.tracing">Tracing</a></td><td>The Tracing class exposes the tracing audit interface.</td></tr><tr><td><a href="/api/puppeteer.webworker">WebWorker</a></td><td>This class represents a <a href="https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API" target="_blank" rel="noopener noreferrer">WebWorker</a>.</td></tr></tbody></table><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><table><thead><tr><th>Enumeration</th><th>Description</th></tr></thead><tbody><tr><td><a href="/api/puppeteer.browsercontextemittedevents">BrowserContextEmittedEvents</a></td><td></td></tr><tr><td><a href="/api/puppeteer.browseremittedevents">BrowserEmittedEvents</a></td><td>All the events a <a href="/api/puppeteer.browser">browser instance</a> may emit.</td></tr><tr><td><a href="/api/puppeteer.interceptresolutionaction">InterceptResolutionAction</a></td><td></td></tr><tr><td><a href="/api/puppeteer.pageemittedevents">PageEmittedEvents</a></td><td>All the events that a page instance may emit.</td></tr></tbody></table><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><table><thead><tr><th>Function</th><th>Description</th></tr></thead><tbody><tr><td><a href="/api/puppeteer.clearcustomqueryhandlers">clearCustomQueryHandlers()</a></td><td></td></tr><tr><td><a href="/api/puppeteer.customqueryhandlernames">customQueryHandlerNames()</a></td><td></td></tr><tr><td><a href="/api/puppeteer.registercustomqueryhandler">registerCustomQueryHandler(name, handler)</a></td><td></td></tr><tr><td><a href="/api/puppeteer.unregistercustomqueryhandler">unregisterCustomQueryHandler(name)</a></td><td></td></tr></tbody></table><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><table><thead><tr><th>Interface</th><th>Description</th></tr></thead><tbody><tr><td><a href="/api/puppeteer.boundingbox">BoundingBox</a></td><td></td></tr><tr><td><a href="/api/puppeteer.boxmodel">BoxModel</a></td><td></td></tr><tr><td><a href="/api/puppeteer.browserconnectoptions">BrowserConnectOptions</a></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><a href="/api/puppeteer.browsercontextoptions">BrowserContextOptions</a></td><td>BrowserContext options.</td></tr><tr><td><a href="/api/puppeteer.browserfetcheroptions">BrowserFetcherOptions</a></td><td></td></tr><tr><td><a href="/api/puppeteer.browserfetcherrevisioninfo">BrowserFetcherRevisionInfo</a></td><td></td></tr><tr><td><a href="/api/puppeteer.browserlaunchargumentoptions">BrowserLaunchArgumentOptions</a></td><td>Launcher options that only apply to Chrome.</td></tr><tr><td><a href="/api/puppeteer.cdpsessiononmessageobject">CDPSessionOnMessageObject</a></td><td></td></tr><tr><td><a href="/api/puppeteer.clickoptions">ClickOptions</a></td><td></td></tr><tr><td><a href="/api/puppeteer.commoneventemitter">CommonEventEmitter</a></td><td></td></tr><tr><td><a href="/api/puppeteer.configuration">Configuration</a></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><a href="/api/puppeteer.connectiontransport">ConnectionTransport</a></td><td></td></tr><tr><td><a href="/api/puppeteer.connectoptions">ConnectOptions</a></td><td></td></tr><tr><td><a href="/api/puppeteer.consolemessagelocation">ConsoleMessageLocation</a></td><td></td></tr><tr><td><a href="/api/puppeteer.continuerequestoverrides">ContinueRequestOverrides</a></td><td></td></tr><tr><td><a href="/api/puppeteer.coverageentry">CoverageEntry</a></td><td>The CoverageEntry class represents one entry of the coverage report.</td></tr><tr><td><a href="/api/puppeteer.credentials">Credentials</a></td><td></td></tr><tr><td><a href="/api/puppeteer.csscoverageoptions">CSSCoverageOptions</a></td><td>Set of configurable options for CSS coverage.</td></tr><tr><td><a href="/api/puppeteer.customqueryhandler">CustomQueryHandler</a></td><td></td></tr><tr><td><a href="/api/puppeteer.device">Device</a></td><td></td></tr><tr><td><a href="/api/puppeteer.experimentsconfiguration">ExperimentsConfiguration</a></td><td><p>Defines experiment options for Puppeteer.</p><p>See individual properties for more information.</p></td></tr><tr><td><a href="/api/puppeteer.frameaddscripttagoptions">FrameAddScriptTagOptions</a></td><td></td></tr><tr><td><a href="/api/puppeteer.frameaddstyletagoptions">FrameAddStyleTagOptions</a></td><td></td></tr><tr><td><a href="/api/puppeteer.framewaitforfunctionoptions">FrameWaitForFunctionOptions</a></td><td></td></tr><tr><td><a href="/api/puppeteer.geolocationoptions">GeolocationOptions</a></td><td></td></tr><tr><td><a href="/api/puppeteer.interceptresolutionstate">InterceptResolutionState</a></td><td></td></tr><tr><td><a href="/api/puppeteer.internalnetworkconditions">InternalNetworkConditions</a></td><td></td></tr><tr><td><a href="/api/puppeteer.jscoverageentry">JSCoverageEntry</a></td><td>The CoverageEntry class for JavaScript</td></tr><tr><td><a href="/api/puppeteer.jscoverageoptions">JSCoverageOptions</a></td><td>Set of configurable options for JS coverage.</td></tr><tr><td><a href="/api/puppeteer.launchoptions">LaunchOptions</a></td><td>Generic launch options that can be passed when launching any browser.</td></tr><tr><td><a href="/api/puppeteer.mediafeature">MediaFeature</a></td><td></td></tr><tr><td><a href="/api/puppeteer.metrics">Metrics</a></td><td></td></tr><tr><td><a href="/api/puppeteer.mouseclickoptions">MouseClickOptions</a></td><td></td></tr><tr><td><a href="/api/puppeteer.mousemoveoptions">MouseMoveOptions</a></td><td></td></tr><tr><td><a href="/api/puppeteer.mouseoptions">MouseOptions</a></td><td></td></tr><tr><td><a href="/api/puppeteer.mousewheeloptions">MouseWheelOptions</a></td><td></td></tr><tr><td><a href="/api/puppeteer.networkconditions">NetworkConditions</a></td><td></td></tr><tr><td><a href="/api/puppeteer.offset">Offset</a></td><td></td></tr><tr><td><a href="/api/puppeteer.pageeventobject">PageEventObject</a></td><td><p>Denotes the objects received by callback functions for page events.</p><p>See <a href="/api/puppeteer.pageemittedevents">PageEmittedEvents</a> for more detail on the events and when they are emitted.</p></td></tr><tr><td><a href="/api/puppeteer.pdfmargin">PDFMargin</a></td><td></td></tr><tr><td><a href="/api/puppeteer.pdfoptions">PDFOptions</a></td><td>Valid options to configure PDF generation via <a href="/api/puppeteer.page.pdf">Page.pdf()</a>.</td></tr><tr><td><a href="/api/puppeteer.point">Point</a></td><td></td></tr><tr><td><a href="/api/puppeteer.pressoptions">PressOptions</a></td><td></td></tr><tr><td><a href="/api/puppeteer.puppeteererrors">PuppeteerErrors</a></td><td></td></tr><tr><td><a href="/api/puppeteer.puppeteerlaunchoptions">PuppeteerLaunchOptions</a></td><td></td></tr><tr><td><a href="/api/puppeteer.remoteaddress">RemoteAddress</a></td><td></td></tr><tr><td><a href="/api/puppeteer.responseforrequest">ResponseForRequest</a></td><td>Required response data to fulfill a request with.</td></tr><tr><td><a href="/api/puppeteer.screenshotclip">ScreenshotClip</a></td><td></td></tr><tr><td><a href="/api/puppeteer.screenshotoptions">ScreenshotOptions</a></td><td></td></tr><tr><td><a href="/api/puppeteer.serializedaxnode">SerializedAXNode</a></td><td>Represents a Node and the properties of it that are relevant to Accessibility.</td></tr><tr><td><a href="/api/puppeteer.snapshotoptions">SnapshotOptions</a></td><td></td></tr><tr><td><a href="/api/puppeteer.tracingoptions">TracingOptions</a></td><td></td></tr><tr><td><a href="/api/puppeteer.viewport">Viewport</a></td><td>Sets the viewport of the page.</td></tr><tr><td><a href="/api/puppeteer.waitforoptions">WaitForOptions</a></td><td></td></tr><tr><td><a href="/api/puppeteer.waitforselectoroptions">WaitForSelectorOptions</a></td><td></td></tr><tr><td><a href="/api/puppeteer.waitfortargetoptions">WaitForTargetOptions</a></td><td></td></tr><tr><td><a href="/api/puppeteer.waittimeoutoptions">WaitTimeoutOptions</a></td><td></td></tr></tbody></table><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><table><thead><tr><th>Variable</th><th>Description</th></tr></thead><tbody><tr><td><a href="/api/puppeteer.connect">connect</a></td><td></td></tr><tr><td><a href="/api/puppeteer.createbrowserfetcher">createBrowserFetcher</a></td><td></td></tr><tr><td><a href="/api/puppeteer.default_intercept_resolution_priority">DEFAULT_INTERCEPT_RESOLUTION_PRIORITY</a></td><td>The default cooperative request interception resolution priority</td></tr><tr><td><a href="/api/puppeteer.defaultargs">defaultArgs</a></td><td></td></tr><tr><td><a href="/api/puppeteer.devices">devices</a></td><td></td></tr><tr><td><a href="/api/puppeteer.errors">errors</a></td><td></td></tr><tr><td><a href="/api/puppeteer.evaluation_script_url">EVALUATION_SCRIPT_URL</a></td><td></td></tr><tr><td><a href="/api/puppeteer.executablepath">executablePath</a></td><td></td></tr><tr><td><a href="/api/puppeteer.knowndevices">KnownDevices</a></td><td>A list of devices to be used with <a href="/api/puppeteer.page.emulate">Page.emulate()</a>.</td></tr><tr><td><a href="/api/puppeteer.launch">launch</a></td><td></td></tr><tr><td><a href="/api/puppeteer.mousebutton">MouseButton</a></td><td>Enum of valid mouse buttons.</td></tr><tr><td><a href="/api/puppeteer.networkconditions">networkConditions</a></td><td></td></tr><tr><td><a href="/api/puppeteer.predefinednetworkconditions">PredefinedNetworkConditions</a></td><td>A list of network conditions to be used with <a href="/api/puppeteer.page.emulatenetworkconditions">Page.emulateNetworkConditions()</a>.</td></tr><tr><td><a href="/api/puppeteer.puppeteer">puppeteer</a></td><td></td></tr></tbody></table><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><table><thead><tr><th>Type Alias</th><th>Description</th></tr></thead><tbody><tr><td><a href="/api/puppeteer.actionresult">ActionResult</a></td><td></td></tr><tr><td><a href="/api/puppeteer.awaitable">Awaitable</a></td><td></td></tr><tr><td><a href="/api/puppeteer.awaitableiterable">AwaitableIterable</a></td><td></td></tr><tr><td><a href="/api/puppeteer.chromereleasechannel">ChromeReleaseChannel</a></td><td></td></tr><tr><td><a href="/api/puppeteer.consolemessagetype">ConsoleMessageType</a></td><td>The supported types for console messages.</td></tr><tr><td><a href="/api/puppeteer.elementfor">ElementFor</a></td><td></td></tr><tr><td><a href="/api/puppeteer.errorcode">ErrorCode</a></td><td></td></tr><tr><td><a href="/api/puppeteer.evaluatefunc">EvaluateFunc</a></td><td></td></tr><tr><td><a href="/api/puppeteer.evaluatefuncwith">EvaluateFuncWith</a></td><td></td></tr><tr><td><a href="/api/puppeteer.eventtype">EventType</a></td><td></td></tr><tr><td><a href="/api/puppeteer.flattenhandle">FlattenHandle</a></td><td></td></tr><tr><td><a href="/api/puppeteer.handlefor">HandleFor</a></td><td></td></tr><tr><td><a href="/api/puppeteer.handleor">HandleOr</a></td><td></td></tr><tr><td><a href="/api/puppeteer.handler">Handler</a></td><td></td></tr><tr><td><a href="/api/puppeteer.innerparams">InnerParams</a></td><td></td></tr><tr><td><a href="/api/puppeteer.interceptresolutionstrategy">InterceptResolutionStrategy</a></td><td></td></tr><tr><td><a href="/api/puppeteer.keyinput">KeyInput</a></td><td>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></td></tr><tr><td><a href="/api/puppeteer.lowercasepaperformat">LowerCasePaperFormat</a></td><td></td></tr><tr><td><a href="/api/puppeteer.mousebutton">MouseButton</a></td><td></td></tr><tr><td><a href="/api/puppeteer.nodefor">NodeFor</a></td><td></td></tr><tr><td><a href="/api/puppeteer.paperformat">PaperFormat</a></td><td>All the valid paper format types when printing a PDF.</td></tr><tr><td><a href="/api/puppeteer.permission">Permission</a></td><td></td></tr><tr><td><a href="/api/puppeteer.platform">Platform</a></td><td>Supported platforms.</td></tr><tr><td><a href="/api/puppeteer.product">Product</a></td><td>Supported products.</td></tr><tr><td><a href="/api/puppeteer.protocollifecycleevent">ProtocolLifeCycleEvent</a></td><td></td></tr><tr><td><a href="/api/puppeteer.puppeteerlifecycleevent">PuppeteerLifeCycleEvent</a></td><td></td></tr><tr><td><a href="/api/puppeteer.puppeteernodelaunchoptions">PuppeteerNodeLaunchOptions</a></td><td>Utility type exposed to enable users to define options that can be passed to <code>puppeteer.launch</code> without having to list the set of all types.</td></tr><tr><td><a href="/api/puppeteer.resourcetype">ResourceType</a></td><td>Resource types for HTTPRequests as perceived by the rendering engine.</td></tr><tr><td><a href="/api/puppeteer.targetfiltercallback">TargetFilterCallback</a></td><td></td></tr></tbody></table></div></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages navigation"></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#classes" class="table-of-contents__link toc-highlight">Classes</a></li><li><a href="#enumerations" class="table-of-contents__link toc-highlight">Enumerations</a></li><li><a href="#functions" class="table-of-contents__link toc-highlight">Functions</a></li><li><a href="#interfaces" class="table-of-contents__link toc-highlight">Interfaces</a></li><li><a href="#variables" class="table-of-contents__link toc-highlight">Variables</a></li><li><a href="#type-aliases" class="table-of-contents__link toc-highlight">Type Aliases</a></li></ul></div></div></div></div></main></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://stackoverflow.com/questions/tagged/puppeteer" target="_blank" rel="noopener noreferrer" class="footer__link-item">Stack Overflow<svg width="13.5" height="13.5" 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 class="footer__item"><a href="https://twitter.com/chromedevtools" target="_blank" rel="noopener noreferrer" class="footer__link-item">Twitter<svg width="13.5" height="13.5" 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 class="footer__item"><a href="https://goo.gle/devtools-youtube" target="_blank" rel="noopener noreferrer" class="footer__link-item">YouTube<svg width="13.5" height="13.5" 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></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2023 Google, Inc.</div></div></div></footer></div>
<script src="/assets/js/runtime~main.21739d7d.js"></script>
<script src="/assets/js/main.db5a1e29.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink