added tsdoc to addAccount function

MetaMask · Dec 18, 2024 · 90bcff7 · 90bcff7
1 parent ee2a9cb
commit 90bcff7
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/test/e2e/page-objects/pages/account-list-page.ts b/test/e2e/page-objects/pages/account-list-page.ts
@@ -202,6 +202,19 @@ class AccountListPage {
     }
   }
 
+  /**
+   * Adds a new account of the specified type with an optional custom name.
+   *
+   * @param accountType - The type of account to add (Ethereum, Bitcoin, or Solana)
+   * @param accountName - Optional custom name for the new account
+   * @throws {Error} If the specified account type is not supported
+   * @example
+   * // Add a new Ethereum account with default name
+   * await accountListPage.addAccount(ACCOUNT_TYPE.Ethereum);
+   *
+   * // Add a new Bitcoin account with custom name
+   * await accountListPage.addAccount(ACCOUNT_TYPE.Bitcoin, 'My BTC Wallet');
+   */
   async addAccount(accountType: ACCOUNT_TYPE, accountName?: string) {
     await this.driver.clickElement(this.createAccountButton);
     // eslint-disable-next-line @typescript-eslint/no-explicit-any