Add Node API documentation for mangling options
This commit is contained in:
committed by
Richard van Velzen
parent
335b72df03
commit
030611b729
29
README.md
29
README.md
@@ -661,7 +661,8 @@ Other options:
|
|||||||
- `fromString` (default `false`) — if you pass `true` then you can pass
|
- `fromString` (default `false`) — if you pass `true` then you can pass
|
||||||
JavaScript source code, rather than file names.
|
JavaScript source code, rather than file names.
|
||||||
|
|
||||||
- `mangle` — pass `false` to skip mangling names.
|
- `mangle` (default `true`) — pass `false` to skip mangling names, or pass
|
||||||
|
an object to specify mangling options (see below).
|
||||||
|
|
||||||
- `mangleProperties` (default `false`) — pass an object to specify custom
|
- `mangleProperties` (default `false`) — pass an object to specify custom
|
||||||
mangle property options.
|
mangle property options.
|
||||||
@@ -680,6 +681,32 @@ Other options:
|
|||||||
|
|
||||||
- `except` - pass an array of identifiers that should be excluded from mangling
|
- `except` - pass an array of identifiers that should be excluded from mangling
|
||||||
|
|
||||||
|
- `toplevel` — mangle names declared in the toplevel scope (disabled by
|
||||||
|
default).
|
||||||
|
|
||||||
|
- `eval` — mangle names visible in scopes where eval or with are used
|
||||||
|
(disabled by default).
|
||||||
|
|
||||||
|
Examples:
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
//tst.js
|
||||||
|
var globalVar;
|
||||||
|
function funcName(firstLongName, anotherLongName)
|
||||||
|
{
|
||||||
|
var myVariable = firstLongName + anotherLongName;
|
||||||
|
}
|
||||||
|
|
||||||
|
UglifyJS.minify("tst.js").code;
|
||||||
|
// 'function funcName(a,n){}var globalVar;'
|
||||||
|
|
||||||
|
UglifyJS.minify("tst.js", { mangle: { except: ['firstLongName'] }}).code;
|
||||||
|
// 'function funcName(firstLongName,a){}var globalVar;'
|
||||||
|
|
||||||
|
UglifyJS.minify("tst.js", { mangle: toplevel: true }}).code;
|
||||||
|
// 'function n(n,a){}var a;'
|
||||||
|
```
|
||||||
|
|
||||||
##### mangleProperties options
|
##### mangleProperties options
|
||||||
|
|
||||||
- `regex` — Pass a RegExp to only mangle certain names (maps to the `--mangle-regex` CLI arguments option)
|
- `regex` — Pass a RegExp to only mangle certain names (maps to the `--mangle-regex` CLI arguments option)
|
||||||
|
|||||||
Reference in New Issue
Block a user