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 )
## Puppeteer class
2020-07-09 13:49:27 +00:00
The main Puppeteer class. Provides the [launch ](./puppeteer.puppeteer.launch.md ) method to launch a browser.
When you `require` or `import` the Puppeteer npm package you get back an instance of this class.
2020-06-04 14:56:45 +00:00
< b > Signature:< / b >
```typescript
export declare class Puppeteer
```
2020-06-24 14:21:46 +00:00
## Remarks
2020-06-04 14:56:45 +00:00
2020-06-24 14:21:46 +00:00
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `Puppeteer` class.
## Example
The following is a typical example of using Puppeteer to drive automation:
```js
const puppeteer = require('puppeteer');
(async () => {
const browser = await puppeteer.launch();
const page = await browser.newPage();
await page.goto('https://www.google.com');
// other actions...
await browser.close();
})();
```
2020-06-04 14:56:45 +00:00
## Properties
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
2020-07-02 11:15:39 +00:00
| [devices ](./puppeteer.puppeteer.devices.md ) | | [DevicesMap ](./puppeteer.devicesmap.md ) | |
2020-06-04 14:56:45 +00:00
| [errors ](./puppeteer.puppeteer.errors.md ) | | [PuppeteerErrors ](./puppeteer.puppeteererrors.md ) | |
2020-07-09 13:49:27 +00:00
| [product ](./puppeteer.puppeteer.product.md ) | | string | The name of the browser that is under automation (< code > " chrome" </ code > or < code > " firefox" </ code > ) |
2020-06-04 14:56:45 +00:00
## Methods
| Method | Modifiers | Description |
| --- | --- | --- |
2020-06-24 14:21:46 +00:00
| [connect(options) ](./puppeteer.puppeteer.connect.md ) | | This method attaches Puppeteer to an existing browser instance. |
2020-06-04 14:56:45 +00:00
| [createBrowserFetcher(options) ](./puppeteer.puppeteer.createbrowserfetcher.md ) | | |
| [defaultArgs(options) ](./puppeteer.puppeteer.defaultargs.md ) | | |
| [executablePath() ](./puppeteer.puppeteer.executablepath.md ) | | |
2020-06-24 14:21:46 +00:00
| [launch(options) ](./puppeteer.puppeteer.launch.md ) | | Launches puppeteer and launches a browser instance with given arguments and options when specified. |
2020-06-04 14:56:45 +00:00