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

fix: deprecate isIncognito (#11962)

Browse Source
This commit is contained in:
Alex Rudenko 2024-02-21 13:52:58 +01:00 committed by GitHub
parent 013bd0b12d
commit ceab7a9042
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/api/puppeteer.browsercontext.isincognito.md
View File

@ -4,6 +4,10 @@ sidebar_label: BrowserContext.isIncognito
# BrowserContext.isIncognito() method # BrowserContext.isIncognito() method
> Warning: This API is now obsolete.
>
> In Chrome, the [default browser context](./puppeteer.browser.defaultbrowsercontext.md) can also be "icognito" if configured via the arguments and in such cases this getter returns wrong results (see https://github.com/puppeteer/puppeteer/issues/8836). Also, the term "incognito" is not applicable to other browsers. To migrate, check the [default browser context](./puppeteer.browser.defaultbrowsercontext.md) instead: in Chrome all non-default contexts are incognito, and the default context might be incognito if you provide the `--incognito` argument when launching the browser.
Whether this [browser context](./puppeteer.browsercontext.md) is incognito. Whether this [browser context](./puppeteer.browsercontext.md) is incognito.
In Chrome, the [default browser context](./puppeteer.browser.defaultbrowsercontext.md) is the only non-incognito browser context. In Chrome, the [default browser context](./puppeteer.browser.defaultbrowsercontext.md) is the only non-incognito browser context.

11
packages/puppeteer-core/src/api/BrowserContext.ts
View File

@ -144,6 +144,17 @@ export abstract class BrowserContext extends EventEmitter<BrowserContextEvents>
* In Chrome, the * In Chrome, the
* {@link Browser.defaultBrowserContext | default browser context} is the only * {@link Browser.defaultBrowserContext | default browser context} is the only
* non-incognito browser context. * non-incognito browser context.
*
* @deprecated In Chrome, the
* {@link Browser.defaultBrowserContext | default browser context} can also be
* "icognito" if configured via the arguments and in such cases this getter
* returns wrong results (see
* https://github.com/puppeteer/puppeteer/issues/8836). Also, the term
* "incognito" is not applicable to other browsers. To migrate, check the
* {@link Browser.defaultBrowserContext | default browser context} instead: in
* Chrome all non-default contexts are incognito, and the default context
* might be incognito if you provide the `--incognito` argument when launching
* the browser.
*/ */
abstract isIncognito(): boolean; abstract isIncognito(): boolean;