puppeteer/new-docs/puppeteer.puppeteer.connect.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; [connect](./puppeteer.puppeteer.connect.md)

## Puppeteer.connect() method

This method attaches Puppeteer to an existing browser instance.

<b>Signature:</b>

```typescript
connect(options: ConnectOptions): Promise<Browser>;
```

## Parameters

|  Parameter | Type | Description |
|  --- | --- | --- |
|  options | [ConnectOptions](./puppeteer.connectoptions.md) | 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
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) > [connect](./puppeteer.puppeteer.connect.md)`

			`## Puppeteer.connect() method`

docs(new): add TSDoc comments to Puppeteer (#6032) 2020-06-24 14:21:46 +00:00			`This method attaches Puppeteer to an existing browser instance.`

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
chore(agnostification): split up root Puppeteer class (#6504) The `Puppeteer` class had two concerns: * connect to an existing browser * launch a new browser The first of those concerns is needed in all environments, but the second is only needed in Node. https://github.com/puppeteer/puppeteer/pull/6484 landing enabled us to pull the `Puppeteer` class apart into two: 1. `Puppeteer` which hosts the behaviour for connecting to existing browsers. 2. `PuppeteerNode`, which extends `Puppeteer` and also adds the ability to launch a new browser. This is a non-breaking change, because Node users will still get an instance of a class with all the methods they expect, but it'll be a `PuppeteerNode` rather than `Puppeteer`. I don't expect this to cause people any issues. We also now have new files that are effectively the entry points for Puppeteer: * `node.ts`: the main entry point for Puppeteer on Node. * `web.ts`: the main entry point for Puppeteer on the web. * `node-puppeteer-core.ts`: for those using puppeteer-core (which only exists in Node, not on the web). 2020-10-13 15:19:26 +00:00			`connect(options: ConnectOptions): Promise<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			```

			`## Parameters`

			`\| Parameter \| Type \| Description \|`
			`\| --- \| --- \| --- \|`
chore(agnostification): split up root Puppeteer class (#6504) The `Puppeteer` class had two concerns: * connect to an existing browser * launch a new browser The first of those concerns is needed in all environments, but the second is only needed in Node. https://github.com/puppeteer/puppeteer/pull/6484 landing enabled us to pull the `Puppeteer` class apart into two: 1. `Puppeteer` which hosts the behaviour for connecting to existing browsers. 2. `PuppeteerNode`, which extends `Puppeteer` and also adds the ability to launch a new browser. This is a non-breaking change, because Node users will still get an instance of a class with all the methods they expect, but it'll be a `PuppeteerNode` rather than `Puppeteer`. I don't expect this to cause people any issues. We also now have new files that are effectively the entry points for Puppeteer: * `node.ts`: the main entry point for Puppeteer on Node. * `web.ts`: the main entry point for Puppeteer on the web. * `node-puppeteer-core.ts`: for those using puppeteer-core (which only exists in Node, not on the web). 2020-10-13 15:19:26 +00:00			`\| options \| [ConnectOptions](./puppeteer.connectoptions.md) \| 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`