Fix docs for printFileSizesAfterBuild (facebook#2942)

* Fix docs for `printFileSizesAfterBuild` * Add optionals parameters for `printFileSizesAfterBuild`
kasperpeulen · Sep 24, 2017 · 0a9f42b · 0a9f42b
1 parent 071d60d
commit 0a9f42b
Showing 1 changed file with 3 additions and 3 deletions.
diff --git 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);
   });
 });
 ```