thunderstrike/puppeteer
thunderstrike/puppeteer
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

chore: commit base new-docs (#5973)

Browse Source 
This adds the new docs that are generated by API Extractor via TSDoc.
They are sparse because we do not yet use TSDoc in the codebase. This is
the starting point and from here we can work through all the different
classes and improve the documentation.
This commit is contained in:
Jack Franklin 2020-06-04 15:56:45 +01:00 committed by GitHub
parent 00324204ff
commit 086c08998b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
505 changed files with 9539 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
new-docs/index.md Normal file
View File

@ -0,0 +1,12 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md)
## API Reference
## Packages
| Package | Description |
| --- | --- |
| [puppeteer](./puppeteer.md) | |

20
new-docs/puppeteer.accessibility._constructor_.md Normal file
View File

@ -0,0 +1,20 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Accessibility](./puppeteer.accessibility.md) &gt; [(constructor)](./puppeteer.accessibility._constructor_.md)
## Accessibility.(constructor)
Constructs a new instance of the `Accessibility` class
<b>Signature:</b>
```typescript
constructor(client: CDPSession);
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| client | [CDPSession](./puppeteer.cdpsession.md) | |

24
new-docs/puppeteer.accessibility.md Normal file
View File

@ -0,0 +1,24 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Accessibility](./puppeteer.accessibility.md)
## Accessibility class
<b>Signature:</b>
```typescript
export declare class Accessibility
```
## Constructors
| Constructor | Modifiers | Description |
| --- | --- | --- |
| [(constructor)(client)](./puppeteer.accessibility._constructor_.md) | | Constructs a new instance of the <code>Accessibility</code> class |
## Methods
| Method | Modifiers | Description |
| --- | --- | --- |
| [snapshot(options)](./puppeteer.accessibility.snapshot.md) | | |

25
new-docs/puppeteer.accessibility.snapshot.md Normal file
View File

@ -0,0 +1,25 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Accessibility](./puppeteer.accessibility.md) &gt; [snapshot](./puppeteer.accessibility.snapshot.md)
## Accessibility.snapshot() method
<b>Signature:</b>
```typescript
snapshot(options?: {
interestingOnly?: boolean;
root?: ElementHandle;
}): Promise<SerializedAXNode>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| options | { interestingOnly?: boolean; root?: [ElementHandle](./puppeteer.elementhandle.md)<!-- -->; } | |
<b>Returns:</b>
Promise&lt;SerializedAXNode&gt;

11
new-docs/puppeteer.browser._closecallback.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Browser](./puppeteer.browser.md) &gt; [\_closeCallback](./puppeteer.browser._closecallback.md)
## Browser.\_closeCallback property
<b>Signature:</b>
```typescript
_closeCallback: BrowserCloseCallback;
```

11
new-docs/puppeteer.browser._connection.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Browser](./puppeteer.browser.md) &gt; [\_connection](./puppeteer.browser._connection.md)
## Browser.\_connection property
<b>Signature:</b>
```typescript
_connection: Connection;
```

25
new-docs/puppeteer.browser._constructor_.md Normal file
View File

@ -0,0 +1,25 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Browser](./puppeteer.browser.md) &gt; [(constructor)](./puppeteer.browser._constructor_.md)
## Browser.(constructor)
Constructs a new instance of the `Browser` class
<b>Signature:</b>
```typescript
constructor(connection: Connection, contextIds: string[], ignoreHTTPSErrors: boolean, defaultViewport?: Viewport, process?: ChildProcess, closeCallback?: BrowserCloseCallback);
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| connection | [Connection](./puppeteer.connection.md) | |
| contextIds | string\[\] | |
| ignoreHTTPSErrors | boolean | |
| defaultViewport | Viewport | |
| process | ChildProcess | |
| closeCallback | BrowserCloseCallback | |

11
new-docs/puppeteer.browser._contexts.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Browser](./puppeteer.browser.md) &gt; [\_contexts](./puppeteer.browser._contexts.md)
## Browser.\_contexts property
<b>Signature:</b>
```typescript
_contexts: Map<string, BrowserContext>;
```

22
new-docs/puppeteer.browser._createpageincontext.md Normal file
View File

@ -0,0 +1,22 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Browser](./puppeteer.browser.md) &gt; [\_createPageInContext](./puppeteer.browser._createpageincontext.md)
## Browser.\_createPageInContext() method
<b>Signature:</b>
```typescript
_createPageInContext(contextId?: string): Promise<Page>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| contextId | string | |
<b>Returns:</b>
Promise&lt;[Page](./puppeteer.page.md)<!-- -->&gt;

11
new-docs/puppeteer.browser._defaultcontext.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Browser](./puppeteer.browser.md) &gt; [\_defaultContext](./puppeteer.browser._defaultcontext.md)
## Browser.\_defaultContext property
<b>Signature:</b>
```typescript
_defaultContext: BrowserContext;
```

11
new-docs/puppeteer.browser._defaultviewport.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Browser](./puppeteer.browser.md) &gt; [\_defaultViewport](./puppeteer.browser._defaultviewport.md)
## Browser.\_defaultViewport property
<b>Signature:</b>
```typescript
_defaultViewport?: Viewport;
```

22
new-docs/puppeteer.browser._disposecontext.md Normal file
View File

