// 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. `uiLogin`.
// ***************************************************************

declare namespace Cypress {
    interface Chainable {

        /**
         * Login vi UI at login page
         *
         * @param {UserProfile} user - user with username and password
         *
         * @example
         *   cy.uiLogin(user);
         */
        uiLogin(user: UserProfile): Chainable;
    }
}