implement requested changes from PR feedback

NoriSte · Apr 30, 2020 · 389cc4c · 389cc4c
1 parent 1a62da2
commit 389cc4c
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 10 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
@@ -5,7 +5,7 @@ const logCommand = ({ options, originalOptions }) => {
     options.logger({
       name: options.description,
       message: options.customMessage,
-      consoleProps: () => originalOptions
+      consoleProps: () => originalOptions,
     });
   }
 };
@@ -19,13 +19,15 @@ const logCommandCheck = ({ result, options, originalOptions }) => {
   options.logger({
     name: options.description,
     message,
-    consoleProps: () => originalOptions
+    consoleProps: () => originalOptions,
   });
 };
 
 const waitUntil = (subject, checkFunction, originalOptions = {}) => {
   if (!(checkFunction instanceof Function)) {
-    throw new Error("`checkFunction` parameter should be a function. Found: " + checkFunction);
+    throw new Error(
+      "`checkFunction` parameter should be a function. Found: " + checkFunction
+    );
   }
 
   const defaultOptions = {
@@ -40,24 +42,29 @@ const waitUntil = (subject, checkFunction, originalOptions = {}) => {
     customMessage: undefined,
     logger: Cypress.log,
     verbose: false,
-    customCheckMessage: undefined
+    customCheckMessage: undefined,
   };
   const options = { ...defaultOptions, ...originalOptions };
 
   // filter out a falsy passed "customMessage" value
-  options.customMessage = [options.customMessage, originalOptions].filter(Boolean);
+  options.customMessage = [options.customMessage, originalOptions].filter(
+    Boolean
+  );
 
   let retries = Math.floor(options.timeout / options.interval);
 
   logCommand({ options, originalOptions });
 
-  const check = result => {
+  const check = (result) => {
     logCommandCheck({ result, options, originalOptions });
     if (result) {
       return result;
     }
     if (retries < 1) {
-      const msg = options.errorMsg.call ? options.errorMsg() : options.errorMsg;
+      const msg =
+        options.errorMsg instanceof Function
+          ? options.errorMsg(result, options)
+          : options.errorMsg;
       throw new Error(msg);
     }
     cy.wait(options.interval, { log: false }).then(() => {