mirror of
https://github.com/puppeteer/puppeteer
synced 2024-06-14 14:02:48 +00:00
1f5e333f00
* chore: Don't store revisions in `package.json` It's quite messy to have to require the `package.json` file in multiple places purely to find out what revision of a given browser we want to use. We can also achieve better type safety by placing it in an actual source file. This commit makes that change and also tidies up our reliance on `package.json` within the source code generally; we now only use it to find the location of the Puppeteer root such that we know where to install downloaded browsers to. To avoid using `package.json` to parse the name of the module, we also now explicitly have an entry point for the Puppeteer module and the Puppeter Core module. This will make it easier in the future to ship less code as part of core (e.g. core never needs to download a browser, so why ship that code?). Core can also then not have any revisions based info contained in it. The test install script has also been updated to ensure that puppeteer-core can be installed correctly too. Finally, the `install` script has been moved to TypeScript for nicer typechecking and safety. The functionality of it has not changed.
2.2 KiB
2.2 KiB
Puppeteer class
The main Puppeteer class Puppeteer module provides a method to launch a browser instance.
Signature:
export declare class Puppeteer
Remarks
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:
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();
})();
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| __productName | string | ||
| _changedProduct | boolean | ||
| _isPuppeteerCore | boolean | ||
| _lazyLauncher | ProductLauncher | ||
| _preferredRevision | string | ||
| devices | DevicesMap | ||
| errors | PuppeteerErrors | ||
| product | string |
Methods
| Method | Modifiers | Description |
|---|---|---|
| connect(options) | This method attaches Puppeteer to an existing browser instance. | |
| createBrowserFetcher(options) | ||
| defaultArgs(options) | ||
| executablePath() | ||
| launch(options) | Launches puppeteer and launches a browser instance with given arguments and options when specified. |