Files
mostlymatter/e2e-tests/cypress/tests/support/ui/modal.d.ts
2023-03-28 18:10:00 +02:00

31 строка
1.0 KiB
TypeScript

// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
// See LICENSE.txt for license information.
/// <reference types="cypress" />
// ***************************************************************
// Each command should be properly documented using JSDoc.
// See https://jsdoc.app/index.html for reference.
// Basic requirements for documentation are the following:
// - Meaningful description
// - Each parameter with `@params`
// - Return value with `@returns`
// - Example usage with `@example`
// Custom command should follow naming convention of having `ui` prefix, e.g. `uiCloseModal`.
// ***************************************************************
declare namespace Cypress {
interface Chainable {
/**
* Close modal with header label
* @param {string} headerLabel - the header label
*
* @example
* const headerLabel = 'What\'s New';
* cy.uiCloseModal(headerLabel);
*/
uiCloseModal(headerLabel: string): Chainable;
}
}