Skip to content

docs: clarify that userDataDir cannot be used concurrently #35228

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dgozman merged 1 commit into from
Mar 17, 2025
Merged

docs: clarify that userDataDir cannot be used concurrently #35228

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions docs/src/api/class-browsertype.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
12 changes: 8 additions & 4 deletions packages/playwright-client/types/types.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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?: {
Expand Down
12 changes: 8 additions & 4 deletions packages/playwright-core/types/types.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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?: {
Expand Down