kyfx
/
playwright
mirror of https://github.com/microsoft/playwright.git
4
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: clarify that userDataDir cannot be used concurrently (#35228)

This commit is contained in:
Dmitry Gozman 2025-03-17 11:11:45 +00:00 committed by GitHub
parent 36c55d8be0
commit accd7c6c9e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 22 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/src/api/class-browsertype.md
View File

@ -324,11 +324,13 @@ this context will automatically close the browser.
* since: v1.8
- `userDataDir` <[path]>
Path to a User Data Directory, which stores browser session data like cookies and local storage. More details for
Path to a User Data Directory, which stores browser session data like cookies and local storage. Pass an empty string to create a temporary directory.
More details for
[Chromium](https://chromium.googlesource.com/chromium/src/+/master/docs/user_data_dir.md#introduction) and
[Firefox](https://wiki.mozilla.org/Firefox/CommandLineOptions#User_profile).
Note that Chromium's user data directory is the **parent** directory of the "Profile Path" seen at `chrome://version`. Pass an empty string to
use a temporary directory instead.
[Firefox](https://wiki.mozilla.org/Firefox/CommandLineOptions#User_profile). Chromium's user data directory is the **parent** directory of the "Profile Path" seen at `chrome://version`.
Note that browsers do not allow launching multiple instances with the same User Data Directory.
### option: BrowserType.launchPersistentContext.-inline- = %%-shared-browser-options-list-v1.8-%%
* since: v1.8

12
packages/playwright-client/types/types.d.ts vendored
View File

@ -14710,11 +14710,15 @@ export interface BrowserType<Unused = {}> {
* Launches browser that uses persistent storage located at
* [`userDataDir`](https://playwright.dev/docs/api/class-browsertype#browser-type-launch-persistent-context-option-user-data-dir)
* and returns the only context. Closing this context will automatically close the browser.
* @param userDataDir Path to a User Data Directory, which stores browser session data like cookies and local storage. More details for
* @param userDataDir Path to a User Data Directory, which stores browser session data like cookies and local storage. Pass an empty
* string to create a temporary directory.
*
* More details for
* [Chromium](https://chromium.googlesource.com/chromium/src/+/master/docs/user_data_dir.md#introduction) and
* [Firefox](https://wiki.mozilla.org/Firefox/CommandLineOptions#User_profile). Note that Chromium's user data
* directory is the **parent** directory of the "Profile Path" seen at `chrome://version`. Pass an empty string to use
* a temporary directory instead.
* [Firefox](https://wiki.mozilla.org/Firefox/CommandLineOptions#User_profile). Chromium's user data directory is the
* **parent** directory of the "Profile Path" seen at `chrome://version`.
*
* Note that browsers do not allow launching multiple instances with the same User Data Directory.
* @param options
*/
launchPersistentContext(userDataDir: string, options?: {

12
packages/playwright-core/types/types.d.ts vendored
View File

@ -14710,11 +14710,15 @@ export interface BrowserType<Unused = {}> {
* Launches browser that uses persistent storage located at
* [`userDataDir`](https://playwright.dev/docs/api/class-browsertype#browser-type-launch-persistent-context-option-user-data-dir)
* and returns the only context. Closing this context will automatically close the browser.
* @param userDataDir Path to a User Data Directory, which stores browser session data like cookies and local storage. More details for
* @param userDataDir Path to a User Data Directory, which stores browser session data like cookies and local storage. Pass an empty
* string to create a temporary directory.
*
* More details for
* [Chromium](https://chromium.googlesource.com/chromium/src/+/master/docs/user_data_dir.md#introduction) and
* [Firefox](https://wiki.mozilla.org/Firefox/CommandLineOptions#User_profile). Note that Chromium's user data
* directory is the **parent** directory of the "Profile Path" seen at `chrome://version`. Pass an empty string to use
* a temporary directory instead.
* [Firefox](https://wiki.mozilla.org/Firefox/CommandLineOptions#User_profile). Chromium's user data directory is the
* **parent** directory of the "Profile Path" seen at `chrome://version`.
*
* Note that browsers do not allow launching multiple instances with the same User Data Directory.
* @param options
*/
launchPersistentContext(userDataDir: string, options?: {