From 010c27410aec9e4e31804664717ffe8643f7a0be Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B3zsi?= Date: Tue, 18 Feb 2020 00:35:11 +0200 Subject: [PATCH] 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`. --- docs/api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api.md b/docs/api.md index f7a9dd7751..0a36c69d9b 100644 --- a/docs/api.md +++ b/docs/api.md @@ -3469,7 +3469,7 @@ const browser = await chromium.launch({ // Or 'firefox' or 'webkit'. - `dumpio` <[boolean]> Whether to pipe the browser process stdout and stderr into `process.stdout` and `process.stderr`. Defaults to `false`. - `env` <[Object]> Specify environment variables that will be visible to the browser. Defaults to `process.env`. - `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`. -- returns: <[Promise]<[BrowserServer]>> Promise which resolves to the browser app instance. +- returns: <[Promise]<[BrowserContext]>> Promise which resolves to the browser app instance. 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.