mirror of
https://github.com/puppeteer/puppeteer
synced 2024-06-14 14:02:48 +00:00
docs: remove unhelpful api pages (#9933)
This commit is contained in:
Nikolay Vitkov
GitHub
parent
9af680d3e5
commit
a99abc9a2f
@ -1,15 +0,0 @@
|
||||
---
|
||||
sidebar_label: BoundingBox.height
|
||||
---
|
||||
|
||||
# BoundingBox.height property
|
||||
|
||||
the height of the element in pixels.
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface BoundingBox {
|
||||
height: number;
|
||||
}
|
||||
```
|
||||
@ -14,7 +14,7 @@ export interface BoundingBox extends Point
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description | Default |
|
||||
| ------------------------------------------- | --------- | ------ | ------------------------------------ | ------- |
|
||||
| [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. | |
|
||||
| Property | Modifiers | Type | Description | Default |
|
||||
| -------- | --------- | ------ | ------------------------------------ | ------- |
|
||||
| height | | number | the height of the element in pixels. | |
|
||||
| width | | number | the width of the element in pixels. | |
|
||||
|
||||
@ -1,15 +0,0 @@
|
||||
---
|
||||
sidebar_label: BoundingBox.width
|
||||
---
|
||||
|
||||
# BoundingBox.width property
|
||||
|
||||
the width of the element in pixels.
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface BoundingBox {
|
||||
width: number;
|
||||
}
|
||||
```
|
||||
@ -1,13 +0,0 @@
|
||||
---
|
||||
sidebar_label: BoxModel.border
|
||||
---
|
||||
|
||||
# BoxModel.border property
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface BoxModel {
|
||||
border: Point[];
|
||||
}
|
||||
```
|
||||
@ -1,13 +0,0 @@
|
||||
---
|
||||
sidebar_label: BoxModel.content
|
||||
---
|
||||
|
||||
# BoxModel.content property
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface BoxModel {
|
||||
content: Point[];
|
||||
}
|
||||
```
|
||||
@ -1,13 +0,0 @@
|
||||
---
|
||||
sidebar_label: BoxModel.height
|
||||
---
|
||||
|
||||
# BoxModel.height property
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface BoxModel {
|
||||
height: number;
|
||||
}
|
||||
```
|
||||
@ -1,13 +0,0 @@
|
||||
---
|
||||
sidebar_label: BoxModel.margin
|
||||
---
|
||||
|
||||
# BoxModel.margin property
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface BoxModel {
|
||||
margin: Point[];
|
||||
}
|
||||
```
|
||||
@ -12,11 +12,11 @@ export interface BoxModel
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description | Default |
|
||||
| ------------------------------------------ | --------- | --------------------------------- | ----------- | ------- |
|
||||
| [border](./puppeteer.boxmodel.border.md) | | [Point](./puppeteer.point.md)\[\] | | |
|
||||
| [content](./puppeteer.boxmodel.content.md) | | [Point](./puppeteer.point.md)\[\] | | |
|
||||
| [height](./puppeteer.boxmodel.height.md) | | number | | |
|
||||
| [margin](./puppeteer.boxmodel.margin.md) | | [Point](./puppeteer.point.md)\[\] | | |
|
||||
| [padding](./puppeteer.boxmodel.padding.md) | | [Point](./puppeteer.point.md)\[\] | | |
|
||||
| [width](./puppeteer.boxmodel.width.md) | | number | | |
|
||||
| Property | Modifiers | Type | Description | Default |
|
||||
| -------- | --------- | --------------------------------- | ----------- | ------- |
|
||||
| border | | [Point](./puppeteer.point.md)\[\] | | |
|
||||
| content | | [Point](./puppeteer.point.md)\[\] | | |
|
||||
| height | | number | | |
|
||||
| margin | | [Point](./puppeteer.point.md)\[\] | | |
|
||||
| padding | | [Point](./puppeteer.point.md)\[\] | | |
|
||||
| width | | number | | |
|
||||
|
||||
@ -1,13 +0,0 @@
|
||||
---
|
||||
sidebar_label: BoxModel.padding
|
||||
---
|
||||
|
||||
# BoxModel.padding property
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface BoxModel {
|
||||
padding: Point[];
|
||||
}
|
||||
```
|
||||
@ -1,13 +0,0 @@
|
||||
---
|
||||
sidebar_label: BoxModel.width
|
||||
---
|
||||
|
||||
# BoxModel.width property
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface BoxModel {
|
||||
width: number;
|
||||
}
|
||||
```
|
||||
@ -1,15 +0,0 @@
|
||||
---
|
||||
sidebar_label: BrowserConnectOptions.defaultViewport
|
||||
---
|
||||
|
||||
# BrowserConnectOptions.defaultViewport property
|
||||
|
||||
Sets the viewport for each page.
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface BrowserConnectOptions {
|
||||
defaultViewport?: Viewport | null;
|
||||
}
|
||||
```
|
||||
@ -1,19 +0,0 @@
|
||||
---
|
||||
sidebar_label: BrowserConnectOptions.ignoreHTTPSErrors
|
||||
---
|
||||
|
||||
# BrowserConnectOptions.ignoreHTTPSErrors property
|
||||
|
||||
Whether to ignore HTTPS errors during navigation.
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface BrowserConnectOptions {
|
||||
ignoreHTTPSErrors?: boolean;
|
||||
}
|
||||
```
|
||||
|
||||
#### Default value:
|
||||
|
||||
false
|
||||
@ -14,10 +14,10 @@ export interface BrowserConnectOptions
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description | Default |
|
||||
| ---------------------------------------------------------------------------- | --------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | ------- |
|
||||
| [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. | 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. | |
|
||||
| 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. | false |
|
||||
| protocolTimeout | <code>optional</code> | number | Timeout setting for individual protocol (CDP) calls. | 180000 |
|
||||
| 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. | |
|
||||
|
||||
@ -1,19 +0,0 @@
|
||||
---
|
||||
sidebar_label: BrowserConnectOptions.protocolTimeout
|
||||
---
|
||||
|
||||
# BrowserConnectOptions.protocolTimeout property
|
||||
|
||||
Timeout setting for individual protocol (CDP) calls.
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface BrowserConnectOptions {
|
||||
protocolTimeout?: number;
|
||||
}
|
||||
```
|
||||
|
||||
#### Default value:
|
||||
|
||||
180000
|
||||
@ -1,15 +0,0 @@
|
||||
---
|
||||
sidebar_label: BrowserConnectOptions.slowMo
|
||||
---
|
||||
|
||||
# BrowserConnectOptions.slowMo property
|
||||
|
||||
Slows down Puppeteer operations by the specified amount of milliseconds to aid debugging.
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface BrowserConnectOptions {
|
||||
slowMo?: number;
|
||||
}
|
||||
```
|
||||
@ -1,15 +0,0 @@
|
||||
---
|
||||
sidebar_label: BrowserConnectOptions.targetFilter
|
||||
---
|
||||
|
||||
# BrowserConnectOptions.targetFilter property
|
||||
|
||||
Callback to decide if Puppeteer should connect to a given target or not.
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface BrowserConnectOptions {
|
||||
targetFilter?: TargetFilterCallback;
|
||||
}
|
||||
```
|
||||
@ -1,13 +0,0 @@
|
||||
---
|
||||
sidebar_label: BrowserContext.id
|
||||
---
|
||||
|
||||
# BrowserContext.id property
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
class BrowserContext {
|
||||
get id(): string | undefined;
|
||||
}
|
||||
```
|
||||
@ -39,9 +39,9 @@ await context.close();
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| -------------------------------------- | --------------------- | ------------------- | ----------- |
|
||||
| [id](./puppeteer.browsercontext.id.md) | <code>readonly</code> | string \| undefined | |
|
||||
| Property | Modifiers | Type | Description |
|
||||
| -------- | --------------------- | ------------------- | ----------- |
|
||||
| id | <code>readonly</code> | string \| undefined | |
|
||||
|
||||
## Methods
|
||||
|
||||
|
||||
@ -14,7 +14,7 @@ export interface BrowserContextOptions
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description | Default |
|
||||
| ------------------------------------------------------------------------ | --------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ------- |
|
||||
| [proxyBypassList?](./puppeteer.browsercontextoptions.proxybypasslist.md) | | string\[\] | _(Optional)_ Bypass the proxy for the given list of hosts. | |
|
||||
| [proxyServer?](./puppeteer.browsercontextoptions.proxyserver.md) | | string | _(Optional)_ Proxy server with optional port to use for all requests. Username and password can be set in <code>Page.authenticate</code>. | |
|
||||
| Property | Modifiers | Type | Description | Default |
|
||||
| --------------- | --------------------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------- | ------- |
|
||||
| proxyBypassList | <code>optional</code> | string\[\] | Bypass the proxy for the given list of hosts. | |
|
||||
| proxyServer | <code>optional</code> | string | Proxy server with optional port to use for all requests. Username and password can be set in <code>Page.authenticate</code>. | |
|
||||
|
||||
@ -1,15 +0,0 @@
|
||||
---
|
||||
sidebar_label: BrowserContextOptions.proxyBypassList
|
||||
---
|
||||
|
||||
# BrowserContextOptions.proxyBypassList property
|
||||
|
||||
Bypass the proxy for the given list of hosts.
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface BrowserContextOptions {
|
||||
proxyBypassList?: string[];
|
||||
}
|
||||
```
|
||||
@ -1,15 +0,0 @@
|
||||
---
|
||||
sidebar_label: BrowserContextOptions.proxyServer
|
||||
---
|
||||
|
||||
# BrowserContextOptions.proxyServer property
|
||||
|
||||
Proxy server with optional port to use for all requests. Username and password can be set in `Page.authenticate`.
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface BrowserContextOptions {
|
||||
proxyServer?: string;
|
||||
}
|
||||
```
|
||||
@ -1,21 +0,0 @@
|
||||
---
|
||||
sidebar_label: BrowserFetcherOptions.host
|
||||
---
|
||||
|
||||
# BrowserFetcherOptions.host property
|
||||
|
||||
Determines the host that will be used for downloading.
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface BrowserFetcherOptions {
|
||||
host?: string;
|
||||
}
|
||||
```
|
||||
|
||||
#### Default value:
|
||||
|
||||
Either
|
||||
|
||||
- https://storage.googleapis.com or - https://archive.mozilla.org/pub/firefox/nightly/latest-mozilla-central
|
||||
@ -12,10 +12,10 @@ export interface BrowserFetcherOptions
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description | Default |
|
||||
| ---------------------------------------------------------------------------- | --------- | ----------------------------------- | ------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| [host?](./puppeteer.browserfetcheroptions.host.md) | | string | _(Optional)_ Determines the host that will be used for downloading. | <p>Either</p><p>- https://storage.googleapis.com or - https://archive.mozilla.org/pub/firefox/nightly/latest-mozilla-central</p> |
|
||||
| [path](./puppeteer.browserfetcheroptions.path.md) | | string | Determines the path to download browsers to. | |
|
||||
| [platform?](./puppeteer.browserfetcheroptions.platform.md) | | [Platform](./puppeteer.platform.md) | _(Optional)_ Determines which platform the browser will be suited for. | Auto-detected. |
|
||||
| [product?](./puppeteer.browserfetcheroptions.product.md) | | 'chrome' \| 'firefox' | _(Optional)_ Determines which product the [BrowserFetcher](./puppeteer.browserfetcher.md) is for. | <code>"chrome"</code>. |
|
||||
| [useMacOSARMBinary?](./puppeteer.browserfetcheroptions.usemacosarmbinary.md) | | boolean | _(Optional)_ Enables the use of the Chromium binary for macOS ARM. | |
|
||||
| Property | Modifiers | Type | Description | Default |
|
||||
| ----------------- | --------------------- | ----------------------------------- | ------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| host | <code>optional</code> | string | Determines the host that will be used for downloading. | <p>Either</p><p>- https://storage.googleapis.com or - https://archive.mozilla.org/pub/firefox/nightly/latest-mozilla-central</p> |
|
||||
| path | | string | Determines the path to download browsers to. | |
|
||||
| platform | <code>optional</code> | [Platform](./puppeteer.platform.md) | Determines which platform the browser will be suited for. | Auto-detected. |
|
||||
| product | <code>optional</code> | 'chrome' \| 'firefox' | Determines which product the [BrowserFetcher](./puppeteer.browserfetcher.md) is for. | <code>"chrome"</code>. |
|
||||
| useMacOSARMBinary | <code>optional</code> | boolean | Enables the use of the Chromium binary for macOS ARM. | |
|
||||
|
||||
@ -1,15 +0,0 @@
|
||||
---
|
||||
sidebar_label: BrowserFetcherOptions.path
|
||||
---
|
||||
|
||||
# BrowserFetcherOptions.path property
|
||||
|
||||
Determines the path to download browsers to.
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface BrowserFetcherOptions {
|
||||
path: string;
|
||||
}
|
||||
```
|
||||
@ -1,19 +0,0 @@
|
||||
---
|
||||
sidebar_label: BrowserFetcherOptions.platform
|
||||
---
|
||||
|
||||
# BrowserFetcherOptions.platform property
|
||||
|
||||
Determines which platform the browser will be suited for.
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface BrowserFetcherOptions {
|
||||
platform?: Platform;
|
||||
}
|
||||
```
|
||||
|
||||
#### Default value:
|
||||
|
||||
Auto-detected.
|
||||
@ -1,19 +0,0 @@
|
||||
---
|
||||
sidebar_label: BrowserFetcherOptions.product
|
||||
---
|
||||
|
||||
# BrowserFetcherOptions.product property
|
||||
|
||||
Determines which product the [BrowserFetcher](./puppeteer.browserfetcher.md) is for.
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface BrowserFetcherOptions {
|
||||
product?: 'chrome' | 'firefox';
|
||||
}
|
||||
```
|
||||
|
||||
#### Default value:
|
||||
|
||||
`"chrome"`.
|
||||
@ -1,15 +0,0 @@
|
||||
---
|
||||
sidebar_label: BrowserFetcherOptions.useMacOSARMBinary
|
||||
---
|
||||
|
||||
# BrowserFetcherOptions.useMacOSARMBinary property
|
||||
|
||||
Enables the use of the Chromium binary for macOS ARM.
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface BrowserFetcherOptions {
|
||||
useMacOSARMBinary?: boolean;
|
||||
}
|
||||
```
|
||||
@ -1,13 +0,0 @@
|
||||
---
|
||||
sidebar_label: BrowserFetcherRevisionInfo.executablePath
|
||||
---
|
||||
|
||||
# BrowserFetcherRevisionInfo.executablePath property
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface BrowserFetcherRevisionInfo {
|
||||
executablePath: string;
|
||||
}
|
||||
```
|
||||
@ -1,13 +0,0 @@
|
||||
---
|
||||
sidebar_label: BrowserFetcherRevisionInfo.folderPath
|
||||
---
|
||||
|
||||
# BrowserFetcherRevisionInfo.folderPath property
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface BrowserFetcherRevisionInfo {
|
||||
folderPath: string;
|
||||
}
|
||||
```
|
||||
@ -1,13 +0,0 @@
|
||||
---
|
||||
sidebar_label: BrowserFetcherRevisionInfo.local
|
||||
---
|
||||
|
||||
# BrowserFetcherRevisionInfo.local property
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface BrowserFetcherRevisionInfo {
|
||||
local: boolean;
|
||||
}
|
||||
```
|
||||
@ -12,11 +12,11 @@ export interface BrowserFetcherRevisionInfo
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description | Default |
|
||||
| -------------------------------------------------------------------------- | --------- | ------- | ----------- | ------- |
|
||||
| [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 | | |
|
||||
| Property | Modifiers | Type | Description | Default |
|
||||
| -------------- | --------- | ------- | ----------- | ------- |
|
||||
| executablePath | | string | | |
|
||||
| folderPath | | string | | |
|
||||
| local | | boolean | | |
|
||||
| product | | string | | |
|
||||
| revision | | string | | |
|
||||
| url | | string | | |
|
||||
|
||||
@ -1,13 +0,0 @@
|
||||
---
|
||||
sidebar_label: BrowserFetcherRevisionInfo.product
|
||||
---
|
||||
|
||||
# BrowserFetcherRevisionInfo.product property
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface BrowserFetcherRevisionInfo {
|
||||
product: string;
|
||||
}
|
||||
```
|
||||
@ -1,13 +0,0 @@
|
||||
---
|
||||
sidebar_label: BrowserFetcherRevisionInfo.revision
|
||||
---
|
||||
|
||||
# BrowserFetcherRevisionInfo.revision property
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface BrowserFetcherRevisionInfo {
|
||||
revision: string;
|
||||
}
|
||||
```
|
||||
@ -1,13 +0,0 @@
|
||||
---
|
||||
sidebar_label: BrowserFetcherRevisionInfo.url
|
||||
---
|
||||
|
||||
# BrowserFetcherRevisionInfo.url property
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface BrowserFetcherRevisionInfo {
|
||||
url: string;
|
||||
}
|
||||
```
|
||||
@ -1,15 +0,0 @@
|
||||
---
|
||||
sidebar_label: BrowserLaunchArgumentOptions.args
|
||||
---
|
||||
|
||||
# BrowserLaunchArgumentOptions.args property
|
||||
|
||||
Additional command line arguments to pass to the browser instance.
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface BrowserLaunchArgumentOptions {
|
||||
args?: string[];
|
||||
}
|
||||
```
|
||||
@ -1,13 +0,0 @@
|
||||
---
|
||||
sidebar_label: BrowserLaunchArgumentOptions.debuggingPort
|
||||
---
|
||||
|
||||
# BrowserLaunchArgumentOptions.debuggingPort property
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface BrowserLaunchArgumentOptions {
|
||||
debuggingPort?: number;
|
||||
}
|
||||
```
|
||||
@ -1,19 +0,0 @@
|
||||
---
|
||||
sidebar_label: BrowserLaunchArgumentOptions.devtools
|
||||
---
|
||||
|
||||
# BrowserLaunchArgumentOptions.devtools property
|
||||
|
||||
Whether to auto-open a DevTools panel for each tab. If this is set to `true`, then `headless` will be forced to `false`.
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface BrowserLaunchArgumentOptions {
|
||||
devtools?: boolean;
|
||||
}
|
||||
```
|
||||
|
||||
#### Default value:
|
||||
|
||||
`false`
|
||||
@ -1,19 +0,0 @@
|
||||
---
|
||||
sidebar_label: BrowserLaunchArgumentOptions.headless
|
||||
---
|
||||
|
||||
# BrowserLaunchArgumentOptions.headless property
|
||||
|
||||
Whether to run the browser in headless mode.
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface BrowserLaunchArgumentOptions {
|
||||
headless?: boolean | 'new';
|
||||
}
|
||||
```
|
||||
|
||||
#### Default value:
|
||||
|
||||
true
|
||||
@ -14,10 +14,10 @@ export interface BrowserLaunchArgumentOptions
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description | Default |
|
||||
| --------------------------------------------------------------------------- | --------- | ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ |
|
||||
| [args?](./puppeteer.browserlaunchargumentoptions.args.md) | | string\[\] | _(Optional)_ Additional command line arguments to pass to the browser instance. | |
|
||||
| [debuggingPort?](./puppeteer.browserlaunchargumentoptions.debuggingport.md) | | number | _(Optional)_ | |
|
||||
| [devtools?](./puppeteer.browserlaunchargumentoptions.devtools.md) | | boolean | _(Optional)_ Whether to auto-open a DevTools panel for each tab. If this is set to <code>true</code>, then <code>headless</code> will be forced to <code>false</code>. | <code>false</code> |
|
||||
| [headless?](./puppeteer.browserlaunchargumentoptions.headless.md) | | boolean \| 'new' | _(Optional)_ Whether to run the browser in headless mode. | true |
|
||||
| [userDataDir?](./puppeteer.browserlaunchargumentoptions.userdatadir.md) | | string | _(Optional)_ Path to a user data directory. [see the Chromium docs](https://chromium.googlesource.com/chromium/src/+/refs/heads/main/docs/user_data_dir.md) for more info. | |
|
||||
| Property | Modifiers | Type | Description | Default |
|
||||
| ------------- | --------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ |
|
||||
| args | <code>optional</code> | string\[\] | Additional command line arguments to pass to the browser instance. | |
|
||||
| debuggingPort | <code>optional</code> | number | | |
|
||||
| devtools | <code>optional</code> | boolean | Whether to auto-open a DevTools panel for each tab. If this is set to <code>true</code>, then <code>headless</code> will be forced to <code>false</code>. | <code>false</code> |
|
||||
| headless | <code>optional</code> | boolean \| 'new' | Whether to run the browser in headless mode. | true |
|
||||
| userDataDir | <code>optional</code> | string | Path to a user data directory. [see the Chromium docs](https://chromium.googlesource.com/chromium/src/+/refs/heads/main/docs/user_data_dir.md) for more info. | |
|
||||
|
||||
@ -1,15 +0,0 @@
|
||||
---
|
||||
sidebar_label: BrowserLaunchArgumentOptions.userDataDir
|
||||
---
|
||||
|
||||
# BrowserLaunchArgumentOptions.userDataDir property
|
||||
|
||||
Path to a user data directory. [see the Chromium docs](https://chromium.googlesource.com/chromium/src/+/refs/heads/main/docs/user_data_dir.md) for more info.
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface BrowserLaunchArgumentOptions {
|
||||
userDataDir?: string;
|
||||
}
|
||||
```
|
||||
@ -1,17 +0,0 @@
|
||||
---
|
||||
sidebar_label: CDPSessionOnMessageObject.error
|
||||
---
|
||||
|
||||
# CDPSessionOnMessageObject.error property
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface CDPSessionOnMessageObject {
|
||||
error: {
|
||||
message: string;
|
||||
data: any;
|
||||
code: number;
|
||||
};
|
||||
}
|
||||
```
|
||||
@ -1,13 +0,0 @@
|
||||
---
|
||||
sidebar_label: CDPSessionOnMessageObject.id
|
||||
---
|
||||
|
||||
# CDPSessionOnMessageObject.id property
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface CDPSessionOnMessageObject {
|
||||
id?: number;
|
||||
}
|
||||
```
|
||||
@ -12,10 +12,10 @@ export interface CDPSessionOnMessageObject
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description | Default |
|
||||
| ---------------------------------------------------------- | --------- | --------------------------------------------- | ------------ | ------- |
|
||||
| [error](./puppeteer.cdpsessiononmessageobject.error.md) | | { message: string; data: any; code: number; } | | |
|
||||
| [id?](./puppeteer.cdpsessiononmessageobject.id.md) | | number | _(Optional)_ | |
|
||||
| [method](./puppeteer.cdpsessiononmessageobject.method.md) | | string | | |
|
||||
| [params](./puppeteer.cdpsessiononmessageobject.params.md) | | Record<string, unknown> | | |
|
||||
| [result?](./puppeteer.cdpsessiononmessageobject.result.md) | | any | _(Optional)_ | |
|
||||
| Property | Modifiers | Type | Description | Default |
|
||||
| -------- | --------------------- | --------------------------------------------- | ----------- | ------- |
|
||||
| error | | { message: string; data: any; code: number; } | | |
|
||||
| id | <code>optional</code> | number | | |
|
||||
| method | | string | | |
|
||||
| params | | Record<string, unknown> | | |
|
||||
| result | <code>optional</code> | any | | |
|
||||
|
||||
@ -1,13 +0,0 @@
|
||||
---
|
||||
sidebar_label: CDPSessionOnMessageObject.method
|
||||
---
|
||||
|
||||
# CDPSessionOnMessageObject.method property
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface CDPSessionOnMessageObject {
|
||||
method: string;
|
||||
}
|
||||
```
|
||||
@ -1,13 +0,0 @@
|
||||
---
|
||||
sidebar_label: CDPSessionOnMessageObject.params
|
||||
---
|
||||
|
||||
# CDPSessionOnMessageObject.params property
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface CDPSessionOnMessageObject {
|
||||
params: Record<string, unknown>;
|
||||
}
|
||||
```
|
||||
@ -1,13 +0,0 @@
|
||||
---
|
||||
sidebar_label: CDPSessionOnMessageObject.result
|
||||
---
|
||||
|
||||
# CDPSessionOnMessageObject.result property
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface CDPSessionOnMessageObject {
|
||||
result?: any;
|
||||
}
|
||||
```
|
||||
@ -1,17 +0,0 @@
|
||||
---
|
||||
sidebar_label: ClickOptions.button
|
||||
---
|
||||
|
||||
# ClickOptions.button property
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface ClickOptions {
|
||||
button?: MouseButton;
|
||||
}
|
||||
```
|
||||
|
||||
#### Default value:
|
||||
|
||||
'left'
|
||||
@ -1,17 +0,0 @@
|
||||
---
|
||||
sidebar_label: ClickOptions.clickCount
|
||||
---
|
||||
|
||||
# ClickOptions.clickCount property
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface ClickOptions {
|
||||
clickCount?: number;
|
||||
}
|
||||
```
|
||||
|
||||
#### Default value:
|
||||
|
||||
1
|
||||
@ -1,19 +0,0 @@
|
||||
---
|
||||
sidebar_label: ClickOptions.delay
|
||||
---
|
||||
|
||||
# ClickOptions.delay property
|
||||
|
||||
Time to wait between `mousedown` and `mouseup` in milliseconds.
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface ClickOptions {
|
||||
delay?: number;
|
||||
}
|
||||
```
|
||||
|
||||
#### Default value:
|
||||
|
||||
0
|
||||
@ -12,9 +12,9 @@ export interface ClickOptions
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description | Default |
|
||||
| ----------------------------------------------------- | --------- | ----------------------------------------- | -------------------------------------------------------------------------------------------------- | ------- |
|
||||
| [button?](./puppeteer.clickoptions.button.md) | | [MouseButton](./puppeteer.mousebutton.md) | _(Optional)_ | 'left' |
|
||||
| [clickCount?](./puppeteer.clickoptions.clickcount.md) | | number | _(Optional)_ | 1 |
|
||||
| [delay?](./puppeteer.clickoptions.delay.md) | | number | _(Optional)_ Time to wait between <code>mousedown</code> and <code>mouseup</code> in milliseconds. | 0 |
|
||||
| [offset?](./puppeteer.clickoptions.offset.md) | | [Offset](./puppeteer.offset.md) | _(Optional)_ Offset for the clickable point relative to the top-left corner of the border box. | |
|
||||
| Property | Modifiers | Type | Description | Default |
|
||||
| ---------- | --------------------- | ----------------------------------------- | ------------------------------------------------------------------------------------- | ------- |
|
||||
| button | <code>optional</code> | [MouseButton](./puppeteer.mousebutton.md) | | 'left' |
|
||||
| clickCount | <code>optional</code> | number | | 1 |
|
||||
| delay | <code>optional</code> | number | Time to wait between <code>mousedown</code> and <code>mouseup</code> in milliseconds. | 0 |
|
||||
| offset | <code>optional</code> | [Offset](./puppeteer.offset.md) | Offset for the clickable point relative to the top-left corner of the border box. | |
|
||||
|
||||
@ -1,15 +0,0 @@
|
||||
---
|
||||
sidebar_label: ClickOptions.offset
|
||||
---
|
||||
|
||||
# ClickOptions.offset property
|
||||
|
||||
Offset for the clickable point relative to the top-left corner of the border box.
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface ClickOptions {
|
||||
offset?: Offset;
|
||||
}
|
||||
```
|
||||
@ -1,23 +0,0 @@
|
||||
---
|
||||
sidebar_label: Configuration.browserRevision
|
||||
---
|
||||
|
||||
# Configuration.browserRevision property
|
||||
|
||||
Specifies a certain version of the browser you'd like Puppeteer to use.
|
||||
|
||||
Can be overridden by `PUPPETEER_BROWSER_REVISION`.
|
||||
|
||||
See [puppeteer.launch](./puppeteer.puppeteernode.launch.md) on how executable path is inferred.
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface Configuration {
|
||||
browserRevision?: string;
|
||||
}
|
||||
```
|
||||
|
||||
#### Default value:
|
||||
|
||||
A compatible-revision of the browser.
|
||||
@ -1,21 +0,0 @@
|
||||
---
|
||||
sidebar_label: Configuration.cacheDirectory
|
||||
---
|
||||
|
||||
# Configuration.cacheDirectory property
|
||||
|
||||
Defines the directory to be used by Puppeteer for caching.
|
||||
|
||||
Can be overridden by `PUPPETEER_CACHE_DIR`.
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface Configuration {
|
||||
cacheDirectory?: string;
|
||||
}
|
||||
```
|
||||
|
||||
#### Default value:
|
||||
|
||||
`path.join(os.homedir(), '.cache', 'puppeteer')`
|
||||
@ -1,21 +0,0 @@
|
||||
---
|
||||
sidebar_label: Configuration.defaultProduct
|
||||
---
|
||||
|
||||
# Configuration.defaultProduct property
|
||||
|
||||
Specifies which browser you'd like Puppeteer to use.
|
||||
|
||||
Can be overridden by `PUPPETEER_PRODUCT`.
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface Configuration {
|
||||
defaultProduct?: Product;
|
||||
}
|
||||
```
|
||||
|
||||
#### Default value:
|
||||
|
||||
`'chrome'`
|
||||
@ -1,25 +0,0 @@
|
||||
---
|
||||
sidebar_label: Configuration.downloadHost
|
||||
---
|
||||
|
||||
# Configuration.downloadHost property
|
||||
|
||||
Specifies the URL prefix that is used to download Chromium.
|
||||
|
||||
Can be overridden by `PUPPETEER_DOWNLOAD_HOST`.
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface Configuration {
|
||||
downloadHost?: string;
|
||||
}
|
||||
```
|
||||
|
||||
#### Default value:
|
||||
|
||||
Either https://storage.googleapis.com or https://archive.mozilla.org/pub/firefox/nightly/latest-mozilla-central, depending on the product.
|
||||
|
||||
## Remarks
|
||||
|
||||
This must include the protocol and may even need a path prefix.
|
||||
@ -1,21 +0,0 @@
|
||||
---
|
||||
sidebar_label: Configuration.downloadPath
|
||||
---
|
||||
|
||||
# Configuration.downloadPath property
|
||||
|
||||
Specifies the path for the downloads folder.
|
||||
|
||||
Can be overridden by `PUPPETEER_DOWNLOAD_PATH`.
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface Configuration {
|
||||
downloadPath?: string;
|
||||
}
|
||||
```
|
||||
|
||||
#### Default value:
|
||||
|
||||
`<cache>/<product>` where `<cache>` is Puppeteer's cache directory and `<product>` is the name of the browser.
|
||||
@ -1,21 +0,0 @@
|
||||
---
|
||||
sidebar_label: Configuration.executablePath
|
||||
---
|
||||
|
||||
# Configuration.executablePath property
|
||||
|
||||
Specifies an executable path to be used in [puppeteer.launch](./puppeteer.puppeteernode.launch.md).
|
||||
|
||||
Can be overridden by `PUPPETEER_EXECUTABLE_PATH`.
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface Configuration {
|
||||
executablePath?: string;
|
||||
}
|
||||
```
|
||||
|
||||
#### Default value:
|
||||
|
||||
Auto-computed.
|
||||
@ -1,15 +0,0 @@
|
||||
---
|
||||
sidebar_label: Configuration.experiments
|
||||
---
|
||||
|
||||
# Configuration.experiments property
|
||||
|
||||
Defines experimental options for Puppeteer.
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface Configuration {
|
||||
experiments?: ExperimentsConfiguration;
|
||||
}
|
||||
```
|
||||
@ -1,21 +0,0 @@
|
||||
---
|
||||
sidebar_label: Configuration.logLevel
|
||||
---
|
||||
|
||||
# Configuration.logLevel property
|
||||
|
||||
Tells Puppeteer to log at the given level.
|
||||
|
||||
At the moment, any option silences logging.
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface Configuration {
|
||||
logLevel?: 'silent' | 'error' | 'warn';
|
||||
}
|
||||
```
|
||||
|
||||
#### Default value:
|
||||
|
||||
`undefined`
|
||||
@ -16,15 +16,15 @@ export interface Configuration
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description | Default |
|
||||
| ---------------------------------------------------------------------- | --------- | ------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| [browserRevision?](./puppeteer.configuration.browserrevision.md) | | string | <p>_(Optional)_ Specifies a certain version of the browser you'd like Puppeteer to use.</p><p>Can be overridden by <code>PUPPETEER_BROWSER_REVISION</code>.</p><p>See [puppeteer.launch](./puppeteer.puppeteernode.launch.md) on how executable path is inferred.</p> | A compatible-revision of the browser. |
|
||||
| [cacheDirectory?](./puppeteer.configuration.cachedirectory.md) | | string | <p>_(Optional)_ Defines the directory to be used by Puppeteer for caching.</p><p>Can be overridden by <code>PUPPETEER_CACHE_DIR</code>.</p> | <code>path.join(os.homedir(), '.cache', 'puppeteer')</code> |
|
||||
| [defaultProduct?](./puppeteer.configuration.defaultproduct.md) | | [Product](./puppeteer.product.md) | <p>_(Optional)_ Specifies which browser you'd like Puppeteer to use.</p><p>Can be overridden by <code>PUPPETEER_PRODUCT</code>.</p> | <code>'chrome'</code> |
|
||||
| [downloadHost?](./puppeteer.configuration.downloadhost.md) | | string | <p>_(Optional)_ Specifies the URL prefix that is used to download Chromium.</p><p>Can be overridden by <code>PUPPETEER_DOWNLOAD_HOST</code>.</p> | Either https://storage.googleapis.com or https://archive.mozilla.org/pub/firefox/nightly/latest-mozilla-central, depending on the product. |
|
||||
| [downloadPath?](./puppeteer.configuration.downloadpath.md) | | string | <p>_(Optional)_ Specifies the path for the downloads folder.</p><p>Can be overridden by <code>PUPPETEER_DOWNLOAD_PATH</code>.</p> | <code><cache>/<product></code> where <code><cache></code> is Puppeteer's cache directory and <code><product></code> is the name of the browser. |
|
||||
| [executablePath?](./puppeteer.configuration.executablepath.md) | | string | <p>_(Optional)_ Specifies an executable path to be used in [puppeteer.launch](./puppeteer.puppeteernode.launch.md).</p><p>Can be overridden by <code>PUPPETEER_EXECUTABLE_PATH</code>.</p> | Auto-computed. |
|
||||
| [experiments?](./puppeteer.configuration.experiments.md) | | [ExperimentsConfiguration](./puppeteer.experimentsconfiguration.md) | _(Optional)_ Defines experimental options for Puppeteer. | |
|
||||
| [logLevel?](./puppeteer.configuration.loglevel.md) | | 'silent' \| 'error' \| 'warn' | <p>_(Optional)_ Tells Puppeteer to log at the given level.</p><p>At the moment, any option silences logging.</p> | <code>undefined</code> |
|
||||
| [skipDownload?](./puppeteer.configuration.skipdownload.md) | | boolean | <p>_(Optional)_ Tells Puppeteer to not download during installation.</p><p>Can be overridden by <code>PUPPETEER_SKIP_DOWNLOAD</code>.</p> | |
|
||||
| [temporaryDirectory?](./puppeteer.configuration.temporarydirectory.md) | | string | <p>_(Optional)_ Defines the directory to be used by Puppeteer for creating temporary files.</p><p>Can be overridden by <code>PUPPETEER_TMP_DIR</code>.</p> | <code>os.tmpdir()</code> |
|
||||
| Property | Modifiers | Type | Description | Default |
|
||||
| ------------------ | --------------------- | ------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| browserRevision | <code>optional</code> | string | <p>Specifies a certain version of the browser you'd like Puppeteer to use.</p><p>Can be overridden by <code>PUPPETEER_BROWSER_REVISION</code>.</p><p>See [puppeteer.launch](./puppeteer.puppeteernode.launch.md) on how executable path is inferred.</p> | A compatible-revision of the browser. |
|
||||
| cacheDirectory | <code>optional</code> | string | <p>Defines the directory to be used by Puppeteer for caching.</p><p>Can be overridden by <code>PUPPETEER_CACHE_DIR</code>.</p> | <code>path.join(os.homedir(), '.cache', 'puppeteer')</code> |
|
||||
| defaultProduct | <code>optional</code> | [Product](./puppeteer.product.md) | <p>Specifies which browser you'd like Puppeteer to use.</p><p>Can be overridden by <code>PUPPETEER_PRODUCT</code>.</p> | <code>'chrome'</code> |
|
||||
| downloadHost | <code>optional</code> | string | <p>Specifies the URL prefix that is used to download Chromium.</p><p>Can be overridden by <code>PUPPETEER_DOWNLOAD_HOST</code>.</p> | Either https://storage.googleapis.com or https://archive.mozilla.org/pub/firefox/nightly/latest-mozilla-central, depending on the product. |
|
||||
| downloadPath | <code>optional</code> | string | <p>Specifies the path for the downloads folder.</p><p>Can be overridden by <code>PUPPETEER_DOWNLOAD_PATH</code>.</p> | <code><cache>/<product></code> where <code><cache></code> is Puppeteer's cache directory and <code><product></code> is the name of the browser. |
|
||||
| executablePath | <code>optional</code> | string | <p>Specifies an executable path to be used in [puppeteer.launch](./puppeteer.puppeteernode.launch.md).</p><p>Can be overridden by <code>PUPPETEER_EXECUTABLE_PATH</code>.</p> | Auto-computed. |
|
||||
| experiments | <code>optional</code> | [ExperimentsConfiguration](./puppeteer.experimentsconfiguration.md) | Defines experimental options for Puppeteer. | |
|
||||
| logLevel | <code>optional</code> | 'silent' \| 'error' \| 'warn' | <p>Tells Puppeteer to log at the given level.</p><p>At the moment, any option silences logging.</p> | <code>undefined</code> |
|
||||
| skipDownload | <code>optional</code> | boolean | <p>Tells Puppeteer to not download during installation.</p><p>Can be overridden by <code>PUPPETEER_SKIP_DOWNLOAD</code>.</p> | |
|
||||
| temporaryDirectory | <code>optional</code> | string | <p>Defines the directory to be used by Puppeteer for creating temporary files.</p><p>Can be overridden by <code>PUPPETEER_TMP_DIR</code>.</p> | <code>os.tmpdir()</code> |
|
||||
|
||||
@ -1,17 +0,0 @@
|
||||
---
|
||||
sidebar_label: Configuration.skipDownload
|
||||
---
|
||||
|
||||
# Configuration.skipDownload property
|
||||
|
||||
Tells Puppeteer to not download during installation.
|
||||
|
||||
Can be overridden by `PUPPETEER_SKIP_DOWNLOAD`.
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface Configuration {
|
||||
skipDownload?: boolean;
|
||||
}
|
||||
```
|
||||
@ -1,21 +0,0 @@
|
||||
---
|
||||
sidebar_label: Configuration.temporaryDirectory
|
||||
---
|
||||
|
||||
# Configuration.temporaryDirectory property
|
||||
|
||||
Defines the directory to be used by Puppeteer for creating temporary files.
|
||||
|
||||
Can be overridden by `PUPPETEER_TMP_DIR`.
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface Configuration {
|
||||
temporaryDirectory?: string;
|
||||
}
|
||||
```
|
||||
|
||||
#### Default value:
|
||||
|
||||
`os.tmpdir()`
|
||||
@ -20,9 +20,9 @@ export declare class Connection extends EventEmitter
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| -------------------------------------------- | --------------------- | ------ | ----------- |
|
||||
| [timeout](./puppeteer.connection.timeout.md) | <code>readonly</code> | number | |
|
||||
| Property | Modifiers | Type | Description |
|
||||
| -------- | --------------------- | ------ | ----------- |
|
||||
| timeout | <code>readonly</code> | number | |
|
||||
|
||||
## Methods
|
||||
|
||||
|
||||
@ -1,13 +0,0 @@
|
||||
---
|
||||
sidebar_label: Connection.timeout
|
||||
---
|
||||
|
||||
# Connection.timeout property
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
class Connection {
|
||||
get timeout(): number;
|
||||
}
|
||||
```
|
||||
@ -12,10 +12,10 @@ export interface ConnectionTransport
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description | Default |
|
||||
| ---------------------------------------------------------- | --------- | ---------------------------- | ------------ | ------- |
|
||||
| [onclose?](./puppeteer.connectiontransport.onclose.md) | | () => void | _(Optional)_ | |
|
||||
| [onmessage?](./puppeteer.connectiontransport.onmessage.md) | | (message: string) => void | _(Optional)_ | |
|
||||
| Property | Modifiers | Type | Description | Default |
|
||||
| --------- | --------------------- | ---------------------------- | ----------- | ------- |
|
||||
| onclose | <code>optional</code> | () => void | | |
|
||||
| onmessage | <code>optional</code> | (message: string) => void | | |
|
||||
|
||||
## Methods
|
||||
|
||||
|
||||
@ -1,13 +0,0 @@
|
||||
---
|
||||
sidebar_label: ConnectionTransport.onclose
|
||||
---
|
||||
|
||||
# ConnectionTransport.onclose property
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface ConnectionTransport {
|
||||
onclose?: () => void;
|
||||
}
|
||||
```
|
||||
@ -1,13 +0,0 @@
|
||||
---
|
||||
sidebar_label: ConnectionTransport.onmessage
|
||||
---
|
||||
|
||||
# ConnectionTransport.onmessage property
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface ConnectionTransport {
|
||||
onmessage?: (message: string) => void;
|
||||
}
|
||||
```
|
||||
@ -1,13 +0,0 @@
|
||||
---
|
||||
sidebar_label: ConnectOptions.browserURL
|
||||
---
|
||||
|
||||
# ConnectOptions.browserURL property
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface ConnectOptions {
|
||||
browserURL?: string;
|
||||
}
|
||||
```
|
||||
@ -1,13 +0,0 @@
|
||||
---
|
||||
sidebar_label: ConnectOptions.browserWSEndpoint
|
||||
---
|
||||
|
||||
# ConnectOptions.browserWSEndpoint property
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface ConnectOptions {
|
||||
browserWSEndpoint?: string;
|
||||
}
|
||||
```
|
||||
@ -1,19 +0,0 @@
|
||||
---
|
||||
sidebar_label: ConnectOptions.headers
|
||||
---
|
||||
|
||||
# ConnectOptions.headers property
|
||||
|
||||
Headers to use for the web socket connection.
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface ConnectOptions {
|
||||
headers?: Record<string, string>;
|
||||
}
|
||||
```
|
||||
|
||||
## Remarks
|
||||
|
||||
Only works in the Node.js environment.
|
||||
@ -14,9 +14,9 @@ export interface ConnectOptions extends BrowserConnectOptions
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description | Default |
|
||||
| --------------------------------------------------------------------- | --------- | --------------------------------------------------------- | ---------------------------------------------------------- | ------- |
|
||||
| [browserURL?](./puppeteer.connectoptions.browserurl.md) | | string | _(Optional)_ | |
|
||||
| [browserWSEndpoint?](./puppeteer.connectoptions.browserwsendpoint.md) | | string | _(Optional)_ | |
|
||||
| [headers?](./puppeteer.connectoptions.headers.md) | | Record<string, string> | _(Optional)_ Headers to use for the web socket connection. | |
|
||||
| [transport?](./puppeteer.connectoptions.transport.md) | | [ConnectionTransport](./puppeteer.connectiontransport.md) | _(Optional)_ | |
|
||||
| Property | Modifiers | Type | Description | Default |
|
||||
| ----------------- | --------------------- | --------------------------------------------------------- | --------------------------------------------- | ------- |
|
||||
| browserURL | <code>optional</code> | string | | |
|
||||
| browserWSEndpoint | <code>optional</code> | string | | |
|
||||
| headers | <code>optional</code> | Record<string, string> | Headers to use for the web socket connection. | |
|
||||
| transport | <code>optional</code> | [ConnectionTransport](./puppeteer.connectiontransport.md) | | |
|
||||
|
||||
@ -1,13 +0,0 @@
|
||||
---
|
||||
sidebar_label: ConnectOptions.transport
|
||||
---
|
||||
|
||||
# ConnectOptions.transport property
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface ConnectOptions {
|
||||
transport?: ConnectionTransport;
|
||||
}
|
||||
```
|
||||
@ -1,15 +0,0 @@
|
||||
---
|
||||
sidebar_label: ConsoleMessageLocation.columnNumber
|
||||
---
|
||||
|
||||
# ConsoleMessageLocation.columnNumber property
|
||||
|
||||
0-based column number in the resource if known or `undefined` otherwise.
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface ConsoleMessageLocation {
|
||||
columnNumber?: number;
|
||||
}
|
||||
```
|
||||
@ -1,15 +0,0 @@
|
||||
---
|
||||
sidebar_label: ConsoleMessageLocation.lineNumber
|
||||
---
|
||||
|
||||
# ConsoleMessageLocation.lineNumber property
|
||||
|
||||
0-based line number in the resource if known or `undefined` otherwise.
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface ConsoleMessageLocation {
|
||||
lineNumber?: number;
|
||||
}
|
||||
```
|
||||
@ -12,8 +12,8 @@ export interface ConsoleMessageLocation
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description | Default |
|
||||
| ------------------------------------------------------------------- | --------- | ------ | ------------------------------------------------------------------------------------------------ | ------- |
|
||||
| [columnNumber?](./puppeteer.consolemessagelocation.columnnumber.md) | | number | _(Optional)_ 0-based column number in the resource if known or <code>undefined</code> otherwise. | |
|
||||
| [lineNumber?](./puppeteer.consolemessagelocation.linenumber.md) | | number | _(Optional)_ 0-based line number in the resource if known or <code>undefined</code> otherwise. | |
|
||||
| [url?](./puppeteer.consolemessagelocation.url.md) | | string | _(Optional)_ URL of the resource if known or <code>undefined</code> otherwise. | |
|
||||
| Property | Modifiers | Type | Description | Default |
|
||||
| ------------ | --------------------- | ------ | ----------------------------------------------------------------------------------- | ------- |
|
||||
| columnNumber | <code>optional</code> | number | 0-based column number in the resource if known or <code>undefined</code> otherwise. | |
|
||||
| lineNumber | <code>optional</code> | number | 0-based line number in the resource if known or <code>undefined</code> otherwise. | |
|
||||
| url | <code>optional</code> | string | URL of the resource if known or <code>undefined</code> otherwise. | |
|
||||
|
||||
@ -1,15 +0,0 @@
|
||||
---
|
||||
sidebar_label: ConsoleMessageLocation.url
|
||||
---
|
||||
|
||||
# ConsoleMessageLocation.url property
|
||||
|
||||
URL of the resource if known or `undefined` otherwise.
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface ConsoleMessageLocation {
|
||||
url?: string;
|
||||
}
|
||||
```
|
||||
@ -1,13 +0,0 @@
|
||||
---
|
||||
sidebar_label: ContinueRequestOverrides.headers
|
||||
---
|
||||
|
||||
# ContinueRequestOverrides.headers property
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface ContinueRequestOverrides {
|
||||
headers?: Record<string, string>;
|
||||
}
|
||||
```
|
||||
@ -12,9 +12,9 @@ export interface ContinueRequestOverrides
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description | Default |
|
||||
| ------------------------------------------------------------- | --------- | ---------------------------- | ------------------------------------------------------------------------- | ------- |
|
||||
| [headers?](./puppeteer.continuerequestoverrides.headers.md) | | Record<string, string> | _(Optional)_ | |
|
||||
| [method?](./puppeteer.continuerequestoverrides.method.md) | | string | _(Optional)_ | |
|
||||
| [postData?](./puppeteer.continuerequestoverrides.postdata.md) | | string | _(Optional)_ | |
|
||||
| [url?](./puppeteer.continuerequestoverrides.url.md) | | string | _(Optional)_ If set, the request URL will change. This is not a redirect. | |
|
||||
| Property | Modifiers | Type | Description | Default |
|
||||
| -------- | --------------------- | ---------------------------- | ------------------------------------------------------------ | ------- |
|
||||
| headers | <code>optional</code> | Record<string, string> | | |
|
||||
| method | <code>optional</code> | string | | |
|
||||
| postData | <code>optional</code> | string | | |
|
||||
| url | <code>optional</code> | string | If set, the request URL will change. This is not a redirect. | |
|
||||
|
||||
@ -1,13 +0,0 @@
|
||||
---
|
||||
sidebar_label: ContinueRequestOverrides.method
|
||||
---
|
||||
|
||||
# ContinueRequestOverrides.method property
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface ContinueRequestOverrides {
|
||||
method?: string;
|
||||
}
|
||||
```
|
||||
@ -1,13 +0,0 @@
|
||||
---
|
||||
sidebar_label: ContinueRequestOverrides.postData
|
||||
---
|
||||
|
||||
# ContinueRequestOverrides.postData property
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface ContinueRequestOverrides {
|
||||
postData?: string;
|
||||
}
|
||||
```
|
||||
@ -1,15 +0,0 @@
|
||||
---
|
||||
sidebar_label: ContinueRequestOverrides.url
|
||||
---
|
||||
|
||||
# ContinueRequestOverrides.url property
|
||||
|
||||
If set, the request URL will change. This is not a redirect.
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface ContinueRequestOverrides {
|
||||
url?: string;
|
||||
}
|
||||
```
|
||||
@ -14,8 +14,8 @@ export interface CoverageEntry
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description | Default |
|
||||
| --------------------------------------------- | --------- | -------------------------------------------- | --------------------------------------------- | ------- |
|
||||
| [ranges](./puppeteer.coverageentry.ranges.md) | | Array<{ start: number; end: number; }> | The covered range as start and end positions. | |
|
||||
| [text](./puppeteer.coverageentry.text.md) | | string | The content of the style sheet or script. | |
|
||||
| [url](./puppeteer.coverageentry.url.md) | | string | The URL of the style sheet or script. | |
|
||||
| Property | Modifiers | Type | Description | Default |
|
||||
| -------- | --------- | -------------------------------------------- | --------------------------------------------- | ------- |
|
||||
| ranges | | Array<{ start: number; end: number; }> | 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. | |
|
||||
|
||||
@ -1,18 +0,0 @@
|
||||
---
|
||||
sidebar_label: CoverageEntry.ranges
|
||||
---
|
||||
|
||||
# CoverageEntry.ranges property
|
||||
|
||||
The covered range as start and end positions.
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface CoverageEntry {
|
||||
ranges: Array<{
|
||||
start: number;
|
||||
end: number;
|
||||
}>;
|
||||
}
|
||||
```
|
||||
@ -1,15 +0,0 @@
|
||||
---
|
||||
sidebar_label: CoverageEntry.text
|
||||
---
|
||||
|
||||
# CoverageEntry.text property
|
||||
|
||||
The content of the style sheet or script.
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface CoverageEntry {
|
||||
text: string;
|
||||
}
|
||||
```
|
||||
@ -1,15 +0,0 @@
|
||||
---
|
||||
sidebar_label: CoverageEntry.url
|
||||
---
|
||||
|
||||
# CoverageEntry.url property
|
||||
|
||||
The URL of the style sheet or script.
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface CoverageEntry {
|
||||
url: string;
|
||||
}
|
||||
```
|
||||
@ -12,7 +12,7 @@ export interface Credentials
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description | Default |
|
||||
| ----------------------------------------------- | --------- | ------ | ----------- | ------- |
|
||||
| [password](./puppeteer.credentials.password.md) | | string | | |
|
||||
| [username](./puppeteer.credentials.username.md) | | string | | |
|
||||
| Property | Modifiers | Type | Description | Default |
|
||||
| -------- | --------- | ------ | ----------- | ------- |
|
||||
| password | | string | | |
|
||||
| username | | string | | |
|
||||
|
||||
@ -1,13 +0,0 @@
|
||||
---
|
||||
sidebar_label: Credentials.password
|
||||
---
|
||||
|
||||
# Credentials.password property
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface Credentials {
|
||||
password: string;
|
||||
}
|
||||
```
|
||||
@ -1,13 +0,0 @@
|
||||
---
|
||||
sidebar_label: Credentials.username
|
||||
---
|
||||
|
||||
# Credentials.username property
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface Credentials {
|
||||
username: string;
|
||||
}
|
||||
```
|
||||
@ -14,6 +14,6 @@ export interface CSSCoverageOptions
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description | Default |
|
||||
| ------------------------------------------------------------------------- | --------- | ------- | ----------------------------------------------------------- | ------- |
|
||||
| [resetOnNavigation?](./puppeteer.csscoverageoptions.resetonnavigation.md) | | boolean | _(Optional)_ Whether to reset coverage on every navigation. | |
|
||||
| Property | Modifiers | Type | Description | Default |
|
||||
| ----------------- | --------------------- | ------- | ---------------------------------------------- | ------- |
|
||||
| resetOnNavigation | <code>optional</code> | boolean | Whether to reset coverage on every navigation. | |
|
||||
|
||||
@ -1,15 +0,0 @@
|
||||
---
|
||||
sidebar_label: CSSCoverageOptions.resetOnNavigation
|
||||
---
|
||||
|
||||
# CSSCoverageOptions.resetOnNavigation property
|
||||
|
||||
Whether to reset coverage on every navigation.
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface CSSCoverageOptions {
|
||||
resetOnNavigation?: boolean;
|
||||
}
|
||||
```
|
||||
@ -12,7 +12,7 @@ export interface CustomQueryHandler
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description | Default |
|
||||
| ------------------------------------------------------- | --------- | --------------------------------------------------------- | ------------ | ------- |
|
||||
| [queryAll?](./puppeteer.customqueryhandler.queryall.md) | | (node: Node, selector: string) => Iterable<Node> | _(Optional)_ | |
|
||||
| [queryOne?](./puppeteer.customqueryhandler.queryone.md) | | (node: Node, selector: string) => Node \| null | _(Optional)_ | |
|
||||
| Property | Modifiers | Type | Description | Default |
|
||||
| -------- | --------------------- | --------------------------------------------------------- | ----------- | ------- |
|
||||
| queryAll | <code>optional</code> | (node: Node, selector: string) => Iterable<Node> | | |
|
||||
| queryOne | <code>optional</code> | (node: Node, selector: string) => Node \| null | | |
|
||||
|
||||
@ -1,13 +0,0 @@
|
||||
---
|
||||
sidebar_label: CustomQueryHandler.queryAll
|
||||
---
|
||||
|
||||
# CustomQueryHandler.queryAll property
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface CustomQueryHandler {
|
||||
queryAll?: (node: Node, selector: string) => Iterable<Node>;
|
||||
}
|
||||
```
|
||||
@ -1,13 +0,0 @@
|
||||
---
|
||||
sidebar_label: CustomQueryHandler.queryOne
|
||||
---
|
||||
|
||||
# CustomQueryHandler.queryOne property
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface CustomQueryHandler {
|
||||
queryOne?: (node: Node, selector: string) => Node | null;
|
||||
}
|
||||
```
|
||||
@ -12,7 +12,7 @@ export interface Device
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description | Default |
|
||||
| -------------------------------------------- | --------- | ----------------------------------- | ----------- | ------- |
|
||||
| [userAgent](./puppeteer.device.useragent.md) | | string | | |
|
||||
| [viewport](./puppeteer.device.viewport.md) | | [Viewport](./puppeteer.viewport.md) | | |
|
||||
| Property | Modifiers | Type | Description | Default |
|
||||
| --------- | --------- | ----------------------------------- | ----------- | ------- |
|
||||
| userAgent | | string | | |
|
||||
| viewport | | [Viewport](./puppeteer.viewport.md) | | |
|
||||
|
||||
@ -1,13 +0,0 @@
|
||||
---
|
||||
sidebar_label: Device.userAgent
|
||||
---
|
||||
|
||||
# Device.userAgent property
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface Device {
|
||||
userAgent: string;
|
||||
}
|
||||
```
|
||||
@ -1,13 +0,0 @@
|
||||
---
|
||||
sidebar_label: Device.viewport
|
||||
---
|
||||
|
||||
# Device.viewport property
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
interface Device {
|
||||
viewport: Viewport;
|
||||
}
|
||||
```
|
||||
@ -1,15 +0,0 @@
|
||||
---
|
||||
sidebar_label: DeviceRequestPrompt.devices
|
||||
---
|
||||
|
||||
# DeviceRequestPrompt.devices property
|
||||
|
||||
Current list of selectable devices.
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
class DeviceRequestPrompt {
|
||||
devices: DeviceRequestPromptDevice[];
|
||||
}
|
||||
```
|
||||
@ -32,9 +32,9 @@ await devicePrompt.select(
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| ----------------------------------------------------- | --------- | ------------------------------------------------------------------------- | ----------------------------------- |
|
||||
| [devices](./puppeteer.devicerequestprompt.devices.md) | | [DeviceRequestPromptDevice](./puppeteer.devicerequestpromptdevice.md)\[\] | Current list of selectable devices. |
|
||||
| Property | Modifiers | Type | Description |
|
||||
| -------- | --------- | ------------------------------------------------------------------------- | ----------------------------------- |
|
||||
| devices | | [DeviceRequestPromptDevice](./puppeteer.devicerequestpromptdevice.md)\[\] | Current list of selectable devices. |
|
||||
|
||||
## Methods
|
||||
|
||||
|
||||
@ -1,15 +0,0 @@
|
||||
---
|
||||
sidebar_label: DeviceRequestPromptDevice.id
|
||||
---
|
||||
|
||||
# DeviceRequestPromptDevice.id property
|
||||
|
||||
Device id during a prompt.
|
||||
|
||||
#### Signature:
|
||||
|
||||
```typescript
|
||||
class DeviceRequestPromptDevice {
|
||||
id: string;
|
||||
}
|
||||
```
|
||||
@ -18,7 +18,7 @@ The constructor for this class is marked as internal. Third-party code should no
|
||||
|
||||
## 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. |
|
||||
| Property | Modifiers | Type | Description |
|
||||
| -------- | --------- | ------ | -------------------------------------- |
|
||||
| id | | string | Device id during a prompt. |
|
||||
| name | | string | Device name as it appears in a prompt. |
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user