@ -0,0 +1,22 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Browser](./puppeteer.browser.md) &gt; [\_disposeContext](./puppeteer.browser._disposecontext.md)
## Browser.\_disposeContext() method
<b>Signature:</b>
```typescript
_disposeContext(contextId?: string): Promise<void>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| contextId | string | |
<b>Returns:</b>
Promise&lt;void&gt;

15
new-docs/puppeteer.browser._getversion.md Normal file
View File

@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Browser](./puppeteer.browser.md) &gt; [\_getVersion](./puppeteer.browser._getversion.md)
## Browser.\_getVersion() method
<b>Signature:</b>
```typescript
_getVersion(): Promise<Protocol.Browser.getVersionReturnValue>;
```
<b>Returns:</b>
Promise&lt;Protocol.Browser.getVersionReturnValue&gt;

11
new-docs/puppeteer.browser._ignorehttpserrors.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Browser](./puppeteer.browser.md) &gt; [\_ignoreHTTPSErrors](./puppeteer.browser._ignorehttpserrors.md)
## Browser.\_ignoreHTTPSErrors property
<b>Signature:</b>
```typescript
_ignoreHTTPSErrors: boolean;
```

11
new-docs/puppeteer.browser._process.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Browser](./puppeteer.browser.md) &gt; [\_process](./puppeteer.browser._process.md)
## Browser.\_process property
<b>Signature:</b>
```typescript
_process?: ChildProcess;
```

22
new-docs/puppeteer.browser._targetcreated.md Normal file
View File

@ -0,0 +1,22 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Browser](./puppeteer.browser.md) &gt; [\_targetCreated](./puppeteer.browser._targetcreated.md)
## Browser.\_targetCreated() method
<b>Signature:</b>
```typescript
_targetCreated(event: Protocol.Target.targetCreatedPayload): Promise<void>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| event | Protocol.Target.targetCreatedPayload | |
<b>Returns:</b>
Promise&lt;void&gt;

24
new-docs/puppeteer.browser._targetdestroyed.md Normal file
View File

@ -0,0 +1,24 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Browser](./puppeteer.browser.md) &gt; [\_targetDestroyed](./puppeteer.browser._targetdestroyed.md)
## Browser.\_targetDestroyed() method
<b>Signature:</b>
```typescript
_targetDestroyed(event: {
targetId: string;
}): Promise<void>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| event | { targetId: string; } | |
<b>Returns:</b>
Promise&lt;void&gt;

22
new-docs/puppeteer.browser._targetinfochanged.md Normal file
View File

@ -0,0 +1,22 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Browser](./puppeteer.browser.md) &gt; [\_targetInfoChanged](./puppeteer.browser._targetinfochanged.md)
## Browser.\_targetInfoChanged() method
<b>Signature:</b>
```typescript
_targetInfoChanged(event: Protocol.Target.targetInfoChangedPayload): void;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| event | Protocol.Target.targetInfoChangedPayload | |
<b>Returns:</b>
void

11
new-docs/puppeteer.browser._targets.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Browser](./puppeteer.browser.md) &gt; [\_targets](./puppeteer.browser._targets.md)
## Browser.\_targets property
<b>Signature:</b>
```typescript
_targets: Map<string, Target>;
```

15
new-docs/puppeteer.browser.browsercontexts.md Normal file
View File

@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Browser](./puppeteer.browser.md) &gt; [browserContexts](./puppeteer.browser.browsercontexts.md)
## Browser.browserContexts() method
<b>Signature:</b>
```typescript
browserContexts(): BrowserContext[];
```
<b>Returns:</b>
[BrowserContext](./puppeteer.browsercontext.md)<!-- -->\[\]

15
new-docs/puppeteer.browser.close.md Normal file
View File

@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Browser](./puppeteer.browser.md) &gt; [close](./puppeteer.browser.close.md)
## Browser.close() method
<b>Signature:</b>
```typescript
close(): Promise<void>;
```
<b>Returns:</b>
Promise&lt;void&gt;

27
new-docs/puppeteer.browser.create.md Normal file
View File

