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 28, 2023
1 parent 6b3196d commit 7dce823
Show file tree
Hide file tree
Showing 758 changed files with 268 additions and 72 deletions.
2 changes: 1 addition & 1 deletion docs/chromium-support.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +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 112.0.5614.0 - [Puppeteer v19.8.0](https://github.com/puppeteer/puppeteer/blob/v19.8.0/docs/api/index.md)
- 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
8 changes: 4 additions & 4 deletions package-lock.json

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

23 changes: 0 additions & 23 deletions website/versioned_docs/version-19.8.0/api/puppeteer.page.pdf.md

This file was deleted.

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +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 |
| [protocolTimeout?](./puppeteer.browserconnectoptions.protocoltimeout.md) | | number | _(Optional)_ Timeout setting for individual protocol (CDP) calls. | 180000 |
| [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
Expand Up @@ -16,4 +16,4 @@ interface BrowserConnectOptions {

#### Default value:

30000
180000
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
sidebar_label: DeviceRequestPrompt.cancel
---

# DeviceRequestPrompt.cancel() method

Cancel the prompt.

#### Signature:

```typescript
class DeviceRequestPrompt {
cancel(): Promise<void>;
}
```

**Returns:**

Promise&lt;void&gt;
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
sidebar_label: DeviceRequestPrompt.devices
---

# DeviceRequestPrompt.devices property

Current list of selectable devices.

#### Signature:

```typescript
class DeviceRequestPrompt {
devices: DeviceRequestPromptDevice[];
}
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
sidebar_label: DeviceRequestPrompt
---

# DeviceRequestPrompt class

Device request prompts let you respond to the page requesting for a device through an API like WebBluetooth.

#### Signature:

```typescript
export declare class DeviceRequestPrompt
```

## Remarks

`DeviceRequestPrompt` instances are returned via the [Page.waitForDevicePrompt()](./puppeteer.page.waitfordeviceprompt.md) method.

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `DeviceRequestPrompt` class.

## Example

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

## Properties

| Property | Modifiers | Type | Description |
| ----------------------------------------------------- | --------- | ------------------------------------------------------------------------- | ----------------------------------- |
| [devices](./puppeteer.devicerequestprompt.devices.md) | | [DeviceRequestPromptDevice](./puppeteer.devicerequestpromptdevice.md)\[\] | Current list of selectable devices. |

## Methods

| Method | Modifiers | Description |
| ---------------------------------------------------------------------------------- | --------- | ------------------------------------------------------------ |
| [cancel()](./puppeteer.devicerequestprompt.cancel.md) | | Cancel the prompt. |
| [select(device)](./puppeteer.devicerequestprompt.select.md) | | Select a device in the prompt's list. |
| [waitForDevice(filter, options)](./puppeteer.devicerequestprompt.waitfordevice.md) | | Resolve to the first device in the prompt matching a filter. |
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
sidebar_label: DeviceRequestPrompt.select
---

# DeviceRequestPrompt.select() method

Select a device in the prompt's list.

#### Signature:

```typescript
class DeviceRequestPrompt {
select(device: DeviceRequestPromptDevice): Promise<void>;
}
```

## Parameters

| Parameter | Type | Description |
| --------- | --------------------------------------------------------------------- | ----------- |
| device | [DeviceRequestPromptDevice](./puppeteer.devicerequestpromptdevice.md) | |

**Returns:**

Promise&lt;void&gt;
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
sidebar_label: DeviceRequestPrompt.waitForDevice
---

# DeviceRequestPrompt.waitForDevice() method

Resolve to the first device in the prompt matching a filter.

#### Signature:

```typescript
class DeviceRequestPrompt {
waitForDevice(
filter: (device: DeviceRequestPromptDevice) => boolean,
options?: WaitTimeoutOptions
): Promise<DeviceRequestPromptDevice>;
}
```

## Parameters

| Parameter | Type | Description |
| --------- | --------------------------------------------------------------------------------------------- | ------------ |
| filter | (device: [DeviceRequestPromptDevice](./puppeteer.devicerequestpromptdevice.md)) =&gt; boolean | |
| options | [WaitTimeoutOptions](./puppeteer.waittimeoutoptions.md) | _(Optional)_ |

**Returns:**

Promise&lt;[DeviceRequestPromptDevice](./puppeteer.devicerequestpromptdevice.md)&gt;
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
sidebar_label: DeviceRequestPromptDevice.id
---

# DeviceRequestPromptDevice.id property

Device id during a prompt.

#### Signature:

```typescript
class DeviceRequestPromptDevice {
id: string;
}
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
sidebar_label: DeviceRequestPromptDevice
---

# DeviceRequestPromptDevice class

Device in a request prompt.

#### Signature:

```typescript
export declare class DeviceRequestPromptDevice
```

## 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 `DeviceRequestPromptDevice` class.

## Properties

| Property | Modifiers | Type | Description |
| ----------------------------------------------------- | --------- | ------ | -------------------------------------- |
| [id](./puppeteer.devicerequestpromptdevice.id.md) | | string | Device id during a prompt. |
| [name](./puppeteer.devicerequestpromptdevice.name.md) | | string | Device name as it appears in a prompt. |
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
sidebar_label: DeviceRequestPromptDevice.name
---

# DeviceRequestPromptDevice.name property

Device name as it appears in a prompt.

#### Signature:

```typescript
class DeviceRequestPromptDevice {
name: string;
}
```
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ class Frame {

**Returns:**

Promise&lt;DeviceRequestPrompt&gt;
Promise&lt;[DeviceRequestPrompt](./puppeteer.devicerequestprompt.md)&gt;

## Example

Expand Down

0 comments on commit 7dce823

Please sign in to comment.