@bigbinary/neeto-playwright-commons 1.22.30 → 1.22.32

package/index.d.ts

@@ -45,6 +45,15 @@ interface AssertCardDetailsProps {
   title: string;
   description: string;
 }
+type ErrorHandlingResult<T> = {
+  success: true;
+  result: T;
+};
+type ErrorHandlingFailure = {
+  success: false;
+  error: string;
+};
+type ErrorHandlingResponse<T> = ErrorHandlingResult<T> | ErrorHandlingFailure;
 interface VerifyHelpPopoverProps {
   triggerElement?: Locator;
   title?: string;
@@ -638,6 +647,36 @@ declare class CustomCommands {
     title,
     description
   }: AssertCardDetailsProps) => Promise<[void, void, void]>;
+  /**
+   *
+   * Method to execute an asynchronous function and safely handle any exceptions that occur. This method provides a simple and type-safe way to handle errors in tests by returning a result object that indicates success or failure.
+   *
+   * asyncFn: The asynchronous function to execute.
+   *
+   * Promise<ErrorHandlingResponse<T>> - A result object with either:
+   *
+   * { success: true, result: T } - When the function executes successfully
+   *
+   * { success: false, error: string } - When an error occurs
+   *
+   * @example 
+   *
+   * const userResult = await neetoPlaywrightUtilities.executeWithErrorHandling(async (): Promise<UserData> => {
+   *   const response = await page.evaluate(() => {
+   *     return fetch('/api/v1/user').then(r => r.json());
+   *   });
+   * 
+   *   return response;
+   * });
+   * 
+   * if (userResult.success === true) {
+   *   expect(userResult.result.name).toBeTruthy();
+   * } else {
+   *   console.error("Failed to fetch user data:", userResult.error);
+   * }
+   * @endexample
+  */
+  executeWithErrorHandling: <T>(asyncFn: () => Promise<T>) => Promise<ErrorHandlingResponse<T>>;
   /**
    *
    * Method to click a button and wait for any loading spinners to disappear.