aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorkzc <kzc@users.noreply.github.com>2017-05-19 05:20:21 -0400
committerAlex Lam S.L <alexlamsl@gmail.com>2017-05-19 17:20:21 +0800
commit1df9d06f4a6b9116216d8420f5b2ec67f576a301 (patch)
treef048c2dc9de14351c87778ae9d58dddda508e526
parent3408fc9d32c4491afdd73f0c46112c5a41963062 (diff)
downloadtracifyjs-1df9d06f4a6b9116216d8420f5b2ec67f576a301.tar.gz
tracifyjs-1df9d06f4a6b9116216d8420f5b2ec67f576a301.zip
document minify `warnings` and add an error example (#1973)
-rw-r--r--README.md20
1 files changed, 19 insertions, 1 deletions
diff --git a/README.md b/README.md
index a7635095..579390ce 100644
--- a/README.md
+++ b/README.md
@@ -319,9 +319,27 @@ var result = UglifyJS.minify({
console.log(result.code);
```
+To produce warnings:
+```javascript
+var result = UglifyJS.minify("function f(){ var u; return 5; }", {
+ warnings: true
+});
+console.log(result.code); // function f(){return 5}
+console.log(result.warnings); // [ 'Dropping unused variable u [0:1,18]' ]
+console.log(result.error); // runtime error, not defined in this case
+```
+
+An error example:
+```javascript
+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}
+```
+
## Minify options
-- `warnings` (default `false`) — pass `true` to display compressor warnings.
+- `warnings` (default `false`) — pass `true` to return compressor warnings
+ in `result.warnings`. Use the value `"verbose"` for more detailed warnings.
- `parse` (default `{}`) — pass an object if you wish to specify some
additional [parse options](#parse-options).