BREAKING CHANGE: remove useRejections and expectRejections (#1362)

sweetalert2 · Jan 18, 2019 · f050caf · f050caf
1 parent d05bf33
commit f050caf
Show file tree

Hide file tree

Showing 6 changed files with 25 additions and 252 deletions.
diff --git a/src/instanceMethods/_main.js b/src/instanceMethods/_main.js
@@ -44,19 +44,11 @@ export function _main (userParams) {
     // functions to handle all resolving/rejecting/settling
     const succeedWith = (value) => {
       constructor.closePopup(innerParams.onClose, innerParams.onAfterClose) // TODO: make closePopup an *instance* method
-      if (innerParams.useRejections) {
-        resolve(value)
-      } else {
-        resolve({ value })
-      }
+      resolve({ value })
     }
     const dismissWith = (dismiss) => {
       constructor.closePopup(innerParams.onClose, innerParams.onAfterClose)
-      if (innerParams.useRejections) {
-        reject(dismiss)
-      } else {
-        resolve({ dismiss })
-      }
+      resolve({ dismiss })
     }
     const errorWith = (error) => {
       constructor.closePopup(innerParams.onClose, innerParams.onAfterClose)
@@ -107,28 +99,16 @@ export function _main (userParams) {
       if (innerParams.preConfirm) {
         this.resetValidationMessage()
         const preConfirmPromise = Promise.resolve().then(() => innerParams.preConfirm(value, innerParams.extraParams))
-        if (innerParams.expectRejections) {
-          preConfirmPromise.then(
-            (preConfirmValue) => succeedWith(preConfirmValue || value),
-            (validationMessage) => {
+        preConfirmPromise.then(
+          (preConfirmValue) => {
+            if (dom.isVisible(domCache.validationMessage) || preConfirmValue === false) {
               this.hideLoading()
-              if (validationMessage) {
-                this.showValidationMessage(validationMessage)
-              }
+            } else {
+              succeedWith(preConfirmValue || value)
             }
-          )
-        } else {
-          preConfirmPromise.then(
-            (preConfirmValue) => {
-              if (dom.isVisible(domCache.validationMessage) || preConfirmValue === false) {
-                this.hideLoading()
-              } else {
-                succeedWith(preConfirmValue || value)
-              }
-            },
-            (error) => errorWith(error)
-          )
-        }
+          },
+          (error) => errorWith(error)
+        )
       } else {
         succeedWith(value)
       }
@@ -152,35 +132,18 @@ export function _main (userParams) {
               if (innerParams.inputValidator) {
                 this.disableInput()
                 const validationPromise = Promise.resolve().then(() => innerParams.inputValidator(inputValue, innerParams.extraParams))
-                if (innerParams.expectRejections) {
-                  validationPromise.then(
-                    () => {
-                      this.enableButtons()
-                      this.enableInput()
+                validationPromise.then(
+                  (validationMessage) => {
+                    this.enableButtons()
+                    this.enableInput()
+                    if (validationMessage) {
+                      this.showValidationMessage(validationMessage)
+                    } else {
                       confirm(inputValue)
-                    },
-                    (validationMessage) => {
-                      this.enableButtons()
-                      this.enableInput()
-                      if (validationMessage) {
-                        this.showValidationMessage(validationMessage)
-                      }
                     }
-                  )
-                } else {
-                  validationPromise.then(
-                    (validationMessage) => {
-                      this.enableButtons()
-                      this.enableInput()
-                      if (validationMessage) {
-                        this.showValidationMessage(validationMessage)
-                      } else {
-                        confirm(inputValue)
-                      }
-                    },
-                    error => errorWith(error)
-                  )
-                }
+                  },
+                  error => errorWith(error)
+                )
               } else if (!this.getInput().checkValidity()) {
                 this.enableButtons()
                 this.showValidationMessage(innerParams.validationMessage)

diff --git a/src/utils/params.js b/src/utils/params.js
@@ -63,14 +63,10 @@ const defaultParams = {
   onBeforeOpen: null,
   onAfterClose: null,
   onOpen: null,
-  onClose: null,
-  useRejections: false,
-  expectRejections: false
+  onClose: null
 }
 
 export const deprecatedParams = [
-  'useRejections',
-  'expectRejections',
   'extraParams'
 ]
 

diff --git a/src/utils/setParameters.js b/src/utils/setParameters.js
@@ -15,7 +15,7 @@ export default function setParameters (params) {
   if (!params.inputValidator) {
     Object.keys(defaultInputValidators).forEach((key) => {
       if (params.input === key) {
-        params.inputValidator = params.expectRejections ? defaultInputValidators[key] : sweetAlert.adaptInputValidator(defaultInputValidators[key])
+        params.inputValidator = sweetAlert.adaptInputValidator(defaultInputValidators[key])
       }
     })
   }

diff --git a/sweetalert2.d.ts b/sweetalert2.d.ts
@@ -20,13 +20,7 @@ declare module 'sweetalert2' {
      *     timer: 2000
      *   })
      */
-    function swal(settings: SweetAlertOptions & { useRejections?: false }): Promise<SweetAlertResult>;
-
-    /**
-     * @deprecated
-     * swal() overload for legacy alerts that use { useRejections: true }.
-     */
-    function swal(settings: SweetAlertOptions & { useRejections: true }): Promise<any>;
+    function swal(settings: SweetAlertOptions): Promise<SweetAlertResult>;
 
     /**
      * A namespace inside the default function, containing utility function for controlling the currently-displayed
@@ -861,15 +855,6 @@ declare module 'sweetalert2' {
          * @default null
          */
         onClose?: (modalElement: HTMLElement) => void;
-
-        /**
-         * Determines whether given `inputValidator` and `preConfirm` functions should be expected to to signal
-         * validation message by rejecting, or by their respective means (see documentation for each option).
-         *
-         * @default false
-         * @deprecated
-         */
-        expectRejections?: boolean;
     }
 
     export default swal;

diff --git a/test/qunit/deprecated.js b/test/qunit/deprecated.js
diff --git a/test/qunit/tests.js b/test/qunit/tests.js
@@ -690,15 +690,15 @@ QUnit.test('on errors in *async* user-defined functions, cleans up and propagate
   }
 
   // inputValidator
-  const rejectedPromise = Swal({ input: 'text', expectRejections: false, inputValidator: erroringFunction })
+  const rejectedPromise = Swal({ input: 'text', inputValidator: erroringFunction })
   Swal.clickConfirm()
   rejectedPromise.catch((error) => {
     assert.equal(error, expectedError) // error is bubbled up back to user code
     setTimeout(() => {
       assert.notOk(Swal.isVisible()) // display is cleaned up
 
       // preConfirm
-      const rejectedPromise = Swal({ expectRejections: false, preConfirm: erroringFunction })
+      const rejectedPromise = Swal({ preConfirm: erroringFunction })
       Swal.clickConfirm()
       rejectedPromise.catch((error) => {
         assert.equal(error, expectedError) // error is bubbled up back to user code