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): reduce warnings when generating docs #6138

Merged
merged 2 commits 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
3 changes: 3 additions & 0 deletions api-extractor.json
Expand Up @@ -27,6 +27,9 @@
},

"extractorMessageReporting": {
"ae-internal-missing-underscore": {
"logLevel": "none"
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this has been disabled because the docs tool wants anything marked as @internal to be prefixed with an underscore. We don't follow this convention (nor do I really want to) so I've disabled this.

},
"default": {
"logLevel": "warning"
}
Expand Down
2 changes: 1 addition & 1 deletion new-docs/puppeteer.browserfetcher.download.md
Expand Up @@ -21,7 +21,7 @@ download(revision: string, progressCallback?: (x: number, y: number) => void): P

<b>Returns:</b>

Promise&lt;BrowserFetcherRevisionInfo&gt;
Promise&lt;[BrowserFetcherRevisionInfo](./puppeteer.browserfetcherrevisioninfo.md)<!-- -->&gt;

A promise with revision information when the revision is downloaded and extracted.

Expand Down
2 changes: 1 addition & 1 deletion new-docs/puppeteer.browserfetcher.platform.md
Expand Up @@ -11,7 +11,7 @@ platform(): Platform;
```
<b>Returns:</b>

Platform
[Platform](./puppeteer.platform.md)

Returns the current `Platform`<!-- -->.

2 changes: 1 addition & 1 deletion new-docs/puppeteer.browserfetcher.product.md
Expand Up @@ -11,7 +11,7 @@ product(): Product;
```
<b>Returns:</b>

Product
[Product](./puppeteer.product.md)

Returns the current `Product`<!-- -->.

2 changes: 1 addition & 1 deletion new-docs/puppeteer.browserfetcher.revisioninfo.md
Expand Up @@ -18,7 +18,7 @@ revisionInfo(revision: string): BrowserFetcherRevisionInfo;

<b>Returns:</b>

BrowserFetcherRevisionInfo
[BrowserFetcherRevisionInfo](./puppeteer.browserfetcherrevisioninfo.md)

The revision info for the given revision.

3 changes: 2 additions & 1 deletion new-docs/puppeteer.browserfetcheroptions.md
Expand Up @@ -4,6 +4,7 @@

## BrowserFetcherOptions interface


<b>Signature:</b>

```typescript
Expand All @@ -16,6 +17,6 @@ export interface BrowserFetcherOptions
| --- | --- | --- |
| [host](./puppeteer.browserfetcheroptions.host.md) | string | |
| [path](./puppeteer.browserfetcheroptions.path.md) | string | |
| [platform](./puppeteer.browserfetcheroptions.platform.md) | Platform | |
| [platform](./puppeteer.browserfetcheroptions.platform.md) | [Platform](./puppeteer.platform.md) | |
| [product](./puppeteer.browserfetcheroptions.product.md) | string | |

11 changes: 11 additions & 0 deletions new-docs/puppeteer.browserfetcherrevisioninfo.executablepath.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; [BrowserFetcherRevisionInfo](./puppeteer.browserfetcherrevisioninfo.md) &gt; [executablePath](./puppeteer.browserfetcherrevisioninfo.executablepath.md)

## BrowserFetcherRevisionInfo.executablePath property

<b>Signature:</b>

```typescript
executablePath: string;
```
11 changes: 11 additions & 0 deletions new-docs/puppeteer.browserfetcherrevisioninfo.folderpath.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; [BrowserFetcherRevisionInfo](./puppeteer.browserfetcherrevisioninfo.md) &gt; [folderPath](./puppeteer.browserfetcherrevisioninfo.folderpath.md)

## BrowserFetcherRevisionInfo.folderPath property

<b>Signature:</b>

```typescript
folderPath: string;
```
11 changes: 11 additions & 0 deletions new-docs/puppeteer.browserfetcherrevisioninfo.local.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; [BrowserFetcherRevisionInfo](./puppeteer.browserfetcherrevisioninfo.md) &gt; [local](./puppeteer.browserfetcherrevisioninfo.local.md)

## BrowserFetcherRevisionInfo.local property

<b>Signature:</b>

```typescript
local: boolean;
```
24 changes: 24 additions & 0 deletions new-docs/puppeteer.browserfetcherrevisioninfo.md
@@ -0,0 +1,24 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [BrowserFetcherRevisionInfo](./puppeteer.browserfetcherrevisioninfo.md)

## BrowserFetcherRevisionInfo interface


<b>Signature:</b>

```typescript
export interface BrowserFetcherRevisionInfo
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [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 | |

11 changes: 11 additions & 0 deletions new-docs/puppeteer.browserfetcherrevisioninfo.product.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; [BrowserFetcherRevisionInfo](./puppeteer.browserfetcherrevisioninfo.md) &gt; [product](./puppeteer.browserfetcherrevisioninfo.product.md)

## BrowserFetcherRevisionInfo.product property

<b>Signature:</b>

```typescript
product: string;
```
11 changes: 11 additions & 0 deletions new-docs/puppeteer.browserfetcherrevisioninfo.revision.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; [BrowserFetcherRevisionInfo](./puppeteer.browserfetcherrevisioninfo.md) &gt; [revision](./puppeteer.browserfetcherrevisioninfo.revision.md)

## BrowserFetcherRevisionInfo.revision property

<b>Signature:</b>

```typescript
revision: string;
```
11 changes: 11 additions & 0 deletions new-docs/puppeteer.browserfetcherrevisioninfo.url.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; [BrowserFetcherRevisionInfo](./puppeteer.browserfetcherrevisioninfo.md) &gt; [url](./puppeteer.browserfetcherrevisioninfo.url.md)

## BrowserFetcherRevisionInfo.url property

<b>Signature:</b>

```typescript
url: string;
```
11 changes: 11 additions & 0 deletions new-docs/puppeteer.browseroptions.defaultviewport.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; [BrowserOptions](./puppeteer.browseroptions.md) &gt; [defaultViewport](./puppeteer.browseroptions.defaultviewport.md)

## BrowserOptions.defaultViewport property

<b>Signature:</b>

```typescript
defaultViewport?: Viewport;
```
11 changes: 11 additions & 0 deletions new-docs/puppeteer.browseroptions.ignorehttpserrors.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; [BrowserOptions](./puppeteer.browseroptions.md) &gt; [ignoreHTTPSErrors](./puppeteer.browseroptions.ignorehttpserrors.md)

## BrowserOptions.ignoreHTTPSErrors property

<b>Signature:</b>

```typescript
ignoreHTTPSErrors?: boolean;
```
22 changes: 22 additions & 0 deletions new-docs/puppeteer.browseroptions.md
@@ -0,0 +1,22 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [BrowserOptions](./puppeteer.browseroptions.md)

## BrowserOptions interface

Generic browser options that can be passed when launching any browser.

<b>Signature:</b>

```typescript
export interface BrowserOptions
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [defaultViewport](./puppeteer.browseroptions.defaultviewport.md) | Viewport | |
| [ignoreHTTPSErrors](./puppeteer.browseroptions.ignorehttpserrors.md) | boolean | |
| [slowMo](./puppeteer.browseroptions.slowmo.md) | number | |

11 changes: 11 additions & 0 deletions new-docs/puppeteer.browseroptions.slowmo.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; [BrowserOptions](./puppeteer.browseroptions.md) &gt; [slowMo](./puppeteer.browseroptions.slowmo.md)

## BrowserOptions.slowMo property

<b>Signature:</b>

```typescript
slowMo?: number;
```
11 changes: 11 additions & 0 deletions new-docs/puppeteer.chromeargoptions.args.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; [ChromeArgOptions](./puppeteer.chromeargoptions.md) &gt; [args](./puppeteer.chromeargoptions.args.md)

## ChromeArgOptions.args property

<b>Signature:</b>

```typescript
args?: string[];
```
11 changes: 11 additions & 0 deletions new-docs/puppeteer.chromeargoptions.devtools.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; [ChromeArgOptions](./puppeteer.chromeargoptions.md) &gt; [devtools](./puppeteer.chromeargoptions.devtools.md)

## ChromeArgOptions.devtools property

<b>Signature:</b>

```typescript
devtools?: boolean;
```
11 changes: 11 additions & 0 deletions new-docs/puppeteer.chromeargoptions.headless.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; [ChromeArgOptions](./puppeteer.chromeargoptions.md) &gt; [headless](./puppeteer.chromeargoptions.headless.md)

## ChromeArgOptions.headless property

<b>Signature:</b>

```typescript
headless?: boolean;
```
23 changes: 23 additions & 0 deletions new-docs/puppeteer.chromeargoptions.md
@@ -0,0 +1,23 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [ChromeArgOptions](./puppeteer.chromeargoptions.md)

## ChromeArgOptions interface

Launcher options that only apply to Chrome.

<b>Signature:</b>

```typescript
export interface ChromeArgOptions
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [args](./puppeteer.chromeargoptions.args.md) | string\[\] | |
| [devtools](./puppeteer.chromeargoptions.devtools.md) | boolean | |
| [headless](./puppeteer.chromeargoptions.headless.md) | boolean | |
| [userDataDir](./puppeteer.chromeargoptions.userdatadir.md) | string | |

11 changes: 11 additions & 0 deletions new-docs/puppeteer.chromeargoptions.userdatadir.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; [ChromeArgOptions](./puppeteer.chromeargoptions.md) &gt; [userDataDir](./puppeteer.chromeargoptions.userdatadir.md)

## ChromeArgOptions.userDataDir property

<b>Signature:</b>

```typescript
userDataDir?: string;
```
11 changes: 11 additions & 0 deletions new-docs/puppeteer.devicesmap.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; [devicesMap](./puppeteer.devicesmap.md)

## devicesMap variable

<b>Signature:</b>

```typescript
devicesMap: DevicesMap
```
4 changes: 2 additions & 2 deletions new-docs/puppeteer.frame.click.md
Expand Up @@ -9,7 +9,7 @@
```typescript
click(selector: string, options?: {
delay?: number;
button?: MouseButtonInput;
button?: MouseButton;
clickCount?: number;
}): Promise<void>;
```
Expand All @@ -19,7 +19,7 @@ click(selector: string, options?: {
| Parameter | Type | Description |
| --- | --- | --- |
| selector | string | |
| options | { delay?: number; button?: [MouseButtonInput](./puppeteer.mousebuttoninput.md)<!-- -->; clickCount?: number; } | |
| options | { delay?: number; button?: [MouseButton](./puppeteer.mousebutton.md)<!-- -->; clickCount?: number; } | |

<b>Returns:</b>

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

This file was deleted.

11 changes: 0 additions & 11 deletions new-docs/puppeteer.keydefinition.key.md

This file was deleted.

11 changes: 0 additions & 11 deletions new-docs/puppeteer.keydefinition.keycode.md

This file was deleted.

11 changes: 0 additions & 11 deletions new-docs/puppeteer.keydefinition.location.md

This file was deleted.