Skip to content

Commit

Permalink
chore: generate versioned docs
Browse files Browse the repository at this point in the history
  • Loading branch information
release-please[bot] committed Dec 4, 2023
1 parent 3126f68 commit 0dcd0d9
Show file tree
Hide file tree
Showing 587 changed files with 551 additions and 328 deletions.
12 changes: 6 additions & 6 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

23 changes: 0 additions & 23 deletions website/versioned_docs/version-21.5.2/browsers-api/browsers.cli.md

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,7 @@ sidebar_label: API
| [Predicate](./puppeteer.predicate.md) | |
| [Product](./puppeteer.product.md) | Supported products. |
| [ProtocolLifeCycleEvent](./puppeteer.protocollifecycleevent.md) | |
| [ProtocolType](./puppeteer.protocoltype.md) | |
| [PuppeteerLifeCycleEvent](./puppeteer.puppeteerlifecycleevent.md) | |
| [PuppeteerNodeLaunchOptions](./puppeteer.puppeteernodelaunchoptions.md) | Utility type exposed to enable users to define options that can be passed to <code>puppeteer.launch</code> without having to list the set of all types. |
| [Quad](./puppeteer.quad.md) | |
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
sidebar_label: AutofillData
---

# AutofillData interface

#### Signature:

```typescript
export interface AutofillData
```

## Properties

| Property | Modifiers | Type | Description | Default |
| ---------- | --------- | ------------------------------------------------------------------------------------------------- | ----------- | ------- |
| creditCard | | &#123; number: string; name: string; expiryMonth: string; expiryYear: string; cvc: string; &#125; | | |
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ Disconnects Puppeteer from this [browser](./puppeteer.browser.md), but leaves th

```typescript
class Browser {
abstract disconnect(): void;
abstract disconnect(): Promise<void>;
}
```

**Returns:**

void
Promise&lt;void&gt;
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ const browser = await puppeteer.launch();
// Store the endpoint to be able to reconnect to the browser.
const browserWSEndpoint = browser.wsEndpoint();
// Disconnect puppeteer from the browser.
browser.disconnect();
await browser.disconnect();