@ -0,0 +1,27 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Browser](./puppeteer.browser.md) &gt; [create](./puppeteer.browser.create.md)
## Browser.create() method
<b>Signature:</b>
```typescript
static create(connection: Connection, contextIds: string[], ignoreHTTPSErrors: boolean, defaultViewport?: Viewport, process?: ChildProcess, closeCallback?: BrowserCloseCallback): Promise<Browser>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| connection | [Connection](./puppeteer.connection.md) | |
| contextIds | string\[\] | |
| ignoreHTTPSErrors | boolean | |
| defaultViewport | Viewport | |
| process | ChildProcess | |
| closeCallback | BrowserCloseCallback | |
<b>Returns:</b>
Promise&lt;[Browser](./puppeteer.browser.md)<!-- -->&gt;

15
new-docs/puppeteer.browser.createincognitobrowsercontext.md Normal file
View File

@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Browser](./puppeteer.browser.md) &gt; [createIncognitoBrowserContext](./puppeteer.browser.createincognitobrowsercontext.md)
## Browser.createIncognitoBrowserContext() method
<b>Signature:</b>
```typescript
createIncognitoBrowserContext(): Promise<BrowserContext>;
```
<b>Returns:</b>
Promise&lt;[BrowserContext](./puppeteer.browsercontext.md)<!-- -->&gt;

15
new-docs/puppeteer.browser.defaultbrowsercontext.md Normal file
View File

@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Browser](./puppeteer.browser.md) &gt; [defaultBrowserContext](./puppeteer.browser.defaultbrowsercontext.md)
## Browser.defaultBrowserContext() method
<b>Signature:</b>
```typescript
defaultBrowserContext(): BrowserContext;
```
<b>Returns:</b>
[BrowserContext](./puppeteer.browsercontext.md)

15
new-docs/puppeteer.browser.disconnect.md Normal file
View File

@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Browser](./puppeteer.browser.md) &gt; [disconnect](./puppeteer.browser.disconnect.md)
## Browser.disconnect() method
<b>Signature:</b>
```typescript
disconnect(): void;
```
<b>Returns:</b>
void

15
new-docs/puppeteer.browser.isconnected.md Normal file
View File

@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Browser](./puppeteer.browser.md) &gt; [isConnected](./puppeteer.browser.isconnected.md)
## Browser.isConnected() method
<b>Signature:</b>
```typescript
isConnected(): boolean;
```
<b>Returns:</b>
boolean

58
new-docs/puppeteer.browser.md Normal file
View File

@ -0,0 +1,58 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Browser](./puppeteer.browser.md)
## Browser class
<b>Signature:</b>
```typescript
export declare class Browser extends EventEmitter
```
## Constructors
| Constructor | Modifiers | Description |
| --- | --- | --- |
| [(constructor)(connection, contextIds, ignoreHTTPSErrors, defaultViewport, process, closeCallback)](./puppeteer.browser._constructor_.md) | | Constructs a new instance of the <code>Browser</code> class |
## Properties
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [\_closeCallback](./puppeteer.browser._closecallback.md) | | BrowserCloseCallback | |
| [\_connection](./puppeteer.browser._connection.md) | | [Connection](./puppeteer.connection.md) | |
| [\_contexts](./puppeteer.browser._contexts.md) | | Map&lt;string, [BrowserContext](./puppeteer.browsercontext.md)<!-- -->&gt; | |
| [\_defaultContext](./puppeteer.browser._defaultcontext.md) | | [BrowserContext](./puppeteer.browsercontext.md) | |
| [\_defaultViewport](./puppeteer.browser._defaultviewport.md) | | Viewport | |
| [\_ignoreHTTPSErrors](./puppeteer.browser._ignorehttpserrors.md) | | boolean | |
| [\_process](./puppeteer.browser._process.md) | | ChildProcess | |
| [\_targets](./puppeteer.browser._targets.md) | | Map&lt;string, [Target](./puppeteer.target.md)<!-- -->&gt; | |
## Methods
| Method | Modifiers | Description |
| --- | --- | --- |
| [\_createPageInContext(contextId)](./puppeteer.browser._createpageincontext.md) | | |
| [\_disposeContext(contextId)](./puppeteer.browser._disposecontext.md) | | |
| [\_getVersion()](./puppeteer.browser._getversion.md) | | |
| [\_targetCreated(event)](./puppeteer.browser._targetcreated.md) | | |
| [\_targetDestroyed(event)](./puppeteer.browser._targetdestroyed.md) | | |
| [\_targetInfoChanged(event)](./puppeteer.browser._targetinfochanged.md) | | |
| [browserContexts()](./puppeteer.browser.browsercontexts.md) | | |
| [close()](./puppeteer.browser.close.md) | | |
| [create(connection, contextIds, ignoreHTTPSErrors, defaultViewport, process, closeCallback)](./puppeteer.browser.create.md) | <code>static</code> | |
| [createIncognitoBrowserContext()](./puppeteer.browser.createincognitobrowsercontext.md) | | |
| [defaultBrowserContext()](./puppeteer.browser.defaultbrowsercontext.md) | | |
| [disconnect()](./puppeteer.browser.disconnect.md) | | |
| [isConnected()](./puppeteer.browser.isconnected.md) | | |
| [newPage()](./puppeteer.browser.newpage.md) | | |
| [pages()](./puppeteer.browser.pages.md) | | |
| [process()](./puppeteer.browser.process.md) | | |
| [target()](./puppeteer.browser.target.md) | | |
| [targets()](./puppeteer.browser.targets.md) | | |
| [userAgent()](./puppeteer.browser.useragent.md) | | |
| [version()](./puppeteer.browser.version.md) | | |
| [waitForTarget(predicate, options)](./puppeteer.browser.waitfortarget.md) | | |
| [wsEndpoint()](./puppeteer.browser.wsendpoint.md) | | |

15
new-docs/puppeteer.browser.newpage.md Normal file
View File

@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Browser](./puppeteer.browser.md) &gt; [newPage](./puppeteer.browser.newpage.md)
## Browser.newPage() method
<b>Signature:</b>
```typescript
newPage(): Promise<Page>;
```
<b>Returns:</b>
Promise&lt;[Page](./puppeteer.page.md)<!-- -->&gt;

15
new-docs/puppeteer.browser.pages.md Normal file
View File

@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Browser](./puppeteer.browser.md) &gt; [pages](./puppeteer.browser.pages.md)
## Browser.pages() method
<b>Signature:</b>
```typescript
pages(): Promise<Page[]>;
```
<b>Returns:</b>
Promise&lt;[Page](./puppeteer.page.md)<!-- -->\[\]&gt;

15
new-docs/puppeteer.browser.process.md Normal file
View File

@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Browser](./puppeteer.browser.md) &gt; [process](./puppeteer.browser.process.md)
## Browser.process() method
<b>Signature:</b>
```typescript
process(): ChildProcess | null;
```
<b>Returns:</b>
ChildProcess \| null

15
new-docs/puppeteer.browser.target.md Normal file
View File

@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Browser](./puppeteer.browser.md) &gt; [target](./puppeteer.browser.target.md)
## Browser.target() method
<b>Signature:</b>
```typescript
target(): Target;
```
<b>Returns:</b>
[Target](./puppeteer.target.md)

15
new-docs/puppeteer.browser.targets.md Normal file
View File

@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Browser](./puppeteer.browser.md) &gt; [targets](./puppeteer.browser.targets.md)
## Browser.targets() method
<b>Signature:</b>
```typescript
targets(): Target[];
```
<b>Returns:</b>
[Target](./puppeteer.target.md)<!-- -->\[\]

15
new-docs/puppeteer.browser.useragent.md Normal file
View File

@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Browser](./puppeteer.browser.md) &gt; [userAgent](./puppeteer.browser.useragent.md)
## Browser.userAgent() method
<b>Signature:</b>
```typescript
userAgent(): Promise<string>;
```
<b>Returns:</b>
Promise&lt;string&gt;

15
new-docs/puppeteer.browser.version.md Normal file
View File

@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Browser](./puppeteer.browser.md) &gt; [version](./puppeteer.browser.version.md)
## Browser.version() method
<b>Signature:</b>
```typescript
version(): Promise<string>;
```
<b>Returns:</b>
Promise&lt;string&gt;

25
new-docs/puppeteer.browser.waitfortarget.md Normal file
View File

@ -0,0 +1,25 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Browser](./puppeteer.browser.md) &gt; [waitForTarget](./puppeteer.browser.waitfortarget.md)
## Browser.waitForTarget() method
<b>Signature:</b>
```typescript
waitForTarget(predicate: (x: Target) => boolean, options?: {
timeout?: number;
}): Promise<Target>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| predicate | (x: [Target](./puppeteer.target.md)<!-- -->) =&gt; boolean | |
| options | { timeout?: number; } | {<!-- -->!Promise<!-- -->&lt;<!-- -->!Target<!-- -->&gt;<!-- -->} |
<b>Returns:</b>
Promise&lt;[Target](./puppeteer.target.md)<!-- -->&gt;

15
new-docs/puppeteer.browser.wsendpoint.md Normal file
View File

@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Browser](./puppeteer.browser.md) &gt; [wsEndpoint](./puppeteer.browser.wsendpoint.md)
## Browser.wsEndpoint() method
<b>Signature:</b>
```typescript
wsEndpoint(): string;
```
<b>Returns:</b>
string

11
new-docs/puppeteer.browsercontext._browser.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [BrowserContext](./puppeteer.browsercontext.md) &gt; [\_browser](./puppeteer.browsercontext._browser.md)
## BrowserContext.\_browser property
<b>Signature:</b>
```typescript
_browser: Browser;
```

11
new-docs/puppeteer.browsercontext._connection.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [BrowserContext](./puppeteer.browsercontext.md) &gt; [\_connection](./puppeteer.browsercontext._connection.md)
## BrowserContext.\_connection property
<b>Signature:</b>
```typescript
_connection: Connection;
```

22
new-docs/puppeteer.browsercontext._constructor_.md Normal file
View File

@ -0,0 +1,22 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [BrowserContext](./puppeteer.browsercontext.md) &gt; [(constructor)](./puppeteer.browsercontext._constructor_.md)
## BrowserContext.(constructor)
Constructs a new instance of the `BrowserContext` class
<b>Signature:</b>
```typescript
constructor(connection: Connection, browser: Browser, contextId?: string);
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| connection | [Connection](./puppeteer.connection.md) | |
| browser | [Browser](./puppeteer.browser.md) | |
| contextId | string | |

11
new-docs/puppeteer.browsercontext._id.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [BrowserContext](./puppeteer.browsercontext.md) &gt; [\_id](./puppeteer.browsercontext._id.md)
## BrowserContext.\_id property
<b>Signature:</b>
```typescript
_id?: string;
```

15
new-docs/puppeteer.browsercontext.browser.md Normal file
View File

@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [BrowserContext](./puppeteer.browsercontext.md) &gt; [browser](./puppeteer.browsercontext.browser.md)
## BrowserContext.browser() method
<b>Signature:</b>
```typescript
browser(): Browser;
```
<b>Returns:</b>
[Browser](./puppeteer.browser.md)

15
new-docs/puppeteer.browsercontext.clearpermissionoverrides.md Normal file
View File

@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [BrowserContext](./puppeteer.browsercontext.md) &gt; [clearPermissionOverrides](./puppeteer.browsercontext.clearpermissionoverrides.md)
## BrowserContext.clearPermissionOverrides() method
<b>Signature:</b>
```typescript
clearPermissionOverrides(): Promise<void>;
```
<b>Returns:</b>
Promise&lt;void&gt;

15
new-docs/puppeteer.browsercontext.close.md Normal file
View File

@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [BrowserContext](./puppeteer.browsercontext.md) &gt; [close](./puppeteer.browsercontext.close.md)
## BrowserContext.close() method
<b>Signature:</b>
```typescript
close(): Promise<void>;
```
<b>Returns:</b>
Promise&lt;void&gt;

15
new-docs/puppeteer.browsercontext.isincognito.md Normal file
View File

@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [BrowserContext](./puppeteer.browsercontext.md) &gt; [isIncognito](./puppeteer.browsercontext.isincognito.md)
## BrowserContext.isIncognito() method
<b>Signature:</b>
```typescript
isIncognito(): boolean;
```
<b>Returns:</b>
boolean

40
new-docs/puppeteer.browsercontext.md Normal file
View File

@ -0,0 +1,40 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [BrowserContext](./puppeteer.browsercontext.md)
## BrowserContext class
<b>Signature:</b>
```typescript
export declare class BrowserContext extends EventEmitter
```
## Constructors
| Constructor | Modifiers | Description |
| --- | --- | --- |
| [(constructor)(connection, browser, contextId)](./puppeteer.browsercontext._constructor_.md) | | Constructs a new instance of the <code>BrowserContext</code> class |
## Properties
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [\_browser](./puppeteer.browsercontext._browser.md) | | [Browser](./puppeteer.browser.md) | |
| [\_connection](./puppeteer.browsercontext._connection.md) | | [Connection](./puppeteer.connection.md) | |
| [\_id](./puppeteer.browsercontext._id.md) | | string | |
## Methods
| Method | Modifiers | Description |
| --- | --- | --- |
| [browser()](./puppeteer.browsercontext.browser.md) | | |
| [clearPermissionOverrides()](./puppeteer.browsercontext.clearpermissionoverrides.md) | | |
| [close()](./puppeteer.browsercontext.close.md) | | |
| [isIncognito()](./puppeteer.browsercontext.isincognito.md) | | |
| [newPage()](./puppeteer.browsercontext.newpage.md) | | |
| [overridePermissions(origin, permissions)](./puppeteer.browsercontext.overridepermissions.md) | | |
| [pages()](./puppeteer.browsercontext.pages.md) | | |
| [targets()](./puppeteer.browsercontext.targets.md) | | |
| [waitForTarget(predicate, options)](./puppeteer.browsercontext.waitfortarget.md) | | |

15
new-docs/puppeteer.browsercontext.newpage.md Normal file
View File

@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [BrowserContext](./puppeteer.browsercontext.md) &gt; [newPage](./puppeteer.browsercontext.newpage.md)
## BrowserContext.newPage() method
<b>Signature:</b>
```typescript
newPage(): Promise<Page>;
```
<b>Returns:</b>
Promise&lt;[Page](./puppeteer.page.md)<!-- -->&gt;

23
new-docs/puppeteer.browsercontext.overridepermissions.md Normal file
View File

@ -0,0 +1,23 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [BrowserContext](./puppeteer.browsercontext.md) &gt; [overridePermissions](./puppeteer.browsercontext.overridepermissions.md)
## BrowserContext.overridePermissions() method
<b>Signature:</b>
```typescript
overridePermissions(origin: string, permissions: Protocol.Browser.PermissionType[]): Promise<void>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| origin | string | |
| permissions | Protocol.Browser.PermissionType\[\] | |
<b>Returns:</b>
Promise&lt;void&gt;

15
new-docs/puppeteer.browsercontext.pages.md Normal file
View File

