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

feat(new-docs): migrate Dialog documentation to TSDoc (#5981)

Browse Source
This commit is contained in:
Jack Franklin
2020-06-09 09:19:42 +01:00
committed by GitHub
parent 0b3d52a70e
commit ca8b0d685c
11 changed files with 93 additions and 82 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
new-docs/puppeteer.dialog._constructor_.md
View File

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

4
new-docs/puppeteer.dialog.accept.md
View File

@@ -14,9 +14,11 @@ accept(promptText?: string): Promise<void>;
| Parameter | Type | Description |
| --- | --- | --- |
| promptText | string | |
| promptText | string | optional text that will be entered in the dialog prompt. Has no effect if the dialog's type is not <code>prompt</code>. |
<b>Returns:</b>
Promise&lt;void&gt;
A promise that resolves when the dialog has been accepted.

2
new-docs/puppeteer.dialog.defaultvalue.md
View File

@@ -13,3 +13,5 @@ defaultValue(): string;
string
The default value of the prompt, or an empty string if the dialog is not a `prompt`<!-- -->.

2
new-docs/puppeteer.dialog.dismiss.md
View File

@@ -13,3 +13,5 @@ dismiss(): Promise<void>;
Promise&lt;void&gt;
A promise which will resolve once the dialog has been dismissed

29
new-docs/puppeteer.dialog.md
View File

@@ -4,23 +4,36 @@
## Dialog class
Dialog instances are dispatched by the [Page](./puppeteer.page.md) via the `dialog` event.
<b>Signature:</b>
```typescript
export declare class Dialog
```
## Constructors
## Remarks
| Constructor | Modifiers | Description |
| --- | --- | --- |
| [(constructor)(client, type, message, defaultValue)](./puppeteer.dialog._constructor_.md) | | Constructs a new instance of the <code>Dialog</code> class |
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `Dialog` class.
## Properties
## Example
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [Type](./puppeteer.dialog.type.md) | <code>static</code> | typeof [DialogType](./puppeteer.dialogtype.md) | |
```js
const puppeteer = require('puppeteer');
(async () => {
const browser = await puppeteer.launch();
const page = await browser.newPage();
page.on('dialog', async dialog => {
console.log(dialog.message());
await dialog.dismiss();
await browser.close();
});
page.evaluate(() => alert('1'));
})();
```
## Methods

2
new-docs/puppeteer.dialog.message.md
View File

@@ -13,3 +13,5 @@ message(): string;
string
The message displayed in the dialog.

12
new-docs/puppeteer.dialog.type.md
View File

@@ -1,11 +1,17 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Dialog](./puppeteer.dialog.md) &gt; [Type](./puppeteer.dialog.type.md)
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Dialog](./puppeteer.dialog.md) &gt; [type](./puppeteer.dialog.type.md)
## Dialog.Type property
## Dialog.type() method
<b>Signature:</b>
```typescript
static Type: typeof DialogType;
type(): Protocol.Page.DialogType;
```
<b>Returns:</b>
Protocol.Page.DialogType
The type of the dialog.

21
new-docs/puppeteer.dialogtype.md
View File

@@ -1,21 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [DialogType](./puppeteer.dialogtype.md)
## DialogType enum
<b>Signature:</b>
```typescript
export declare enum DialogType
```
## Enumeration Members
| Member | Value | Description |
| --- | --- | --- |
| Alert | <code>&quot;alert&quot;</code> | |
| BeforeUnload | <code>&quot;beforeunload&quot;</code> | |
| Confirm | <code>&quot;confirm&quot;</code> | |
| Prompt | <code>&quot;prompt&quot;</code> | |

8
new-docs/puppeteer.md
View File

@@ -16,7 +16,7 @@
| [Connection](./puppeteer.connection.md) | |
| [ConsoleMessage](./puppeteer.consolemessage.md) | |
| [Coverage](./puppeteer.coverage.md) | |
| [Dialog](./puppeteer.dialog.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) | |
| [ExecutionContext](./puppeteer.executioncontext.md) | |
| [FileChooser](./puppeteer.filechooser.md) | |
@@ -36,12 +36,6 @@
| [Tracing](./puppeteer.tracing.md) | |
| [WebWorker](./puppeteer.webworker.md) | |
## Enumerations
| Enumeration | Description |
| --- | --- |
| [DialogType](./puppeteer.dialogtype.md) | |
## Functions
| Function | Description |