github/puppeteer
0
0
Fork 0
mirror of https://github.com/puppeteer/puppeteer synced 2024-06-14 14:02:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(new): migrate ConsoleMessage docs to TSDoc (#6065)

Browse Source
This commit is contained in:
Paul Lewis
2020-06-22 13:52:39 +01:00
committed by GitHub
parent 983a7b67df
commit 819afbebf7
14 changed files with 145 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
new-docs/puppeteer.consolemessage._constructor_.md
View File

@@ -9,15 +9,15 @@ Constructs a new instance of the `ConsoleMessage` class
<b>Signature:</b>
```typescript
constructor(type: string, text: string, args: JSHandle[], location?: ConsoleMessageLocation);
constructor(type: ConsoleMessageType, text: string, args: JSHandle[], location?: ConsoleMessageLocation);
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| type | string | |
| type | [ConsoleMessageType](./puppeteer.consolemessagetype.md) | |
| text | string | |
| args | [JSHandle](./puppeteer.jshandle.md)<!-- -->\[\] | |
| location | ConsoleMessageLocation | |
| location | [ConsoleMessageLocation](./puppeteer.consolemessagelocation.md) | |

2
new-docs/puppeteer.consolemessage.args.md
View File

@@ -13,3 +13,5 @@ args(): JSHandle[];
[JSHandle](./puppeteer.jshandle.md)<!-- -->\[\]
An array of arguments passed to the console.

4
new-docs/puppeteer.consolemessage.location.md
View File

@@ -11,5 +11,7 @@ location(): ConsoleMessageLocation;
```
<b>Returns:</b>
ConsoleMessageLocation
[ConsoleMessageLocation](./puppeteer.consolemessagelocation.md)
The location of the console message.

2
new-docs/puppeteer.consolemessage.md
View File

@@ -4,6 +4,8 @@
## ConsoleMessage class
ConsoleMessage objects are dispatched by page via the 'console' event.
<b>Signature:</b>
```typescript

2
new-docs/puppeteer.consolemessage.text.md
View File

@@ -13,3 +13,5 @@ text(): string;
string
The text of the console message.

6
new-docs/puppeteer.consolemessage.type.md
View File

@@ -7,9 +7,11 @@
<b>Signature:</b>
```typescript
type(): string;
type(): ConsoleMessageType;
```
<b>Returns:</b>
string
[ConsoleMessageType](./puppeteer.consolemessagetype.md)
The type of the console message.

13
new-docs/puppeteer.consolemessagelocation.columnnumber.md Normal file
View File

@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [ConsoleMessageLocation](./puppeteer.consolemessagelocation.md) &gt; [columnNumber](./puppeteer.consolemessagelocation.columnnumber.md)
## ConsoleMessageLocation.columnNumber property
0-based column number in the resource if known or `undefined` otherwise.
<b>Signature:</b>
```typescript
columnNumber?: number;
```

13
new-docs/puppeteer.consolemessagelocation.linenumber.md Normal file
View File

@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [ConsoleMessageLocation](./puppeteer.consolemessagelocation.md) &gt; [lineNumber](./puppeteer.consolemessagelocation.linenumber.md)
## ConsoleMessageLocation.lineNumber property
0-based line number in the resource if known or `undefined` otherwise.
<b>Signature:</b>
```typescript
lineNumber?: number;
```

21
new-docs/puppeteer.consolemessagelocation.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; [ConsoleMessageLocation](./puppeteer.consolemessagelocation.md)
## ConsoleMessageLocation interface
<b>Signature:</b>
```typescript
export interface ConsoleMessageLocation
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [columnNumber](./puppeteer.consolemessagelocation.columnnumber.md) | number | 0-based column number in the resource if known or <code>undefined</code> otherwise. |
| [lineNumber](./puppeteer.consolemessagelocation.linenumber.md) | number | 0-based line number in the resource if known or <code>undefined</code> otherwise. |
| [url](./puppeteer.consolemessagelocation.url.md) | string | URL of the resource if known or <code>undefined</code> otherwise. |

13
new-docs/puppeteer.consolemessagelocation.url.md Normal file
View File

@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [ConsoleMessageLocation](./puppeteer.consolemessagelocation.md) &gt; [url](./puppeteer.consolemessagelocation.url.md)
## ConsoleMessageLocation.url property
URL of the resource if known or `undefined` otherwise.
<b>Signature:</b>
```typescript
url?: string;
```

13
new-docs/puppeteer.consolemessagetype.md Normal file
View File

@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [ConsoleMessageType](./puppeteer.consolemessagetype.md)
## ConsoleMessageType type
The supported types for console messages.
<b>Signature:</b>
```typescript
export declare type ConsoleMessageType = 'log' | 'debug' | 'info' | 'error' | 'warning' | 'dir' | 'dirxml' | 'table' | 'trace' | 'clear' | 'startGroup' | 'startGroupCollapsed' | 'endGroup' | 'assert' | 'profile' | 'profileEnd' | 'count' | 'timeEnd' | 'verbose';
```

4
new-docs/puppeteer.md
View File

@@ -14,7 +14,7 @@
| [BrowserFetcher](./puppeteer.browserfetcher.md) | |
| [CDPSession](./puppeteer.cdpsession.md) | The <code>CDPSession</code> instances are used to talk raw Chrome Devtools Protocol. |
| [Connection](./puppeteer.connection.md) | |
| [ConsoleMessage](./puppeteer.consolemessage.md) | |
| [ConsoleMessage](./puppeteer.consolemessage.md) | ConsoleMessage objects are dispatched by page via the 'console' event. |
| [Coverage](./puppeteer.coverage.md) | |
| [Dialog](./puppeteer.dialog.md) | Dialog instances are dispatched by the [Page](./puppeteer.page.md) via the <code>dialog</code> event. |
| [ElementHandle](./puppeteer.elementhandle.md) | |
@@ -54,6 +54,7 @@
| Interface | Description |
| --- | --- |
| [BrowserFetcherOptions](./puppeteer.browserfetcheroptions.md) | |
| [ConsoleMessageLocation](./puppeteer.consolemessagelocation.md) | |
| [SerializedAXNode](./puppeteer.serializedaxnode.md) | Represents a Node and the properties of it that are relevant to Accessibility. |
| [SnapshotOptions](./puppeteer.snapshotoptions.md) | |
@@ -68,6 +69,7 @@
| Type Alias | Description |
| --- | --- |
| [ConsoleMessageType](./puppeteer.consolemessagetype.md) | The supported types for console messages. |
| [MouseButtonInput](./puppeteer.mousebuttoninput.md) | |
| [PuppeteerErrors](./puppeteer.puppeteererrors.md) | |