Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(docs): fix more documentation warnings #6145

Merged
merged 1 commit into from Jul 2, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
20 changes: 20 additions & 0 deletions new-docs/puppeteer.credentials.md
@@ -0,0 +1,20 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Credentials](./puppeteer.credentials.md)

## Credentials interface


<b>Signature:</b>

```typescript
export interface Credentials
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [password](./puppeteer.credentials.password.md) | string | |
| [username](./puppeteer.credentials.username.md) | string | |

11 changes: 11 additions & 0 deletions new-docs/puppeteer.credentials.password.md
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Credentials](./puppeteer.credentials.md) &gt; [password](./puppeteer.credentials.password.md)

## Credentials.password property

<b>Signature:</b>

```typescript
password: string;
```
11 changes: 11 additions & 0 deletions new-docs/puppeteer.credentials.username.md
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Credentials](./puppeteer.credentials.md) &gt; [username](./puppeteer.credentials.username.md)

## Credentials.username property

<b>Signature:</b>

```typescript
username: string;
```
11 changes: 0 additions & 11 deletions new-docs/puppeteer.frame._childframes.md

This file was deleted.

11 changes: 0 additions & 11 deletions new-docs/puppeteer.frame._client.md

This file was deleted.

23 changes: 0 additions & 23 deletions new-docs/puppeteer.frame._constructor_.md

This file was deleted.

11 changes: 0 additions & 11 deletions new-docs/puppeteer.frame._detached.md

This file was deleted.

11 changes: 0 additions & 11 deletions new-docs/puppeteer.frame._framemanager.md

This file was deleted.

11 changes: 0 additions & 11 deletions new-docs/puppeteer.frame._id.md

This file was deleted.

11 changes: 0 additions & 11 deletions new-docs/puppeteer.frame._lifecycleevents.md

This file was deleted.

11 changes: 0 additions & 11 deletions new-docs/puppeteer.frame._loaderid.md

This file was deleted.

11 changes: 0 additions & 11 deletions new-docs/puppeteer.frame._mainworld.md

This file was deleted.

11 changes: 0 additions & 11 deletions new-docs/puppeteer.frame._name.md

This file was deleted.

11 changes: 0 additions & 11 deletions new-docs/puppeteer.frame._parentframe.md

This file was deleted.

11 changes: 0 additions & 11 deletions new-docs/puppeteer.frame._secondaryworld.md

This file was deleted.

11 changes: 0 additions & 11 deletions new-docs/puppeteer.frame._url.md

This file was deleted.

23 changes: 2 additions & 21 deletions new-docs/puppeteer.frame.md
Expand Up @@ -10,28 +10,9 @@
export declare class Frame
```

## Constructors
## Remarks

| Constructor | Modifiers | Description |
| --- | --- | --- |
| [(constructor)(frameManager, client, parentFrame, frameId)](./puppeteer.frame._constructor_.md) | | Constructs a new instance of the <code>Frame</code> class |

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [\_childFrames](./puppeteer.frame._childframes.md) | | Set&lt;[Frame](./puppeteer.frame.md)<!-- -->&gt; | |
| [\_client](./puppeteer.frame._client.md) | | [CDPSession](./puppeteer.cdpsession.md) | |
| [\_detached](./puppeteer.frame._detached.md) | | boolean | |
| [\_frameManager](./puppeteer.frame._framemanager.md) | | [FrameManager](./puppeteer.framemanager.md) | |
| [\_id](./puppeteer.frame._id.md) | | string | |
| [\_lifecycleEvents](./puppeteer.frame._lifecycleevents.md) | | Set&lt;string&gt; | |
| [\_loaderId](./puppeteer.frame._loaderid.md) | | string | |
| [\_mainWorld](./puppeteer.frame._mainworld.md) | | DOMWorld | |
| [\_name](./puppeteer.frame._name.md) | | string | |
| [\_parentFrame](./puppeteer.frame._parentframe.md) | | [Frame](./puppeteer.frame.md) | |
| [\_secondaryWorld](./puppeteer.frame._secondaryworld.md) | | DOMWorld | |
| [\_url](./puppeteer.frame._url.md) | | string | |
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `Frame` class.

## Methods

Expand Down
2 changes: 1 addition & 1 deletion new-docs/puppeteer.frame.waitforselector.md
Expand Up @@ -15,7 +15,7 @@ waitForSelector(selector: string, options?: WaitForSelectorOptions): Promise<Ele
| Parameter | Type | Description |
| --- | --- | --- |
| selector | string | |
| options | WaitForSelectorOptions | |
| options | [WaitForSelectorOptions](./puppeteer.waitforselectoroptions.md) | |

<b>Returns:</b>

Expand Down
2 changes: 1 addition & 1 deletion new-docs/puppeteer.frame.waitforxpath.md
Expand Up @@ -15,7 +15,7 @@ waitForXPath(xpath: string, options?: WaitForSelectorOptions): Promise<ElementHa
| Parameter | Type | Description |
| --- | --- | --- |
| xpath | string | |
| options | WaitForSelectorOptions | |
| options | [WaitForSelectorOptions](./puppeteer.waitforselectoroptions.md) | |

<b>Returns:</b>

Expand Down
11 changes: 0 additions & 11 deletions new-docs/puppeteer.framemanager._client.md

This file was deleted.

23 changes: 0 additions & 23 deletions new-docs/puppeteer.framemanager._constructor_.md

This file was deleted.

11 changes: 0 additions & 11 deletions new-docs/puppeteer.framemanager._contextidtocontext.md

This file was deleted.

22 changes: 0 additions & 22 deletions new-docs/puppeteer.framemanager._ensureisolatedworld.md

This file was deleted.

11 changes: 0 additions & 11 deletions new-docs/puppeteer.framemanager._frames.md

This file was deleted.

22 changes: 0 additions & 22 deletions new-docs/puppeteer.framemanager._handleframetree.md

This file was deleted.

11 changes: 0 additions & 11 deletions new-docs/puppeteer.framemanager._isolatedworlds.md

This file was deleted.

11 changes: 0 additions & 11 deletions new-docs/puppeteer.framemanager._mainframe.md

This file was deleted.