Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
They are generating a lot of noise in PRs. This commit removes them from git, but updates CI to generate them - to ensure there are no errors when generating the new documentation. Further commits will: 1. Introduce linting to enforce methods are documented. 2. Generate previews of the new docs via GitHub actions or similar. diff --git a/.gitignore b/.gitignore index c5f0b19c..167bc446 100644 --- a/.gitignore +++ b/.gitignore @@ -18,3 +18,4 @@ test/coverage.json temp/ dependency-chart.png puppeteer-core-*.tgz +new-docs/ diff --git a/.travis.yml b/.travis.yml index b8b46964..30b3fc31 100644 --- a/.travis.yml +++ b/.travis.yml @@ -71,7 +71,8 @@ jobs: - CHROMIUM=true script: - npm run lint - - npm run ensure-new-docs-up-to-date + # Ensure that we can generate the new docs without erroring + - npm run generate-docs - npm run ensure-correct-devtools-protocol-revision # This bot runs separately as it changes package.json to test puppeteer-core diff --git a/new-docs/index.md b/new-docs/index.md deleted file mode 100644 index bf798762..00000000 --- a/new-docs/index.md +++ /dev/null @@ -1,12 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) - -## API Reference - -## Packages - -| Package | Description | -| --- | --- | -| [puppeteer](./puppeteer.md) | | - diff --git a/new-docs/puppeteer.accessibility.md b/new-docs/puppeteer.accessibility.md deleted file mode 100644 index 3f8b4b90..00000000 --- a/new-docs/puppeteer.accessibility.md +++ /dev/null @@ -1,30 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Accessibility](./puppeteer.accessibility.md) - -## Accessibility class - -The Accessibility class provides methods for inspecting Chromium's accessibility tree. The accessibility tree is used by assistive technology such as [screen readers](https://en.wikipedia.org/wiki/Screen_reader) or [switches](https://en.wikipedia.org/wiki/Switch_access)<!-- -->. - -<b>Signature:</b> - -```typescript -export declare class Accessibility -``` - -## Remarks - -Accessibility is a very platform-specific thing. On different platforms, there are different screen readers that might have wildly different output. - -Blink - Chrome's rendering engine - has a concept of "accessibility tree", which is then translated into different platform-specific APIs. Accessibility namespace gives users access to the Blink Accessibility Tree. - -Most of the accessibility tree gets filtered out when converting from Blink AX Tree to Platform-specific AX-Tree or by assistive technologies themselves. By default, Puppeteer tries to approximate this filtering, exposing only the "interesting" nodes of the tree. - -The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `Accessibility` class. - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [snapshot(options)](./puppeteer.accessibility.snapshot.md) | | Captures the current state of the accessibility tree. The returned object represents the root accessible node of the page. | - diff --git a/new-docs/puppeteer.accessibility.snapshot.md b/new-docs/puppeteer.accessibility.snapshot.md deleted file mode 100644 index b8547a1d..00000000 --- a/new-docs/puppeteer.accessibility.snapshot.md +++ /dev/null @@ -1,61 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Accessibility](./puppeteer.accessibility.md) > [snapshot](./puppeteer.accessibility.snapshot.md) - -## Accessibility.snapshot() method - -Captures the current state of the accessibility tree. The returned object represents the root accessible node of the page. - -<b>Signature:</b> - -```typescript -snapshot(options?: SnapshotOptions): Promise<SerializedAXNode>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| options | [SnapshotOptions](./puppeteer.snapshotoptions.md) | | - -<b>Returns:</b> - -Promise<[SerializedAXNode](./puppeteer.serializedaxnode.md)<!-- -->> - -An AXNode object representing the snapshot. - -## Remarks - -\*\*NOTE\*\* The Chromium accessibility tree contains nodes that go unused on most platforms and by most screen readers. Puppeteer will discard them as well for an easier to process tree, unless `interestingOnly` is set to `false`<!-- -->. - -## Example 1 - -An example of dumping the entire accessibility tree: - -```js -const snapshot = await page.accessibility.snapshot(); -console.log(snapshot); - -``` - -## Example 2 - -An example of logging the focused node's name: - -```js -const snapshot = await page.accessibility.snapshot(); -const node = findFocusedNode(snapshot); -console.log(node && node.name); - -function findFocusedNode(node) { - if (node.focused) - return node; - for (const child of node.children || []) { - const foundNode = findFocusedNode(child); - return foundNode; - } - return null; -} - -``` - diff --git a/new-docs/puppeteer.boundingbox.height.md b/new-docs/puppeteer.boundingbox.height.md deleted file mode 100644 index 426528b0..00000000 --- a/new-docs/puppeteer.boundingbox.height.md +++ /dev/null @@ -1,13 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BoundingBox](./puppeteer.boundingbox.md) > [height](./puppeteer.boundingbox.height.md) - -## BoundingBox.height property - -the height of the element in pixels. - -<b>Signature:</b> - -```typescript -height: number; -``` diff --git a/new-docs/puppeteer.boundingbox.md b/new-docs/puppeteer.boundingbox.md deleted file mode 100644 index 9cb816c7..00000000 --- a/new-docs/puppeteer.boundingbox.md +++ /dev/null @@ -1,22 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BoundingBox](./puppeteer.boundingbox.md) - -## BoundingBox interface - - -<b>Signature:</b> - -```typescript -export interface BoundingBox -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [height](./puppeteer.boundingbox.height.md) | number | the height of the element in pixels. | -| [width](./puppeteer.boundingbox.width.md) | number | the width of the element in pixels. | -| [x](./puppeteer.boundingbox.x.md) | number | the x coordinate of the element in pixels. | -| [y](./puppeteer.boundingbox.y.md) | number | the y coordinate of the element in pixels. | - diff --git a/new-docs/puppeteer.boundingbox.width.md b/new-docs/puppeteer.boundingbox.width.md deleted file mode 100644 index fe5d16d7..00000000 --- a/new-docs/puppeteer.boundingbox.width.md +++ /dev/null @@ -1,13 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BoundingBox](./puppeteer.boundingbox.md) > [width](./puppeteer.boundingbox.width.md) - -## BoundingBox.width property - -the width of the element in pixels. - -<b>Signature:</b> - -```typescript -width: number; -``` diff --git a/new-docs/puppeteer.boundingbox.x.md b/new-docs/puppeteer.boundingbox.x.md deleted file mode 100644 index 7803f442..00000000 --- a/new-docs/puppeteer.boundingbox.x.md +++ /dev/null @@ -1,13 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BoundingBox](./puppeteer.boundingbox.md) > [x](./puppeteer.boundingbox.x.md) - -## BoundingBox.x property - -the x coordinate of the element in pixels. - -<b>Signature:</b> - -```typescript -x: number; -``` diff --git a/new-docs/puppeteer.boundingbox.y.md b/new-docs/puppeteer.boundingbox.y.md deleted file mode 100644 index c574ee6c..00000000 --- a/new-docs/puppeteer.boundingbox.y.md +++ /dev/null @@ -1,13 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BoundingBox](./puppeteer.boundingbox.md) > [y](./puppeteer.boundingbox.y.md) - -## BoundingBox.y property - -the y coordinate of the element in pixels. - -<b>Signature:</b> - -```typescript -y: number; -``` diff --git a/new-docs/puppeteer.boxmodel.border.md b/new-docs/puppeteer.boxmodel.border.md deleted file mode 100644 index f5eb3741..00000000 --- a/new-docs/puppeteer.boxmodel.border.md +++ /dev/null @@ -1,14 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BoxModel](./puppeteer.boxmodel.md) > [border](./puppeteer.boxmodel.border.md) - -## BoxModel.border property - -<b>Signature:</b> - -```typescript -border: Array<{ - x: number; - y: number; - }>; -``` diff --git a/new-docs/puppeteer.boxmodel.content.md b/new-docs/puppeteer.boxmodel.content.md deleted file mode 100644 index a0a4723c..00000000 --- a/new-docs/puppeteer.boxmodel.content.md +++ /dev/null @@ -1,14 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BoxModel](./puppeteer.boxmodel.md) > [content](./puppeteer.boxmodel.content.md) - -## BoxModel.content property - -<b>Signature:</b> - -```typescript -content: Array<{ - x: number; - y: number; - }>; -``` diff --git a/new-docs/puppeteer.boxmodel.height.md b/new-docs/puppeteer.boxmodel.height.md deleted file mode 100644 index 952ca5f8..00000000 --- a/new-docs/puppeteer.boxmodel.height.md +++ /dev/null @@ -1,11 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BoxModel](./puppeteer.boxmodel.md) > [height](./puppeteer.boxmodel.height.md) - -## BoxModel.height property - -<b>Signature:</b> - -```typescript -height: number; -``` diff --git a/new-docs/puppeteer.boxmodel.margin.md b/new-docs/puppeteer.boxmodel.margin.md deleted file mode 100644 index 418f1928..00000000 --- a/new-docs/puppeteer.boxmodel.margin.md +++ /dev/null @@ -1,14 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BoxModel](./puppeteer.boxmodel.md) > [margin](./puppeteer.boxmodel.margin.md) - -## BoxModel.margin property - -<b>Signature:</b> - -```typescript -margin: Array<{ - x: number; - y: number; - }>; -``` diff --git a/new-docs/puppeteer.boxmodel.md b/new-docs/puppeteer.boxmodel.md deleted file mode 100644 index 04414d0a..00000000 --- a/new-docs/puppeteer.boxmodel.md +++ /dev/null @@ -1,23 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BoxModel](./puppeteer.boxmodel.md) - -## BoxModel interface - -<b>Signature:</b> - -```typescript -export interface BoxModel -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [border](./puppeteer.boxmodel.border.md) | Array<{ x: number; y: number; }> | | -| [content](./puppeteer.boxmodel.content.md) | Array<{ x: number; y: number; }> | | -| [height](./puppeteer.boxmodel.height.md) | number | | -| [margin](./puppeteer.boxmodel.margin.md) | Array<{ x: number; y: number; }> | | -| [padding](./puppeteer.boxmodel.padding.md) | Array<{ x: number; y: number; }> | | -| [width](./puppeteer.boxmodel.width.md) | number | | - diff --git a/new-docs/puppeteer.boxmodel.padding.md b/new-docs/puppeteer.boxmodel.padding.md deleted file mode 100644 index 3c47ceeb..00000000 --- a/new-docs/puppeteer.boxmodel.padding.md +++ /dev/null @@ -1,14 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BoxModel](./puppeteer.boxmodel.md) > [padding](./puppeteer.boxmodel.padding.md) - -## BoxModel.padding property - -<b>Signature:</b> - -```typescript -padding: Array<{ - x: number; - y: number; - }>; -``` diff --git a/new-docs/puppeteer.boxmodel.width.md b/new-docs/puppeteer.boxmodel.width.md deleted file mode 100644 index 14e7b208..00000000 --- a/new-docs/puppeteer.boxmodel.width.md +++ /dev/null @@ -1,11 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BoxModel](./puppeteer.boxmodel.md) > [width](./puppeteer.boxmodel.width.md) - -## BoxModel.width property - -<b>Signature:</b> - -```typescript -width: number; -``` diff --git a/new-docs/puppeteer.browser.browsercontexts.md b/new-docs/puppeteer.browser.browsercontexts.md deleted file mode 100644 index 309170ea..00000000 --- a/new-docs/puppeteer.browser.browsercontexts.md +++ /dev/null @@ -1,17 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [browserContexts](./puppeteer.browser.browsercontexts.md) - -## Browser.browserContexts() method - -Returns an array of all open browser contexts. In a newly created browser, this will return a single instance of [BrowserContext](./puppeteer.browsercontext.md)<!-- -->. - -<b>Signature:</b> - -```typescript -browserContexts(): BrowserContext[]; -``` -<b>Returns:</b> - -[BrowserContext](./puppeteer.browsercontext.md)<!-- -->\[\] - diff --git a/new-docs/puppeteer.browser.close.md b/new-docs/puppeteer.browser.close.md deleted file mode 100644 index 714dd1f8..00000000 --- a/new-docs/puppeteer.browser.close.md +++ /dev/null @@ -1,17 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [close](./puppeteer.browser.close.md) - -## Browser.close() method - -Closes Chromium and all of its pages (if any were opened). The [Browser](./puppeteer.browser.md) object itself is considered to be disposed and cannot be used anymore. - -<b>Signature:</b> - -```typescript -close(): Promise<void>; -``` -<b>Returns:</b> - -Promise<void> - diff --git a/new-docs/puppeteer.browser.createincognitobrowsercontext.md b/new-docs/puppeteer.browser.createincognitobrowsercontext.md deleted file mode 100644 index 93b9f963..00000000 --- a/new-docs/puppeteer.browser.createincognitobrowsercontext.md +++ /dev/null @@ -1,33 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [createIncognitoBrowserContext](./puppeteer.browser.createincognitobrowsercontext.md) - -## Browser.createIncognitoBrowserContext() method - -Creates a new incognito browser context. This won't share cookies/cache with other browser contexts. - -<b>Signature:</b> - -```typescript -createIncognitoBrowserContext(): Promise<BrowserContext>; -``` -<b>Returns:</b> - -Promise<[BrowserContext](./puppeteer.browsercontext.md)<!-- -->> - -## Example - - -```js -(async () => { - const browser = await puppeteer.launch(); - // Create a new incognito browser context. - const context = await browser.createIncognitoBrowserContext(); - // Create a new page in a pristine context. - const page = await context.newPage(); - // Do stuff - await page.goto('https://example.com'); -})(); - -``` - diff --git a/new-docs/puppeteer.browser.defaultbrowsercontext.md b/new-docs/puppeteer.browser.defaultbrowsercontext.md deleted file mode 100644 index 88dba1c6..00000000 --- a/new-docs/puppeteer.browser.defaultbrowsercontext.md +++ /dev/null @@ -1,17 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [defaultBrowserContext](./puppeteer.browser.defaultbrowsercontext.md) - -## Browser.defaultBrowserContext() method - -Returns the default browser context. The default browser context cannot be closed. - -<b>Signature:</b> - -```typescript -defaultBrowserContext(): BrowserContext; -``` -<b>Returns:</b> - -[BrowserContext](./puppeteer.browsercontext.md) - diff --git a/new-docs/puppeteer.browser.disconnect.md b/new-docs/puppeteer.browser.disconnect.md deleted file mode 100644 index 1382226c..00000000 --- a/new-docs/puppeteer.browser.disconnect.md +++ /dev/null @@ -1,17 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [disconnect](./puppeteer.browser.disconnect.md) - -## Browser.disconnect() method - -Disconnects Puppeteer from the browser, but leaves the Chromium process running. After calling `disconnect`<!-- -->, the [Browser](./puppeteer.browser.md) object is considered disposed and cannot be used anymore. - -<b>Signature:</b> - -```typescript -disconnect(): void; -``` -<b>Returns:</b> - -void - diff --git a/new-docs/puppeteer.browser.isconnected.md b/new-docs/puppeteer.browser.isconnected.md deleted file mode 100644 index 987adae7..00000000 --- a/new-docs/puppeteer.browser.isconnected.md +++ /dev/null @@ -1,17 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [isConnected](./puppeteer.browser.isconnected.md) - -## Browser.isConnected() method - -Indicates that the browser is connected. - -<b>Signature:</b> - -```typescript -isConnected(): boolean; -``` -<b>Returns:</b> - -boolean - diff --git a/new-docs/puppeteer.browser.md b/new-docs/puppeteer.browser.md deleted file mode 100644 index 5b590876..00000000 --- a/new-docs/puppeteer.browser.md +++ /dev/null @@ -1,79 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) - -## Browser class - -A Browser is created when Puppeteer connects to a Chromium instance, either through [PuppeteerNode.launch()](./puppeteer.puppeteernode.launch.md) or [Puppeteer.connect()](./puppeteer.puppeteer.connect.md)<!-- -->. - -<b>Signature:</b> - -```typescript -export declare class Browser extends EventEmitter -``` -<b>Extends:</b> [EventEmitter](./puppeteer.eventemitter.md) - -## Remarks - -The Browser class extends from Puppeteer's [EventEmitter](./puppeteer.eventemitter.md) class and will emit various events which are documented in the [BrowserEmittedEvents](./puppeteer.browseremittedevents.md) enum. - -The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `Browser` class. - -## Example 1 - -An example of using a [Browser](./puppeteer.browser.md) to create a [Page](./puppeteer.page.md)<!-- -->: - -```js -const puppeteer = require('puppeteer'); - -(async () => { - const browser = await puppeteer.launch(); - const page = await browser.newPage(); - await page.goto('https://example.com'); - await browser.close(); -})(); - -``` - -## Example 2 - -An example of disconnecting from and reconnecting to a [Browser](./puppeteer.browser.md)<!-- -->: - -```js -const puppeteer = require('puppeteer'); - -(async () => { - const browser = await puppeteer.launch(); - // Store the endpoint to be able to reconnect to Chromium - const browserWSEndpoint = browser.wsEndpoint(); - // Disconnect puppeteer from Chromium - browser.disconnect(); - - // Use the endpoint to reestablish a connection - const browser2 = await puppeteer.connect({browserWSEndpoint}); - // Close Chromium - await browser2.close(); -})(); - -``` - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [browserContexts()](./puppeteer.browser.browsercontexts.md) | | Returns an array of all open browser contexts. In a newly created browser, this will return a single instance of [BrowserContext](./puppeteer.browsercontext.md)<!-- -->. | -| [close()](./puppeteer.browser.close.md) | | Closes Chromium and all of its pages (if any were opened). The [Browser](./puppeteer.browser.md) object itself is considered to be disposed and cannot be used anymore. | -| [createIncognitoBrowserContext()](./puppeteer.browser.createincognitobrowsercontext.md) | | Creates a new incognito browser context. This won't share cookies/cache with other browser contexts. | -| [defaultBrowserContext()](./puppeteer.browser.defaultbrowsercontext.md) | | Returns the default browser context. The default browser context cannot be closed. | -| [disconnect()](./puppeteer.browser.disconnect.md) | | Disconnects Puppeteer from the browser, but leaves the Chromium process running. After calling <code>disconnect</code>, the [Browser](./puppeteer.browser.md) object is considered disposed and cannot be used anymore. | -| [isConnected()](./puppeteer.browser.isconnected.md) | | Indicates that the browser is connected. | -| [newPage()](./puppeteer.browser.newpage.md) | | Creates a [Page](./puppeteer.page.md) in the default browser context. | -| [pages()](./puppeteer.browser.pages.md) | | An array of all open pages inside the Browser. | -| [process()](./puppeteer.browser.process.md) | | The spawned browser process. Returns <code>null</code> if the browser instance was created with [Puppeteer.connect()](./puppeteer.puppeteer.connect.md)<!-- -->. | -| [target()](./puppeteer.browser.target.md) | | The target associated with the browser. | -| [targets()](./puppeteer.browser.targets.md) | | All active targets inside the Browser. In case of multiple browser contexts, returns an array with all the targets in all browser contexts. | -| [userAgent()](./puppeteer.browser.useragent.md) | | The browser's original user agent. Pages can override the browser user agent with [Page.setUserAgent()](./puppeteer.page.setuseragent.md)<!-- -->. | -| [version()](./puppeteer.browser.version.md) | | A string representing the browser name and version. | -| [waitForTarget(predicate, options)](./puppeteer.browser.waitfortarget.md) | | Searches for a target in all browser contexts. | -| [wsEndpoint()](./puppeteer.browser.wsendpoint.md) | | The browser websocket endpoint which can be used as an argument to [Puppeteer.connect()](./puppeteer.puppeteer.connect.md)<!-- -->. | - diff --git a/new-docs/puppeteer.browser.newpage.md b/new-docs/puppeteer.browser.newpage.md deleted file mode 100644 index 9b695fe2..00000000 --- a/new-docs/puppeteer.browser.newpage.md +++ /dev/null @@ -1,17 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [newPage](./puppeteer.browser.newpage.md) - -## Browser.newPage() method - -Creates a [Page](./puppeteer.page.md) in the default browser context. - -<b>Signature:</b> - -```typescript -newPage(): Promise<Page>; -``` -<b>Returns:</b> - -Promise<[Page](./puppeteer.page.md)<!-- -->> - diff --git a/new-docs/puppeteer.browser.pages.md b/new-docs/puppeteer.browser.pages.md deleted file mode 100644 index ea86a7f4..00000000 --- a/new-docs/puppeteer.browser.pages.md +++ /dev/null @@ -1,21 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [pages](./puppeteer.browser.pages.md) - -## Browser.pages() method - -An array of all open pages inside the Browser. - -<b>Signature:</b> - -```typescript -pages(): Promise<Page[]>; -``` -<b>Returns:</b> - -Promise<[Page](./puppeteer.page.md)<!-- -->\[\]> - -## Remarks - -In case of multiple browser contexts, returns an array with all the pages in all browser contexts. Non-visible pages, such as `"background_page"`<!-- -->, will not be listed here. You can find them using [Target.page()](./puppeteer.target.page.md)<!-- -->. - diff --git a/new-docs/puppeteer.browser.process.md b/new-docs/puppeteer.browser.process.md deleted file mode 100644 index ae112dc1..00000000 --- a/new-docs/puppeteer.browser.process.md +++ /dev/null @@ -1,17 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [process](./puppeteer.browser.process.md) - -## Browser.process() method - -The spawned browser process. Returns `null` if the browser instance was created with [Puppeteer.connect()](./puppeteer.puppeteer.connect.md)<!-- -->. - -<b>Signature:</b> - -```typescript -process(): ChildProcess | null; -``` -<b>Returns:</b> - -ChildProcess \| null - diff --git a/new-docs/puppeteer.browser.target.md b/new-docs/puppeteer.browser.target.md deleted file mode 100644 index 2bc6f43e..00000000 --- a/new-docs/puppeteer.browser.target.md +++ /dev/null @@ -1,17 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [target](./puppeteer.browser.target.md) - -## Browser.target() method - -The target associated with the browser. - -<b>Signature:</b> - -```typescript -target(): Target; -``` -<b>Returns:</b> - -[Target](./puppeteer.target.md) - diff --git a/new-docs/puppeteer.browser.targets.md b/new-docs/puppeteer.browser.targets.md deleted file mode 100644 index c823ffed..00000000 --- a/new-docs/puppeteer.browser.targets.md +++ /dev/null @@ -1,17 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [targets](./puppeteer.browser.targets.md) - -## Browser.targets() method - -All active targets inside the Browser. In case of multiple browser contexts, returns an array with all the targets in all browser contexts. - -<b>Signature:</b> - -```typescript -targets(): Target[]; -``` -<b>Returns:</b> - -[Target](./puppeteer.target.md)<!-- -->\[\] - diff --git a/new-docs/puppeteer.browser.useragent.md b/new-docs/puppeteer.browser.useragent.md deleted file mode 100644 index a93a98ff..00000000 --- a/new-docs/puppeteer.browser.useragent.md +++ /dev/null @@ -1,17 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [userAgent](./puppeteer.browser.useragent.md) - -## Browser.userAgent() method - -The browser's original user agent. Pages can override the browser user agent with [Page.setUserAgent()](./puppeteer.page.setuseragent.md)<!-- -->. - -<b>Signature:</b> - -```typescript -userAgent(): Promise<string>; -``` -<b>Returns:</b> - -Promise<string> - diff --git a/new-docs/puppeteer.browser.version.md b/new-docs/puppeteer.browser.version.md deleted file mode 100644 index 9570f3fc..00000000 --- a/new-docs/puppeteer.browser.version.md +++ /dev/null @@ -1,23 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [version](./puppeteer.browser.version.md) - -## Browser.version() method - -A string representing the browser name and version. - -<b>Signature:</b> - -```typescript -version(): Promise<string>; -``` -<b>Returns:</b> - -Promise<string> - -## Remarks - -For headless Chromium, this is similar to `HeadlessChrome/61.0.3153.0`<!-- -->. For non-headless, this is similar to `Chrome/61.0.3153.0`<!-- -->. - -The format of browser.version() might change with future releases of Chromium. - diff --git a/new-docs/puppeteer.browser.waitfortarget.md b/new-docs/puppeteer.browser.waitfortarget.md deleted file mode 100644 index 15d2806f..00000000 --- a/new-docs/puppeteer.browser.waitfortarget.md +++ /dev/null @@ -1,37 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [waitForTarget](./puppeteer.browser.waitfortarget.md) - -## Browser.waitForTarget() method - -Searches for a target in all browser contexts. - -<b>Signature:</b> - -```typescript -waitForTarget(predicate: (x: Target) => boolean, options?: WaitForTargetOptions): Promise<Target>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| predicate | (x: [Target](./puppeteer.target.md)<!-- -->) => boolean | A function to be run for every target. | -| options | [WaitForTargetOptions](./puppeteer.waitfortargetoptions.md) | | - -<b>Returns:</b> - -Promise<[Target](./puppeteer.target.md)<!-- -->> - -The first target found that matches the `predicate` function. - -## Example - -An example of finding a target for a page opened via `window.open`<!-- -->: - -```js -await page.evaluate(() => window.open('https://www.example.com/')); -const newWindowTarget = await browser.waitForTarget(target => target.url() === 'https://www.example.com/'); - -``` - diff --git a/new-docs/puppeteer.browser.wsendpoint.md b/new-docs/puppeteer.browser.wsendpoint.md deleted file mode 100644 index 670c2cef..00000000 --- a/new-docs/puppeteer.browser.wsendpoint.md +++ /dev/null @@ -1,25 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [Browser](./puppeteer.browser.md) > [wsEndpoint](./puppeteer.browser.wsendpoint.md) - -## Browser.wsEndpoint() method - -The browser websocket endpoint which can be used as an argument to [Puppeteer.connect()](./puppeteer.puppeteer.connect.md)<!-- -->. - -<b>Signature:</b> - -```typescript -wsEndpoint(): string; -``` -<b>Returns:</b> - -string - -The Browser websocket url. - -## Remarks - -The format is `ws://${host}:${port}/devtools/browser/<id>`<!-- -->. - -You can find the `webSocketDebuggerUrl` from `http://${host}:${port}/json/version`<!-- -->. Learn more about the [devtools protocol](https://chromedevtools.github.io/devtools-protocol) and the [browser endpoint](https://chromedevtools.github.io/devtools-protocol/#how-do-i-access-the-browser-target)<!-- -->. - diff --git a/new-docs/puppeteer.browsercontext.browser.md b/new-docs/puppeteer.browsercontext.browser.md deleted file mode 100644 index 92bfd842..00000000 --- a/new-docs/puppeteer.browsercontext.browser.md +++ /dev/null @@ -1,17 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserContext](./puppeteer.browsercontext.md) > [browser](./puppeteer.browsercontext.browser.md) - -## BrowserContext.browser() method - -The browser this browser context belongs to. - -<b>Signature:</b> - -```typescript -browser(): Browser; -``` -<b>Returns:</b> - -[Browser](./puppeteer.browser.md) - diff --git a/new-docs/puppeteer.browsercontext.clearpermissionoverrides.md b/new-docs/puppeteer.browsercontext.clearpermissionoverrides.md deleted file mode 100644 index 0ca4c2f5..00000000 --- a/new-docs/puppeteer.browsercontext.clearpermissionoverrides.md +++ /dev/null @@ -1,28 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserContext](./puppeteer.browsercontext.md) > [clearPermissionOverrides](./puppeteer.browsercontext.clearpermissionoverrides.md) - -## BrowserContext.clearPermissionOverrides() method - -Clears all permission overrides for the browser context. - -<b>Signature:</b> - -```typescript -clearPermissionOverrides(): Promise<void>; -``` -<b>Returns:</b> - -Promise<void> - -## Example - - -```js -const context = browser.defaultBrowserContext(); -context.overridePermissions('https://example.com', ['clipboard-read']); -// do stuff .. -context.clearPermissionOverrides(); - -``` - diff --git a/new-docs/puppeteer.browsercontext.close.md b/new-docs/puppeteer.browsercontext.close.md deleted file mode 100644 index 88455198..00000000 --- a/new-docs/puppeteer.browsercontext.close.md +++ /dev/null @@ -1,21 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserContext](./puppeteer.browsercontext.md) > [close](./puppeteer.browsercontext.close.md) - -## BrowserContext.close() method - -Closes the browser context. All the targets that belong to the browser context will be closed. - -<b>Signature:</b> - -```typescript -close(): Promise<void>; -``` -<b>Returns:</b> - -Promise<void> - -## Remarks - -Only incognito browser contexts can be closed. - diff --git a/new-docs/puppeteer.browsercontext.isincognito.md b/new-docs/puppeteer.browsercontext.isincognito.md deleted file mode 100644 index f54f9189..00000000 --- a/new-docs/puppeteer.browsercontext.isincognito.md +++ /dev/null @@ -1,21 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserContext](./puppeteer.browsercontext.md) > [isIncognito](./puppeteer.browsercontext.isincognito.md) - -## BrowserContext.isIncognito() method - -Returns whether BrowserContext is incognito. The default browser context is the only non-incognito browser context. - -<b>Signature:</b> - -```typescript -isIncognito(): boolean; -``` -<b>Returns:</b> - -boolean - -## Remarks - -The default browser context cannot be closed. - diff --git a/new-docs/puppeteer.browsercontext.md b/new-docs/puppeteer.browsercontext.md deleted file mode 100644 index d3df508b..00000000 --- a/new-docs/puppeteer.browsercontext.md +++ /dev/null @@ -1,54 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserContext](./puppeteer.browsercontext.md) - -## BrowserContext class - -BrowserContexts provide a way to operate multiple independent browser sessions. When a browser is launched, it has a single BrowserContext used by default. The method [Browser.newPage](./puppeteer.browser.newpage.md) creates a page in the default browser context. - -<b>Signature:</b> - -```typescript -export declare class BrowserContext extends EventEmitter -``` -<b>Extends:</b> [EventEmitter](./puppeteer.eventemitter.md) - -## Remarks - -The Browser class extends from Puppeteer's [EventEmitter](./puppeteer.eventemitter.md) class and will emit various events which are documented in the [BrowserContextEmittedEvents](./puppeteer.browsercontextemittedevents.md) enum. - -If a page opens another page, e.g. with a `window.open` call, the popup will belong to the parent page's browser context. - -Puppeteer allows creation of "incognito" browser contexts with [Browser.createIncognitoBrowserContext](./puppeteer.browser.createincognitobrowsercontext.md) method. "Incognito" browser contexts don't write any browsing data to disk. - -The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `BrowserContext` class. - -## Example - - -```js -// Create a new incognito browser context -const context = await browser.createIncognitoBrowserContext(); -// Create a new page inside context. -const page = await context.newPage(); -// ... do stuff with page ... -await page.goto('https://example.com'); -// Dispose context once it's no longer needed. -await context.close(); - -``` - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [browser()](./puppeteer.browsercontext.browser.md) | | The browser this browser context belongs to. | -| [clearPermissionOverrides()](./puppeteer.browsercontext.clearpermissionoverrides.md) | | Clears all permission overrides for the browser context. | -| [close()](./puppeteer.browsercontext.close.md) | | Closes the browser context. All the targets that belong to the browser context will be closed. | -| [isIncognito()](./puppeteer.browsercontext.isincognito.md) | | Returns whether BrowserContext is incognito. The default browser context is the only non-incognito browser context. | -| [newPage()](./puppeteer.browsercontext.newpage.md) | | Creates a new page in the browser context. | -| [overridePermissions(origin, permissions)](./puppeteer.browsercontext.overridepermissions.md) | | | -| [pages()](./puppeteer.browsercontext.pages.md) | | An array of all pages inside the browser context. | -| [targets()](./puppeteer.browsercontext.targets.md) | | An array of all active targets inside the browser context. | -| [waitForTarget(predicate, options)](./puppeteer.browsercontext.waitfortarget.md) | | This searches for a target in this specific browser context. | - diff --git a/new-docs/puppeteer.browsercontext.newpage.md b/new-docs/puppeteer.browsercontext.newpage.md deleted file mode 100644 index b68ba5cc..00000000 --- a/new-docs/puppeteer.browsercontext.newpage.md +++ /dev/null @@ -1,17 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserContext](./puppeteer.browsercontext.md) > [newPage](./puppeteer.browsercontext.newpage.md) - -## BrowserContext.newPage() method - -Creates a new page in the browser context. - -<b>Signature:</b> - -```typescript -newPage(): Promise<Page>; -``` -<b>Returns:</b> - -Promise<[Page](./puppeteer.page.md)<!-- -->> - diff --git a/new-docs/puppeteer.browsercontext.overridepermissions.md b/new-docs/puppeteer.browsercontext.overridepermissions.md deleted file mode 100644 index 8f1e5b78..00000000 --- a/new-docs/puppeteer.browsercontext.overridepermissions.md +++ /dev/null @@ -1,32 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserContext](./puppeteer.browsercontext.md) > [overridePermissions](./puppeteer.browsercontext.overridepermissions.md) - -## BrowserContext.overridePermissions() method - -<b>Signature:</b> - -```typescript -overridePermissions(origin: string, permissions: string[]): Promise<void>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| origin | string | The origin to grant permissions to, e.g. "https://example.com". | -| permissions | string\[\] | An array of permissions to grant. All permissions that are not listed here will be automatically denied. | - -<b>Returns:</b> - -Promise<void> - -## Example - - -```js -const context = browser.defaultBrowserContext(); -await context.overridePermissions('https://html5demos.com', ['geolocation']); - -``` - diff --git a/new-docs/puppeteer.browsercontext.pages.md b/new-docs/puppeteer.browsercontext.pages.md deleted file mode 100644 index 23a563b0..00000000 --- a/new-docs/puppeteer.browsercontext.pages.md +++ /dev/null @@ -1,19 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserContext](./puppeteer.browsercontext.md) > [pages](./puppeteer.browsercontext.pages.md) - -## BrowserContext.pages() method - -An array of all pages inside the browser context. - -<b>Signature:</b> - -```typescript -pages(): Promise<Page[]>; -``` -<b>Returns:</b> - -Promise<[Page](./puppeteer.page.md)<!-- -->\[\]> - -Promise which resolves to an array of all open pages. Non visible pages, such as `"background_page"`<!-- -->, will not be listed here. You can find them using [the target page](./puppeteer.target.page.md)<!-- -->. - diff --git a/new-docs/puppeteer.browsercontext.targets.md b/new-docs/puppeteer.browsercontext.targets.md deleted file mode 100644 index 57326cc6..00000000 --- a/new-docs/puppeteer.browsercontext.targets.md +++ /dev/null @@ -1,17 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserContext](./puppeteer.browsercontext.md) > [targets](./puppeteer.browsercontext.targets.md) - -## BrowserContext.targets() method - -An array of all active targets inside the browser context. - -<b>Signature:</b> - -```typescript -targets(): Target[]; -``` -<b>Returns:</b> - -[Target](./puppeteer.target.md)<!-- -->\[\] - diff --git a/new-docs/puppeteer.browsercontext.waitfortarget.md b/new-docs/puppeteer.browsercontext.waitfortarget.md deleted file mode 100644 index 13421992..00000000 --- a/new-docs/puppeteer.browsercontext.waitfortarget.md +++ /dev/null @@ -1,39 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserContext](./puppeteer.browsercontext.md) > [waitForTarget](./puppeteer.browsercontext.waitfortarget.md) - -## BrowserContext.waitForTarget() method - -This searches for a target in this specific browser context. - -<b>Signature:</b> - -```typescript -waitForTarget(predicate: (x: Target) => boolean, options?: { - timeout?: number; - }): Promise<Target>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| predicate | (x: [Target](./puppeteer.target.md)<!-- -->) => boolean | A function to be run for every target | -| options | { timeout?: number; } | An object of options. Accepts a timout, which is the maximum wait time in milliseconds. Pass <code>0</code> to disable the timeout. Defaults to 30 seconds. | - -<b>Returns:</b> - -Promise<[Target](./puppeteer.target.md)<!-- -->> - -Promise which resolves to the first target found that matches the `predicate` function. - -## Example - -An example of finding a target for a page opened via `window.open`<!-- -->: - -```js -await page.evaluate(() => window.open('https://www.example.com/')); -const newWindowTarget = await browserContext.waitForTarget(target => target.url() === 'https://www.example.com/'); - -``` - diff --git a/new-docs/puppeteer.browsercontextemittedevents.md b/new-docs/puppeteer.browsercontextemittedevents.md deleted file mode 100644 index 3929ad58..00000000 --- a/new-docs/puppeteer.browsercontextemittedevents.md +++ /dev/null @@ -1,20 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserContextEmittedEvents](./puppeteer.browsercontextemittedevents.md) - -## BrowserContextEmittedEvents enum - -<b>Signature:</b> - -```typescript -export declare const enum BrowserContextEmittedEvents -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| TargetChanged | <code>"targetchanged"</code> | Emitted when the url of a target inside the browser context changes. Contains a [Target](./puppeteer.target.md) instance. | -| TargetCreated | <code>"targetcreated"</code> | Emitted when a target is created within the browser context, for example when a new page is opened by [window.open](https://developer.mozilla.org/en-US/docs/Web/API/Window/open) or by [browserContext.newPage](./puppeteer.browsercontext.newpage.md)<!-- -->Contains a [Target](./puppeteer.target.md) instance. | -| TargetDestroyed | <code>"targetdestroyed"</code> | Emitted when a target is destroyed within the browser context, for example when a page is closed. Contains a [Target](./puppeteer.target.md) instance. | - diff --git a/new-docs/puppeteer.browseremittedevents.md b/new-docs/puppeteer.browseremittedevents.md deleted file mode 100644 index 1a8feaf8..00000000 --- a/new-docs/puppeteer.browseremittedevents.md +++ /dev/null @@ -1,23 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserEmittedEvents](./puppeteer.browseremittedevents.md) - -## BrowserEmittedEvents enum - -All the events a [browser instance](./puppeteer.browser.md) may emit. - -<b>Signature:</b> - -```typescript -export declare const enum BrowserEmittedEvents -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| Disconnected | <code>"disconnected"</code> | Emitted when Puppeteer gets disconnected from the Chromium instance. This might happen because of one of the following:<!-- -->- Chromium is closed or crashed<!-- -->- The [browser.disconnect](./puppeteer.browser.disconnect.md) method was called. | -| TargetChanged | <code>"targetchanged"</code> | Emitted when the url of a target changes. Contains a [Target](./puppeteer.target.md) instance. | -| TargetCreated | <code>"targetcreated"</code> | Emitted when a target is created, for example when a new page is opened by [window.open](https://developer.mozilla.org/en-US/docs/Web/API/Window/open) or by [browser.newPage](./puppeteer.browser.newpage.md)<!-- -->Contains a [Target](./puppeteer.target.md) instance. | -| TargetDestroyed | <code>"targetdestroyed"</code> | Emitted when a target is destroyed, for example when a page is closed. Contains a [Target](./puppeteer.target.md) instance. | - diff --git a/new-docs/puppeteer.browserfetcher.candownload.md b/new-docs/puppeteer.browserfetcher.candownload.md deleted file mode 100644 index f0a2d544..00000000 --- a/new-docs/puppeteer.browserfetcher.candownload.md +++ /dev/null @@ -1,30 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcher](./puppeteer.browserfetcher.md) > [canDownload](./puppeteer.browserfetcher.candownload.md) - -## BrowserFetcher.canDownload() method - -Initiates a HEAD request to check if the revision is available. - -<b>Signature:</b> - -```typescript -canDownload(revision: string): Promise<boolean>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| revision | string | The revision to check availability for. | - -<b>Returns:</b> - -Promise<boolean> - -A promise that resolves to `true` if the revision could be downloaded from the host. - -## Remarks - -This method is affected by the current `product`<!-- -->. - diff --git a/new-docs/puppeteer.browserfetcher.download.md b/new-docs/puppeteer.browserfetcher.download.md deleted file mode 100644 index 81725d09..00000000 --- a/new-docs/puppeteer.browserfetcher.download.md +++ /dev/null @@ -1,31 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcher](./puppeteer.browserfetcher.md) > [download](./puppeteer.browserfetcher.download.md) - -## BrowserFetcher.download() method - -Initiates a GET request to download the revision from the host. - -<b>Signature:</b> - -```typescript -download(revision: string, progressCallback?: (x: number, y: number) => void): Promise<BrowserFetcherRevisionInfo>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| revision | string | The revision to download. | -| progressCallback | (x: number, y: number) => void | A function that will be called with two arguments: How many bytes have been downloaded and the total number of bytes of the download. | - -<b>Returns:</b> - -Promise<[BrowserFetcherRevisionInfo](./puppeteer.browserfetcherrevisioninfo.md)<!-- -->> - -A promise with revision information when the revision is downloaded and extracted. - -## Remarks - -This method is affected by the current `product`<!-- -->. - diff --git a/new-docs/puppeteer.browserfetcher.host.md b/new-docs/puppeteer.browserfetcher.host.md deleted file mode 100644 index 5667cb51..00000000 --- a/new-docs/puppeteer.browserfetcher.host.md +++ /dev/null @@ -1,17 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcher](./puppeteer.browserfetcher.md) > [host](./puppeteer.browserfetcher.host.md) - -## BrowserFetcher.host() method - -<b>Signature:</b> - -```typescript -host(): string; -``` -<b>Returns:</b> - -string - -The download host being used. - diff --git a/new-docs/puppeteer.browserfetcher.localrevisions.md b/new-docs/puppeteer.browserfetcher.localrevisions.md deleted file mode 100644 index 8f7c65d1..00000000 --- a/new-docs/puppeteer.browserfetcher.localrevisions.md +++ /dev/null @@ -1,21 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcher](./puppeteer.browserfetcher.md) > [localRevisions](./puppeteer.browserfetcher.localrevisions.md) - -## BrowserFetcher.localRevisions() method - -<b>Signature:</b> - -```typescript -localRevisions(): Promise<string[]>; -``` -<b>Returns:</b> - -Promise<string\[\]> - -A promise with a list of all revision strings (for the current `product`<!-- -->) available locally on disk. - -## Remarks - -This method is affected by the current `product`<!-- -->. - diff --git a/new-docs/puppeteer.browserfetcher.md b/new-docs/puppeteer.browserfetcher.md deleted file mode 100644 index e335b693..00000000 --- a/new-docs/puppeteer.browserfetcher.md +++ /dev/null @@ -1,45 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcher](./puppeteer.browserfetcher.md) - -## BrowserFetcher class - -BrowserFetcher can download and manage different versions of Chromium and Firefox. - -<b>Signature:</b> - -```typescript -export declare class BrowserFetcher -``` - -## Remarks - -BrowserFetcher operates on revision strings that specify a precise version of Chromium, e.g. `"533271"`<!-- -->. Revision strings can be obtained from [omahaproxy.appspot.com](http://omahaproxy.appspot.com/)<!-- -->. In the Firefox case, BrowserFetcher downloads Firefox Nightly and operates on version numbers such as `"75"`<!-- -->. - -The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `BrowserFetcher` class. - -## Example - -An example of using BrowserFetcher to download a specific version of Chromium and running Puppeteer against it: - -```js -const browserFetcher = puppeteer.createBrowserFetcher(); -const revisionInfo = await browserFetcher.download('533271'); -const browser = await puppeteer.launch({executablePath: revisionInfo.executablePath}) - -``` -\*\*NOTE\*\* BrowserFetcher is not designed to work concurrently with other instances of BrowserFetcher that share the same downloads directory. - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [canDownload(revision)](./puppeteer.browserfetcher.candownload.md) | | Initiates a HEAD request to check if the revision is available. | -| [download(revision, progressCallback)](./puppeteer.browserfetcher.download.md) | | Initiates a GET request to download the revision from the host. | -| [host()](./puppeteer.browserfetcher.host.md) | | | -| [localRevisions()](./puppeteer.browserfetcher.localrevisions.md) | | | -| [platform()](./puppeteer.browserfetcher.platform.md) | | | -| [product()](./puppeteer.browserfetcher.product.md) | | | -| [remove(revision)](./puppeteer.browserfetcher.remove.md) | | | -| [revisionInfo(revision)](./puppeteer.browserfetcher.revisioninfo.md) | | | - diff --git a/new-docs/puppeteer.browserfetcher.platform.md b/new-docs/puppeteer.browserfetcher.platform.md deleted file mode 100644 index 84e37a79..00000000 --- a/new-docs/puppeteer.browserfetcher.platform.md +++ /dev/null @@ -1,17 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcher](./puppeteer.browserfetcher.md) > [platform](./puppeteer.browserfetcher.platform.md) - -## BrowserFetcher.platform() method - -<b>Signature:</b> - -```typescript -platform(): Platform; -``` -<b>Returns:</b> - -[Platform](./puppeteer.platform.md) - -Returns the current `Platform`<!-- -->. - diff --git a/new-docs/puppeteer.browserfetcher.product.md b/new-docs/puppeteer.browserfetcher.product.md deleted file mode 100644 index 4066dfce..00000000 --- a/new-docs/puppeteer.browserfetcher.product.md +++ /dev/null @@ -1,17 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcher](./puppeteer.browserfetcher.md) > [product](./puppeteer.browserfetcher.product.md) - -## BrowserFetcher.product() method - -<b>Signature:</b> - -```typescript -product(): Product; -``` -<b>Returns:</b> - -[Product](./puppeteer.product.md) - -Returns the current `Product`<!-- -->. - diff --git a/new-docs/puppeteer.browserfetcher.remove.md b/new-docs/puppeteer.browserfetcher.remove.md deleted file mode 100644 index 334abc5f..00000000 --- a/new-docs/puppeteer.browserfetcher.remove.md +++ /dev/null @@ -1,28 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcher](./puppeteer.browserfetcher.md) > [remove](./puppeteer.browserfetcher.remove.md) - -## BrowserFetcher.remove() method - -<b>Signature:</b> - -```typescript -remove(revision: string): Promise<void>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| revision | string | A revision to remove for the current <code>product</code>. | - -<b>Returns:</b> - -Promise<void> - -A promise that resolves when the revision has been removes or throws if the revision has not been downloaded. - -## Remarks - -This method is affected by the current `product`<!-- -->. - diff --git a/new-docs/puppeteer.browserfetcher.revisioninfo.md b/new-docs/puppeteer.browserfetcher.revisioninfo.md deleted file mode 100644 index 88d4ecad..00000000 --- a/new-docs/puppeteer.browserfetcher.revisioninfo.md +++ /dev/null @@ -1,24 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcher](./puppeteer.browserfetcher.md) > [revisionInfo](./puppeteer.browserfetcher.revisioninfo.md) - -## BrowserFetcher.revisionInfo() method - -<b>Signature:</b> - -```typescript -revisionInfo(revision: string): BrowserFetcherRevisionInfo; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| revision | string | The revision to get info for. | - -<b>Returns:</b> - -[BrowserFetcherRevisionInfo](./puppeteer.browserfetcherrevisioninfo.md) - -The revision info for the given revision. - diff --git a/new-docs/puppeteer.browserfetcheroptions.host.md b/new-docs/puppeteer.browserfetcheroptions.host.md deleted file mode 100644 index bdf86cb8..00000000 --- a/new-docs/puppeteer.browserfetcheroptions.host.md +++ /dev/null @@ -1,11 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcherOptions](./puppeteer.browserfetcheroptions.md) > [host](./puppeteer.browserfetcheroptions.host.md) - -## BrowserFetcherOptions.host property - -<b>Signature:</b> - -```typescript -host?: string; -``` diff --git a/new-docs/puppeteer.browserfetcheroptions.md b/new-docs/puppeteer.browserfetcheroptions.md deleted file mode 100644 index 58d14dd5..00000000 --- a/new-docs/puppeteer.browserfetcheroptions.md +++ /dev/null @@ -1,22 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcherOptions](./puppeteer.browserfetcheroptions.md) - -## BrowserFetcherOptions interface - - -<b>Signature:</b> - -```typescript -export interface BrowserFetcherOptions -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [host](./puppeteer.browserfetcheroptions.host.md) | string | | -| [path](./puppeteer.browserfetcheroptions.path.md) | string | | -| [platform](./puppeteer.browserfetcheroptions.platform.md) | [Platform](./puppeteer.platform.md) | | -| [product](./puppeteer.browserfetcheroptions.product.md) | string | | - diff --git a/new-docs/puppeteer.browserfetcheroptions.path.md b/new-docs/puppeteer.browserfetcheroptions.path.md deleted file mode 100644 index ea0fd9d1..00000000 --- a/new-docs/puppeteer.browserfetcheroptions.path.md +++ /dev/null @@ -1,11 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcherOptions](./puppeteer.browserfetcheroptions.md) > [path](./puppeteer.browserfetcheroptions.path.md) - -## BrowserFetcherOptions.path property - -<b>Signature:</b> - -```typescript -path?: string; -``` diff --git a/new-docs/puppeteer.browserfetcheroptions.platform.md b/new-docs/puppeteer.browserfetcheroptions.platform.md deleted file mode 100644 index cec53aab..00000000 --- a/new-docs/puppeteer.browserfetcheroptions.platform.md +++ /dev/null @@ -1,11 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcherOptions](./puppeteer.browserfetcheroptions.md) > [platform](./puppeteer.browserfetcheroptions.platform.md) - -## BrowserFetcherOptions.platform property - -<b>Signature:</b> - -```typescript -platform?: Platform; -``` diff --git a/new-docs/puppeteer.browserfetcheroptions.product.md b/new-docs/puppeteer.browserfetcheroptions.product.md deleted file mode 100644 index e7125e46..00000000 --- a/new-docs/puppeteer.browserfetcheroptions.product.md +++ /dev/null @@ -1,11 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcherOptions](./puppeteer.browserfetcheroptions.md) > [product](./puppeteer.browserfetcheroptions.product.md) - -## BrowserFetcherOptions.product property - -<b>Signature:</b> - -```typescript -product?: string; -``` diff --git a/new-docs/puppeteer.browserfetcherrevisioninfo.executablepath.md b/new-docs/puppeteer.browserfetcherrevisioninfo.executablepath.md deleted file mode 100644 index ef45fac9..00000000 --- a/new-docs/puppeteer.browserfetcherrevisioninfo.executablepath.md +++ /dev/null @@ -1,11 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcherRevisionInfo](./puppeteer.browserfetcherrevisioninfo.md) > [executablePath](./puppeteer.browserfetcherrevisioninfo.executablepath.md) - -## BrowserFetcherRevisionInfo.executablePath property - -<b>Signature:</b> - -```typescript -executablePath: string; -``` diff --git a/new-docs/puppeteer.browserfetcherrevisioninfo.folderpath.md b/new-docs/puppeteer.browserfetcherrevisioninfo.folderpath.md deleted file mode 100644 index c4ab7a51..00000000 --- a/new-docs/puppeteer.browserfetcherrevisioninfo.folderpath.md +++ /dev/null @@ -1,11 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcherRevisionInfo](./puppeteer.browserfetcherrevisioninfo.md) > [folderPath](./puppeteer.browserfetcherrevisioninfo.folderpath.md) - -## BrowserFetcherRevisionInfo.folderPath property - -<b>Signature:</b> - -```typescript -folderPath: string; -``` diff --git a/new-docs/puppeteer.browserfetcherrevisioninfo.local.md b/new-docs/puppeteer.browserfetcherrevisioninfo.local.md deleted file mode 100644 index eed4b9cb..00000000 --- a/new-docs/puppeteer.browserfetcherrevisioninfo.local.md +++ /dev/null @@ -1,11 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcherRevisionInfo](./puppeteer.browserfetcherrevisioninfo.md) > [local](./puppeteer.browserfetcherrevisioninfo.local.md) - -## BrowserFetcherRevisionInfo.local property - -<b>Signature:</b> - -```typescript -local: boolean; -``` diff --git a/new-docs/puppeteer.browserfetcherrevisioninfo.md b/new-docs/puppeteer.browserfetcherrevisioninfo.md deleted file mode 100644 index d17fc3df..00000000 --- a/new-docs/puppeteer.browserfetcherrevisioninfo.md +++ /dev/null @@ -1,24 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcherRevisionInfo](./puppeteer.browserfetcherrevisioninfo.md) - -## BrowserFetcherRevisionInfo interface - - -<b>Signature:</b> - -```typescript -export interface BrowserFetcherRevisionInfo -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [executablePath](./puppeteer.browserfetcherrevisioninfo.executablepath.md) | string | | -| [folderPath](./puppeteer.browserfetcherrevisioninfo.folderpath.md) | string | | -| [local](./puppeteer.browserfetcherrevisioninfo.local.md) | boolean | | -| [product](./puppeteer.browserfetcherrevisioninfo.product.md) | string | | -| [revision](./puppeteer.browserfetcherrevisioninfo.revision.md) | string | | -| [url](./puppeteer.browserfetcherrevisioninfo.url.md) | string | | - diff --git a/new-docs/puppeteer.browserfetcherrevisioninfo.product.md b/new-docs/puppeteer.browserfetcherrevisioninfo.product.md deleted file mode 100644 index eb32e35b..00000000 --- a/new-docs/puppeteer.browserfetcherrevisioninfo.product.md +++ /dev/null @@ -1,11 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcherRevisionInfo](./puppeteer.browserfetcherrevisioninfo.md) > [product](./puppeteer.browserfetcherrevisioninfo.product.md) - -## BrowserFetcherRevisionInfo.product property - -<b>Signature:</b> - -```typescript -product: string; -``` diff --git a/new-docs/puppeteer.browserfetcherrevisioninfo.revision.md b/new-docs/puppeteer.browserfetcherrevisioninfo.revision.md deleted file mode 100644 index 9fa0d1d5..00000000 --- a/new-docs/puppeteer.browserfetcherrevisioninfo.revision.md +++ /dev/null @@ -1,11 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcherRevisionInfo](./puppeteer.browserfetcherrevisioninfo.md) > [revision](./puppeteer.browserfetcherrevisioninfo.revision.md) - -## BrowserFetcherRevisionInfo.revision property - -<b>Signature:</b> - -```typescript -revision: string; -``` diff --git a/new-docs/puppeteer.browserfetcherrevisioninfo.url.md b/new-docs/puppeteer.browserfetcherrevisioninfo.url.md deleted file mode 100644 index aced0bfc..00000000 --- a/new-docs/puppeteer.browserfetcherrevisioninfo.url.md +++ /dev/null @@ -1,11 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserFetcherRevisionInfo](./puppeteer.browserfetcherrevisioninfo.md) > [url](./puppeteer.browserfetcherrevisioninfo.url.md) - -## BrowserFetcherRevisionInfo.url property - -<b>Signature:</b> - -```typescript -url: string; -``` diff --git a/new-docs/puppeteer.browseroptions.defaultviewport.md b/new-docs/puppeteer.browseroptions.defaultviewport.md deleted file mode 100644 index 5cb4035c..00000000 --- a/new-docs/puppeteer.browseroptions.defaultviewport.md +++ /dev/null @@ -1,11 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserOptions](./puppeteer.browseroptions.md) > [defaultViewport](./puppeteer.browseroptions.defaultviewport.md) - -## BrowserOptions.defaultViewport property - -<b>Signature:</b> - -```typescript -defaultViewport?: Viewport; -``` diff --git a/new-docs/puppeteer.browseroptions.ignorehttpserrors.md b/new-docs/puppeteer.browseroptions.ignorehttpserrors.md deleted file mode 100644 index a1951dde..00000000 --- a/new-docs/puppeteer.browseroptions.ignorehttpserrors.md +++ /dev/null @@ -1,11 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserOptions](./puppeteer.browseroptions.md) > [ignoreHTTPSErrors](./puppeteer.browseroptions.ignorehttpserrors.md) - -## BrowserOptions.ignoreHTTPSErrors property - -<b>Signature:</b> - -```typescript -ignoreHTTPSErrors?: boolean; -``` diff --git a/new-docs/puppeteer.browseroptions.md b/new-docs/puppeteer.browseroptions.md deleted file mode 100644 index 3decd6b9..00000000 --- a/new-docs/puppeteer.browseroptions.md +++ /dev/null @@ -1,22 +0,0 @@ -<!-- Do not edit this file. It is automatically generated by API Documenter. --> - -[Home](./index.md) > [puppeteer](./puppeteer.md) > [BrowserOptions](./puppeteer.browseroptions.md) - -## BrowserOptions interfa…
- Loading branch information