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
1ea85bb67e
puppeteer/next/api/puppeteer.browsercontext/index.html

31 lines
89 KiB
HTML
Raw Normal View History

Deploy website - based on 01c76b7eb1f62c9467695c6825fe32da757848d3
2022-07-01 15:15:07 +00:00
<!doctype html>
deploy: 1014abc087e8bc549697fbc688dd332af4ec6959
2023-11-29 13:34:30 +00:00
<html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-api/puppeteer.browsercontext" data-has-hydrated="false">
Deploy website - based on 01c76b7eb1f62c9467695c6825fe32da757848d3
2022-07-01 15:15:07 +00:00
<head>
<meta charset="UTF-8">
deploy: cde1efb962aad48a198c71d58f9471431df8976d
2024-05-06 08:01:08 +00:00
<meta name="generator" content="Docusaurus v3.3.2">
deploy: 46a3ef2681456d604e775f578fa447a094200610
2024-02-05 09:48:28 +00:00
<title data-rh="true">BrowserContext class | 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/next/api/puppeteer.browsercontext"><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="3"><meta data-rh="true" property="og:title" content="BrowserContext class | Puppeteer"><meta data-rh="true" name="description" content="BrowserContext represents individual user contexts within a browser."><meta data-rh="true" property="og:description" content="BrowserContext represents individual user contexts within a browser."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pptr.dev/next/api/puppeteer.browsercontext"><link data-rh="true" rel="alternate" href="https://pptr.dev/next/api/puppeteer.browsercontext" hreflang="en"><link data-rh="true" rel="alternate" href="https://pptr.dev/next/api/puppeteer.browsercontext" 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: cde1efb962aad48a198c71d58f9471431df8976d
2024-05-06 08:01:08 +00:00
<script src="/fix-location.js"></script><link rel="stylesheet" href="/assets/css/styles.67634aff.css">
deploy: 3c8f0e8dd73b564194bdb57e5511bfcb1054a4af
2024-05-16 05:06:51 +00:00
<script src="/assets/js/runtime~main.281c450d.js" defer="defer"></script>
<script src="/assets/js/main.aa9d625f.js" defer="defer"></script>
Deploy website - based on 01c76b7eb1f62c9467695c6825fe32da757848d3
2022-07-01 15:15:07 +00:00
</head>
<body class="navigation-with-keyboard">
deploy: 598b2a94bd2311eacaef63059d829fcf31ce914f
2024-05-15 06:17:32 +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_gu5v" 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="/next/category/introduction">Docs</a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/next/api/puppeteer.puppeteernode">Puppeteer API</a><a class="navbar__item navbar__link" href="/next/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="/next/">Next</a><ul class="dropdown__menu"><li><a aria-current="page" class="dropdown__link dropdown__link--active" href="/next/api/puppeteer.browsercontext">Next</a></li><li><a class="dropdown__link" href="/api/puppeteer.browsercontext">22.8.2</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.8.1/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">22.8.1<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_T11m"><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.8.0/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">22.8.0<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_T11m"><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.7.1/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">22.7.1<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_T11m"><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.7.0/docs/api/index.md" target="_blank" rel="noopener noreferrer" class="dropdown__link">22.7.0<svg width="12" height="12" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_T11m"><path fill="currentColor" d="M21 13
deploy: 46a3ef2681456d604e775f578fa447a094200610
2024-02-05 09:48:28 +00:00
<p><a href="/next/api/puppeteer.browsercontext">BrowserContext</a> represents individual user contexts within a <a href="/next/api/puppeteer.browser">browser</a>.</p>
<p>When a <a href="/next/api/puppeteer.browser">browser</a> is launched, it has a single <a href="/next/api/puppeteer.browsercontext">browser context</a> by default. Others can be created using <a href="/next/api/puppeteer.browser.createbrowsercontext">Browser.createBrowserContext()</a>. Each context has isolated storage (cookies/localStorage/etc.)</p>
deploy: 1014abc087e8bc549697fbc688dd332af4ec6959
2023-11-29 13:34:30 +00:00
<p><a href="/next/api/puppeteer.browsercontext">BrowserContext</a> <a href="/next/api/puppeteer.eventemitter">emits</a> various events which are documented in the <a href="/next/api/puppeteer.browsercontextevent">BrowserContextEvent</a> enum.</p>
<p>If a <a href="/next/api/puppeteer.page">page</a> opens another <a href="/next/api/puppeteer.page">page</a>, e.g. using <code>window.open</code>, the popup will belong to the parent <a href="/next/api/puppeteer.page.browsercontext">page&#x27;s browser context</a>.</p>
deploy: cde1efb962aad48a198c71d58f9471431df8976d
2024-05-06 08:01:08 +00:00
<h4 class="anchor anchorWithStickyNavbar_FNw8" 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_aalF theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_MHx8"><pre tabindex="0" class="prism-code language-typescript codeBlock_zHgq thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_RjmQ"><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">abstract</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">class</span><span class="token plain"> </span><span class="token class-name">BrowserContext</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">extends</span><span class="token plain"> </span><span class="token class-name">EventEmitter</span><span class="token class-name operator" style="color:#393A34">&lt;</span><span class="token class-name">BrowserContextEvents</span><span class="token class-name operator" style="color:#393A34">&gt;</span><br></span></code></pre><div class="buttonGroup_Sd8_"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_LnQD" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_t3l1"><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_IiZV"><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>
deploy: 1014abc087e8bc549697fbc688dd332af4ec6959
2023-11-29 13:34:30 +00:00
<p><strong>Extends:</strong> <a href="/next/api/puppeteer.eventemitter">EventEmitter</a>&lt;<a href="/next/api/puppeteer.browsercontextevents">BrowserContextEvents</a>&gt;</p>
deploy: cde1efb962aad48a198c71d58f9471431df8976d
2024-05-06 08:01:08 +00:00
<h2 class="anchor anchorWithStickyNavbar_FNw8" id="remarks">Remarks<a href="#remarks" class="hash-link" aria-label="Direct link to Remarks" title="Direct link to Remarks">​</a></h2>
deploy: 1014abc087e8bc549697fbc688dd332af4ec6959
2023-11-29 13:34:30 +00:00
<p>The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the <code>BrowserContext</code> class.</p>
deploy: cde1efb962aad48a198c71d58f9471431df8976d
2024-05-06 08:01:08 +00:00
<h2 class="anchor anchorWithStickyNavbar_FNw8" id="example">Example<a href="#example" class="hash-link" aria-label="Direct link to Example" title="Direct link to Example">​</a></h2>
deploy: 46a3ef2681456d604e775f578fa447a094200610
2024-02-05 09:48:28 +00:00
<p>Creating a new <a href="/next/api/puppeteer.browsercontext">browser context</a>:</p>
deploy: cde1efb962aad48a198c71d58f9471431df8976d
2024-05-06 08:01:08 +00:00
<div class="language-ts codeBlockContainer_aalF theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_MHx8"><pre tabindex="0" class="prism-code language-ts codeBlock_zHgq thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_RjmQ"><span class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Create a new browser context</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">const</span><span class="token plain"> context </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">await</span><span class="token plain"> browser</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">createBrowserContext</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// Create a new page inside context.</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">const</span><span class="token plain"> page </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">await</span><span class="token plain"> context</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">newPage</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// ... do stuff with page ...</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">await</span><span class="token plain"> page</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">goto</span><span class="token punctuation" style="color:#393A34">(</span><span class="token string" style="color:#e3116c">&#x27;https://example.com&#x27;</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// Dispose context once it&#x27;s no longer needed.</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">await</span><span class="token plain"> context</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">close</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><br></span></code></pre><div class="buttonGroup_Sd8_"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_LnQD" aria-hidden="true"><svg viewBox="0 0 24 24" class="copyButtonIcon_t3l1"><path fill="
<h2 class="anchor anchorWithStickyNavbar_FNw8" id="properties">Properties<a href="#properties" class="hash-link" aria-label="Direct link to Properties" title="Direct link to Properties">​</a></h2>
deploy: 60699da691da3f6544c3fcdad68dcabdca35cd57
2024-04-11 12:01:20 +00:00
<table><thead><tr><th><p>Property</p></th><th><p>Modifiers</p></th><th><p>Type</p></th><th><p>Description</p></th></tr></thead><tbody><tr><td><span id="closed">closed</span></td><td><p><code>readonly</code></p></td><td><p>boolean</p></td><td><p>Whether this <a href="/next/api/puppeteer.browsercontext">browser context</a> is closed.</p></td></tr><tr><td><span id="id">id</span></td><td><p><code>readonly</code></p></td><td><p>string | undefined</p></td><td><p>Identifier for this <a href="/next/api/puppeteer.browsercontext">browser context</a>.</p></td></tr></tbody></table>
deploy: cde1efb962aad48a198c71d58f9471431df8976d
2024-05-06 08:01:08 +00:00
<h2 class="anchor anchorWithStickyNavbar_FNw8" id="methods">Methods<a href="#methods" class="hash-link" aria-label="Direct link to Methods" title="Direct link to Methods">​</a></h2>
<table><thead><tr><th><p>Method</p></th><th><p>Modifiers</p></th><th><p>Description</p></th></tr></thead><tbody><tr><td><span id="browser"><a href="/next/api/puppeteer.browsercontext.browser">browser()</a></span></td><td></td><td><p>Gets the <a href="/next/api/puppeteer.browser">browser</a> associated with this <a href="/next/api/puppeteer.browsercontext">browser context</a>.</p></td></tr><tr><td><span id="clearpermissionoverrides"><a href="/next/api/puppeteer.browsercontext.clearpermissionoverrides">clearPermissionOverrides()</a></span></td><td></td><td><p>Clears all permission overrides for this <a href="/next/api/puppeteer.browsercontext">browser context</a>.</p></td></tr><tr><td><span id="close"><a href="/next/api/puppeteer.browsercontext.close">close()</a></span></td><td></td><td><p>Closes this <a href="/next/api/puppeteer.browsercontext">browser context</a> and all associated <a href="/next/api/puppeteer.page">pages</a>.</p><p><strong>Remarks:</strong></p><p>The <a href="/next/api/puppeteer.browser.defaultbrowsercontext">default browser context</a> cannot be closed.</p></td></tr><tr><td><span id="isincognito"><a href="/next/api/puppeteer.browsercontext.isincognito">isIncognito()</a></span></td><td><p><code>deprecated</code></p></td><td><p>Whether this <a href="/next/api/puppeteer.browsercontext">browser context</a> is incognito.</p><p>In Chrome, the <a href="/next/api/puppeteer.browser.defaultbrowsercontext">default browser context</a> is the only non-incognito browser context.</p><p><strong>Deprecated:</strong></p><p>In Chrome, the <a href="/next/api/puppeteer.browser.defaultbrowsercontext">default browser context</a> can also be &quot;incognito&quot; if configured via the arguments and in such cases this getter returns wrong results (see <a href="https://github.com/puppeteer/puppeteer/issues/8836" target="_blank" rel="noopener noreferrer">https://github.com/puppeteer/puppeteer/issues/8836</a>). Also, the term &quot;incognito&quot; is not applicable to other browsers. To migrate, check the <a href="/next/api/puppeteer.browser.defaultbrowsercontext">default browser context</a> instead: in Chrome all non-default contexts are incognito, and the default context might be incognito if you provide the <code>--incognito</code> argument when launching the browser.</p></td></tr><tr><td><span id="newpage"><a href="/next/api/puppeteer.browsercontext.newpage">newPage()</a></span></td><td></td><td><p>Creates a new <a href="/next/api/puppeteer.page">page</a> in this <a href="/next/api/puppeteer.browsercontext">browser context</a>.</p></td></tr><tr><td><span id="overridepermissions"><a href="/next/api/puppeteer.browsercontext.overridepermissions">overridePermissions(origin, permissions)</a></span></td><td></td><td><p>Grants this <a href="/next/api/puppeteer.browsercontext">browser context</a> the given <code>permissions</code> within the given <code>origin</code>.</p></td></tr><tr><td><span id="pages"><a href="/next/api/puppeteer.browsercontext.pages">pages()</a></span></td><td></td><td><p>Gets a list of all open <a href="/next/api/puppeteer.page">pages</a> inside this <a href="/next/api/puppeteer.browsercontext">browser context</a>.</p><p><strong>Remarks:</strong></p><p>Non-visible <a href="/next/api/puppeteer.page">pages</a>, such as <code>&quot;background_page&quot;</code>, will not be listed here. You can find them using <a href="/next/api/puppeteer.target.page">Target.page()</a>.</p></td></tr><tr><td><span id="targets"><a href="/next/api/puppeteer.browsercontext.targets">targets()</a></span></td><td></td><td><p>Gets all active <a href="/next/api/puppeteer.target">targets</a> inside this <a href="/next/api/puppeteer.browsercontext">browser context</a>.</p></td></tr><tr><td><span id="waitfortarget"><a href="/next/api/puppeteer.browsercontext.waitfortarget">waitForTarget(predicate, options)</a></span></td><td></td><td><p>Waits until a <a href="/next/api/puppeteer.target">target</a> matching the given <code>predicate</code> appears and returns it.</p><p>This will look all open <a href="/next/api/puppeteer.browsercontext">browse
Deploy website - based on 01c76b7eb1f62c9467695c6825fe32da757848d3
2022-07-01 15:15:07 +00:00
</body>
</html>
Reference in New Issue Copy Permalink