fix: types for the parallel option (#448)

webpack-contrib · Sep 9, 2021 · 1e14230 · 1e14230
1 parent 210a5a0
commit 1e14230
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 6 deletions.
diff --git a/src/index.js b/src/index.js
@@ -123,13 +123,17 @@ import { minify as minimize } from "./minify";
  * @typedef {BasicMinimizerImplementation<T> & MinimizeFunctionHelpers } MinimizerImplementation
  */
 
+/**
+ * @typedef {undefined | boolean | number} Parallel
+ */
+
 /**
  * @typedef {Object} BasePluginOptions
  * @property {Rules} [test]
  * @property {Rules} [include]
  * @property {Rules} [exclude]
  * @property {ExtractCommentsOptions} [extractComments]
- * @property {boolean} [parallel]
+ * @property {Parallel} [parallel]
  */
 
 /**
@@ -307,7 +311,7 @@ class TerserPlugin {
 
   /**
    * @private
-   * @param {boolean | undefined} parallel
+   * @param {Parallel} parallel
    * @returns {number}
    */
   static getAvailableNumberOfCores(parallel) {

diff --git a/types/index.d.ts b/types/index.d.ts
@@ -80,12 +80,13 @@ export type MinimizeFunctionHelpers = {
 };
 export type MinimizerImplementation<T> = BasicMinimizerImplementation<T> &
   MinimizeFunctionHelpers;
+export type Parallel = undefined | boolean | number;
 export type BasePluginOptions = {
   test?: Rules | undefined;
   include?: Rules | undefined;
   exclude?: Rules | undefined;
   extractComments?: ExtractCommentsOptions | undefined;
-  parallel?: boolean | undefined;
+  parallel?: Parallel;
 };
 export type InferDefaultType<T> = T extends infer U
   ? U
@@ -188,13 +189,16 @@ export type DefinedDefaultMinimizerAndOptions<T> =
  * @template T
  * @typedef {BasicMinimizerImplementation<T> & MinimizeFunctionHelpers } MinimizerImplementation
  */
+/**
+ * @typedef {undefined | boolean | number} Parallel
+ */
 /**
  * @typedef {Object} BasePluginOptions
  * @property {Rules} [test]
  * @property {Rules} [include]
  * @property {Rules} [exclude]
  * @property {ExtractCommentsOptions} [extractComments]
- * @property {boolean} [parallel]
+ * @property {Parallel} [parallel]
  */
 /**
  * @template T
@@ -232,7 +236,7 @@ declare class TerserPlugin<T = TerserOptions> {
   private static buildError;
   /**
    * @private
-   * @param {boolean | undefined} parallel
+   * @param {Parallel} parallel
    * @returns {number}
    */
   private static getAvailableNumberOfCores;
@@ -253,7 +257,7 @@ declare class TerserPlugin<T = TerserOptions> {
   options: {
     test: Rules;
     extractComments: ExtractCommentsOptions;
-    parallel: boolean;
+    parallel: number | boolean;
     include: Rules | undefined;
     exclude: Rules | undefined;
     minimizer: {