@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [BrowserContext](./puppeteer.browsercontext.md) &gt; [pages](./puppeteer.browsercontext.pages.md)
## BrowserContext.pages() method
<b>Signature:</b>
```typescript
pages(): Promise<Page[]>;
```
<b>Returns:</b>
Promise&lt;[Page](./puppeteer.page.md)<!-- -->\[\]&gt;

15
new-docs/puppeteer.browsercontext.targets.md Normal file
View File

@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [BrowserContext](./puppeteer.browsercontext.md) &gt; [targets](./puppeteer.browsercontext.targets.md)
## BrowserContext.targets() method
<b>Signature:</b>
```typescript
targets(): Target[];
```
<b>Returns:</b>
[Target](./puppeteer.target.md)<!-- -->\[\]

25
new-docs/puppeteer.browsercontext.waitfortarget.md Normal file
View File

@ -0,0 +1,25 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [BrowserContext](./puppeteer.browsercontext.md) &gt; [waitForTarget](./puppeteer.browsercontext.waitfortarget.md)
## BrowserContext.waitForTarget() method
<b>Signature:</b>
```typescript
waitForTarget(predicate: (x: Target) => boolean, options: {
timeout?: number;
}): Promise<Target>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| predicate | (x: [Target](./puppeteer.target.md)<!-- -->) =&gt; boolean | |
| options | { timeout?: number; } | |
<b>Returns:</b>
Promise&lt;[Target](./puppeteer.target.md)<!-- -->&gt;

21
new-docs/puppeteer.browserfetcher._constructor_.md Normal file
View File

@ -0,0 +1,21 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [BrowserFetcher](./puppeteer.browserfetcher.md) &gt; [(constructor)](./puppeteer.browserfetcher._constructor_.md)
## BrowserFetcher.(constructor)
Constructs a new instance of the `BrowserFetcher` class
<b>Signature:</b>
```typescript
constructor(projectRoot: string, options?: BrowserFetcherOptions);
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| projectRoot | string | |
| options | [BrowserFetcherOptions](./puppeteer.browserfetcheroptions.md) | |

22
new-docs/puppeteer.browserfetcher._getfolderpath.md Normal file
View File

@ -0,0 +1,22 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [BrowserFetcher](./puppeteer.browserfetcher.md) &gt; [\_getFolderPath](./puppeteer.browserfetcher._getfolderpath.md)
## BrowserFetcher.\_getFolderPath() method
<b>Signature:</b>
```typescript
_getFolderPath(revision: string): string;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| revision | string | {<!-- -->string<!-- -->} |
<b>Returns:</b>
string

22
new-docs/puppeteer.browserfetcher.candownload.md Normal file
View File

@ -0,0 +1,22 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [BrowserFetcher](./puppeteer.browserfetcher.md) &gt; [canDownload](./puppeteer.browserfetcher.candownload.md)
## BrowserFetcher.canDownload() method
<b>Signature:</b>
```typescript
canDownload(revision: string): Promise<boolean>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| revision | string | |
<b>Returns:</b>
Promise&lt;boolean&gt;

23
new-docs/puppeteer.browserfetcher.download.md Normal file
View File

@ -0,0 +1,23 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [BrowserFetcher](./puppeteer.browserfetcher.md) &gt; [download](./puppeteer.browserfetcher.download.md)
## BrowserFetcher.download() method
<b>Signature:</b>
```typescript
download(revision: string, progressCallback: (x: number, y: number) => void): Promise<BrowserFetcherRevisionInfo>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| revision | string | |
| progressCallback | (x: number, y: number) =&gt; void | {<!-- -->!Promise<!-- -->&lt;<!-- -->!BrowserFetcher.RevisionInfo<!-- -->&gt;<!-- -->} |
<b>Returns:</b>
Promise&lt;BrowserFetcherRevisionInfo&gt;

15
new-docs/puppeteer.browserfetcher.host.md Normal file
View File

@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [BrowserFetcher](./puppeteer.browserfetcher.md) &gt; [host](./puppeteer.browserfetcher.host.md)
## BrowserFetcher.host() method
<b>Signature:</b>
```typescript
host(): string;
```
<b>Returns:</b>
string

15
new-docs/puppeteer.browserfetcher.localrevisions.md Normal file
View File

@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [BrowserFetcher](./puppeteer.browserfetcher.md) &gt; [localRevisions](./puppeteer.browserfetcher.localrevisions.md)
## BrowserFetcher.localRevisions() method
<b>Signature:</b>
```typescript
localRevisions(): Promise<string[]>;
```
<b>Returns:</b>
Promise&lt;string\[\]&gt;

32
new-docs/puppeteer.browserfetcher.md Normal file
View File

@ -0,0 +1,32 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [BrowserFetcher](./puppeteer.browserfetcher.md)
## BrowserFetcher class
<b>Signature:</b>
```typescript
export declare class BrowserFetcher
```
## Constructors
| Constructor | Modifiers | Description |
| --- | --- | --- |
| [(constructor)(projectRoot, options)](./puppeteer.browserfetcher._constructor_.md) | | Constructs a new instance of the <code>BrowserFetcher</code> class |
## Methods
| Method | Modifiers | Description |
| --- | --- | --- |
| [\_getFolderPath(revision)](./puppeteer.browserfetcher._getfolderpath.md) | | |
| [canDownload(revision)](./puppeteer.browserfetcher.candownload.md) | | |
| [download(revision, progressCallback)](./puppeteer.browserfetcher.download.md) | | |
| [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) | | |

15
new-docs/puppeteer.browserfetcher.platform.md Normal file
View File

@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [BrowserFetcher](./puppeteer.browserfetcher.md) &gt; [platform](./puppeteer.browserfetcher.platform.md)
## BrowserFetcher.platform() method
<b>Signature:</b>
```typescript
platform(): string;
```
<b>Returns:</b>
string

15
new-docs/puppeteer.browserfetcher.product.md Normal file
View File

@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [BrowserFetcher](./puppeteer.browserfetcher.md) &gt; [product](./puppeteer.browserfetcher.product.md)
## BrowserFetcher.product() method
<b>Signature:</b>
```typescript
product(): string;
```
<b>Returns:</b>
string

22
new-docs/puppeteer.browserfetcher.remove.md Normal file
View File

@ -0,0 +1,22 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [BrowserFetcher](./puppeteer.browserfetcher.md) &gt; [remove](./puppeteer.browserfetcher.remove.md)
## BrowserFetcher.remove() method
<b>Signature:</b>
```typescript
remove(revision: string): Promise<void>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| revision | string | |
<b>Returns:</b>
Promise&lt;void&gt;

