export = CompressionPlugin; /** @typedef {import("schema-utils/declarations/validate").Schema} Schema */ /** @typedef {import("webpack").AssetInfo} AssetInfo */ /** @typedef {import("webpack").Compiler} Compiler */ /** @typedef {import("webpack").PathData} PathData */ /** @typedef {import("webpack").WebpackPluginInstance} WebpackPluginInstance */ /** @typedef {import("webpack").Compilation} Compilation */ /** @typedef {import("webpack").sources.Source} Source */ /** @typedef {import("webpack").Asset} Asset */ /** @typedef {import("webpack").WebpackError} WebpackError */ /** * @template T * @typedef {T | { valueOf(): T }} WithImplicitCoercion */ /** @typedef {RegExp | string} Rule */ /** @typedef {Rule[] | Rule} Rules */ /** @typedef {any} EXPECTED_ANY */ /** * @typedef {{ [key: string]: EXPECTED_ANY }} CustomOptions */ /** * @template T * @typedef {T extends infer U ? U : CustomOptions} InferDefaultType */ /** * @template T * @typedef {InferDefaultType} CompressionOptions */ /** * @template T * @callback AlgorithmFunction * @param {Buffer} input * @param {CompressionOptions} options * @param {(error: Error | null | undefined, result: WithImplicitCoercion | Uint8Array | ReadonlyArray | WithImplicitCoercion | string> | WithImplicitCoercion | { [Symbol.toPrimitive](hint: 'string'): string }) => void} callback */ /** * @typedef {string | ((fileData: PathData) => string)} Filename */ /** * @typedef {boolean | "keep-source-map" | ((name: string) => boolean)} DeleteOriginalAssets */ /** * @template T * @typedef {object} BasePluginOptions * @property {Rules=} test include all assets that pass test assertion * @property {Rules=} include include all assets matching any of these conditions * @property {Rules=} exclude exclude all assets matching any of these conditions * @property {number=} threshold only assets bigger than this size are processed, in bytes * @property {number=} minRatio only assets that compress better than this ratio are processed (`minRatio = Compressed Size / Original Size`) * @property {DeleteOriginalAssets=} deleteOriginalAssets whether to delete the original assets or not * @property {Filename=} filename the target asset filename */ /** * @typedef {import("zlib").ZlibOptions} ZlibOptions */ /** * @template T * @typedef {T extends ZlibOptions ? { algorithm?: string | AlgorithmFunction | undefined, compressionOptions?: CompressionOptions | undefined } : { algorithm: string | AlgorithmFunction, compressionOptions?: CompressionOptions | undefined }} DefinedDefaultAlgorithmAndOptions */ /** * @template T * @typedef {BasePluginOptions & { algorithm: string | AlgorithmFunction, compressionOptions: CompressionOptions, threshold: number, minRatio: number, deleteOriginalAssets: DeleteOriginalAssets, filename: Filename }} InternalPluginOptions */ /** * @template [T=ZlibOptions] * @implements WebpackPluginInstance */ declare class CompressionPlugin< T = import("zlib").ZlibOptions, > implements WebpackPluginInstance { /** * @param {(BasePluginOptions & DefinedDefaultAlgorithmAndOptions)=} options options */ constructor( options?: | (BasePluginOptions & DefinedDefaultAlgorithmAndOptions) | undefined, ); /** * @private * @type {InternalPluginOptions} */ private options; /** * @private * @type {AlgorithmFunction} */ private algorithm; /** * @private * @param {Buffer} input input * @returns {Promise} compressed buffer */ private runCompressionAlgorithm; /** * @private * @param {Compiler} compiler compiler * @param {Compilation} compilation compilation * @param {Record} assets assets * @returns {Promise} */ private compress; /** * @param {Compiler} compiler compiler * @returns {void} */ apply(compiler: Compiler): void; } declare namespace CompressionPlugin { export { Schema, AssetInfo, Compiler, PathData, WebpackPluginInstance, Compilation, Source, Asset, WebpackError, WithImplicitCoercion, Rule, Rules, EXPECTED_ANY, CustomOptions, InferDefaultType, CompressionOptions, AlgorithmFunction, Filename, DeleteOriginalAssets, BasePluginOptions, ZlibOptions, DefinedDefaultAlgorithmAndOptions, InternalPluginOptions, }; } type Schema = import("schema-utils/declarations/validate").Schema; type AssetInfo = import("webpack").AssetInfo; type Compiler = import("webpack").Compiler; type PathData = import("webpack").PathData; type WebpackPluginInstance = import("webpack").WebpackPluginInstance; type Compilation = import("webpack").Compilation; type Source = import("webpack").sources.Source; type Asset = import("webpack").Asset; type WebpackError = import("webpack").WebpackError; type WithImplicitCoercion = | T | { valueOf(): T; }; type Rule = RegExp | string; type Rules = Rule[] | Rule; type EXPECTED_ANY = any; type CustomOptions = { [key: string]: EXPECTED_ANY; }; type InferDefaultType = T extends infer U ? U : CustomOptions; type CompressionOptions = InferDefaultType; type AlgorithmFunction = ( input: Buffer, options: CompressionOptions, callback: ( error: Error | null | undefined, result: | WithImplicitCoercion | Uint8Array | ReadonlyArray | WithImplicitCoercion | string> | WithImplicitCoercion | { [Symbol.toPrimitive](hint: "string"): string; }, ) => void, ) => any; type Filename = string | ((fileData: PathData) => string); type DeleteOriginalAssets = | boolean | "keep-source-map" | ((name: string) => boolean); type BasePluginOptions = { /** * include all assets that pass test assertion */ test?: Rules | undefined; /** * include all assets matching any of these conditions */ include?: Rules | undefined; /** * exclude all assets matching any of these conditions */ exclude?: Rules | undefined; /** * only assets bigger than this size are processed, in bytes */ threshold?: number | undefined; /** * only assets that compress better than this ratio are processed (`minRatio = Compressed Size / Original Size`) */ minRatio?: number | undefined; /** * whether to delete the original assets or not */ deleteOriginalAssets?: DeleteOriginalAssets | undefined; /** * the target asset filename */ filename?: Filename | undefined; }; type ZlibOptions = import("zlib").ZlibOptions; type DefinedDefaultAlgorithmAndOptions = T extends ZlibOptions ? { algorithm?: string | AlgorithmFunction | undefined; compressionOptions?: CompressionOptions | undefined; } : { algorithm: string | AlgorithmFunction; compressionOptions?: CompressionOptions | undefined; }; type InternalPluginOptions = BasePluginOptions & { algorithm: string | AlgorithmFunction; compressionOptions: CompressionOptions; threshold: number; minRatio: number; deleteOriginalAssets: DeleteOriginalAssets; filename: Filename; };