Skip to content

Commit e9d87bf

Browse files
committed
Update README for compressedSize* options
1 parent 8117cd0 commit e9d87bf

File tree

1 file changed

+20
-17
lines changed

1 file changed

+20
-17
lines changed

README.md

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,8 @@ new BundleAnalyzerPlugin(options?: object)
6262
|**`reportFilename`**|`{String}`|Default: `report.html`. Path to bundle report file that will be generated in `static` mode. It can be either an absolute path or a path relative to a bundle output directory (which is output.path in webpack config).|
6363
|**`reportTitle`**|`{String\|function}`|Default: function that returns pretty printed current date and time. Content of the HTML `title` element; or a function of the form `() => string` that provides the content.|
6464
|**`defaultSizes`**|One of: `stat`, `parsed`, `compressed`|Default: `parsed`. Module sizes to show in report by default. [Size definitions](#size-definitions) section describes what these values mean.|
65+
|**`compressedSize`**|`{function}`|Default: gzip (with compression level 9). A function of the form `(buffer) => number` that provides a custom computation of the compressed size. For example `(buffer) => zlib.brotliCompressSync(buffer).length`|
66+
|**`compressedSizeLabel`**|`{String}`|Default: `Gzipped`. Content of compressed module size buttons and labels. For example `Brotli`.|
6567
|**`openAnalyzer`**|`{Boolean}`|Default: `true`. Automatically open report in default browser.|
6668
|**`generateStatsFile`**|`{Boolean}`|Default: `false`. If `true`, webpack stats JSON file will be generated in bundle output directory|
6769
|**`statsFilename`**|`{String}`|Default: `stats.json`. Name of webpack stats JSON file that will be generated if `generateStatsFile` is `true`. It can be either an absolute path or a path relative to a bundle output directory (which is output.path in webpack config).|
@@ -111,23 +113,24 @@ Directory containing all generated bundles.
111113
### `options`
112114

113115
```
114-
-V, --version output the version number
115-
-m, --mode <mode> Analyzer mode. Should be `server`, `static` or `json`.
116-
In `server` mode analyzer will start HTTP server to show bundle report.
117-
In `static` mode single HTML file with bundle report will be generated.
118-
In `json` mode single JSON file with bundle report will be generated. (default: server)
119-
-h, --host <host> Host that will be used in `server` mode to start HTTP server. (default: 127.0.0.1)
120-
-p, --port <n> Port that will be used in `server` mode to start HTTP server. Should be a number or `auto` (default: 8888)
121-
-r, --report <file> Path to bundle report file that will be generated in `static` mode. (default: report.html)
122-
-t, --title <title> String to use in title element of html report. (default: pretty printed current date)
123-
-s, --default-sizes <type> Module sizes to show in treemap by default.
124-
Possible values: stat, parsed, compressed (default: parsed)
125-
-O, --no-open Don't open report in default browser automatically.
126-
-e, --exclude <regexp> Assets that should be excluded from the report.
127-
Can be specified multiple times.
128-
-l, --log-level <level> Log level.
129-
Possible values: debug, info, warn, error, silent (default: info)
130-
-h, --help output usage information
116+
-V, --version output the version number
117+
-m, --mode <mode> Analyzer mode. Should be `server`, `static` or `json`.
118+
In `server` mode analyzer will start HTTP server to show bundle report.
119+
In `static` mode single HTML file with bundle report will be generated.
120+
In `json` mode single JSON file with bundle report will be generated. (default: server)
121+
-h, --host <host> Host that will be used in `server` mode to start HTTP server. (default: 127.0.0.1)
122+
-p, --port <n> Port that will be used in `server` mode to start HTTP server. Should be a number or `auto` (default: 8888)
123+
-r, --report <file> Path to bundle report file that will be generated in `static` mode. (default: report.html)
124+
-t, --title <title> String to use in title element of html report. (default: pretty printed current date)
125+
-s, --default-sizes <type> Module sizes to show in treemap by default.
126+
Possible values: stat, parsed, compressed (default: parsed)
127+
--compressed-size-label <label> String to use for the compressed module size option. (default: Gzipped)
128+
-O, --no-open Don't open report in default browser automatically.
129+
-e, --exclude <regexp> Assets that should be excluded from the report.
130+
Can be specified multiple times.
131+
-l, --log-level <level> Log level.
132+
Possible values: debug, info, warn, error, silent (default: info)
133+
-h, --help output usage information
131134
```
132135

133136
<h2 align="center" id="size-definitions">Size definitions</h2>

0 commit comments

Comments
 (0)