docs(api.md): add note regarding puppeteer.executablePath() (#4092)

References #4091
puppeteer · Mar 14, 2019 · 27cf859 · 27cf859
1 parent 3511a35
commit 27cf859
Showing 1 changed file with 2 additions and 0 deletions.
diff --git 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`.