22
new-docs/puppeteer.browserfetcher.revisioninfo.md Normal file
View File

@ -0,0 +1,22 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [BrowserFetcher](./puppeteer.browserfetcher.md) &gt; [revisionInfo](./puppeteer.browserfetcher.revisioninfo.md)
## BrowserFetcher.revisionInfo() method
<b>Signature:</b>
```typescript
revisionInfo(revision: string): BrowserFetcherRevisionInfo;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| revision | string | |
<b>Returns:</b>
BrowserFetcherRevisionInfo

11
new-docs/puppeteer.browserfetcheroptions.host.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [BrowserFetcherOptions](./puppeteer.browserfetcheroptions.md) &gt; [host](./puppeteer.browserfetcheroptions.host.md)
## BrowserFetcherOptions.host property
<b>Signature:</b>
```typescript
host?: string;
```

21
new-docs/puppeteer.browserfetcheroptions.md Normal file
View File

@ -0,0 +1,21 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [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 | |
| [product](./puppeteer.browserfetcheroptions.product.md) | string | |

11
new-docs/puppeteer.browserfetcheroptions.path.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [BrowserFetcherOptions](./puppeteer.browserfetcheroptions.md) &gt; [path](./puppeteer.browserfetcheroptions.path.md)
## BrowserFetcherOptions.path property
<b>Signature:</b>
```typescript
path?: string;
```

11
new-docs/puppeteer.browserfetcheroptions.platform.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [BrowserFetcherOptions](./puppeteer.browserfetcheroptions.md) &gt; [platform](./puppeteer.browserfetcheroptions.platform.md)
## BrowserFetcherOptions.platform property
<b>Signature:</b>
```typescript
platform?: Platform;
```

11
new-docs/puppeteer.browserfetcheroptions.product.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [BrowserFetcherOptions](./puppeteer.browserfetcheroptions.md) &gt; [product](./puppeteer.browserfetcheroptions.product.md)
## BrowserFetcherOptions.product property
<b>Signature:</b>
```typescript
product?: string;
```

11
new-docs/puppeteer.cdpsession._callbacks.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [CDPSession](./puppeteer.cdpsession.md) &gt; [\_callbacks](./puppeteer.cdpsession._callbacks.md)
## CDPSession.\_callbacks property
<b>Signature:</b>
```typescript
_callbacks: Map<number, ConnectionCallback>;
```

11
new-docs/puppeteer.cdpsession._connection.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [CDPSession](./puppeteer.cdpsession.md) &gt; [\_connection](./puppeteer.cdpsession._connection.md)
## CDPSession.\_connection property
<b>Signature:</b>
```typescript
_connection: Connection;
```

22
new-docs/puppeteer.cdpsession._constructor_.md Normal file
View File

@ -0,0 +1,22 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [CDPSession](./puppeteer.cdpsession.md) &gt; [(constructor)](./puppeteer.cdpsession._constructor_.md)
## CDPSession.(constructor)
Constructs a new instance of the `CDPSession` class
<b>Signature:</b>
```typescript
constructor(connection: Connection, targetType: string, sessionId: string);
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| connection | [Connection](./puppeteer.connection.md) | |
| targetType | string | |
| sessionId | string | |

15
new-docs/puppeteer.cdpsession._onclosed.md Normal file
View File

@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [CDPSession](./puppeteer.cdpsession.md) &gt; [\_onClosed](./puppeteer.cdpsession._onclosed.md)
## CDPSession.\_onClosed() method
<b>Signature:</b>
```typescript
_onClosed(): void;
```
<b>Returns:</b>
void

22
new-docs/puppeteer.cdpsession._onmessage.md Normal file
View File

@ -0,0 +1,22 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [CDPSession](./puppeteer.cdpsession.md) &gt; [\_onMessage](./puppeteer.cdpsession._onmessage.md)
## CDPSession.\_onMessage() method
<b>Signature:</b>
```typescript
_onMessage(object: CDPSessionOnMessageObject): void;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| object | CDPSessionOnMessageObject | |
<b>Returns:</b>
void

11
new-docs/puppeteer.cdpsession._sessionid.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [CDPSession](./puppeteer.cdpsession.md) &gt; [\_sessionId](./puppeteer.cdpsession._sessionid.md)
## CDPSession.\_sessionId property
<b>Signature:</b>
```typescript
_sessionId: string;
```

11
new-docs/puppeteer.cdpsession._targettype.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [CDPSession](./puppeteer.cdpsession.md) &gt; [\_targetType](./puppeteer.cdpsession._targettype.md)
## CDPSession.\_targetType property
<b>Signature:</b>
```typescript
_targetType: string;
```

15
new-docs/puppeteer.cdpsession.detach.md Normal file
View File

@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [CDPSession](./puppeteer.cdpsession.md) &gt; [detach](./puppeteer.cdpsession.detach.md)
## CDPSession.detach() method
<b>Signature:</b>
```typescript
detach(): Promise<void>;
```
<b>Returns:</b>
Promise&lt;void&gt;

36
new-docs/puppeteer.cdpsession.md Normal file
View File

@ -0,0 +1,36 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [CDPSession](./puppeteer.cdpsession.md)
## CDPSession class
<b>Signature:</b>
```typescript
export declare class CDPSession extends EventEmitter
```
## Constructors
| Constructor | Modifiers | Description |
| --- | --- | --- |
| [(constructor)(connection, targetType, sessionId)](./puppeteer.cdpsession._constructor_.md) | | Constructs a new instance of the <code>CDPSession</code> class |
## Properties
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [\_callbacks](./puppeteer.cdpsession._callbacks.md) | | Map&lt;number, ConnectionCallback&gt; | |
| [\_connection](./puppeteer.cdpsession._connection.md) | | [Connection](./puppeteer.connection.md) | |
| [\_sessionId](./puppeteer.cdpsession._sessionid.md) | | string | |
| [\_targetType](./puppeteer.cdpsession._targettype.md) | | string | |
## Methods
| Method | Modifiers | Description |
| --- | --- | --- |
| [\_onClosed()](./puppeteer.cdpsession._onclosed.md) | | |
| [\_onMessage(object)](./puppeteer.cdpsession._onmessage.md) | | |
| [detach()](./puppeteer.cdpsession.detach.md) | | |
| [send(method, params)](./puppeteer.cdpsession.send.md) | | |

23
new-docs/puppeteer.cdpsession.send.md Normal file
View File

@ -0,0 +1,23 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [CDPSession](./puppeteer.cdpsession.md) &gt; [send](./puppeteer.cdpsession.send.md)
## CDPSession.send() method
<b>Signature:</b>
```typescript
send<T extends keyof Protocol.CommandParameters>(method: T, params?: Protocol.CommandParameters[T]): Promise<Protocol.CommandReturnValues[T]>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| method | T | |
| params | Protocol.CommandParameters\[T\] | |
<b>Returns:</b>
Promise&lt;Protocol.CommandReturnValues\[T\]&gt;

