Skip to content

Commit

Permalink
chore: commit base new-docs (#5973)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
jackfranklin committed Jun 4, 2020
1 parent 0032420 commit 086c089
Show file tree
Hide file tree
Showing 505 changed files with 9,539 additions and 0 deletions.
12 changes: 12 additions & 0 deletions new-docs/index.md
Original file line number Diff line number Diff line change
@@ -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 changes: 20 additions & 0 deletions new-docs/puppeteer.accessibility._constructor_.md
Original file line number Diff line number Diff line change
@@ -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 changes: 24 additions & 0 deletions new-docs/puppeteer.accessibility.md
Original file line number Diff line number Diff line change
@@ -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 changes: 25 additions & 0 deletions new-docs/puppeteer.accessibility.snapshot.md
Original file line number Diff line number Diff line change
@@ -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 changes: 11 additions & 0 deletions new-docs/puppeteer.browser._closecallback.md
Original file line number Diff line number Diff line change
@@ -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 changes: 11 additions & 0 deletions new-docs/puppeteer.browser._connection.md
Original file line number Diff line number Diff line change
@@ -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 changes: 25 additions & 0 deletions new-docs/puppeteer.browser._constructor_.md
Original file line number Diff line number Diff line change
@@ -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 changes: 11 additions & 0 deletions new-docs/puppeteer.browser._contexts.md
Original file line number Diff line number Diff line change
@@ -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 changes: 22 additions & 0 deletions new-docs/puppeteer.browser._createpageincontext.md
Original file line number Diff line number Diff line change
@@ -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 changes: 11 additions & 0 deletions new-docs/puppeteer.browser._defaultcontext.md
Original file line number Diff line number Diff line change
@@ -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 changes: 11 additions & 0 deletions new-docs/puppeteer.browser._defaultviewport.md
Original file line number Diff line number Diff line change
@@ -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 changes: 22 additions & 0 deletions new-docs/puppeteer.browser._disposecontext.md
Original file line number Diff line number Diff line change
@@ -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 changes: 15 additions & 0 deletions new-docs/puppeteer.browser._getversion.md
Original file line number Diff line number Diff line change
@@ -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 changes: 11 additions & 0 deletions new-docs/puppeteer.browser._ignorehttpserrors.md
Original file line number Diff line number Diff line change
@@ -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 changes: 11 additions & 0 deletions new-docs/puppeteer.browser._process.md
Original file line number Diff line number Diff line change
@@ -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 changes: 22 additions & 0 deletions new-docs/puppeteer.browser._targetcreated.md
Original file line number Diff line number Diff line change
@@ -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 changes: 24 additions & 0 deletions new-docs/puppeteer.browser._targetdestroyed.md
Original file line number Diff line number Diff line change
@@ -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 changes: 22 additions & 0 deletions new-docs/puppeteer.browser._targetinfochanged.md
Original file line number Diff line number Diff line change
@@ -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 changes: 11 additions & 0 deletions new-docs/puppeteer.browser._targets.md
Original file line number Diff line number Diff line change
@@ -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 changes: 15 additions & 0 deletions new-docs/puppeteer.browser.browsercontexts.md
Original file line number Diff line number Diff line change
@@ -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 changes: 15 additions & 0 deletions new-docs/puppeteer.browser.close.md
Original file line number Diff line number Diff line change
@@ -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 changes: 27 additions & 0 deletions new-docs/puppeteer.browser.create.md
Original file line number Diff line number Diff line change
@@ -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;

0 comments on commit 086c089

Please sign in to comment.