// Use the endpoint to reestablish a connection
const browser2 = await puppeteer.connect({browserWSEndpoint});
Expand Down Expand Up @@ -78,4 +78,4 @@ await browser2.close();
| [userAgent()](./puppeteer.browser.useragent.md) | | <p>Gets this [browser's](./puppeteer.browser.md) original user agent.</p><p>[Pages](./puppeteer.page.md) can override the user agent with [Page.setUserAgent()](./puppeteer.page.setuseragent.md).</p> |
| [version()](./puppeteer.browser.version.md) | | <p>Gets a string representing this [browser's](./puppeteer.browser.md) name and version.</p><p>For headless browser, this is similar to <code>&quot;HeadlessChrome/61.0.3153.0&quot;</code>. For non-headless or new-headless, this is similar to <code>&quot;Chrome/61.0.3153.0&quot;</code>. For Firefox, it is similar to <code>&quot;Firefox/116.0a1&quot;</code>.</p><p>The format of [Browser.version()](./puppeteer.browser.version.md) might change with future releases of browsers.</p> |
| [waitForTarget(predicate, options)](./puppeteer.browser.waitfortarget.md) | | <p>Waits until a [target](./puppeteer.target.md) matching the given <code>predicate</code> appears and returns it.</p><p>This will look all open [browser contexts](./puppeteer.browsercontext.md).</p> |
| [wsEndpoint()](./puppeteer.browser.wsendpoint.md) | | <p>Gets the WebSocket URL to connect to this [browser](./puppeteer.browser.md).</p><p>This is usually used with [Puppeteer.connect()](./puppeteer.puppeteer.connect.md).</p><p>You can find the debugger URL (<code>webSocketDebuggerUrl</code>) from <code>http://$\{host\}:$\{port\}/json/version</code>.</p><p>See [browser endpoint](https://chromedevtools.github.io/devtools-protocol/#how-do-i-access-the-browser-target) for more information.</p> |
| [wsEndpoint()](./puppeteer.browser.wsendpoint.md) | | <p>Gets the WebSocket URL to connect to this [browser](./puppeteer.browser.md).</p><p>This is usually used with [Puppeteer.connect()](./puppeteer.puppeteer.connect.md).</p><p>You can find the debugger URL (<code>webSocketDebuggerUrl</code>) from <code>http://HOST:PORT/json/version</code>.</p><p>See [browser endpoint](https://chromedevtools.github.io/devtools-protocol/#how-do-i-access-the-browser-target) for more information.</p> |
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Gets the WebSocket URL to connect to this [browser](./puppeteer.browser.md).

This is usually used with [Puppeteer.connect()](./puppeteer.puppeteer.connect.md).

You can find the debugger URL (`webSocketDebuggerUrl`) from `http://${host}:${port}/json/version`.
You can find the debugger URL (`webSocketDebuggerUrl`) from `http://HOST:PORT/json/version`.

See [browser endpoint](https://chromedevtools.github.io/devtools-protocol/#how-do-i-access-the-browser-target) for more information.

Expand All @@ -26,4 +26,4 @@ string

## Remarks

The format is always `ws://${host}:${port}/devtools/browser/<id>`.
The format is always `ws://HOST:PORT/devtools/browser/<id>`.
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,11 @@ export interface BrowserConnectOptions

## Properties

| Property | Modifiers | Type | Description | Default |
| ----------------- | --------------------- | ----------------------------------------------------------- | ----------------------------------------------------------------------------------------- | -------------------- |
| defaultViewport | <code>optional</code> | [Viewport](./puppeteer.viewport.md) \| null | Sets the viewport for each page. | |
| ignoreHTTPSErrors | <code>optional</code> | boolean | Whether to ignore HTTPS errors during navigation. | <code>false</code> |
| protocolTimeout | <code>optional</code> | number | Timeout setting for individual protocol (CDP) calls. | <code>180_000</code> |
| slowMo | <code>optional</code> | number | Slows down Puppeteer operations by the specified amount of milliseconds to aid debugging. | |
| targetFilter | <code>optional</code> | [TargetFilterCallback](./puppeteer.targetfiltercallback.md) | Callback to decide if Puppeteer should connect to a given target or not. | |
| Property | Modifiers | Type | Description | Default |
| ----------------- | --------------------- | ----------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ------------------------------------- |
| defaultViewport | <code>optional</code> | [Viewport](./puppeteer.viewport.md) \| null | Sets the viewport for each page. | '&#123;width: 800, height: 600&#125;' |
| ignoreHTTPSErrors | <code>optional</code> | boolean | Whether to ignore HTTPS errors during navigation. | <code>false</code> |
| protocol | <code>optional</code> | [ProtocolType](./puppeteer.protocoltype.md) | | 'cdp' |
| protocolTimeout | <code>optional</code> | number | Timeout setting for individual protocol (CDP) calls. | <code>180_000</code> |
| slowMo | <code>optional</code> | number | Slows down Puppeteer operations by the specified amount of milliseconds to aid debugging. | |
| targetFilter | <code>optional</code> | [TargetFilterCallback](./puppeteer.targetfiltercallback.md) | Callback to decide if Puppeteer should connect to a given target or not. | |
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ export interface CoverageEntry

## Properties

| Property | Modifiers | Type | Description | Default |
| -------- | --------- | -------------------------------------------- | --------------------------------------------- | ------- |
| ranges | | Array&lt;\{ start: number; end: number; \}&gt; | The covered range as start and end positions. | |
| text | | string | The content of the style sheet or script. | |
| url | | string | The URL of the style sheet or script. | |
| Property | Modifiers | Type | Description | Default |
| -------- | --------- | ------------------------------------------------------ | --------------------------------------------- | ------- |
| ranges | | Array&lt;&#123; start: number; end: number; &#125;&gt; | The covered range as start and end positions. | |
| text | | string | The content of the style sheet or script. | |
| url | | string | The URL of the style sheet or script. | |
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ class CSSCoverage {

## Parameters

| Parameter | Type | Description |
| --------- | -------------------------------- | ------------ |
| options | \{ resetOnNavigation?: boolean; \} | _(Optional)_ |
| Parameter | Type | Description |
| --------- | ------------------------------------------ | ------------ |
| options | &#123; resetOnNavigation?: boolean; &#125; | _(Optional)_ |

**Returns:**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ class ElementHandle {
| --------- | ------------------------------------------------------------ | ------------ |
| this | [ElementHandle](./puppeteer.elementhandle.md)&lt;Element&gt; | |
| target | [ElementHandle](./puppeteer.elementhandle.md)&lt;Node&gt; | |
| options | \{ delay: number; \} | _(Optional)_ |
| options | &#123; delay: number; &#125; | _(Optional)_ |

**Returns:**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ class ElementHandle {
| Parameter | Type | Description |
| --------- | ------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------- |
| this | [ElementHandle](./puppeteer.elementhandle.md)&lt;Element&gt; | |
| options | \{ threshold?: number; \} | _(Optional)_ Threshold for the intersection between 0 (no intersection) and 1 (full intersection). Defaults to 1. |
| options | &#123; threshold?: number; &#125; | _(Optional)_ Threshold for the intersection between 0 (no intersection) and 1 (full intersection). Defaults to 1. |

**Returns:**

Expand Down

0 comments on commit 0dcd0d9

Please sign in to comment.