docs: add JSDoc for PrintFileSizeOptions (#4043)

web-infra-dev · Nov 22, 2024 · e3350e3 · e3350e3
1 parent 50a1c99
commit e3350e3
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 9 deletions.
diff --git a/packages/core/src/types/config.ts b/packages/core/src/types/config.ts
@@ -443,8 +443,21 @@ export type BuildCacheOptions = {
 };
 
 export type PrintFileSizeOptions = {
+  /**
+   * Whether to print the total size of all static assets.
+   * @default true
+   */
   total?: boolean;
+  /**
+   * Whether to print the size of each static asset.
+   * @default true
+   */
   detail?: boolean;
+  /**
+   * Whether to print the gzip-compressed size of each static asset.
+   * Disable this option can save some gzip computation time for large projects.
+   * @default true
+   */
   compressed?: boolean;
 };
 

diff --git a/website/docs/en/config/performance/print-file-size.mdx b/website/docs/en/config/performance/print-file-size.mdx
@@ -4,21 +4,24 @@
 
 ```ts
 type PrintFileSizeOptions =
+  | boolean
   | {
       /**
-       * whether to print total size
+       * Whether to print the total size of all static assets.
+       * @default true
        */
       total?: boolean;
       /**
-       * whether to print size of each file
+       * Whether to print the size of each static asset.
+       * @default true
        */
       detail?: boolean;
       /**
-       * whether to print gzip-compressed size
+       * Whether to print the gzip-compressed size of each static asset.
+       * @default true
        */
       compressed?: boolean;
-    }
-  | boolean;
+    };
 ```
 
 - **Default:** `true`

diff --git a/website/docs/zh/config/performance/print-file-size.mdx b/website/docs/zh/config/performance/print-file-size.mdx
@@ -4,21 +4,24 @@
 
 ```ts
 type PrintFileSizeOptions =
+  | boolean
   | {
       /**
-       * 是否输出所有静态资源文件的总体积
+       * 是否输出所有静态资源的总体积
+       * @default true
        */
       total?: boolean;
       /**
-       * 是否输出每个静态资源文件的体积
+       * 是否输出每个静态资源的体积
+       * @default true
        */
       detail?: boolean;
       /**
        * 是否输出 gzip 压缩后的体积
+       * @default true
        */
       compressed?: boolean;
-    }
-  | boolean;
+    };
 ```
 
 - **默认值：** `true`