nightwatch/lib/api/client-commands/alerts/dismiss.js

Easy to use Node.js based end-to-end testing solution for web applications using the W3C WebDriver API.

const ClientCommand = require('../_base-command.js');

/**
 * Dismisses the currently displayed alert dialog.
 *
 * For confirm() and prompt() dialogs, this is equivalent to clicking the 'Cancel' button.
 * For alert() dialogs, this is equivalent to clicking the 'OK' button.
 *
 * @example
 * module.exports = {
 *   'dismiss open alert': function (browser) {
 *     browser
 *       .alerts.dismiss(function () {
 *         console.log('alert dismissed successfully');
 *       });
 *   },
 *
 *   'dismiss open alert with ES6 async/await': async function (browser) {
 *     await browser.alerts.dismiss();
 *   }
 * };
 *
 * @syntax .alerts.dismiss([callback])
 * @method alerts.dismiss
 * @param {function} [callback] Optional callback function to be called when the command finishes.
 * @see alerts.accept
 * @see alerts.getText
 * @see alerts.setText
 * @link /#dismiss-alert
 * @api protocol.userprompts
 */
class DismissAlert extends ClientCommand {
  static get isTraceable() {
    return true;
  }

  performAction(callback) {
    this.transportActions.dismissAlert(callback);
  }
}

module.exports = DismissAlert;