Fix docs for `printFileSizesAfterBuild` (#2942)

* Fix docs for `printFileSizesAfterBuild` * Add optionals parameters for `printFileSizesAfterBuild`

Fix docs for `printFileSizesAfterBuild` (#2942)
* Fix docs for `printFileSizesAfterBuild` * Add optionals parameters for `printFileSizesAfterBuild`
e8a3e4b2 · Yann Pringault · Joe Haddad · 6efab2e1 · e8a3e4b2
Commit e8a3e4b2 authored 7 years ago by Yann Pringault Committed by Joe Haddad 7 years ago
Hide whitespace changes
Inline Side-by-side

Showing

with 3 additions and 3 deletions
+3 -3
--- a/packages/react-dev-utils/README.md
+++ b/packages/react-dev-utils/README.md
@@ -170,9 +170,9 @@ module: {

 Captures JS and CSS asset sizes inside the passed `buildFolder`. Save the result value to compare it after the build.

-##### `printFileSizesAfterBuild(webpackStats: WebpackStats, previousFileSizes: OpaqueFileSizes)`
+##### `printFileSizesAfterBuild(webpackStats: WebpackStats, previousFileSizes: OpaqueFileSizes, buildFolder: string, maxBundleGzipSize?: number, maxChunkGzipSize?: number)`

-Prints the JS and CSS asset sizes after the build, and includes a size comparison with `previousFileSizes` that were captured earlier using `measureFileSizesBeforeBuild()`.
+Prints the JS and CSS asset sizes after the build, and includes a size comparison with `previousFileSizes` that were captured earlier using `measureFileSizesBeforeBuild()`. `maxBundleGzipSize` and `maxChunkGzipSizemay` may optionally be specified to display a warning when the main bundle or a chunk exceeds the specified size (in bytes).

 ```js
 var {
@@ -182,7 +182,7 @@ var {

 measureFileSizesBeforeBuild(buildFolder).then(previousFileSizes => {
  return cleanAndRebuild().then(webpackStats => {
-    printFileSizesAfterBuild(webpackStats, previousFileSizes);
+    printFileSizesAfterBuild(webpackStats, previousFileSizes, buildFolder);
  });
 });
 ```