11
new-docs/puppeteer.connection._callbacks.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Connection](./puppeteer.connection.md) &gt; [\_callbacks](./puppeteer.connection._callbacks.md)
## Connection.\_callbacks property
<b>Signature:</b>
```typescript
_callbacks: Map<number, ConnectionCallback>;
```

11
new-docs/puppeteer.connection._closed.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Connection](./puppeteer.connection.md) &gt; [\_closed](./puppeteer.connection._closed.md)
## Connection.\_closed property
<b>Signature:</b>
```typescript
_closed: boolean;
```

22
new-docs/puppeteer.connection._constructor_.md Normal file
View File

@ -0,0 +1,22 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Connection](./puppeteer.connection.md) &gt; [(constructor)](./puppeteer.connection._constructor_.md)
## Connection.(constructor)
Constructs a new instance of the `Connection` class
<b>Signature:</b>
```typescript
constructor(url: string, transport: ConnectionTransport, delay?: number);
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| url | string | |
| transport | ConnectionTransport | |
| delay | number | |

11
new-docs/puppeteer.connection._delay.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Connection](./puppeteer.connection.md) &gt; [\_delay](./puppeteer.connection._delay.md)
## Connection.\_delay property
<b>Signature:</b>
```typescript
_delay: number;
```

11
new-docs/puppeteer.connection._lastid.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Connection](./puppeteer.connection.md) &gt; [\_lastId](./puppeteer.connection._lastid.md)
## Connection.\_lastId property
<b>Signature:</b>
```typescript
_lastId: number;
```

15
new-docs/puppeteer.connection._onclose.md Normal file
View File

@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Connection](./puppeteer.connection.md) &gt; [\_onClose](./puppeteer.connection._onclose.md)
## Connection.\_onClose() method
<b>Signature:</b>
```typescript
_onClose(): void;
```
<b>Returns:</b>
void

22
new-docs/puppeteer.connection._onmessage.md Normal file
View File

@ -0,0 +1,22 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Connection](./puppeteer.connection.md) &gt; [\_onMessage](./puppeteer.connection._onmessage.md)
## Connection.\_onMessage() method
<b>Signature:</b>
```typescript
_onMessage(message: string): Promise<void>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| message | string | |
<b>Returns:</b>
Promise&lt;void&gt;

22
new-docs/puppeteer.connection._rawsend.md Normal file
View File

@ -0,0 +1,22 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Connection](./puppeteer.connection.md) &gt; [\_rawSend](./puppeteer.connection._rawsend.md)
## Connection.\_rawSend() method
<b>Signature:</b>
```typescript
_rawSend(message: {}): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| message | {} | |
<b>Returns:</b>
number

11
new-docs/puppeteer.connection._sessions.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Connection](./puppeteer.connection.md) &gt; [\_sessions](./puppeteer.connection._sessions.md)
## Connection.\_sessions property
<b>Signature:</b>
```typescript
_sessions: Map<string, CDPSession>;
```

11
new-docs/puppeteer.connection._transport.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Connection](./puppeteer.connection.md) &gt; [\_transport](./puppeteer.connection._transport.md)
## Connection.\_transport property
<b>Signature:</b>
```typescript
_transport: ConnectionTransport;
```

11
new-docs/puppeteer.connection._url.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Connection](./puppeteer.connection.md) &gt; [\_url](./puppeteer.connection._url.md)
## Connection.\_url property
<b>Signature:</b>
```typescript
_url: string;
```

22
new-docs/puppeteer.connection.createsession.md Normal file
View File

@ -0,0 +1,22 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Connection](./puppeteer.connection.md) &gt; [createSession](./puppeteer.connection.createsession.md)
## Connection.createSession() method
<b>Signature:</b>
```typescript
createSession(targetInfo: Protocol.Target.TargetInfo): Promise<CDPSession>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| targetInfo | Protocol.Target.TargetInfo | {<!-- -->!Promise<!-- -->&lt;<!-- -->!CDPSession<!-- -->&gt;<!-- -->} |
<b>Returns:</b>
Promise&lt;[CDPSession](./puppeteer.cdpsession.md)<!-- -->&gt;

15
new-docs/puppeteer.connection.dispose.md Normal file
View File

@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Connection](./puppeteer.connection.md) &gt; [dispose](./puppeteer.connection.dispose.md)
## Connection.dispose() method
<b>Signature:</b>
```typescript
dispose(): void;
```
<b>Returns:</b>
void

22
new-docs/puppeteer.connection.fromsession.md Normal file
View File

