puppeteer/new-docs/puppeteer.puppeteer.launch.md

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Puppeteer](./puppeteer.puppeteer.md) &gt; [launch](./puppeteer.puppeteer.launch.md)

## Puppeteer.launch() method

Launches puppeteer and launches a browser instance with given arguments and options when specified.

<b>Signature:</b>

```typescript
launch(options?: LaunchOptions & ChromeArgOptions & BrowserOptions & {
        product?: string;
        extraPrefsFirefox?: {};
    }): Promise<Browser>;
```

## Parameters

|  Parameter | Type | Description |
|  --- | --- | --- |
|  options | [LaunchOptions](./puppeteer.launchoptions.md) &amp; [ChromeArgOptions](./puppeteer.chromeargoptions.md) &amp; [BrowserOptions](./puppeteer.browseroptions.md) &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.
chore: commit base new-docs (#5973) This adds the new docs that are generated by API Extractor via TSDoc. They are sparse because we do not yet use TSDoc in the codebase. This is the starting point and from here we can work through all the different classes and improve the documentation. 2020-06-04 14:56:45 +00:00			`<!-- Do not edit this file. It is automatically generated by API Documenter. -->`

			`[Home](./index.md) > [puppeteer](./puppeteer.md) > [Puppeteer](./puppeteer.puppeteer.md) > [launch](./puppeteer.puppeteer.launch.md)`

			`## Puppeteer.launch() method`

docs(new): add TSDoc comments to Puppeteer (#6032) 2020-06-24 14:21:46 +00:00			`Launches puppeteer and launches a browser instance with given arguments and options when specified.`

chore: commit base new-docs (#5973) This adds the new docs that are generated by API Extractor via TSDoc. They are sparse because we do not yet use TSDoc in the codebase. This is the starting point and from here we can work through all the different classes and improve the documentation. 2020-06-04 14:56:45 +00:00			`<b>Signature:</b>`

			```typescript
			`launch(options?: LaunchOptions & ChromeArgOptions & BrowserOptions & {`
			`product?: string;`
			`extraPrefsFirefox?: {};`
			`}): Promise<Browser>;`
			```

			`## Parameters`

			`\| Parameter \| Type \| Description \|`
			`\| --- \| --- \| --- \|`
chore(docs): reduce warnings when generating docs (#6138) * chore(docs): reduce warnings when generating docs This is a bunch of small miscellaneous fixes that reduce the amount of warnings logged when generating our new docs. The long term goal is to get this list down to 0 warnings, but I'll do it in multiple PRs. * satisfy doclint 2020-07-02 11:15:39 +00:00			`\| options \| [LaunchOptions](./puppeteer.launchoptions.md) & [ChromeArgOptions](./puppeteer.chromeargoptions.md) & [BrowserOptions](./puppeteer.browseroptions.md) & { product?: string; extraPrefsFirefox?: {}; } \| Set of configurable options to set on the browser. \|`
chore: commit base new-docs (#5973) This adds the new docs that are generated by API Extractor via TSDoc. They are sparse because we do not yet use TSDoc in the codebase. This is the starting point and from here we can work through all the different classes and improve the documentation. 2020-06-04 14:56:45 +00:00
			`<b>Returns:</b>`

			`Promise<[Browser](./puppeteer.browser.md)<!-- -->>`

docs(new): add TSDoc comments to Puppeteer (#6032) 2020-06-24 14:21:46 +00:00			`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.