From 27cf8594c2cf76874a65cae2ab5a3b2a658d4962 Mon Sep 17 00:00:00 2001 From: Andrey Lushnikov Date: Thu, 14 Mar 2019 11:32:44 -0700 Subject: [PATCH] docs(api.md): add note regarding puppeteer.executablePath() (#4092) References #4091 --- docs/api.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/api.md b/docs/api.md index 186fa136..cec49f80 100644 --- a/docs/api.md +++ b/docs/api.md @@ -482,6 +482,8 @@ The default flags that Chromium will be launched with. #### puppeteer.executablePath() - returns: <[string]> A path where Puppeteer expects to find bundled Chromium. Chromium might not exist there if the download was skipped with [`PUPPETEER_SKIP_CHROMIUM_DOWNLOAD`](#environment-variables). +> **NOTE** `puppeteer.executablePath()` is affected by the `PUPPETEER_EXECUTABLE_PATH` and `PUPPETEER_CHROMIUM_REVISION` env variables. See [Environment Variables](#environment-variables) for details. + #### puppeteer.launch([options]) - `options` <[Object]> Set of configurable options to set on the browser. Can have the following fields: - `ignoreHTTPSErrors` <[boolean]> Whether to ignore HTTPS errors during navigation. Defaults to `false`.