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 Mar 24, 2023
1 parent 823d0ed commit 7617a20
Show file tree
Hide file tree
Showing 755 changed files with 153 additions and 111 deletions.
1 change: 1 addition & 0 deletions docs/chromium-support.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ The following versions of Chromium are supported, mapped to Puppeteer version:

<!-- version-start -->

- Chromium 112.0.5614.0 - [Puppeteer v19.8.0](https://pptr.dev/19.8.0)
- Chromium 111.0.5556.0 - [Puppeteer v19.7.0](https://github.com/puppeteer/puppeteer/blob/v19.7.0/docs/api/index.md)
- Chromium 110.0.5479.0 - [Puppeteer v19.6.0](https://github.com/puppeteer/puppeteer/blob/v19.6.0/docs/api/index.md)
- Chromium 109.0.5412.0 - [Puppeteer v19.4.0](https://github.com/puppeteer/puppeteer/blob/v19.4.0/docs/api/index.md)
Expand Down
10 changes: 5 additions & 5 deletions package-lock.json

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

2 changes: 1 addition & 1 deletion versions.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
const versionsPerRelease = new Map([
// This is a mapping from Chromium version => Puppeteer version.
// In Chromium roll patches, use `NEXT` for the Puppeteer version.
['112.0.5614.0', 'NEXT'],
['112.0.5614.0', 'v19.8.0'],
['111.0.5556.0', 'v19.7.0'],
['110.0.5479.0', 'v19.6.0'],
['109.0.5412.0', 'v19.4.0'],
Expand Down

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,6 @@ sidebar_label: API
| [ClickOptions](./puppeteer.clickoptions.md) | |
| [CommonEventEmitter](./puppeteer.commoneventemitter.md) | |
| [Configuration](./puppeteer.configuration.md) | <p>Defines options to configure Puppeteer's behavior during installation and runtime.</p><p>See individual properties for more information.</p> |
| [ConnectionCallback](./puppeteer.connectioncallback.md) | |
| [ConnectionTransport](./puppeteer.connectiontransport.md) | |
| [ConnectOptions](./puppeteer.connectoptions.md) | |
| [ConsoleMessageLocation](./puppeteer.consolemessagelocation.md) | |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,6 @@ export interface BrowserConnectOptions
| ---------------------------------------------------------------------------- | --------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | ------- |
| [defaultViewport?](./puppeteer.browserconnectoptions.defaultviewport.md) | | [Viewport](./puppeteer.viewport.md) \| null | _(Optional)_ Sets the viewport for each page. | |
| [ignoreHTTPSErrors?](./puppeteer.browserconnectoptions.ignorehttpserrors.md) | | boolean | _(Optional)_ Whether to ignore HTTPS errors during navigation. | false |
| [protocolTimeout?](./puppeteer.browserconnectoptions.protocoltimeout.md) | | number | _(Optional)_ Timeout setting for individual protocol (CDP) calls. | 30000 |
| [slowMo?](./puppeteer.browserconnectoptions.slowmo.md) | | number | _(Optional)_ Slows down Puppeteer operations by the specified amount of milliseconds to aid debugging. | |
| [targetFilter?](./puppeteer.browserconnectoptions.targetfilter.md) | | [TargetFilterCallback](./puppeteer.targetfiltercallback.md) | _(Optional)_ Callback to decide if Puppeteer should connect to a given target or not. | |
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
sidebar_label: BrowserConnectOptions.protocolTimeout
---

# BrowserConnectOptions.protocolTimeout property

Timeout setting for individual protocol (CDP) calls.

#### Signature:

```typescript
interface BrowserConnectOptions {
protocolTimeout?: number;
}
```

#### Default value:

30000
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,12 @@ Constructs a new instance of the `Connection` class

```typescript
class Connection {
constructor(url: string, transport: ConnectionTransport, delay?: number);
constructor(
url: string,
transport: ConnectionTransport,
delay?: number,
timeout?: number
);
}
```

Expand All @@ -21,3 +26,4 @@ class Connection {
| url | string | |
| transport | [ConnectionTransport](./puppeteer.connectiontransport.md) | |
| delay | number | _(Optional)_ |
| timeout | number | _(Optional)_ |
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,15 @@ export declare class Connection extends EventEmitter
## Constructors
| Constructor | Modifiers | Description |
| ------------------------------------------------------------------------------- | --------- | -------------------------------------------------------------- |
| [(constructor)(url, transport, delay)](./puppeteer.connection._constructor_.md) | | Constructs a new instance of the <code>Connection</code> class |
| Constructor | Modifiers | Description |
| ---------------------------------------------------------------------------------------- | --------- | -------------------------------------------------------------- |
| [(constructor)(url, transport, delay, timeout)](./puppeteer.connection._constructor_.md) | | Constructs a new instance of the <code>Connection</code> class |
## Properties
| Property | Modifiers | Type | Description |
| -------------------------------------------- | --------------------- | ------ | ----------- |
| [timeout](./puppeteer.connection.timeout.md) | <code>readonly</code> | number | |
## Methods
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
sidebar_label: Connection.timeout
---

# Connection.timeout property

#### Signature:

```typescript
class Connection {
get timeout(): number;
}
```
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@ console.log(text);
| [title()](./puppeteer.frame.title.md) | | |
| [type(selector, text, options)](./puppeteer.frame.type.md) | | Sends a <code>keydown</code>, <code>keypress</code>/<code>input</code>, and <code>keyup</code> event for each character in the text. |
| [url()](./puppeteer.frame.url.md) | | |
| [waitForDevicePrompt(options)](./puppeteer.frame.waitfordeviceprompt.md) | | <p>This method is typically coupled with an action that triggers a device request from an api such as WebBluetooth.</p><p>:::caution</p><p>This must be called before the device request is made. It will not return a currently active device prompt.</p><p>:::</p> |
| [waitForFunction(pageFunction, options, args)](./puppeteer.frame.waitforfunction.md) | | |
| [waitForNavigation(options)](./puppeteer.frame.waitfornavigation.md) | | <p>Waits for the frame to navigate. It is useful for when you run code which will indirectly cause the frame to navigate.</p><p>Usage of the [History API](https://developer.mozilla.org/en-US/docs/Web/API/History_API) to change the URL is considered a navigation.</p> |
| [waitForSelector(selector, options)](./puppeteer.frame.waitforselector.md) | | <p>Waits for an element matching the given selector to appear in the frame.</p><p>This method works across navigations.</p> |
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
sidebar_label: Frame.waitForDevicePrompt
---

# Frame.waitForDevicePrompt() method

This method is typically coupled with an action that triggers a device request from an api such as WebBluetooth.

:::caution

This must be called before the device request is made. It will not return a currently active device prompt.

:::

#### Signature:

```typescript
class Frame {
waitForDevicePrompt(
options?: WaitTimeoutOptions
): Promise<DeviceRequestPrompt>;
}
```

## Parameters

| Parameter | Type | Description |
| --------- | ------------------------------------------------------- | ------------ |
| options | [WaitTimeoutOptions](./puppeteer.waittimeoutoptions.md) | _(Optional)_ |

**Returns:**

Promise&lt;DeviceRequestPrompt&gt;

## Example

```ts
const [devicePrompt] = Promise.all([
frame.waitForDevicePrompt(),
frame.click('#connect-bluetooth'),
]);
await devicePrompt.select(
await devicePrompt.waitForDevice(({name}) => name.includes('My Device'))
);
```

0 comments on commit 7617a20

Please sign in to comment.