docs: add doc for option.outFileName
author1111hui <26634873@qq.com>
Sat, 29 Oct 2016 07:55:47 +0000 (15:55 +0800)
committerRichard van Velzen <rvanvelzen1@gmail.com>
Tue, 29 Nov 2016 19:29:12 +0000 (20:29 +0100)
README.md

index 6e9e5f2..eb3305b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -651,15 +651,22 @@ To generate a source map with the fromString option, you can also use an object:
 ```javascript
 var result = UglifyJS.minify({"file1.js": "var a = function () {};"}, {
   outSourceMap: "out.js.map",
+  outFileName: "out.js",
   fromString: true
 });
 ```
 
 Note that the source map is not saved in a file, it's just returned in
-`result.map`.  The value passed for `outSourceMap` is only used to set the
-`file` attribute in the source map (see [the spec][sm-spec]). You can set 
-option `sourceMapInline` to be `true` and source map will be appended to 
-code.
+`result.map`.  The value passed for `outSourceMap` is only used to set
+`//# sourceMappingURL=out.js.map` in `result.code`. The value of
+`outFileName` is only used to set `file` attribute in source map file.
+
+The `file` attribute in the source map (see [the spec][sm-spec]) will
+use `outFileName` firstly, if it's falsy, then will be deduced from
+`outSourceMap` (by removing `'.map'`).
+
+You can set option `sourceMapInline` to be `true` and source map will
+be appended to code.
 
 You can also specify sourceRoot property to be included in source map:
 ```javascript