Skip to content

Commit 010c274

Browse files
authored
Docs: fix return type of launchPersistent (#1047)
Docs fix: the return type of `browserType.launchPersistent` is [BrowserContext](https://github.com/microsoft/playwright/blob/master/src/server/browserType.ts#L46), not ` BrowserServer`.
1 parent e658978 commit 010c274

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/api.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3469,7 +3469,7 @@ const browser = await chromium.launch({ // Or 'firefox' or 'webkit'.
34693469
- `dumpio` <[boolean]> Whether to pipe the browser process stdout and stderr into `process.stdout` and `process.stderr`. Defaults to `false`.
34703470
- `env` <[Object]> Specify environment variables that will be visible to the browser. Defaults to `process.env`.
34713471
- `devtools` <[boolean]> **Chromium-only** Whether to auto-open a Developer Tools panel for each tab. If this option is `true`, the `headless` option will be set `false`.
3472-
- returns: <[Promise]<[BrowserServer]>> Promise which resolves to the browser app instance.
3472+
- returns: <[Promise]<[BrowserContext]>> Promise which resolves to the browser app instance.
34733473

34743474
Launches browser instance that uses persistent storage located at `userDataDir`. If `userDataDir` is not specified, temporary folder is created for the persistent storage. That folder is deleted when browser closes.
34753475

0 commit comments

Comments
 (0)