document 3.x minify() does not throw errors (#1975)
authorkzc <kzc@users.noreply.github.com>
Sat, 20 May 2017 02:49:35 +0000 (22:49 -0400)
committerAlex Lam S.L <alexlamsl@gmail.com>
Sat, 20 May 2017 02:49:35 +0000 (10:49 +0800)
README.md

index 579390c..f73bd27 100644 (file)
--- a/README.md
+++ b/README.md
@@ -307,7 +307,7 @@ Example:
 ```javascript
 var result = UglifyJS.minify("var b = function() {};");
 console.log(result.code);  // minified output
-console.log(result.error); // runtime error
+console.log(result.error); // runtime error, if present
 ```
 
 You can also compress multiple files:
@@ -335,6 +335,12 @@ var result = UglifyJS.minify({"foo.js" : "if (0) else console.log(1);"});
 console.log(JSON.stringify(result.error));
 // {"message":"Unexpected token: keyword (else)","filename":"foo.js","line":1,"col":7,"pos":7}
 ```
+Note: unlike `uglify-js@2.x`, the `3.x` API does not throw errors. To 
+achieve a similar effect one could do the following:
+```javascript
+var result = UglifyJS.minify("if (0) else console.log(1);");
+if (result.error) throw result.error;
+```
 
 ## Minify options