@ -0,0 +1,22 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Connection](./puppeteer.connection.md) &gt; [fromSession](./puppeteer.connection.fromsession.md)
## Connection.fromSession() method
<b>Signature:</b>
```typescript
static fromSession(session: CDPSession): Connection;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| session | [CDPSession](./puppeteer.cdpsession.md) | |
<b>Returns:</b>
[Connection](./puppeteer.connection.md)

44
new-docs/puppeteer.connection.md Normal file
View File

@ -0,0 +1,44 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Connection](./puppeteer.connection.md)
## Connection class
<b>Signature:</b>
```typescript
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 |
## Properties
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [\_callbacks](./puppeteer.connection._callbacks.md) | | Map&lt;number, ConnectionCallback&gt; | |
| [\_closed](./puppeteer.connection._closed.md) | | boolean | |
| [\_delay](./puppeteer.connection._delay.md) | | number | |
| [\_lastId](./puppeteer.connection._lastid.md) | | number | |
| [\_sessions](./puppeteer.connection._sessions.md) | | Map&lt;string, [CDPSession](./puppeteer.cdpsession.md)<!-- -->&gt; | |
| [\_transport](./puppeteer.connection._transport.md) | | ConnectionTransport | |
| [\_url](./puppeteer.connection._url.md) | | string | |
## Methods
| Method | Modifiers | Description |
| --- | --- | --- |
| [\_onClose()](./puppeteer.connection._onclose.md) | | |
| [\_onMessage(message)](./puppeteer.connection._onmessage.md) | | |
| [\_rawSend(message)](./puppeteer.connection._rawsend.md) | | |
| [createSession(targetInfo)](./puppeteer.connection.createsession.md) | | |
| [dispose()](./puppeteer.connection.dispose.md) | | |
| [fromSession(session)](./puppeteer.connection.fromsession.md) | <code>static</code> | |
| [send(method, params)](./puppeteer.connection.send.md) | | |
| [session(sessionId)](./puppeteer.connection.session.md) | | |
| [url()](./puppeteer.connection.url.md) | | |

23
new-docs/puppeteer.connection.send.md Normal file
View File

@ -0,0 +1,23 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Connection](./puppeteer.connection.md) &gt; [send](./puppeteer.connection.send.md)
## Connection.send() method
<b>Signature:</b>
```typescript
send<T extends keyof Protocol.CommandParameters>(method: T, params?: Protocol.CommandParameters[T]): Promise<Protocol.CommandReturnValues[T]>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| method | T | |
| params | Protocol.CommandParameters\[T\] | |
<b>Returns:</b>
Promise&lt;Protocol.CommandReturnValues\[T\]&gt;

22
new-docs/puppeteer.connection.session.md Normal file
View File

@ -0,0 +1,22 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Connection](./puppeteer.connection.md) &gt; [session](./puppeteer.connection.session.md)
## Connection.session() method
<b>Signature:</b>
```typescript
session(sessionId: string): CDPSession | null;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| sessionId | string | {<!-- -->?CDPSession<!-- -->} |
<b>Returns:</b>
[CDPSession](./puppeteer.cdpsession.md) \| null

15
new-docs/puppeteer.connection.url.md Normal file
View File

@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Connection](./puppeteer.connection.md) &gt; [url](./puppeteer.connection.url.md)
## Connection.url() method
<b>Signature:</b>
```typescript
url(): string;
```
<b>Returns:</b>
string

23
new-docs/puppeteer.consolemessage._constructor_.md Normal file
View File

@ -0,0 +1,23 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [ConsoleMessage](./puppeteer.consolemessage.md) &gt; [(constructor)](./puppeteer.consolemessage._constructor_.md)
## ConsoleMessage.(constructor)
Constructs a new instance of the `ConsoleMessage` class
<b>Signature:</b>
```typescript
constructor(type: string, text: string, args: JSHandle[], location?: ConsoleMessageLocation);
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| type | string | |
| text | string | |
| args | [JSHandle](./puppeteer.jshandle.md)<!-- -->\[\] | |
| location | ConsoleMessageLocation | |

15
new-docs/puppeteer.consolemessage.args.md Normal file
View File

@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [ConsoleMessage](./puppeteer.consolemessage.md) &gt; [args](./puppeteer.consolemessage.args.md)
## ConsoleMessage.args() method
<b>Signature:</b>
```typescript
args(): JSHandle[];
```
<b>Returns:</b>
[JSHandle](./puppeteer.jshandle.md)<!-- -->\[\]

15
new-docs/puppeteer.consolemessage.location.md Normal file
View File

@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [ConsoleMessage](./puppeteer.consolemessage.md) &gt; [location](./puppeteer.consolemessage.location.md)
## ConsoleMessage.location() method
<b>Signature:</b>
```typescript
location(): ConsoleMessageLocation;
```
<b>Returns:</b>
ConsoleMessageLocation

27
new-docs/puppeteer.consolemessage.md Normal file
View File

@ -0,0 +1,27 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [ConsoleMessage](./puppeteer.consolemessage.md)
## ConsoleMessage class
<b>Signature:</b>
```typescript
export declare class ConsoleMessage
```
## Constructors
| Constructor | Modifiers | Description |
| --- | --- | --- |
| [(constructor)(type, text, args, location)](./puppeteer.consolemessage._constructor_.md) | | Constructs a new instance of the <code>ConsoleMessage</code> class |
## Methods
| Method | Modifiers | Description |
| --- | --- | --- |
| [args()](./puppeteer.consolemessage.args.md) | | |
| [location()](./puppeteer.consolemessage.location.md) | | |
| [text()](./puppeteer.consolemessage.text.md) | | |
| [type()](./puppeteer.consolemessage.type.md) | | |

15
new-docs/puppeteer.consolemessage.text.md Normal file
View File

@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [ConsoleMessage](./puppeteer.consolemessage.md) &gt; [text](./puppeteer.consolemessage.text.md)
## ConsoleMessage.text() method
<b>Signature:</b>
```typescript
text(): string;
```
<b>Returns:</b>
string

15
new-docs/puppeteer.consolemessage.type.md Normal file
View File

@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [ConsoleMessage](./puppeteer.consolemessage.md) &gt; [type](./puppeteer.consolemessage.type.md)
## ConsoleMessage.type() method
<b>Signature:</b>
```typescript
type(): string;
```
<b>Returns:</b>
string

Some files were not shown because too many files have changed in this diff Show More