implement requested changes from PR feedback

NoriSte · Apr 30, 2020 · 3fbca94 · 3fbca94
1 parent 1a62da2
commit 3fbca94
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 4 deletions.
diff --git a/cypress/types/plugin.spec.ts b/cypress/types/plugin.spec.ts
@@ -18,7 +18,18 @@ cy.waitUntil(() => Promise.resolve(false), { timeout: 500 });
 cy.waitUntil(() => true, { errorMsg: "Custom error message" });
 cy.waitUntil(() => false, { errorMsg: "Custom error message" });
 cy.waitUntil(() => Promise.resolve(true), { errorMsg: "Custom error message" });
-cy.waitUntil(() => Promise.resolve(false), { errorMsg: "Custom error message" });
+cy.waitUntil(() => Promise.resolve(false), {
+  errorMsg: "Custom error message",
+});
+
+cy.waitUntil(() => true, { errorMsg: () => "Custom error message" });
+cy.waitUntil(() => false, { errorMsg: () => "Custom error message" });
+cy.waitUntil(() => Promise.resolve(true), {
+  errorMsg: () => "Custom error message",
+});
+cy.waitUntil(() => Promise.resolve(false), {
+  errorMsg: () => "Custom error message",
+});
 
 cy.waitUntil(() => true, { description: "Custom description" });
 

diff --git a/index.d.ts b/index.d.ts
@@ -1,11 +1,16 @@
 /// <reference types="Cypress" />
 
-type WaitUntilLog = Pick<Cypress.LogConfig, "name" | "message" | "consoleProps">;
+type WaitUntilLog = Pick<
+  Cypress.LogConfig,
+  "name" | "message" | "consoleProps"
+>;
+
+type ErrorMsgCallback = (result: any, options: any) => string;
 
 interface WaitUntilOptions {
   timeout?: number;
   interval?: number;
-  errorMsg?: string;
+  errorMsg?: string | ErrorMsgCallback;
   description?: string;
   customMessage?: string;
   verbose?: boolean;

diff --git a/src/index.js b/src/index.js
@@ -57,7 +57,10 @@ const waitUntil = (subject, checkFunction, originalOptions = {}) => {
       return result;
     }
     if (retries < 1) {
-      const msg = options.errorMsg.call ? options.errorMsg() : options.errorMsg;
+      const msg =
+        options.errorMsg instanceof Function
+          ? options.errorMsg({ result, options: originalOptions })
+          : options.errorMsg;
       throw new Error(msg);
     }
     cy.wait(options.interval, { log: false }).then(() => {