fix: types for multi stats (#20556)

alexander-akait · web-flow · commit a3d783937678 · 2026-02-28T17:46:42.000+03:00
diff --git a/.changeset/fine-lines-grin.md b/.changeset/fine-lines-grin.md
@@ -0,0 +1,5 @@
+---
+"webpack": patch
+---
+
+Fixed types for multi stats.
diff --git a/lib/MultiStats.js b/lib/MultiStats.js
@@ -8,6 +8,7 @@
 const identifierUtils = require("./util/identifier");
 
 /** @typedef {import("../declarations/WebpackOptions").StatsOptions} StatsOptions */
+/** @typedef {import("../declarations/WebpackOptions").StatsValue} StatsValue */
 /** @typedef {import("./Compilation").CreateStatsOptionsContext} CreateStatsOptionsContext */
 /** @typedef {import("./Compilation").NormalizedStatsOptions} NormalizedStatsOptions */
 /** @typedef {import("./Stats")} Stats */
@@ -25,8 +26,7 @@ const indent = (str, prefix) => {
 	return prefix + rem;
 };
 
-/** @typedef {undefined | string | boolean | StatsOptions} ChildrenStatsOptions */
-/** @typedef {Omit<StatsOptions, "children"> & { children?: ChildrenStatsOptions | ChildrenStatsOptions[] }} MultiStatsOptions */
+/** @typedef {StatsOptions} MultiStatsOptions */
 /** @typedef {{ version: boolean, hash: boolean, errorsCount: boolean, warningsCount: boolean, errors: boolean, warnings: boolean, children: NormalizedStatsOptions[] }} ChildOptions */
 
 class MultiStats {
@@ -56,7 +56,7 @@ class MultiStats {
 	}
 
 	/**
-	 * @param {undefined | string | boolean | MultiStatsOptions} options stats options
+	 * @param {undefined | StatsValue} options stats options
 	 * @param {CreateStatsOptionsContext} context context
 	 * @returns {ChildOptions} context context
 	 */
@@ -109,7 +109,7 @@ class MultiStats {
 	}
 
 	/**
-	 * @param {(string | boolean | MultiStatsOptions)=} options stats options
+	 * @param {StatsValue=} options stats options
 	 * @returns {StatsCompilation} json output
 	 */
 	toJson(options) {
@@ -184,7 +184,7 @@ class MultiStats {
 	}
 
 	/**
-	 * @param {(string | boolean | MultiStatsOptions)=} options stats options
+	 * @param {StatsValue=} options stats options
 	 * @returns {string} string output
 	 */
 	toString(options) {
diff --git a/lib/Stats.js b/lib/Stats.js
@@ -6,6 +6,7 @@
 "use strict";
 
 /** @typedef {import("../declarations/WebpackOptions").StatsOptions} StatsOptions */
+/** @typedef {import("../declarations/WebpackOptions").StatsValue} StatsValue */
 /** @typedef {import("./Compilation")} Compilation */
 /** @typedef {import("./stats/DefaultStatsFactoryPlugin").StatsCompilation} StatsCompilation */
 
@@ -50,7 +51,7 @@ class Stats {
 	}
 
 	/**
-	 * @param {(string | boolean | StatsOptions)=} options stats options
+	 * @param {StatsValue=} options stats options
 	 * @returns {StatsCompilation} json output
 	 */
 	toJson(options) {
@@ -66,7 +67,7 @@ class Stats {
 	}
 
 	/**
-	 * @param {(string | boolean | StatsOptions)=} options stats options
+	 * @param {StatsValue=} options stats options
 	 * @returns {string} string output
 	 */
 	toString(options) {
diff --git a/types.d.ts b/types.d.ts
@@ -1285,7 +1285,6 @@ declare interface CallbackWebpackFunction_2<T, R = void> {
 	(err: null | Error, result?: T): R;
 }
 type Cell<T> = undefined | T;
-type ChildrenStatsOptions = undefined | string | boolean | StatsOptions;
 declare class Chunk {
 	constructor(name?: null | string, backCompat?: boolean);
 	id: null | string | number;
@@ -11583,12 +11582,33 @@ declare abstract class MultiStats {
 	get hash(): string;
 	hasErrors(): boolean;
 	hasWarnings(): boolean;
-	toJson(options?: string | boolean | MultiStatsOptions): StatsCompilation;
-	toString(options?: string | boolean | MultiStatsOptions): string;
+	toJson(
+		options?:
+			| boolean
+			| StatsOptions
+			| "none"
+			| "summary"
+			| "errors-only"
+			| "errors-warnings"
+			| "minimal"
+			| "normal"
+			| "detailed"
+			| "verbose"
+	): StatsCompilation;
+	toString(
+		options?:
+			| boolean
+			| StatsOptions
+			| "none"
+			| "summary"
+			| "errors-only"
+			| "errors-warnings"
+			| "minimal"
+			| "normal"
+			| "detailed"
+			| "verbose"
+	): string;
 }
-type MultiStatsOptions = Omit<StatsOptions, "children"> & {
-	children?: string | boolean | StatsOptions | ChildrenStatsOptions[];
-};
 declare abstract class MultiWatching {
 	watchings: Watching[];
 	compiler: MultiCompiler;
@@ -12274,43 +12294,43 @@ declare interface NormalizedModules {
 type NormalizedStatsOptions = KnownNormalizedStatsOptions &
 	Omit<
 		StatsOptions,
-		| "assetsSort"
-		| "assetsSpace"
-		| "cachedAssets"
-		| "cachedModules"
-		| "chunkGroupAuxiliary"
-		| "chunkGroupChildren"
-		| "chunkGroupMaxAssets"
+		| "context"
 		| "chunkGroups"
-		| "chunkModulesSpace"
+		| "requestShortener"
 		| "chunksSort"
-		| "context"
-		| "dependentModules"
-		| "entrypoints"
-		| "excludeAssets"
-		| "excludeModules"
+		| "modulesSort"
+		| "chunkModulesSort"
+		| "nestedModulesSort"
+		| "assetsSort"
+		| "ids"
+		| "cachedAssets"
 		| "groupAssetsByEmitStatus"
-		| "groupAssetsByExtension"
 		| "groupAssetsByPath"
-		| "groupModulesByAttributes"
+		| "groupAssetsByExtension"
+		| "assetsSpace"
+		| "excludeAssets"
+		| "excludeModules"
+		| "warningsFilter"
+		| "cachedModules"
+		| "orphanModules"
+		| "dependentModules"
+		| "runtimeModules"
 		| "groupModulesByCacheStatus"
-		| "groupModulesByExtension"
 		| "groupModulesByLayer"
+		| "groupModulesByAttributes"
 		| "groupModulesByPath"
+		| "groupModulesByExtension"
 		| "groupModulesByType"
-		| "ids"
+		| "entrypoints"
+		| "chunkGroupAuxiliary"
+		| "chunkGroupChildren"
+		| "chunkGroupMaxAssets"
+		| "modulesSpace"
+		| "chunkModulesSpace"
+		| "nestedModulesSpace"
 		| "logging"
 		| "loggingDebug"
 		| "loggingTrace"
-		| "modulesSort"
-		| "modulesSpace"
-		| "nestedModulesSpace"
-		| "orphanModules"
-		| "runtimeModules"
-		| "warningsFilter"
-		| "requestShortener"
-		| "chunkModulesSort"
-		| "nestedModulesSort"
 		| "_env"
 	> &
 	Record<string, any>;
@@ -14145,7 +14165,7 @@ declare class ProgressPlugin {
 	showModules?: boolean;
 	showDependencies?: boolean;
 	showActiveModules?: boolean;
-	percentBy?: null | "modules" | "entries" | "dependencies";
+	percentBy?: null | "entries" | "modules" | "dependencies";
 	apply(compiler: MultiCompiler | Compiler): void;
 	static getReporter(
 		compiler: Compiler
@@ -14210,7 +14230,7 @@ declare interface ProgressPluginOptions {
 	/**
 	 * Collect percent algorithm. By default it calculates by a median from modules, entries and dependencies percent.
 	 */
-	percentBy?: null | "modules" | "entries" | "dependencies";
+	percentBy?: null | "entries" | "modules" | "dependencies";
 
 	/**
 	 * Collect profile data for progress steps. Default: false.
@@ -17768,8 +17788,32 @@ declare class Stats {
 	get endTime(): number;
 	hasWarnings(): boolean;
 	hasErrors(): boolean;
-	toJson(options?: string | boolean | StatsOptions): StatsCompilation;
-	toString(options?: string | boolean | StatsOptions): string;
+	toJson(
+		options?:
+			| boolean
+			| StatsOptions
+			| "none"
+			| "summary"
+			| "errors-only"
+			| "errors-warnings"
+			| "minimal"
+			| "normal"
+			| "detailed"
+			| "verbose"
+	): StatsCompilation;
+	toString(
+		options?:
+			| boolean
+			| StatsOptions
+			| "none"
+			| "summary"
+			| "errors-only"
+			| "errors-warnings"
+			| "minimal"
+			| "normal"
+			| "detailed"
+			| "verbose"
+	): string;
 }
 type StatsAsset = KnownStatsAsset & Record<string, any>;
 type StatsChunk = KnownStatsChunk & Record<string, any>;
@@ -20115,7 +20159,7 @@ declare namespace exports {
 		MultiCompilerOptions,
 		MultiConfiguration,
 		MultiStats,
-		MultiStatsOptions,
+		StatsOptions as MultiStatsOptions,
 		ResolveData,
 		ParserState,
 		ResolvePluginInstance,

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"webpack": patch
 +---
++
 +Fixed types for multi stats.