github/puppeteer
0
0
Fork 0
mirror of https://github.com/puppeteer/puppeteer synced 2024-06-14 14:02:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(new): add TSDoc comments to Puppeteer (#6032)

Browse Source
This commit is contained in:
Martin Splitt
2020-06-24 16:21:46 +02:00
committed by Mathias Bynens
parent a46c78fc91
commit f1f7339a3b
18 changed files with 256 additions and 140 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
new-docs/puppeteer.puppeteer.launch.md
View File

@@ -4,6 +4,8 @@
## Puppeteer.launch() method
Launches puppeteer and launches a browser instance with given arguments and options when specified.
<b>Signature:</b>
```typescript
@@ -17,9 +19,26 @@ launch(options?: LaunchOptions & ChromeArgOptions & BrowserOptions & {
| Parameter | Type | Description |
| --- | --- | --- |
| options | LaunchOptions &amp; ChromeArgOptions &amp; BrowserOptions &amp; { product?: string; extraPrefsFirefox?: {}; } | |
| options | LaunchOptions &amp; ChromeArgOptions &amp; BrowserOptions &amp; { product?: string; extraPrefsFirefox?: {}; } | Set of configurable options to set on the browser. |
<b>Returns:</b>
Promise&lt;[Browser](./puppeteer.browser.md)<!-- -->&gt;
Promise which resolves to browser instance.
## Remarks
## Example
You can use `ignoreDefaultArgs` to filter out `--mute-audio` from default arguments:
```js
const browser = await puppeteer.launch({
ignoreDefaultArgs: ['--mute-audio']
});
```
\*\*NOTE\*\* Puppeteer can also be used to control the Chrome browser, but it works best with the version of Chromium it is bundled with. There is no guarantee it will work with any other version. Use `executablePath` option with extreme caution. If Google Chrome (rather than Chromium) is preferred, a [Chrome Canary](https://www.google.com/chrome/browser/canary.html) or [Dev Channel](https://www.chromium.org/getting-involved/dev-channel) build is suggested. In `puppeteer.launch([options])`<!-- -->, any mention of Chromium also applies to Chrome. See [this article](https://www.howtogeek.com/202825/what%E2%80%99s-the-difference-between-chromium-and-chrome/) for a description of the differences between Chromium and Chrome. [This article](https://chromium.googlesource.com/chromium/src/+/lkgr/docs/chromium_browser_vs_google_chrome.md) describes some differences for Linux users.