aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorkzc <kzc@users.noreply.github.com>2017-05-31 09:52:43 -0400
committerAlex Lam S.L <alexlamsl@gmail.com>2017-05-31 21:52:43 +0800
commitf71e8fd9488b28b92e6897254b7a54cf51471557 (patch)
tree1c0d4990ecae743f04ca60ee4362acf4720fe5c2
parent3e62faa64fd563dddca0b6fb86edb34fa006db6a (diff)
downloadtracifyjs-f71e8fd9488b28b92e6897254b7a54cf51471557.tar.gz
tracifyjs-f71e8fd9488b28b92e6897254b7a54cf51471557.zip
reformat mangle options section of README (#2036)
-rw-r--r--README.md17
1 files changed, 9 insertions, 8 deletions
diff --git a/README.md b/README.md
index d9a0162c..b6b52a46 100644
--- a/README.md
+++ b/README.md
@@ -680,17 +680,18 @@ If you're using the `X-SourceMap` header instead, you can just omit `sourceMap.u
## Mangle options
-- `reserved` - pass an array of identifiers that should be excluded from mangling
+- `reserved` (default `[]`). Pass an array of identifiers that should be
+ excluded from mangling. Example: `["foo", "bar"]`.
-- `toplevel` — mangle names declared in the top level scope (disabled by
-default).
+- `toplevel` (default `false`). Pass `true` to mangle names declared in the
+ top level scope.
-- `eval` — mangle names visible in scopes where eval or with are used
-(disabled by default).
+- `keep_fnames` (default `false`). Pass `true` to not mangle function names.
+ Useful for code relying on `Function.prototype.name`. See also: the `keep_fnames`
+ [compress option](#compress-options).
-- `keep_fnames` -- default `false`. Pass `true` to not mangle
-function names. Useful for code relying on `Function.prototype.name`.
-See also: the `keep_fnames` [compress option](#compress-options).
+- `eval` (default `false`). Pass `true` to mangle names visible in scopes
+ where `eval` or `with` are used.
Examples: