summaryrefslogtreecommitdiffstats
path: root/remote/test/puppeteer/src/common/Dialog.ts
diff options
context:
space:
mode:
Diffstat (limited to 'remote/test/puppeteer/src/common/Dialog.ts')
-rw-r--r--remote/test/puppeteer/src/common/Dialog.ts114
1 files changed, 114 insertions, 0 deletions
diff --git a/remote/test/puppeteer/src/common/Dialog.ts b/remote/test/puppeteer/src/common/Dialog.ts
new file mode 100644
index 0000000000..6d84fd0d0b
--- /dev/null
+++ b/remote/test/puppeteer/src/common/Dialog.ts
@@ -0,0 +1,114 @@
+/**
+ * Copyright 2017 Google Inc. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import {assert} from '../util/assert.js';
+import {CDPSession} from './Connection.js';
+import {Protocol} from 'devtools-protocol';
+
+/**
+ * Dialog instances are dispatched by the {@link Page} via the `dialog` event.
+ *
+ * @remarks
+ *
+ * @example
+ *
+ * ```ts
+ * 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'));
+ * })();
+ * ```
+ *
+ * @public
+ */
+export class Dialog {
+ #client: CDPSession;
+ #type: Protocol.Page.DialogType;
+ #message: string;
+ #defaultValue: string;
+ #handled = false;
+
+ /**
+ * @internal
+ */
+ constructor(
+ client: CDPSession,
+ type: Protocol.Page.DialogType,
+ message: string,
+ defaultValue = ''
+ ) {
+ this.#client = client;
+ this.#type = type;
+ this.#message = message;
+ this.#defaultValue = defaultValue;
+ }
+
+ /**
+ * @returns The type of the dialog.
+ */
+ type(): Protocol.Page.DialogType {
+ return this.#type;
+ }
+
+ /**
+ * @returns The message displayed in the dialog.
+ */
+ message(): string {
+ return this.#message;
+ }
+
+ /**
+ * @returns The default value of the prompt, or an empty string if the dialog
+ * is not a `prompt`.
+ */
+ defaultValue(): string {
+ return this.#defaultValue;
+ }
+
+ /**
+ * @param promptText - optional text that will be entered in the dialog
+ * prompt. Has no effect if the dialog's type is not `prompt`.
+ *
+ * @returns A promise that resolves when the dialog has been accepted.
+ */
+ async accept(promptText?: string): Promise<void> {
+ assert(!this.#handled, 'Cannot accept dialog which is already handled!');
+ this.#handled = true;
+ await this.#client.send('Page.handleJavaScriptDialog', {
+ accept: true,
+ promptText: promptText,
+ });
+ }
+
+ /**
+ * @returns A promise which will resolve once the dialog has been dismissed
+ */
+ async dismiss(): Promise<void> {
+ assert(!this.#handled, 'Cannot dismiss dialog which is already handled!');
+ this.#handled = true;
+ await this.#client.send('Page.handleJavaScriptDialog', {
+ accept: false,
+ });
+ }
+}