From de3824a99c7e4ee0a4f06059ffe6620c6e588457 Mon Sep 17 00:00:00 2001 From: Aviv Keller Date: Tue, 7 Apr 2026 17:36:45 -0400 Subject: [PATCH 1/2] feat(pages): more pages --- generate-md.mjs | 27 +- package-lock.json | 12 - pages/v5.x/AggressiveSplitting.md | 77 + pages/v5.x/Argument.md | 29 + pages/v5.x/Asset.md | 57 + pages/v5.x/AsyncDependenciesBlock.md | 163 + pages/v5.x/AutomaticPrefetchPlugin.md | 23 + pages/v5.x/BannerPlugin.md | 104 + pages/v5.x/Cache.md | 112 + pages/v5.x/Chunk.md | 1663 +++ pages/v5.x/CleanPlugin.md | 43 + pages/v5.x/CodeGenerationResults.md | 97 + pages/v5.x/Colors.md | 507 + pages/v5.x/Compilation.md | 1216 +++ pages/v5.x/Compiler.md | 429 + pages/v5.x/ConcatenationScope.md | 129 + pages/v5.x/Configuration.md | 303 + pages/v5.x/ConsumeShared.md | 53 + pages/v5.x/ContainerReference.md | 59 + pages/v5.x/ContextExclusionPlugin.md | 33 + pages/v5.x/ContextReplacementPlugin.md | 82 + pages/v5.x/DefinePlugin.md | 61 + pages/v5.x/DelegatedPlugin.md | 33 + pages/v5.x/Dependency.md | 246 + pages/v5.x/Dll.md | 185 + pages/v5.x/DotenvPlugin.md | 31 + pages/v5.x/DynamicEntryPlugin.md | 43 + pages/v5.x/Entry.md | 116 + pages/v5.x/Entrypoint.md | 536 + pages/v5.x/EnvironmentPlugin.md | 39 + pages/v5.x/EvalDevToolModulePlugin.md | 45 + pages/v5.x/EvalSourceMapDevToolPlugin.md | 51 + pages/v5.x/ExternalItem.md | 136 + pages/v5.x/ExternalModule.md | 963 ++ pages/v5.x/Externals.md | 42 + pages/v5.x/FileCacheOptions.md | 171 + pages/v5.x/Generator.md | 165 + pages/v5.x/HASH.md | 7 + pages/v5.x/HashedModule.md | 67 + pages/v5.x/HotModuleReplacementPlugin.md | 33 + pages/v5.x/HotUpdateChunk.md | 556 + pages/v5.x/ID.md | 7 + pages/v5.x/IgnorePlugin.md | 66 + pages/v5.x/InitFragment.md | 145 + pages/v5.x/InputFileSystem.md | 155 + pages/v5.x/JsonModules.md | 45 + pages/v5.x/LOADERS.md | 7 + pages/v5.x/LibManifestPlugin.md | 33 + pages/v5.x/LibraryOptions.md | 55 + pages/v5.x/LibraryTemplatePlugin.md | 43 + pages/v5.x/LimitChunk.md | 57 + pages/v5.x/Loader.md | 147 + pages/v5.x/ManifestPlugin.md | 73 + pages/v5.x/MemoryCache.md | 51 + pages/v5.x/MergeDuplicate.md | 41 + pages/v5.x/MinChunk.md | 59 + pages/v5.x/Module.md | 3235 ++++++ pages/v5.x/MultiCompiler.md | 176 + pages/v5.x/MultiConfiguration.md | 7 + pages/v5.x/MultiStats.md | 55 + pages/v5.x/NAMESPACE.md | 7 + pages/v5.x/NoEmitOnErrorsPlugin.md | 23 + pages/v5.x/NormalModule.md | 1125 ++ pages/v5.x/ObjectDeserializerContext.md | 25 + pages/v5.x/ObjectSerializerContext.md | 74 + pages/v5.x/OccurrenceChunk.md | 43 + pages/v5.x/OccurrenceModule.md | 43 + pages/v5.x/OptimizationStages.md | 17 + pages/v5.x/OutputFileSystem.md | 122 + pages/v5.x/Parser.md | 116 + pages/v5.x/PathData.md | 119 + pages/v5.x/PitchLoaderDefinitionFunction.md | 16 + pages/v5.x/PlatformPlugin.md | 33 + pages/v5.x/PrefetchPlugin.md | 40 + pages/v5.x/Problem.md | 41 + pages/v5.x/ProgressPlugin.md | 193 + pages/v5.x/ProvidePlugin.md | 33 + pages/v5.x/ProvideShared.md | 51 + pages/v5.x/QUERY.md | 7 + pages/v5.x/RESOURCE.md | 7 + pages/v5.x/RawLoader.md | 27 + pages/v5.x/RenderManifest.md | 73 + pages/v5.x/ResolveData.md | 85 + pages/v5.x/ResolveOptions.md | 290 + pages/v5.x/ResolvePluginInstance.md | 27 + pages/v5.x/Resolver.md | 157 + pages/v5.x/RuleSet.md | 347 + pages/v5.x/Runtime.md | 1512 +++ pages/v5.x/Stats.md | 628 ++ pages/v5.x/Template.md | 176 + pages/v5.x/UsageState.md | 7 + pages/v5.x/WatchIgnore.md | 43 + pages/v5.x/Watching.md | 146 + pages/v5.x/Webpack.md | 661 ++ pages/v5.x/_media/GOVERNANCE.md | 3 - pages/v5.x/_media/WORKING_GROUP.md | 48 - .../cache.md => cache/MemoryCachePlugin.md} | 7 +- pages/v5.x/cache/index.md | 9 + pages/v5.x/cli/index.md | 7 + pages/v5.x/config/index.md | 15 + pages/v5.x/container/ContainerPlugin.md | 73 + .../container/ContainerReferencePlugin.md | 33 + .../v5.x/container/ModuleFederationPlugin.md | 45 + pages/v5.x/container/index.md | 15 + .../css.md => css/CssModulesPlugin.md} | 42 +- pages/v5.x/css/index.md | 9 + pages/v5.x/debug/ProfilingPlugin.md | 49 + pages/v5.x/debug/index.md | 9 + pages/v5.x/dependencies/ConstDependency.md | 322 + .../dependencies/HarmonyImportDependency.md | 426 + pages/v5.x/dependencies/ModuleDependency.md | 323 + pages/v5.x/dependencies/NullDependency.md | 294 + pages/v5.x/dependencies/index.md | 12 + .../ElectronTargetPlugin.md} | 10 +- pages/v5.x/electron/index.md | 9 + .../esm/ModuleChunkLoadingRuntimeModule.md | 1053 ++ pages/v5.x/esm/index.md | 9 + .../ids/SyncModuleIdsPlugin.md} | 14 +- pages/v5.x/experiments/ids/index.md | 9 + pages/v5.x/experiments/index.md | 13 + .../v5.x/experiments/schemes/HttpUriPlugin.md | 37 + .../schemes/VirtualUrlPlugin.md} | 68 +- pages/v5.x/experiments/schemes/index.md | 10 + pages/v5.x/globals.md | 7404 ------------- pages/v5.x/ids/ChunkModuleIdRangePlugin.md | 33 + pages/v5.x/ids/DeterministicChunkIdsPlugin.md | 33 + .../v5.x/ids/DeterministicModuleIdsPlugin.md | 33 + pages/v5.x/ids/HashedModuleIdsPlugin.md | 33 + pages/v5.x/ids/NamedChunkIdsPlugin.md | 33 + pages/v5.x/ids/NamedModuleIdsPlugin.md | 33 + pages/v5.x/ids/NaturalModuleIdsPlugin.md | 23 + pages/v5.x/ids/OccurrenceChunkIdsPlugin.md | 33 + pages/v5.x/ids/OccurrenceModuleIdsPlugin.md | 33 + pages/v5.x/ids/index.md | 17 + pages/v5.x/index.md | 889 +- .../javascript/EnableChunkLoadingPlugin.md | 55 + .../javascript/JavascriptModulesPlugin.md | 136 + .../JavascriptParser.md} | 997 +- pages/v5.x/javascript/index.md | 11 + .../AbstractLibraryPlugin.md} | 102 +- pages/v5.x/library/EnableLibraryPlugin.md | 62 + pages/v5.x/library/index.md | 10 + pages/v5.x/node/NodeEnvironmentPlugin.md | 33 + pages/v5.x/node/NodeSourcePlugin.md | 23 + pages/v5.x/node/NodeTargetPlugin.md | 33 + pages/v5.x/node/NodeTemplatePlugin.md | 27 + .../node/ReadFileCompileAsyncWasmPlugin.md | 27 + pages/v5.x/node/ReadFileCompileWasmPlugin.md | 57 + pages/v5.x/node/index.md | 14 + .../v5.x/optimize/AggressiveMergingPlugin.md | 33 + .../optimize/AggressiveSplittingPlugin.md | 43 + .../optimize/InnerGraph/TopLevelSymbol.md | 21 + .../InnerGraph/index.md} | 105 +- pages/v5.x/optimize/LimitChunkCountPlugin.md | 31 + .../optimize/MergeDuplicateChunksPlugin.md | 31 + pages/v5.x/optimize/MinChunkSizePlugin.md | 33 + .../optimize/ModuleConcatenationPlugin.md | 23 + pages/v5.x/optimize/RealContentHashPlugin.md | 37 + pages/v5.x/optimize/RuntimeChunkPlugin.md | 39 + pages/v5.x/optimize/SideEffectsFlagPlugin.md | 39 + pages/v5.x/optimize/SplitChunksPlugin.md | 33 + pages/v5.x/optimize/index.md | 19 + .../ChunkPrefetchPreloadPlugin.md} | 7 +- pages/v5.x/prefetch/index.md | 9 + .../runtime/GetChunkFilenameRuntimeModule.md | 1079 ++ pages/v5.x/runtime/LoadScriptRuntimeModule.md | 1054 ++ pages/v5.x/runtime/index.md | 10 + pages/v5.x/sharing/ConsumeSharedPlugin.md | 33 + pages/v5.x/sharing/ProvideSharedPlugin.md | 33 + pages/v5.x/sharing/SharePlugin.md | 45 + pages/v5.x/sharing/index.md | 15 + pages/v5.x/sources/CachedSource.md | 112 + pages/v5.x/sources/CompatSource.md | 75 + pages/v5.x/sources/ConcatSource.md | 119 + pages/v5.x/sources/OriginalSource.md | 100 + pages/v5.x/sources/PrefixSource.md | 106 + pages/v5.x/sources/RawSource.md | 100 + pages/v5.x/sources/ReplaceSource.md | 143 + pages/v5.x/sources/SizeOnlySource.md | 65 + pages/v5.x/sources/Source.md | 310 + pages/v5.x/sources/SourceMapSource.md | 104 + pages/v5.x/sources/index.md | 20 + pages/v5.x/type-map.json | 9346 ++++++++++------- .../util/index.md => util/LazySet.md} | 107 +- pages/v5.x/util/comparators/index.md | 7 + .../v5.x/util/compileBooleanMatcher/index.md | 23 + pages/v5.x/util/index.md | 52 + pages/v5.x/util/runtime/RuntimeSpecMap.md | 101 + pages/v5.x/util/runtime/RuntimeSpecSet.md | 47 + pages/v5.x/util/runtime/index.md | 12 + .../serialization/MEASURE_END_OPERATION.md | 9 + .../serialization/MEASURE_START_OPERATION.md | 9 + pages/v5.x/util/serialization/index.md | 33 + .../AsyncWebAssemblyModulesPlugin.md} | 58 +- pages/v5.x/wasm/EnableWasmLoadingPlugin.md | 55 + pages/v5.x/wasm/index.md | 10 + pages/v5.x/web/CssLoadingRuntimeModule.md | 1053 ++ pages/v5.x/web/FetchCompileAsyncWasmPlugin.md | 23 + pages/v5.x/web/FetchCompileWasmPlugin.md | 53 + .../web/JsonpChunkLoadingRuntimeModule.md | 1053 ++ pages/v5.x/web/JsonpTemplatePlugin.md | 37 + pages/v5.x/web/index.md | 13 + .../namespaces/ModuleFilenameHelpers.md | 176 - .../webpack/namespaces/OptimizationStages.md | 17 - .../v5.x/webpack/namespaces/RuntimeGlobals.md | 497 - pages/v5.x/webpack/namespaces/cli.md | 36 - pages/v5.x/webpack/namespaces/config.md | 18 - pages/v5.x/webpack/namespaces/container.md | 91 - pages/v5.x/webpack/namespaces/debug.md | 24 - pages/v5.x/webpack/namespaces/dependencies.md | 582 - pages/v5.x/webpack/namespaces/esm.md | 391 - .../webpack/namespaces/experiments/index.md | 6 - pages/v5.x/webpack/namespaces/ids.md | 210 - pages/v5.x/webpack/namespaces/node.md | 130 - .../v5.x/webpack/namespaces/optimize/index.md | 243 - pages/v5.x/webpack/namespaces/runtime.md | 787 -- pages/v5.x/webpack/namespaces/sharing.md | 80 - pages/v5.x/webpack/namespaces/sources.md | 594 -- .../namespaces/util/namespaces/comparators.md | 190 - .../util/namespaces/compileBooleanMatcher.md | 18 - .../namespaces/util/namespaces/runtime.md | 266 - .../util/namespaces/serialization.md | 75 - pages/v5.x/webpack/namespaces/web.md | 854 -- .../WebWorkerTemplatePlugin.md} | 7 +- pages/v5.x/webworker/index.md | 9 + plugins/constants.mjs | 54 + plugins/processor.mjs | 355 +- plugins/shared/family.mjs | 149 + plugins/shared/type-visitor.mjs | 75 + plugins/theme/helpers/index.mjs | 122 +- plugins/theme/index.mjs | 6 +- plugins/theme/partials/index.mjs | 135 +- plugins/theme/partials/types.mjs | 65 +- plugins/theme/router.mjs | 214 +- plugins/theme/templates/index.mjs | 116 + plugins/theme/utils/branching.mjs | 270 + plugins/theme/utils/formatting.mjs | 59 + plugins/theme/utils/members.mjs | 35 + plugins/theme/utils/routing/namespaces.mjs | 70 + plugins/theme/utils/routing/state.mjs | 395 + plugins/theme/utils/types.mjs | 115 + tsconfig.json => tsconfig.typedoc.json | 0 242 files changed, 38641 insertions(+), 17694 deletions(-) create mode 100644 pages/v5.x/AggressiveSplitting.md create mode 100644 pages/v5.x/Argument.md create mode 100644 pages/v5.x/Asset.md create mode 100644 pages/v5.x/AsyncDependenciesBlock.md create mode 100644 pages/v5.x/AutomaticPrefetchPlugin.md create mode 100644 pages/v5.x/BannerPlugin.md create mode 100644 pages/v5.x/Cache.md create mode 100644 pages/v5.x/Chunk.md create mode 100644 pages/v5.x/CleanPlugin.md create mode 100644 pages/v5.x/CodeGenerationResults.md create mode 100644 pages/v5.x/Colors.md create mode 100644 pages/v5.x/Compilation.md create mode 100644 pages/v5.x/Compiler.md create mode 100644 pages/v5.x/ConcatenationScope.md create mode 100644 pages/v5.x/Configuration.md create mode 100644 pages/v5.x/ConsumeShared.md create mode 100644 pages/v5.x/ContainerReference.md create mode 100644 pages/v5.x/ContextExclusionPlugin.md create mode 100644 pages/v5.x/ContextReplacementPlugin.md create mode 100644 pages/v5.x/DefinePlugin.md create mode 100644 pages/v5.x/DelegatedPlugin.md create mode 100644 pages/v5.x/Dependency.md create mode 100644 pages/v5.x/Dll.md create mode 100644 pages/v5.x/DotenvPlugin.md create mode 100644 pages/v5.x/DynamicEntryPlugin.md create mode 100644 pages/v5.x/Entry.md create mode 100644 pages/v5.x/Entrypoint.md create mode 100644 pages/v5.x/EnvironmentPlugin.md create mode 100644 pages/v5.x/EvalDevToolModulePlugin.md create mode 100644 pages/v5.x/EvalSourceMapDevToolPlugin.md create mode 100644 pages/v5.x/ExternalItem.md create mode 100644 pages/v5.x/ExternalModule.md create mode 100644 pages/v5.x/Externals.md create mode 100644 pages/v5.x/FileCacheOptions.md create mode 100644 pages/v5.x/Generator.md create mode 100644 pages/v5.x/HASH.md create mode 100644 pages/v5.x/HashedModule.md create mode 100644 pages/v5.x/HotModuleReplacementPlugin.md create mode 100644 pages/v5.x/HotUpdateChunk.md create mode 100644 pages/v5.x/ID.md create mode 100644 pages/v5.x/IgnorePlugin.md create mode 100644 pages/v5.x/InitFragment.md create mode 100644 pages/v5.x/InputFileSystem.md create mode 100644 pages/v5.x/JsonModules.md create mode 100644 pages/v5.x/LOADERS.md create mode 100644 pages/v5.x/LibManifestPlugin.md create mode 100644 pages/v5.x/LibraryOptions.md create mode 100644 pages/v5.x/LibraryTemplatePlugin.md create mode 100644 pages/v5.x/LimitChunk.md create mode 100644 pages/v5.x/Loader.md create mode 100644 pages/v5.x/ManifestPlugin.md create mode 100644 pages/v5.x/MemoryCache.md create mode 100644 pages/v5.x/MergeDuplicate.md create mode 100644 pages/v5.x/MinChunk.md create mode 100644 pages/v5.x/Module.md create mode 100644 pages/v5.x/MultiCompiler.md create mode 100644 pages/v5.x/MultiConfiguration.md create mode 100644 pages/v5.x/MultiStats.md create mode 100644 pages/v5.x/NAMESPACE.md create mode 100644 pages/v5.x/NoEmitOnErrorsPlugin.md create mode 100644 pages/v5.x/NormalModule.md create mode 100644 pages/v5.x/ObjectDeserializerContext.md create mode 100644 pages/v5.x/ObjectSerializerContext.md create mode 100644 pages/v5.x/OccurrenceChunk.md create mode 100644 pages/v5.x/OccurrenceModule.md create mode 100644 pages/v5.x/OptimizationStages.md create mode 100644 pages/v5.x/OutputFileSystem.md create mode 100644 pages/v5.x/Parser.md create mode 100644 pages/v5.x/PathData.md create mode 100644 pages/v5.x/PitchLoaderDefinitionFunction.md create mode 100644 pages/v5.x/PlatformPlugin.md create mode 100644 pages/v5.x/PrefetchPlugin.md create mode 100644 pages/v5.x/Problem.md create mode 100644 pages/v5.x/ProgressPlugin.md create mode 100644 pages/v5.x/ProvidePlugin.md create mode 100644 pages/v5.x/ProvideShared.md create mode 100644 pages/v5.x/QUERY.md create mode 100644 pages/v5.x/RESOURCE.md create mode 100644 pages/v5.x/RawLoader.md create mode 100644 pages/v5.x/RenderManifest.md create mode 100644 pages/v5.x/ResolveData.md create mode 100644 pages/v5.x/ResolveOptions.md create mode 100644 pages/v5.x/ResolvePluginInstance.md create mode 100644 pages/v5.x/Resolver.md create mode 100644 pages/v5.x/RuleSet.md create mode 100644 pages/v5.x/Runtime.md create mode 100644 pages/v5.x/Stats.md create mode 100644 pages/v5.x/Template.md create mode 100644 pages/v5.x/UsageState.md create mode 100644 pages/v5.x/WatchIgnore.md create mode 100644 pages/v5.x/Watching.md create mode 100644 pages/v5.x/Webpack.md delete mode 100644 pages/v5.x/_media/GOVERNANCE.md delete mode 100644 pages/v5.x/_media/WORKING_GROUP.md rename pages/v5.x/{webpack/namespaces/cache.md => cache/MemoryCachePlugin.md} (78%) create mode 100644 pages/v5.x/cache/index.md create mode 100644 pages/v5.x/cli/index.md create mode 100644 pages/v5.x/config/index.md create mode 100644 pages/v5.x/container/ContainerPlugin.md create mode 100644 pages/v5.x/container/ContainerReferencePlugin.md create mode 100644 pages/v5.x/container/ModuleFederationPlugin.md create mode 100644 pages/v5.x/container/index.md rename pages/v5.x/{webpack/namespaces/css.md => css/CssModulesPlugin.md} (85%) create mode 100644 pages/v5.x/css/index.md create mode 100644 pages/v5.x/debug/ProfilingPlugin.md create mode 100644 pages/v5.x/debug/index.md create mode 100644 pages/v5.x/dependencies/ConstDependency.md create mode 100644 pages/v5.x/dependencies/HarmonyImportDependency.md create mode 100644 pages/v5.x/dependencies/ModuleDependency.md create mode 100644 pages/v5.x/dependencies/NullDependency.md create mode 100644 pages/v5.x/dependencies/index.md rename pages/v5.x/{webpack/namespaces/electron.md => electron/ElectronTargetPlugin.md} (76%) create mode 100644 pages/v5.x/electron/index.md create mode 100644 pages/v5.x/esm/ModuleChunkLoadingRuntimeModule.md create mode 100644 pages/v5.x/esm/index.md rename pages/v5.x/{webpack/namespaces/experiments/namespaces/ids.md => experiments/ids/SyncModuleIdsPlugin.md} (67%) create mode 100644 pages/v5.x/experiments/ids/index.md create mode 100644 pages/v5.x/experiments/index.md create mode 100644 pages/v5.x/experiments/schemes/HttpUriPlugin.md rename pages/v5.x/{webpack/namespaces/experiments/namespaces/schemes.md => experiments/schemes/VirtualUrlPlugin.md} (54%) create mode 100644 pages/v5.x/experiments/schemes/index.md delete mode 100644 pages/v5.x/globals.md create mode 100644 pages/v5.x/ids/ChunkModuleIdRangePlugin.md create mode 100644 pages/v5.x/ids/DeterministicChunkIdsPlugin.md create mode 100644 pages/v5.x/ids/DeterministicModuleIdsPlugin.md create mode 100644 pages/v5.x/ids/HashedModuleIdsPlugin.md create mode 100644 pages/v5.x/ids/NamedChunkIdsPlugin.md create mode 100644 pages/v5.x/ids/NamedModuleIdsPlugin.md create mode 100644 pages/v5.x/ids/NaturalModuleIdsPlugin.md create mode 100644 pages/v5.x/ids/OccurrenceChunkIdsPlugin.md create mode 100644 pages/v5.x/ids/OccurrenceModuleIdsPlugin.md create mode 100644 pages/v5.x/ids/index.md create mode 100644 pages/v5.x/javascript/EnableChunkLoadingPlugin.md create mode 100644 pages/v5.x/javascript/JavascriptModulesPlugin.md rename pages/v5.x/{webpack/namespaces/javascript.md => javascript/JavascriptParser.md} (73%) create mode 100644 pages/v5.x/javascript/index.md rename pages/v5.x/{webpack/namespaces/library.md => library/AbstractLibraryPlugin.md} (75%) create mode 100644 pages/v5.x/library/EnableLibraryPlugin.md create mode 100644 pages/v5.x/library/index.md create mode 100644 pages/v5.x/node/NodeEnvironmentPlugin.md create mode 100644 pages/v5.x/node/NodeSourcePlugin.md create mode 100644 pages/v5.x/node/NodeTargetPlugin.md create mode 100644 pages/v5.x/node/NodeTemplatePlugin.md create mode 100644 pages/v5.x/node/ReadFileCompileAsyncWasmPlugin.md create mode 100644 pages/v5.x/node/ReadFileCompileWasmPlugin.md create mode 100644 pages/v5.x/node/index.md create mode 100644 pages/v5.x/optimize/AggressiveMergingPlugin.md create mode 100644 pages/v5.x/optimize/AggressiveSplittingPlugin.md create mode 100644 pages/v5.x/optimize/InnerGraph/TopLevelSymbol.md rename pages/v5.x/{webpack/namespaces/optimize/namespaces/InnerGraph.md => optimize/InnerGraph/index.md} (63%) create mode 100644 pages/v5.x/optimize/LimitChunkCountPlugin.md create mode 100644 pages/v5.x/optimize/MergeDuplicateChunksPlugin.md create mode 100644 pages/v5.x/optimize/MinChunkSizePlugin.md create mode 100644 pages/v5.x/optimize/ModuleConcatenationPlugin.md create mode 100644 pages/v5.x/optimize/RealContentHashPlugin.md create mode 100644 pages/v5.x/optimize/RuntimeChunkPlugin.md create mode 100644 pages/v5.x/optimize/SideEffectsFlagPlugin.md create mode 100644 pages/v5.x/optimize/SplitChunksPlugin.md create mode 100644 pages/v5.x/optimize/index.md rename pages/v5.x/{webpack/namespaces/prefetch.md => prefetch/ChunkPrefetchPreloadPlugin.md} (76%) create mode 100644 pages/v5.x/prefetch/index.md create mode 100644 pages/v5.x/runtime/GetChunkFilenameRuntimeModule.md create mode 100644 pages/v5.x/runtime/LoadScriptRuntimeModule.md create mode 100644 pages/v5.x/runtime/index.md create mode 100644 pages/v5.x/sharing/ConsumeSharedPlugin.md create mode 100644 pages/v5.x/sharing/ProvideSharedPlugin.md create mode 100644 pages/v5.x/sharing/SharePlugin.md create mode 100644 pages/v5.x/sharing/index.md create mode 100644 pages/v5.x/sources/CachedSource.md create mode 100644 pages/v5.x/sources/CompatSource.md create mode 100644 pages/v5.x/sources/ConcatSource.md create mode 100644 pages/v5.x/sources/OriginalSource.md create mode 100644 pages/v5.x/sources/PrefixSource.md create mode 100644 pages/v5.x/sources/RawSource.md create mode 100644 pages/v5.x/sources/ReplaceSource.md create mode 100644 pages/v5.x/sources/SizeOnlySource.md create mode 100644 pages/v5.x/sources/Source.md create mode 100644 pages/v5.x/sources/SourceMapSource.md create mode 100644 pages/v5.x/sources/index.md rename pages/v5.x/{webpack/namespaces/util/index.md => util/LazySet.md} (59%) create mode 100644 pages/v5.x/util/comparators/index.md create mode 100644 pages/v5.x/util/compileBooleanMatcher/index.md create mode 100644 pages/v5.x/util/index.md create mode 100644 pages/v5.x/util/runtime/RuntimeSpecMap.md create mode 100644 pages/v5.x/util/runtime/RuntimeSpecSet.md create mode 100644 pages/v5.x/util/runtime/index.md create mode 100644 pages/v5.x/util/serialization/MEASURE_END_OPERATION.md create mode 100644 pages/v5.x/util/serialization/MEASURE_START_OPERATION.md create mode 100644 pages/v5.x/util/serialization/index.md rename pages/v5.x/{webpack/namespaces/wasm.md => wasm/AsyncWebAssemblyModulesPlugin.md} (54%) create mode 100644 pages/v5.x/wasm/EnableWasmLoadingPlugin.md create mode 100644 pages/v5.x/wasm/index.md create mode 100644 pages/v5.x/web/CssLoadingRuntimeModule.md create mode 100644 pages/v5.x/web/FetchCompileAsyncWasmPlugin.md create mode 100644 pages/v5.x/web/FetchCompileWasmPlugin.md create mode 100644 pages/v5.x/web/JsonpChunkLoadingRuntimeModule.md create mode 100644 pages/v5.x/web/JsonpTemplatePlugin.md create mode 100644 pages/v5.x/web/index.md delete mode 100644 pages/v5.x/webpack/namespaces/ModuleFilenameHelpers.md delete mode 100644 pages/v5.x/webpack/namespaces/OptimizationStages.md delete mode 100644 pages/v5.x/webpack/namespaces/RuntimeGlobals.md delete mode 100644 pages/v5.x/webpack/namespaces/cli.md delete mode 100644 pages/v5.x/webpack/namespaces/config.md delete mode 100644 pages/v5.x/webpack/namespaces/container.md delete mode 100644 pages/v5.x/webpack/namespaces/debug.md delete mode 100644 pages/v5.x/webpack/namespaces/dependencies.md delete mode 100644 pages/v5.x/webpack/namespaces/esm.md delete mode 100644 pages/v5.x/webpack/namespaces/experiments/index.md delete mode 100644 pages/v5.x/webpack/namespaces/ids.md delete mode 100644 pages/v5.x/webpack/namespaces/node.md delete mode 100644 pages/v5.x/webpack/namespaces/optimize/index.md delete mode 100644 pages/v5.x/webpack/namespaces/runtime.md delete mode 100644 pages/v5.x/webpack/namespaces/sharing.md delete mode 100644 pages/v5.x/webpack/namespaces/sources.md delete mode 100644 pages/v5.x/webpack/namespaces/util/namespaces/comparators.md delete mode 100644 pages/v5.x/webpack/namespaces/util/namespaces/compileBooleanMatcher.md delete mode 100644 pages/v5.x/webpack/namespaces/util/namespaces/runtime.md delete mode 100644 pages/v5.x/webpack/namespaces/util/namespaces/serialization.md delete mode 100644 pages/v5.x/webpack/namespaces/web.md rename pages/v5.x/{webpack/namespaces/webworker.md => webworker/WebWorkerTemplatePlugin.md} (77%) create mode 100644 pages/v5.x/webworker/index.md create mode 100644 plugins/constants.mjs create mode 100644 plugins/shared/family.mjs create mode 100644 plugins/shared/type-visitor.mjs create mode 100644 plugins/theme/templates/index.mjs create mode 100644 plugins/theme/utils/branching.mjs create mode 100644 plugins/theme/utils/formatting.mjs create mode 100644 plugins/theme/utils/members.mjs create mode 100644 plugins/theme/utils/routing/namespaces.mjs create mode 100644 plugins/theme/utils/routing/state.mjs create mode 100644 plugins/theme/utils/types.mjs rename tsconfig.json => tsconfig.typedoc.json (100%) diff --git a/generate-md.mjs b/generate-md.mjs index b192ffa..59a0a28 100644 --- a/generate-md.mjs +++ b/generate-md.mjs @@ -1,10 +1,28 @@ import { Application } from 'typedoc'; +import { rmSync } from 'node:fs'; import webpack from './webpack/package.json' with { type: 'json' }; import { major } from 'semver'; +const out = `pages/v${major(webpack.version)}.x`; + const app = await Application.bootstrapWithPlugins({ - entryPoints: ['./webpack/types.d.ts'], - out: `pages/v${major(webpack.version)}.x`, + // Inputs + // `lib` gives us the runtime export surface for the root `webpack` page, + // `types.d.ts` gives us the primary declarations, and the declaration files + // fill in option/config types that are not re-exported through `types.d.ts`. + entryPoints: [ + './webpack/lib', + './webpack/types.d.ts', + './webpack/declarations/**/*.d.ts', + ], + + // Configuration + tsconfig: './tsconfig.typedoc.json', + + // Outputs + out, + modulesFileName: 'index', + readme: 'none', // Plugins plugin: [ @@ -20,14 +38,11 @@ const app = await Application.bootstrapWithPlugins({ hideBreadcrumbs: true, hidePageHeader: true, disableSources: true, - propertiesFormat: 'table', - - entryFileName: 'index', - tsconfig: 'tsconfig.json', }); const project = await app.convert(); if (project) { + rmSync(out, { recursive: true, force: true }); await app.generateOutputs(project); } diff --git a/package-lock.json b/package-lock.json index 2f22380..f5cb0d4 100644 --- a/package-lock.json +++ b/package-lock.json @@ -2560,18 +2560,6 @@ "hast-util-to-html": "^9.0.5" } }, - "node_modules/@shikijs/engine-javascript": { - "version": "3.23.0", - "resolved": "https://registry.npmjs.org/@shikijs/engine-javascript/-/engine-javascript-3.23.0.tgz", - "integrity": "sha512-aHt9eiGFobmWR5uqJUViySI1bHMqrAgamWE1TYSUoftkAeCCAiGawPMwM+VCadylQtF4V3VNOZ5LmfItH5f3yA==", - "extraneous": true, - "license": "MIT", - "dependencies": { - "@shikijs/types": "3.23.0", - "@shikijs/vscode-textmate": "^10.0.2", - "oniguruma-to-es": "^4.3.4" - } - }, "node_modules/@shikijs/engine-oniguruma": { "version": "3.23.0", "resolved": "https://registry.npmjs.org/@shikijs/engine-oniguruma/-/engine-oniguruma-3.23.0.tgz", diff --git a/pages/v5.x/AggressiveSplitting.md b/pages/v5.x/AggressiveSplitting.md new file mode 100644 index 0000000..b38d7e8 --- /dev/null +++ b/pages/v5.x/AggressiveSplitting.md @@ -0,0 +1,77 @@ +# AggressiveSplitting + + + +## `AggressiveSplittingPluginOptions` + +### Properties + +#### `chunkOverhead` + +* Type: {number} Optional. + +Extra cost for each chunk (Default: 9.8kiB). + +*** + +#### `entryChunkMultiplicator` + +* Type: {number} Optional. + +Extra cost multiplicator for entry chunks (Default: 10). + +*** + +#### `maxSize` + +* Type: {number} Optional. + +Byte, max size of per file (Default: 50kiB). + +*** + +#### `minSize` + +* Type: {number} Optional. + +Byte, split point. (Default: 30kiB). + +## Class: `AggressiveSplittingPlugin` + +### Constructors + +#### `new AggressiveSplittingPlugin([options])` + +##### Parameters + +* `options` {AggressiveSplittingPluginOptions} + +* Returns: {AggressiveSplittingPlugin} + +### Properties + +#### `options` + +* Type: {AggressiveSplittingPluginOptions} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} + +Apply the plugin + +*** + +#### Static method: `wasChunkRecorded(chunk)` + +##### Parameters + +* `chunk` {Chunk} + +* Returns: {boolean} diff --git a/pages/v5.x/Argument.md b/pages/v5.x/Argument.md new file mode 100644 index 0000000..a034eb5 --- /dev/null +++ b/pages/v5.x/Argument.md @@ -0,0 +1,29 @@ +# Argument + + + +## `Argument` + +### Properties + +#### `configs` + +* Type: {ArgumentConfig[]} + +*** + +#### `description` + +* Type: {string} Optional. + +*** + +#### `multiple` + +* Type: {boolean} + +*** + +#### `simpleType` + +* Type: {SimpleType} diff --git a/pages/v5.x/Asset.md b/pages/v5.x/Asset.md new file mode 100644 index 0000000..7145072 --- /dev/null +++ b/pages/v5.x/Asset.md @@ -0,0 +1,57 @@ +# Asset + + + +## `Asset` + +### Properties + +#### `info` + +* Type: {AssetInfo} + +info about the asset + +*** + +#### `name` + +* Type: {string} + +the filename of the asset + +*** + +#### `source` + +* Type: {Source} + +source of the asset + +## `AssetInfo` + +* Type: {KnownAssetInfo & Record} + +## `AssetEmittedInfo` + +### Properties + +#### `compilation` + +* Type: {Compilation} + +#### `content` + +* Type: {Buffer} + +#### `outputPath` + +* Type: {string} + +#### `source` + +* Type: {Source} + +#### `targetPath` + +* Type: {string} diff --git a/pages/v5.x/AsyncDependenciesBlock.md b/pages/v5.x/AsyncDependenciesBlock.md new file mode 100644 index 0000000..1b72dda --- /dev/null +++ b/pages/v5.x/AsyncDependenciesBlock.md @@ -0,0 +1,163 @@ +# AsyncDependenciesBlock + + + +## Class: `AsyncDependenciesBlock` + +* Extends: {DependenciesBlock} + +### Constructors + +#### `new AsyncDependenciesBlock(groupOptions[, loc][, request])` + +##### Parameters + +* `groupOptions` {string|GroupOptionsAsyncDependenciesBlock} +* `loc` {SyntheticDependencyLocation|RealDependencyLocation} +* `request` {string} + +* Returns: {AsyncDependenciesBlock} + +### Properties + +#### `blocks` + +* Type: {AsyncDependenciesBlock[]} + +##### Inherited from + +`DependenciesBlock.blocks` + +*** + +#### `chunkName` + +* Type: {string} Optional. + +*** + +#### `circular` + +* Type: {boolean} + +*** + +#### `dependencies` + +* Type: {Dependency[]} + +##### Inherited from + +`DependenciesBlock.dependencies` + +*** + +#### `groupOptions` + +* Type: {GroupOptionsAsyncDependenciesBlock} + +*** + +#### `loc` + +* Type: {SyntheticDependencyLocation|RealDependencyLocation} Optional. + +*** + +#### `module` + +* Type: {any} + +*** + +#### `parent` + +* Type: {DependenciesBlock} Optional. + +##### Inherited from + +`DependenciesBlock.parent` + +*** + +#### `request` + +* Type: {string} Optional. + +### Methods + +#### `addBlock(block)` + +##### Parameters + +* `block` {AsyncDependenciesBlock} + +* Returns: {void} + +Adds a DependencyBlock to DependencyBlock relationship. +This is used for when a Module has a AsyncDependencyBlock tie (for code-splitting) + +*** + +#### `addDependency(dependency)` + +##### Parameters + +* `dependency` {Dependency} + +* Returns: {void} + +*** + +#### `clearDependenciesAndBlocks()` + +* Returns: {void} + +Removes all dependencies and blocks + +*** + +#### `deserialize(__namedParameters)` + +##### Parameters + +* `__namedParameters` {ObjectDeserializerContext} + +* Returns: {void} + +*** + +#### `getRootBlock()` + +* Returns: {DependenciesBlock} + +*** + +#### `removeDependency(dependency)` + +##### Parameters + +* `dependency` {Dependency} + +* Returns: {void} + +*** + +#### `serialize(__namedParameters)` + +##### Parameters + +* `__namedParameters` {ObjectSerializerContext} + +* Returns: {void} + +*** + +#### `updateHash(hash, context)` + +##### Parameters + +* `hash` {Hash} +* `context` {UpdateHashContextDependency} + +* Returns: {void} diff --git a/pages/v5.x/AutomaticPrefetchPlugin.md b/pages/v5.x/AutomaticPrefetchPlugin.md new file mode 100644 index 0000000..2daef01 --- /dev/null +++ b/pages/v5.x/AutomaticPrefetchPlugin.md @@ -0,0 +1,23 @@ +# AutomaticPrefetchPlugin + + + +## Class: `AutomaticPrefetchPlugin` + +### Constructors + +#### `new AutomaticPrefetchPlugin()` + +* Returns: {AutomaticPrefetchPlugin} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} + +Apply the plugin diff --git a/pages/v5.x/BannerPlugin.md b/pages/v5.x/BannerPlugin.md new file mode 100644 index 0000000..3f01ab3 --- /dev/null +++ b/pages/v5.x/BannerPlugin.md @@ -0,0 +1,104 @@ +# BannerPlugin + + + +## Class: `BannerPlugin` + +### Constructors + +#### `new BannerPlugin(options)` + +##### Parameters + +* `options` {BannerPluginArgument} + +* Returns: {BannerPlugin} + +### Properties + +#### `banner` + +* Type: {Function} + +##### Parameters + +* `data` {object} + * `chunk` {Chunk} + * `filename` {string} + * `hash` {string} + +* Returns: {string} + +*** + +#### `options` + +* Type: {BannerPluginOptions} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} + +Apply the plugin + +## `BannerPluginOptions` + +### Properties + +#### `banner` + +* Type: {string|BannerFunction} + +Specifies the banner. + +#### `entryOnly` + +* Type: {boolean} Optional. + +If true, the banner will only be added to the entry chunks. + +#### `exclude` + +* Type: {Rules} Optional. + +Exclude all modules matching any of these conditions. + +#### `footer` + +* Type: {boolean} Optional. + +If true, banner will be placed at the end of the output. + +#### `include` + +* Type: {Rules} Optional. + +Include all modules matching any of these conditions. + +#### `raw` + +* Type: {boolean} Optional. + +If true, banner will not be wrapped in a comment. + +#### `stage` + +* Type: {number} Optional. + +Specifies the stage when add a banner. + +#### `test` + +* Type: {Rules} Optional. + +Include all modules that pass test assertion. + +## `BannerPluginArgument` + +* Type: {string|BannerPluginOptions|BannerFunction} diff --git a/pages/v5.x/Cache.md b/pages/v5.x/Cache.md new file mode 100644 index 0000000..a5894ee --- /dev/null +++ b/pages/v5.x/Cache.md @@ -0,0 +1,112 @@ +# Cache + + + +## Class: `Cache` + +### Constructors + +#### `new Cache()` + +* Returns: {CacheClass} + +### Properties + +#### `hooks` + +* Type: {object} + +* `beginIdle` {SyncHook<[]>} +* `endIdle` {AsyncParallelHook<[]>} +* `get` {AsyncSeriesBailHook<[string, Etag, GotHandler[]], any>} +* `shutdown` {AsyncParallelHook<[]>} +* `store` {AsyncParallelHook<[string, Etag, any]>} +* `storeBuildDependencies` {AsyncParallelHook<[Iterable]>} + +*** + +#### `STAGE_DEFAULT` + +* Type: {number} + +*** + +#### `STAGE_DISK` + +* Type: {number} + +*** + +#### `STAGE_MEMORY` + +* Type: {number} + +*** + +#### `STAGE_NETWORK` + +* Type: {number} + +### Methods + +#### `beginIdle()` + +* Returns: {void} + +*** + +#### `endIdle(callback)` + +##### Parameters + +* `callback` {CallbackCacheCache} + +* Returns: {void} + +*** + +#### `get(identifier, etag, callback)` + +##### Parameters + +* `identifier` {string} +* `etag` {Etag} +* `callback` {CallbackCacheCache} + +* Returns: {void} + +*** + +#### `shutdown(callback)` + +##### Parameters + +* `callback` {CallbackCacheCache} + +* Returns: {void} + +*** + +#### `store(identifier, etag, data, callback)` + +##### Parameters + +* `identifier` {string} +* `etag` {Etag} +* `data` {T} +* `callback` {CallbackCacheCache} + +* Returns: {void} + +*** + +#### `storeBuildDependencies(dependencies, callback)` + +##### Parameters + +* `dependencies` {Iterable} +* `callback` {CallbackCacheCache} + +* Returns: {void} + +After this method has succeeded the cache can only be restored when build dependencies are diff --git a/pages/v5.x/Chunk.md b/pages/v5.x/Chunk.md new file mode 100644 index 0000000..9316290 --- /dev/null +++ b/pages/v5.x/Chunk.md @@ -0,0 +1,1663 @@ +# Chunk + + + +## Class: `Chunk` + +### Constructors + +#### `new Chunk([name][, backCompat])` + +##### Parameters + +* `name` {string} +* `backCompat` {boolean} + +* Returns: {Chunk} + +### Properties + +#### `auxiliaryFiles` + +* Type: {Set} + +*** + +#### `chunkReason` + +* Type: {string} Optional. + +*** + +#### `contentHash` + +* Type: {Record} + +*** + +#### `cssFilenameTemplate` + +* Type: {string|Function} Optional. + +*** + +#### `debugId` + +* Type: {number} + +*** + +#### `entryModule` + +* Type: {Module} + +##### Deprecated + +*** + +#### `extraAsync` + +* Type: {boolean} + +*** + +#### `filenameTemplate` + +* Type: {string|Function} Optional. + +*** + +#### `files` + +* Type: {Set} + +*** + +#### `groupsIterable` + +* Type: {SortableSet} + +*** + +#### `hash` + +* Type: {string} Optional. + +*** + +#### `id` + +* Type: {string|number} + +*** + +#### `idNameHints` + +* Type: {SortableSet} + +*** + +#### `ids` + +* Type: {ChunkId[]} + +*** + +#### `modulesIterable` + +* Type: {Iterable} + +*** + +#### `name` + +* Type: {string} Optional. + +*** + +#### `preventIntegration` + +* Type: {boolean} + +*** + +#### `rendered` + +* Type: {boolean} + +*** + +#### `renderedHash` + +* Type: {string} Optional. + +*** + +#### `runtime` + +* Type: {RuntimeSpec} + +### Methods + +#### `addGroup(chunkGroup)` + +##### Parameters + +* `chunkGroup` {ChunkGroup} + +* Returns: {void} + +*** + +#### `addModule(module)` + +##### Parameters + +* `module` {Module} + +* Returns: {boolean} + +*** + +#### `canBeInitial()` + +* Returns: {boolean} + +*** + +#### `canBeIntegrated(otherChunk)` + +##### Parameters + +* `otherChunk` {Chunk} + +* Returns: {boolean} + +*** + +#### `compareTo(otherChunk)` + +##### Parameters + +* `otherChunk` {Chunk} + +* Returns: {-1|0|1} + +*** + +#### `containsModule(module)` + +##### Parameters + +* `module` {Module} + +* Returns: {boolean} + +*** + +#### `disconnectFromGroups()` + +* Returns: {void} + +*** + +#### `getAllAsyncChunks()` + +* Returns: {Set} + +*** + +#### `getAllInitialChunks()` + +* Returns: {Set} + +*** + +#### `getAllReferencedAsyncEntrypoints()` + +* Returns: {Set} + +*** + +#### `getAllReferencedChunks()` + +* Returns: {Set} + +*** + +#### `getChildIdsByOrders(chunkGraph[, filterFn])` + +##### Parameters + +* `chunkGraph` {ChunkGraph} +* `filterFn` {Function} + * `c` {Chunk} + * `chunkGraph` {ChunkGraph} + * Returns: {boolean} + +* Returns: {Record} + +*** + +#### `getChildIdsByOrdersMap(chunkGraph[, includeDirectChildren][, filterFn])` + +##### Parameters + +* `chunkGraph` {ChunkGraph} +* `includeDirectChildren` {boolean} +* `filterFn` {Function} + * `c` {Chunk} + * `chunkGraph` {ChunkGraph} + * Returns: {boolean} + +* Returns: {ChunkChildIdsByOrdersMapByData} + +*** + +#### `getChildrenOfTypeInOrder(chunkGraph, type)` + +##### Parameters + +* `chunkGraph` {ChunkGraph} +* `type` {string} + +* Returns: {ChunkChildOfTypeInOrder[]} + +*** + +#### `getChunkMaps(realHash)` + +> Stability: 0 - Deprecated + +##### Parameters + +* `realHash` {boolean} + +* Returns: {ChunkMaps} + +*** + +#### `getChunkModuleMaps(filterFn)` + +##### Parameters + +* `filterFn` {Function} + * `m` {Module} + * Returns: {boolean} + +* Returns: {ChunkModuleMaps} + +*** + +#### `getEntryOptions()` + +* Returns: {EntryOptions} + +*** + +#### `getModules()` + +* Returns: {Module[]} + +*** + +#### `getNumberOfGroups()` + +* Returns: {number} + +*** + +#### `getNumberOfModules()` + +* Returns: {number} + +*** + +#### `hasAsyncChunks()` + +* Returns: {boolean} + +*** + +#### `hasChildByOrder(chunkGraph, type[, includeDirectChildren][, filterFn])` + +##### Parameters + +* `chunkGraph` {ChunkGraph} +* `type` {string} +* `includeDirectChildren` {boolean} +* `filterFn` {Function} + * `c` {Chunk} + * `chunkGraph` {ChunkGraph} + * Returns: {boolean} + +* Returns: {boolean} + +*** + +#### `hasEntryModule()` + +* Returns: {boolean} + +*** + +#### `hasModuleInGraph(filterFn[, filterChunkFn])` + +##### Parameters + +* `filterFn` {Function} + * `m` {Module} + * Returns: {boolean} +* `filterChunkFn` {Function} + * `c` {Chunk} + * `chunkGraph` {ChunkGraph} + * Returns: {boolean} + +* Returns: {boolean} + +*** + +#### `hasRuntime()` + +* Returns: {boolean} + +*** + +#### `integrate(otherChunk)` + +##### Parameters + +* `otherChunk` {Chunk} + +* Returns: {boolean} + +*** + +#### `integratedSize(otherChunk, options)` + +##### Parameters + +* `otherChunk` {Chunk} +* `options` {ChunkSizeOptions} + +* Returns: {number} + +*** + +#### `isEmpty()` + +* Returns: {boolean} + +*** + +#### `isInGroup(chunkGroup)` + +##### Parameters + +* `chunkGroup` {ChunkGroup} + +* Returns: {boolean} + +*** + +#### `isOnlyInitial()` + +* Returns: {boolean} + +*** + +#### `modulesSize()` + +* Returns: {number} + +*** + +#### `moveModule(module, otherChunk)` + +##### Parameters + +* `module` {Module} +* `otherChunk` {Chunk} + +* Returns: {void} + +*** + +#### `remove()` + +* Returns: {void} + +*** + +#### `removeGroup(chunkGroup)` + +##### Parameters + +* `chunkGroup` {ChunkGroup} + +* Returns: {void} + +*** + +#### `removeModule(module)` + +##### Parameters + +* `module` {Module} + +* Returns: {void} + +*** + +#### `size([options])` + +##### Parameters + +* `options` {ChunkSizeOptions} + +* Returns: {number} + +*** + +#### `split(newChunk)` + +##### Parameters + +* `newChunk` {Chunk} + +* Returns: {void} + +*** + +#### `updateHash(hash, chunkGraph)` + +##### Parameters + +* `hash` {Hash} +* `chunkGraph` {ChunkGraph} + +* Returns: {void} + +## Class: `ChunkGraph` + +### Constructors + +#### `new ChunkGraph(moduleGraph[, hashFunction])` + +##### Parameters + +* `moduleGraph` {ModuleGraph} +* `hashFunction` {HashFunction} + +* Returns: {ChunkGraph} + +### Properties + +#### `moduleGraph` + +* Type: {ModuleGraph} + +### Methods + +#### `addChunkRuntimeRequirements(chunk, items)` + +##### Parameters + +* `chunk` {Chunk} +* `items` {Set} + +* Returns: {void} + +#### `addDependentHashModuleToChunk(chunk, module)` + +##### Parameters + +* `chunk` {Chunk} +* `module` {RuntimeModule} + +* Returns: {void} + +#### `addFullHashModuleToChunk(chunk, module)` + +##### Parameters + +* `chunk` {Chunk} +* `module` {RuntimeModule} + +* Returns: {void} + +#### `addModuleRuntimeRequirements(module, runtime, items[, transferOwnership])` + +##### Parameters + +* `module` {Module} +* `runtime` {RuntimeSpec} +* `items` {Set} +* `transferOwnership` {boolean} + +* Returns: {void} + +#### `addTreeRuntimeRequirements(chunk, items)` + +##### Parameters + +* `chunk` {Chunk} +* `items` {Iterable} + +* Returns: {void} + +#### `attachDependentHashModules(chunk, modules)` + +##### Parameters + +* `chunk` {Chunk} +* `modules` {Iterable} + +* Returns: {void} + +#### `attachFullHashModules(chunk, modules)` + +##### Parameters + +* `chunk` {Chunk} +* `modules` {Iterable} + +* Returns: {void} + +#### `attachModules(chunk, modules)` + +##### Parameters + +* `chunk` {Chunk} +* `modules` {Iterable} + +* Returns: {void} + +#### `attachRuntimeModules(chunk, modules)` + +##### Parameters + +* `chunk` {Chunk} +* `modules` {Iterable} + +* Returns: {void} + +#### `canChunksBeIntegrated(chunkA, chunkB)` + +##### Parameters + +* `chunkA` {Chunk} +* `chunkB` {Chunk} + +* Returns: {boolean} + +#### `compareChunks(chunkA, chunkB)` + +##### Parameters + +* `chunkA` {Chunk} +* `chunkB` {Chunk} + +* Returns: {-1|0|1} + +#### `connectBlockAndChunkGroup(depBlock, chunkGroup)` + +##### Parameters + +* `depBlock` {AsyncDependenciesBlock} +* `chunkGroup` {ChunkGroup} + +* Returns: {void} + +#### `connectChunkAndEntryModule(chunk, module, entrypoint)` + +##### Parameters + +* `chunk` {Chunk} +* `module` {Module} +* `entrypoint` {Entrypoint} + +* Returns: {void} + +#### `connectChunkAndModule(chunk, module)` + +##### Parameters + +* `chunk` {Chunk} +* `module` {Module} + +* Returns: {void} + +#### `connectChunkAndRuntimeModule(chunk, module)` + +##### Parameters + +* `chunk` {Chunk} +* `module` {RuntimeModule} + +* Returns: {void} + +#### `disconnectChunk(chunk)` + +##### Parameters + +* `chunk` {Chunk} + +* Returns: {void} + +#### `disconnectChunkAndEntryModule(chunk, module)` + +##### Parameters + +* `chunk` {Chunk} +* `module` {Module} + +* Returns: {void} + +#### `disconnectChunkAndModule(chunk, module)` + +##### Parameters + +* `chunk` {Chunk} +* `module` {Module} + +* Returns: {void} + +#### `disconnectChunkAndRuntimeModule(chunk, module)` + +##### Parameters + +* `chunk` {Chunk} +* `module` {RuntimeModule} + +* Returns: {void} + +#### `disconnectChunkGroup(chunkGroup)` + +##### Parameters + +* `chunkGroup` {ChunkGroup} + +* Returns: {void} + +#### `disconnectEntries(chunk)` + +##### Parameters + +* `chunk` {Chunk} + +* Returns: {void} + +#### `disconnectEntryModule(module)` + +##### Parameters + +* `module` {Module} + +* Returns: {void} + +#### `getBlockChunkGroup(depBlock)` + +##### Parameters + +* `depBlock` {AsyncDependenciesBlock} + +* Returns: {ChunkGroup} + +#### `getChunkConditionMap(chunk, filterFn)` + +##### Parameters + +* `chunk` {Chunk} +* `filterFn` {Function} + * `c` {Chunk} + * `chunkGraph` {ChunkGraph} + * Returns: {boolean} + +* Returns: {ChunkConditionMap} + +#### `getChunkDependentHashModulesIterable(chunk)` + +##### Parameters + +* `chunk` {Chunk} + +* Returns: {Iterable} + +#### `getChunkEntryDependentChunksIterable(chunk)` + +##### Parameters + +* `chunk` {Chunk} + +* Returns: {Iterable} + +#### `getChunkEntryModulesIterable(chunk)` + +##### Parameters + +* `chunk` {Chunk} + +* Returns: {Iterable} + +#### `getChunkEntryModulesWithChunkGroupIterable(chunk)` + +##### Parameters + +* `chunk` {Chunk} + +* Returns: {Iterable<[Module, Entrypoint]>} + +#### `getChunkFullHashModulesIterable(chunk)` + +##### Parameters + +* `chunk` {Chunk} + +* Returns: {Iterable} + +#### `getChunkFullHashModulesSet(chunk)` + +##### Parameters + +* `chunk` {Chunk} + +* Returns: {ReadonlySet} + +#### `getChunkModuleIdMap(chunk, filterFn[, includeAllChunks])` + +##### Parameters + +* `chunk` {Chunk} +* `filterFn` {Function} + * `m` {Module} + * Returns: {boolean} +* `includeAllChunks` {boolean} + +* Returns: {ChunkModuleIdMapEs5Alias_2} + +#### `getChunkModuleRenderedHashMap(chunk, filterFn[, hashLength][, includeAllChunks])` + +##### Parameters + +* `chunk` {Chunk} +* `filterFn` {Function} + * `m` {Module} + * Returns: {boolean} +* `hashLength` {number} +* `includeAllChunks` {boolean} + +* Returns: {ChunkModuleHashMap} + +#### `getChunkModules(chunk)` + +##### Parameters + +* `chunk` {Chunk} + +* Returns: {Module[]} + +#### `getChunkModulesIterable(chunk)` + +##### Parameters + +* `chunk` {Chunk} + +* Returns: {Iterable} + +#### `getChunkModulesIterableBySourceType(chunk, sourceType)` + +##### Parameters + +* `chunk` {Chunk} +* `sourceType` {string} + +* Returns: {Iterable} + +#### `getChunkModuleSourceTypes(chunk, module)` + +##### Parameters + +* `chunk` {Chunk} +* `module` {Module} + +* Returns: {ReadonlySet} + +#### `getChunkModulesSize(chunk)` + +##### Parameters + +* `chunk` {Chunk} + +* Returns: {number} + +#### `getChunkModulesSizes(chunk)` + +##### Parameters + +* `chunk` {Chunk} + +* Returns: {Record} + +#### `getChunkRootModules(chunk)` + +##### Parameters + +* `chunk` {Chunk} + +* Returns: {Module[]} + +#### `getChunkRuntimeModulesInOrder(chunk)` + +##### Parameters + +* `chunk` {Chunk} + +* Returns: {RuntimeModule[]} + +#### `getChunkRuntimeModulesIterable(chunk)` + +##### Parameters + +* `chunk` {Chunk} + +* Returns: {Iterable} + +#### `getChunkRuntimeRequirements(chunk)` + +##### Parameters + +* `chunk` {Chunk} + +* Returns: {ReadonlySet} + +#### `getChunkSize(chunk[, options])` + +##### Parameters + +* `chunk` {Chunk} +* `options` {ChunkSizeOptions} + +* Returns: {number} + +#### `getIntegratedChunksSize(chunkA, chunkB[, options])` + +##### Parameters + +* `chunkA` {Chunk} +* `chunkB` {Chunk} +* `options` {ChunkSizeOptions} + +* Returns: {number} + +#### `getModuleChunks(module)` + +##### Parameters + +* `module` {Module} + +* Returns: {Chunk[]} + +#### `getModuleChunksIterable(module)` + +##### Parameters + +* `module` {Module} + +* Returns: {Iterable} + +#### `getModuleGraphHash(module, runtime[, withConnections])` + +##### Parameters + +* `module` {Module} +* `runtime` {RuntimeSpec} +* `withConnections` {boolean} + +* Returns: {string} + +#### `getModuleGraphHashBigInt(module, runtime[, withConnections])` + +##### Parameters + +* `module` {Module} +* `runtime` {RuntimeSpec} +* `withConnections` {boolean} + +* Returns: {bigint} + +#### `getModuleHash(module, runtime)` + +##### Parameters + +* `module` {Module} +* `runtime` {RuntimeSpec} + +* Returns: {string} + +#### `getModuleId(module)` + +##### Parameters + +* `module` {Module} + +* Returns: {string|number} + +#### `getModuleRuntimeRequirements(module, runtime)` + +##### Parameters + +* `module` {Module} +* `runtime` {RuntimeSpec} + +* Returns: {ReadonlySet} + +#### `getModuleRuntimes(module)` + +##### Parameters + +* `module` {Module} + +* Returns: {RuntimeSpecSet} + +#### `getModuleSourceTypes(module)` + +##### Parameters + +* `module` {Module} + +* Returns: {ReadonlySet} + +#### `getNumberOfChunkFullHashModules(chunk)` + +##### Parameters + +* `chunk` {Chunk} + +* Returns: {number} + +#### `getNumberOfChunkModules(chunk)` + +##### Parameters + +* `chunk` {Chunk} + +* Returns: {number} + +#### `getNumberOfEntryModules(chunk)` + +##### Parameters + +* `chunk` {Chunk} + +* Returns: {number} + +#### `getNumberOfModuleChunks(module)` + +##### Parameters + +* `module` {Module} + +* Returns: {number} + +#### `getNumberOfRuntimeModules(chunk)` + +##### Parameters + +* `chunk` {Chunk} + +* Returns: {number} + +#### `getOrderedChunkModules(chunk, comparator)` + +##### Parameters + +* `chunk` {Chunk} +* `comparator` {Function} + * `a` {Module} + * `b` {Module} + * Returns: {-1|0|1} + +* Returns: {Module[]} + +#### `getOrderedChunkModulesIterable(chunk, comparator)` + +##### Parameters + +* `chunk` {Chunk} +* `comparator` {Function} + * `a` {Module} + * `b` {Module} + * Returns: {-1|0|1} + +* Returns: {Iterable} + +#### `getOrderedChunkModulesIterableBySourceType(chunk, sourceType, comparator)` + +##### Parameters + +* `chunk` {Chunk} +* `sourceType` {string} +* `comparator` {Function} + * `a` {Module} + * `b` {Module} + * Returns: {-1|0|1} + +* Returns: {Iterable} + +#### `getOrderedModuleChunksIterable(module, sortFn)` + +##### Parameters + +* `module` {Module} +* `sortFn` {Function} + * `a` {Chunk} + * `b` {Chunk} + * Returns: {-1|0|1} + +* Returns: {Iterable} + +#### `getRenderedModuleHash(module, runtime)` + +##### Parameters + +* `module` {Module} +* `runtime` {RuntimeSpec} + +* Returns: {string} + +#### `getRuntimeChunkDependentChunksIterable(chunk)` + +##### Parameters + +* `chunk` {Chunk} + +* Returns: {Iterable} + +#### `getRuntimeId(runtime)` + +##### Parameters + +* `runtime` {string} + +* Returns: {RuntimeId} + +#### `getTreeRuntimeRequirements(chunk)` + +##### Parameters + +* `chunk` {Chunk} + +* Returns: {ReadonlySet} + +#### `hasChunkEntryDependentChunks(chunk)` + +##### Parameters + +* `chunk` {Chunk} + +* Returns: {boolean} + +#### `hasModuleHashes(module, runtime)` + +##### Parameters + +* `module` {Module} +* `runtime` {RuntimeSpec} + +* Returns: {boolean} + +#### `hasModuleInGraph(chunk, filterFn[, filterChunkFn])` + +##### Parameters + +* `chunk` {Chunk} +* `filterFn` {Function} + * `m` {Module} + * Returns: {boolean} +* `filterChunkFn` {Function} + * `c` {Chunk} + * `chunkGraph` {ChunkGraph} + * Returns: {boolean} + +* Returns: {boolean} + +#### `integrateChunks(chunkA, chunkB)` + +##### Parameters + +* `chunkA` {Chunk} +* `chunkB` {Chunk} + +* Returns: {void} + +#### `isEntryModule(module)` + +##### Parameters + +* `module` {Module} + +* Returns: {boolean} + +#### `isEntryModuleInChunk(module, chunk)` + +##### Parameters + +* `module` {Module} +* `chunk` {Chunk} + +* Returns: {boolean} + +#### `isModuleInChunk(module, chunk)` + +##### Parameters + +* `module` {Module} +* `chunk` {Chunk} + +* Returns: {boolean} + +#### `isModuleInChunkGroup(module, chunkGroup)` + +##### Parameters + +* `module` {Module} +* `chunkGroup` {ChunkGroup} + +* Returns: {boolean} + +#### `replaceModule(oldModule, newModule)` + +##### Parameters + +* `oldModule` {Module} +* `newModule` {Module} + +* Returns: {void} + +#### `setChunkModuleSourceTypes(chunk, module, sourceTypes)` + +##### Parameters + +* `chunk` {Chunk} +* `module` {Module} +* `sourceTypes` {ReadonlySet} + +* Returns: {void} + +#### `setModuleHashes(module, runtime, hash, renderedHash)` + +##### Parameters + +* `module` {Module} +* `runtime` {RuntimeSpec} +* `hash` {string} +* `renderedHash` {string} + +* Returns: {void} + +#### `setModuleId(module, id)` + +##### Parameters + +* `module` {Module} +* `id` {ModuleId} + +* Returns: {void} + +#### `setRuntimeId(runtime, id)` + +##### Parameters + +* `runtime` {string} +* `id` {RuntimeId} + +* Returns: {void} + +#### `upgradeDependentToFullHashModules(chunk)` + +##### Parameters + +* `chunk` {Chunk} + +* Returns: {void} + +#### Static method: `clearChunkGraphForChunk(chunk)` + +> Stability: 0 - Deprecated + +##### Parameters + +* `chunk` {Chunk} + +* Returns: {void} + +#### Static method: `clearChunkGraphForModule(module)` + +> Stability: 0 - Deprecated + +##### Parameters + +* `module` {Module} + +* Returns: {void} + +#### Static method: `getChunkGraphForChunk(chunk, deprecateMessage, deprecationCode)` + +> Stability: 0 - Deprecated + +##### Parameters + +* `chunk` {Chunk} +* `deprecateMessage` {string} +* `deprecationCode` {string} + +* Returns: {ChunkGraph} + +#### Static method: `getChunkGraphForModule(module, deprecateMessage, deprecationCode)` + +> Stability: 0 - Deprecated + +##### Parameters + +* `module` {Module} +* `deprecateMessage` {string} +* `deprecationCode` {string} + +* Returns: {ChunkGraph} + +#### Static method: `setChunkGraphForChunk(chunk, chunkGraph)` + +> Stability: 0 - Deprecated + +##### Parameters + +* `chunk` {Chunk} +* `chunkGraph` {ChunkGraph} + +* Returns: {void} + +#### Static method: `setChunkGraphForModule(module, chunkGraph)` + +> Stability: 0 - Deprecated + +##### Parameters + +* `module` {Module} +* `chunkGraph` {ChunkGraph} + +* Returns: {void} + +## Class: `ChunkGroup` + +### Constructors + +#### `new ChunkGroup()` + +* Returns: {ChunkGroup} + +### Properties + +#### `asyncEntrypointsIterable` + +* Type: {SortableSet} + +#### `blocksIterable` + +* Type: {Iterable} + +#### `childrenIterable` + +* Type: {SortableSet} + +#### `chunks` + +* Type: {Chunk[]} + +#### `debugId` + +* Type: {string} + +get a uniqueId for ChunkGroup, made up of its member Chunk debugId's + +#### `getModuleIndex` + +* Type: {Function} + +##### Parameters + +* `module` {Module} + +* Returns: {number} + +#### `getModuleIndex2` + +* Type: {Function} + +##### Parameters + +* `module` {Module} + +* Returns: {number} + +#### `groupDebugId` + +* Type: {number} + +#### `id` + +* Type: {string} + +get a unique id for ChunkGroup, made up of its member Chunk id's + +#### `index` + +* Type: {number} Optional. + +#### `name` + +* Type: {string} Optional. + +returns the name of current ChunkGroup +sets a new name for current ChunkGroup + +#### `options` + +* Type: {ChunkGroupOptions} + +#### `origins` + +* Type: {OriginRecord[]} + +#### `parentsIterable` + +* Type: {SortableSet} + +### Methods + +#### `addAsyncEntrypoint(entrypoint)` + +##### Parameters + +* `entrypoint` {Entrypoint} + +* Returns: {boolean} + +#### `addBlock(block)` + +##### Parameters + +* `block` {AsyncDependenciesBlock} + +* Returns: {boolean} + +#### `addChild(group)` + +##### Parameters + +* `group` {ChunkGroup} + +* Returns: {boolean} + +#### `addOptions(options)` + +##### Parameters + +* `options` {ChunkGroupOptions} + +* Returns: {void} + +when a new chunk is added to a chunkGroup, addingOptions will occur. + +#### `addOrigin(module, loc, request)` + +##### Parameters + +* `module` {Module} +* `loc` {DependencyLocation} +* `request` {string} + +* Returns: {void} + +#### `addParent(parentChunk)` + +##### Parameters + +* `parentChunk` {ChunkGroup} + +* Returns: {boolean} + +#### `checkConstraints()` + +* Returns: {void} + +#### `compareTo(chunkGraph, otherGroup)` + +##### Parameters + +* `chunkGraph` {ChunkGraph} +* `otherGroup` {ChunkGroup} + +* Returns: {-1|0|1} + +Sorting predicate which allows current ChunkGroup to be compared against another. +Sorting values are based off of number of chunks in ChunkGroup. + +#### `getBlocks()` + +* Returns: {AsyncDependenciesBlock[]} + +#### `getChildren()` + +* Returns: {ChunkGroup[]} + +#### `getChildrenByOrders(moduleGraph, chunkGraph)` + +##### Parameters + +* `moduleGraph` {ModuleGraph} +* `chunkGraph` {ChunkGraph} + +* Returns: {Record} + +#### `getFiles()` + +* Returns: {string[]} + +#### `getModulePostOrderIndex(module)` + +##### Parameters + +* `module` {Module} + +* Returns: {number} + +Gets the bottom-up index of a module in this ChunkGroup + +#### `getModulePreOrderIndex(module)` + +##### Parameters + +* `module` {Module} + +* Returns: {number} + +Gets the top-down index of a module in this ChunkGroup + +#### `getNumberOfBlocks()` + +* Returns: {number} + +#### `getNumberOfChildren()` + +* Returns: {number} + +#### `getNumberOfParents()` + +* Returns: {number} + +#### `getParents()` + +* Returns: {ChunkGroup[]} + +#### `hasBlock(block)` + +##### Parameters + +* `block` {AsyncDependenciesBlock} + +* Returns: {boolean} + +#### `hasParent(parent)` + +##### Parameters + +* `parent` {ChunkGroup} + +* Returns: {boolean} + +#### `insertChunk(chunk, before)` + +##### Parameters + +* `chunk` {Chunk} +* `before` {Chunk} + +* Returns: {boolean} + +inserts a chunk before another existing chunk in group + +#### `isInitial()` + +* Returns: {boolean} + +#### `pushChunk(chunk)` + +##### Parameters + +* `chunk` {Chunk} + +* Returns: {boolean} + +add a chunk into ChunkGroup. Is pushed on or prepended + +#### `remove()` + +* Returns: {void} + +#### `removeChild(group)` + +##### Parameters + +* `group` {ChunkGroup} + +* Returns: {boolean} + +#### `removeChunk(chunk)` + +##### Parameters + +* `chunk` {Chunk} + +* Returns: {boolean} + +#### `removeParent(chunkGroup)` + +##### Parameters + +* `chunkGroup` {ChunkGroup} + +* Returns: {boolean} + +#### `replaceChunk(oldChunk, newChunk)` + +##### Parameters + +* `oldChunk` {Chunk} +* `newChunk` {Chunk} + +* Returns: {boolean} + +#### `setModulePostOrderIndex(module, index)` + +##### Parameters + +* `module` {Module} +* `index` {number} + +* Returns: {void} + +Sets the bottom-up index of a module in this ChunkGroup + +#### `setModulePreOrderIndex(module, index)` + +##### Parameters + +* `module` {Module} +* `index` {number} + +* Returns: {void} + +Sets the top-down index of a module in this ChunkGroup + +#### `sortItems()` + +* Returns: {void} + +#### `unshiftChunk(chunk)` + +##### Parameters + +* `chunk` {Chunk} + +* Returns: {boolean} + +Performs an unshift of a specific chunk + +## Class: `ChunkModuleIdRangePlugin` + +### Constructors + +#### `new ChunkModuleIdRangePlugin(options)` + +##### Parameters + +* `options` {ChunkModuleIdRangePluginOptions} + +* Returns: {ChunkModuleIdRangePlugin} + +### Properties + +#### `options` + +* Type: {ChunkModuleIdRangePluginOptions} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} + +Apply the plugin + +## Class: `ChunkPrefetchPreloadPlugin` + +### Constructors + +#### `new ChunkPrefetchPreloadPlugin()` + +* Returns: {ChunkPrefetchPreloadPlugin} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} diff --git a/pages/v5.x/CleanPlugin.md b/pages/v5.x/CleanPlugin.md new file mode 100644 index 0000000..c28ec9b --- /dev/null +++ b/pages/v5.x/CleanPlugin.md @@ -0,0 +1,43 @@ +# CleanPlugin + + + +## Class: `CleanPlugin` + +### Constructors + +#### `new CleanPlugin([options])` + +##### Parameters + +* `options` {CleanOptions} + +* Returns: {CleanPlugin} + +### Properties + +#### `options` + +* Type: {CleanOptions} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} + +Apply the plugin + +*** + +#### Static method: `getCompilationHooks(compilation)` + +##### Parameters + +* `compilation` {Compilation} + +* Returns: {CleanPluginCompilationHooks} diff --git a/pages/v5.x/CodeGenerationResults.md b/pages/v5.x/CodeGenerationResults.md new file mode 100644 index 0000000..1d40d53 --- /dev/null +++ b/pages/v5.x/CodeGenerationResults.md @@ -0,0 +1,97 @@ +# CodeGenerationResults + + + +## Class: `CodeGenerationResults` + +### Constructors + +#### `new CodeGenerationResults()` + +* Returns: {CodeGenerationResults} + +### Properties + +#### `map` + +* Type: {Map>} + +### Methods + +#### `add(module, runtime, result)` + +##### Parameters + +* `module` {Module} +* `runtime` {RuntimeSpec} +* `result` {CodeGenerationResult} + +* Returns: {void} + +*** + +#### `get(module, runtime)` + +##### Parameters + +* `module` {Module} +* `runtime` {RuntimeSpec} + +* Returns: {CodeGenerationResult} + +*** + +#### `getData(module, runtime, key)` + +##### Parameters + +* `module` {Module} +* `runtime` {RuntimeSpec} +* `key` {string} + +* Returns: {any} + +*** + +#### `getHash(module, runtime)` + +##### Parameters + +* `module` {Module} +* `runtime` {RuntimeSpec} + +* Returns: {string} + +*** + +#### `getRuntimeRequirements(module, runtime)` + +##### Parameters + +* `module` {Module} +* `runtime` {RuntimeSpec} + +* Returns: {ReadonlySet} + +*** + +#### `getSource(module, runtime, sourceType)` + +##### Parameters + +* `module` {Module} +* `runtime` {RuntimeSpec} +* `sourceType` {string} + +* Returns: {Source} + +*** + +#### `has(module, runtime)` + +##### Parameters + +* `module` {Module} +* `runtime` {RuntimeSpec} + +* Returns: {boolean} diff --git a/pages/v5.x/Colors.md b/pages/v5.x/Colors.md new file mode 100644 index 0000000..c8ca9c9 --- /dev/null +++ b/pages/v5.x/Colors.md @@ -0,0 +1,507 @@ +# Colors + + + +## `Colors` + +### Properties + +#### `bgBlack` + +* Type: {Function} + +##### Parameters + +* `value` {any} + +* Returns: {string} + +*** + +#### `bgBlackBright` + +* Type: {Function} + +##### Parameters + +* `value` {any} + +* Returns: {string} + +*** + +#### `bgBlue` + +* Type: {Function} + +##### Parameters + +* `value` {any} + +* Returns: {string} + +*** + +#### `bgBlueBright` + +* Type: {Function} + +##### Parameters + +* `value` {any} + +* Returns: {string} + +*** + +#### `bgCyan` + +* Type: {Function} + +##### Parameters + +* `value` {any} + +* Returns: {string} + +*** + +#### `bgCyanBright` + +* Type: {Function} + +##### Parameters + +* `value` {any} + +* Returns: {string} + +*** + +#### `bgGreen` + +* Type: {Function} + +##### Parameters + +* `value` {any} + +* Returns: {string} + +*** + +#### `bgGreenBright` + +* Type: {Function} + +##### Parameters + +* `value` {any} + +* Returns: {string} + +*** + +#### `bgMagenta` + +* Type: {Function} + +##### Parameters + +* `value` {any} + +* Returns: {string} + +*** + +#### `bgMagentaBright` + +* Type: {Function} + +##### Parameters + +* `value` {any} + +* Returns: {string} + +*** + +#### `bgRed` + +* Type: {Function} + +##### Parameters + +* `value` {any} + +* Returns: {string} + +*** + +#### `bgRedBright` + +* Type: {Function} + +##### Parameters + +* `value` {any} + +* Returns: {string} + +*** + +#### `bgWhite` + +* Type: {Function} + +##### Parameters + +* `value` {any} + +* Returns: {string} + +*** + +#### `bgWhiteBright` + +* Type: {Function} + +##### Parameters + +* `value` {any} + +* Returns: {string} + +*** + +#### `bgYellow` + +* Type: {Function} + +##### Parameters + +* `value` {any} + +* Returns: {string} + +*** + +#### `bgYellowBright` + +* Type: {Function} + +##### Parameters + +* `value` {any} + +* Returns: {string} + +*** + +#### `black` + +* Type: {Function} + +##### Parameters + +* `value` {any} + +* Returns: {string} + +*** + +#### `blackBright` + +* Type: {Function} + +##### Parameters + +* `value` {any} + +* Returns: {string} + +*** + +#### `blue` + +* Type: {Function} + +##### Parameters + +* `value` {any} + +* Returns: {string} + +*** + +#### `blueBright` + +* Type: {Function} + +##### Parameters + +* `value` {any} + +* Returns: {string} + +*** + +#### `bold` + +* Type: {Function} + +##### Parameters + +* `value` {any} + +* Returns: {string} + +*** + +#### `cyan` + +* Type: {Function} + +##### Parameters + +* `value` {any} + +* Returns: {string} + +*** + +#### `cyanBright` + +* Type: {Function} + +##### Parameters + +* `value` {any} + +* Returns: {string} + +*** + +#### `dim` + +* Type: {Function} + +##### Parameters + +* `value` {any} + +* Returns: {string} + +*** + +#### `gray` + +* Type: {Function} + +##### Parameters + +* `value` {any} + +* Returns: {string} + +*** + +#### `green` + +* Type: {Function} + +##### Parameters + +* `value` {any} + +* Returns: {string} + +*** + +#### `greenBright` + +* Type: {Function} + +##### Parameters + +* `value` {any} + +* Returns: {string} + +*** + +#### `hidden` + +* Type: {Function} + +##### Parameters + +* `value` {any} + +* Returns: {string} + +*** + +#### `inverse` + +* Type: {Function} + +##### Parameters + +* `value` {any} + +* Returns: {string} + +*** + +#### `italic` + +* Type: {Function} + +##### Parameters + +* `value` {any} + +* Returns: {string} + +*** + +#### `magenta` + +* Type: {Function} + +##### Parameters + +* `value` {any} + +* Returns: {string} + +*** + +#### `magentaBright` + +* Type: {Function} + +##### Parameters + +* `value` {any} + +* Returns: {string} + +*** + +#### `red` + +* Type: {Function} + +##### Parameters + +* `value` {any} + +* Returns: {string} + +*** + +#### `redBright` + +* Type: {Function} + +##### Parameters + +* `value` {any} + +* Returns: {string} + +*** + +#### `reset` + +* Type: {Function} + +##### Parameters + +* `value` {any} + +* Returns: {string} + +*** + +#### `strikethrough` + +* Type: {Function} + +##### Parameters + +* `value` {any} + +* Returns: {string} + +*** + +#### `underline` + +* Type: {Function} + +##### Parameters + +* `value` {any} + +* Returns: {string} + +*** + +#### `white` + +* Type: {Function} + +##### Parameters + +* `value` {any} + +* Returns: {string} + +*** + +#### `whiteBright` + +* Type: {Function} + +##### Parameters + +* `value` {any} + +* Returns: {string} + +*** + +#### `yellow` + +* Type: {Function} + +##### Parameters + +* `value` {any} + +* Returns: {string} + +*** + +#### `yellowBright` + +* Type: {Function} + +##### Parameters + +* `value` {any} + +* Returns: {string} + +## `ColorsOptions` + +### Properties + +#### `useColor` + +* Type: {boolean} Optional. + +force use colors diff --git a/pages/v5.x/Compilation.md b/pages/v5.x/Compilation.md new file mode 100644 index 0000000..1c38ac9 --- /dev/null +++ b/pages/v5.x/Compilation.md @@ -0,0 +1,1216 @@ +# Compilation + + + +## Class: `Compilation` + +### Constructors + +#### `new Compilation(compiler, params)` + +##### Parameters + +* `compiler` {Compiler} +* `params` {CompilationParams} + +* Returns: {Compilation} + +Creates an instance of Compilation. + +### Properties + +#### `additionalChunkAssets` + +* Type: {string[]} + +*** + +#### `addModuleQueue` + +* Type: {AsyncQueue} + +*** + +#### `assets` + +* Type: {CompilationAssets} + +*** + +#### `assetsInfo` + +* Type: {Map} + +*** + +#### `asyncEntrypoints` + +* Type: {Entrypoint[]} + +*** + +#### `bail` + +* Type: {boolean} + +*** + +#### `buildDependencies` + +* Type: {LazySet} + +*** + +#### `buildQueue` + +* Type: {AsyncQueue} + +*** + +#### `buildTimeExecutedModules` + +* Type: {WeakSet} + +*** + +#### `builtModules` + +* Type: {WeakSet} + +*** + +#### `children` + +* Type: {Compilation[]} + +*** + +#### `childrenCounters` + +* Type: {Record} + +*** + +#### `chunkGraph` + +* Type: {ChunkGraph} + +*** + +#### `chunkGroups` + +* Type: {ChunkGroup[]} + +*** + +#### `chunks` + +* Type: {Set} + +*** + +#### `chunkTemplate` + +* Type: {ChunkTemplate} + +*** + +#### `codeGeneratedModules` + +* Type: {WeakSet} + +*** + +#### `codeGenerationResults` + +* Type: {CodeGenerationResults} Optional. + +*** + +#### `comparedForEmitAssets` + +* Type: {Set} + +*** + +#### `compilationDependencies` + +* Type: {object} + +* `add` {Function} + * `item` {string} + * Returns: {LazySet} + +##### Deprecated + +*** + +#### `compiler` + +* Type: {Compiler} + +*** + +#### `compilerPath` + +* Type: {string} + +*** + +#### `contextDependencies` + +* Type: {LazySet} + +*** + +#### `creatingModuleDuringBuild` + +* Type: {WeakMap>} + +Modules in value are building during the build of Module in key. +Means value blocking key from finishing. +Needed to detect build cycles. + +*** + +#### `dependencyFactories` + +* Type: {Map} + +*** + +#### `dependencyTemplates` + +* Type: {DependencyTemplates} + +*** + +#### `emittedAssets` + +* Type: {Set} + +*** + +#### `endTime` + +* Type: {number} Optional. + +*** + +#### `entries` + +* Type: {Map} + +*** + +#### `entrypoints` + +* Type: {Map} + +*** + +#### `errors` + +* Type: {Error[]} + +*** + +#### `factorizeQueue` + +* Type: {AsyncQueue} + +*** + +#### `fileDependencies` + +* Type: {LazySet} + +*** + +#### `fileSystemInfo` + +* Type: {FileSystemInfo} + +*** + +#### `fullHash` + +* Type: {string} Optional. + +*** + +#### `globalEntry` + +* Type: {EntryData} + +*** + +#### `hash` + +* Type: {string} Optional. + +*** + +#### `hooks` + +* Type: {Readonly} + +*** + +#### `inputFileSystem` + +* Type: {InputFileSystem} + +*** + +#### `logger` + +* Type: {WebpackLogger} + +*** + +#### `logging` + +* Type: {Map} + +*** + +#### `mainTemplate` + +* Type: {MainTemplate} + +*** + +#### `missingDependencies` + +* Type: {LazySet} + +*** + +#### `moduleGraph` + +* Type: {ModuleGraph} + +*** + +#### `moduleMemCaches` + +* Type: {Map>} Optional. + +*** + +#### `moduleMemCaches2` + +* Type: {Map>} Optional. + +*** + +#### `modules` + +* Type: {Set} + +*** + +#### `moduleTemplates` + +* Type: {ModuleTemplates} + +*** + +#### `name` + +* Type: {string} Optional. + +*** + +#### `namedChunkGroups` + +* Type: {Map} + +*** + +#### `namedChunks` + +* Type: {Map} + +*** + +#### `needAdditionalPass` + +* Type: {boolean} + +*** + +#### `options` + +* Type: {WebpackOptionsNormalizedWithDefaults} + +*** + +#### `outputOptions` + +* Type: {OutputNormalizedWithDefaults} + +*** + +#### `params` + +* Type: {CompilationParams} + +*** + +#### `processDependenciesQueue` + +* Type: {AsyncQueue} + +*** + +#### `profile` + +* Type: {boolean} + +*** + +#### `rebuildQueue` + +* Type: {AsyncQueue} + +*** + +#### `records` + +* Type: {Records} + +*** + +#### `requestShortener` + +* Type: {RequestShortener} + +*** + +#### `resolverFactory` + +* Type: {ResolverFactory} + +*** + +#### `runtimeTemplate` + +* Type: {RuntimeTemplate} + +*** + +#### `startTime` + +* Type: {number} Optional. + +*** + +#### `usedChunkIds` + +* Type: {Set} + +*** + +#### `usedModuleIds` + +* Type: {Set} + +*** + +#### `valueCacheVersions` + +* Type: {Map} + +*** + +#### `warnings` + +* Type: {Error[]} + +*** + +#### `PROCESS_ASSETS_STAGE_ADDITIONAL` + +* Type: {number} + +Add additional assets to the compilation. + +*** + +#### `PROCESS_ASSETS_STAGE_ADDITIONS` + +* Type: {number} + +Add additional sections to existing assets, like a banner or initialization code. + +*** + +#### `PROCESS_ASSETS_STAGE_ANALYSE` + +* Type: {number} + +Analyse existing assets. + +*** + +#### `PROCESS_ASSETS_STAGE_DERIVED` + +* Type: {number} + +Derive new assets from existing assets. +Existing assets should not be treated as complete. + +*** + +#### `PROCESS_ASSETS_STAGE_DEV_TOOLING` + +* Type: {number} + +Add development tooling to assets, e. g. by extracting a SourceMap. + +*** + +#### `PROCESS_ASSETS_STAGE_OPTIMIZE` + +* Type: {number} + +Optimize existing assets in a general way. + +*** + +#### `PROCESS_ASSETS_STAGE_OPTIMIZE_COMPATIBILITY` + +* Type: {number} + +Optimize the compatibility of existing assets, e. g. add polyfills or vendor-prefixes. + +*** + +#### `PROCESS_ASSETS_STAGE_OPTIMIZE_COUNT` + +* Type: {number} + +Optimize the count of existing assets, e. g. by merging them. +Only assets of the same type should be merged. +For assets of different types see PROCESS_ASSETS_STAGE_OPTIMIZE_INLINE. + +*** + +#### `PROCESS_ASSETS_STAGE_OPTIMIZE_HASH` + +* Type: {number} + +Optimize the hashes of the assets, e. g. by generating real hashes of the asset content. + +*** + +#### `PROCESS_ASSETS_STAGE_OPTIMIZE_INLINE` + +* Type: {number} + +Optimize the count of existing assets, e. g. by inlining assets of into other assets. +Only assets of different types should be inlined. +For assets of the same type see PROCESS_ASSETS_STAGE_OPTIMIZE_COUNT. + +*** + +#### `PROCESS_ASSETS_STAGE_OPTIMIZE_SIZE` + +* Type: {number} + +Optimize the size of existing assets, e. g. by minimizing or omitting whitespace. + +*** + +#### `PROCESS_ASSETS_STAGE_OPTIMIZE_TRANSFER` + +* Type: {number} + +Optimize the transfer of existing assets, e. g. by preparing a compressed (gzip) file as separate asset. + +*** + +#### `PROCESS_ASSETS_STAGE_PRE_PROCESS` + +* Type: {number} + +Basic preprocessing of assets. + +*** + +#### `PROCESS_ASSETS_STAGE_REPORT` + +* Type: {number} + +Creating assets for reporting purposes. + +*** + +#### `PROCESS_ASSETS_STAGE_SUMMARIZE` + +* Type: {number} + +Summarize the list of existing assets +e. g. creating an assets manifest of Service Workers. + +### Methods + +#### `addAsyncEntrypoint(options, module, loc, request)` + +##### Parameters + +* `options` {EntryOptions} +* `module` {Module} +* `loc` {DependencyLocation} +* `request` {string} + +* Returns: {Entrypoint} + +*** + +#### `addChunk([name])` + +##### Parameters + +* `name` {string} + +* Returns: {Chunk} + +This method first looks to see if a name is provided for a new chunk, +and first looks to see if any named chunks already exist and reuse that chunk instead. + +*** + +#### `addChunkInGroup(groupOptions[, module][, loc][, request])` + +##### Parameters + +* `groupOptions` {string|ChunkGroupOptions} +* `module` {Module} +* `loc` {SyntheticDependencyLocation|RealDependencyLocation} +* `request` {string} + +* Returns: {ChunkGroup} + +If `module` is passed, `loc` and `request` must also be passed. + +*** + +#### `addEntry(context, entry, optionsOrName, callback)` + +##### Parameters + +* `context` {string} +* `entry` {Dependency} +* `optionsOrName` {string|EntryOptions} +* `callback` {Function} + * `err` {WebpackError} + * `result` {Module} + * Returns: {void} + +* Returns: {void} + +*** + +#### `addInclude(context, dependency, options, callback)` + +##### Parameters + +* `context` {string} +* `dependency` {Dependency} +* `options` {EntryOptions} +* `callback` {Function} + * `err` {WebpackError} + * `result` {Module} + * Returns: {void} + +* Returns: {void} + +*** + +#### `addModule(module, callback)` + +##### Parameters + +* `module` {Module} +* `callback` {Function} + * `err` {WebpackError} + * `result` {Module} + * Returns: {void} + +* Returns: {void} + +*** + +#### `addModuleChain(context, dependency, callback)` + +##### Parameters + +* `context` {string} +* `dependency` {Dependency} +* `callback` {Function} + * `err` {WebpackError} + * `result` {Module} + * Returns: {void} + +* Returns: {void} + +*** + +#### `addModuleTree(__namedParameters, callback)` + +##### Parameters + +* `__namedParameters` {object} + * `context` {string} context string path + * `contextInfo` {Partial} additional context info for the root module + * `dependency` {Dependency} dependency used to create Module chain +* `callback` {Function} + * `err` {WebpackError} + * `result` {Module} + * Returns: {void} + +* Returns: {void} + +*** + +#### `addRuntimeModule(chunk, module[, chunkGraph])` + +##### Parameters + +* `chunk` {Chunk} +* `module` {RuntimeModule} +* `chunkGraph` {ChunkGraph} + +* Returns: {void} + +*** + +#### `assignDepth(module)` + +> Stability: 0 - Deprecated + +##### Parameters + +* `module` {Module} + +* Returns: {void} + +*** + +#### `assignDepths(modules)` + +##### Parameters + +* `modules` {Set} + +* Returns: {void} + +*** + +#### `assignRuntimeIds()` + +* Returns: {void} + +*** + +#### `buildModule(module, callback)` + +##### Parameters + +* `module` {Module} +* `callback` {Function} + * `err` {WebpackError} + * `result` {Module} + * Returns: {void} + +* Returns: {void} + +Schedules a build of the module object + +*** + +#### `checkConstraints()` + +* Returns: {void} + +*** + +#### `clearAssets()` + +* Returns: {void} + +*** + +#### `codeGeneration(callback)` + +##### Parameters + +* `callback` {Function} + * `err` {WebpackError} + * Returns: {void} + +* Returns: {void} + +*** + +#### `createChildCompiler(name[, outputOptions][, plugins])` + +##### Parameters + +* `name` {string} +* `outputOptions` {Partial} +* `plugins` {false|""|0|Function|WebpackPluginInstance[]} + +* Returns: {Compiler} + +This function allows you to run another instance of webpack inside of webpack however as +a child with different settings and configurations (if desired) applied. It copies all hooks, plugins +from parent (or top level compiler) and creates a child Compilation + +*** + +#### `createChunkAssets(callback)` + +##### Parameters + +* `callback` {Function} + * `err` {WebpackError} + * Returns: {void} + +* Returns: {void} + +*** + +#### `createHash()` + +* Returns: {CodeGenerationJob[]} + +*** + +#### `createModuleAssets()` + +* Returns: {void} + +*** + +#### `createModuleHashes()` + +* Returns: {void} + +*** + +#### `createStatsFactory(options)` + +##### Parameters + +* `options` {NormalizedStatsOptions} + +* Returns: {StatsFactory} + +*** + +#### `createStatsOptions([optionsOrPreset][, context])` + +##### Parameters + +* `optionsOrPreset` {string|boolean|StatsOptions} +* `context` {CreateStatsOptionsContext} + +* Returns: {NormalizedStatsOptions} + +*** + +#### `createStatsPrinter(options)` + +##### Parameters + +* `options` {NormalizedStatsOptions} + +* Returns: {StatsPrinter} + +*** + +#### `deleteAsset(file)` + +##### Parameters + +* `file` {string} + +* Returns: {void} + +*** + +#### `emitAsset(file, source[, assetInfo])` + +##### Parameters + +* `file` {string} +* `source` {Source} +* `assetInfo` {AssetInfo} + +* Returns: {void} + +*** + +#### `executeModule(module, options, callback)` + +##### Parameters + +* `module` {Module} +* `options` {ExecuteModuleOptions} +* `callback` {Function} + * `err` {WebpackError} + * `result` {ExecuteModuleResult} + * Returns: {void} + +* Returns: {void} + +*** + +#### `factorizeModule(options, callback)` + +##### Call Signature + +##### Parameters + +* `options` {FactorizeModuleOptions & object} +* `callback` {Function} + * `err` {WebpackError} + * `result` {Module} + * Returns: {void} + +* Returns: {void} + +##### Call Signature + +##### Parameters + +* `options` {FactorizeModuleOptions & object} +* `callback` {Function} + * `err` {WebpackError} + * `result` {ModuleFactoryResult} + * Returns: {void} + +* Returns: {void} + +*** + +#### `findModule(identifier)` + +##### Parameters + +* `identifier` {string} + +* Returns: {Module} + +Attempts to search for a module by its identifier + +*** + +#### `finish(callback)` + +##### Parameters + +* `callback` {Function} + * `err` {WebpackError} + * Returns: {void} + +* Returns: {void} + +*** + +#### `getAsset(name)` + +##### Parameters + +* `name` {string} + +* Returns: {Readonly} + +*** + +#### `getAssetPath(filename, data)` + +##### Parameters + +* `filename` {TemplatePath} +* `data` {PathData} + +* Returns: {string} + +*** + +#### `getAssetPathWithInfo(filename, data)` + +##### Parameters + +* `filename` {TemplatePath} +* `data` {PathData} + +* Returns: {InterpolatedPathAndAssetInfo} + +*** + +#### `getAssets()` + +* Returns: {Readonly[]} + +*** + +#### `getCache(name)` + +##### Parameters + +* `name` {string} + +* Returns: {CacheFacade} + +*** + +#### `getDependencyReferencedExports(dependency, runtime)` + +##### Parameters + +* `dependency` {Dependency} +* `runtime` {RuntimeSpec} + +* Returns: {string[]|ReferencedExport[]} + +*** + +#### `getErrors()` + +* Returns: {Error[]} + +*** + +#### `getLogger(name)` + +##### Parameters + +* `name` {string|Function} + +* Returns: {WebpackLogger} + +*** + +#### `getModule(module)` + +##### Parameters + +* `module` {Module} + +* Returns: {Module} + +Fetches a module from a compilation by its identifier + +*** + +#### `getPath(filename[, data])` + +##### Parameters + +* `filename` {TemplatePath} +* `data` {PathData} + +* Returns: {string} + +*** + +#### `getPathWithInfo(filename[, data])` + +##### Parameters + +* `filename` {TemplatePath} +* `data` {PathData} + +* Returns: {InterpolatedPathAndAssetInfo} + +*** + +#### `getRenderManifest(options)` + +##### Parameters + +* `options` {RenderManifestOptions} + +* Returns: {RenderManifestEntry[]} + +*** + +#### `getStats()` + +* Returns: {Stats} + +*** + +#### `getWarnings()` + +* Returns: {Error[]} + +*** + +#### `handleModuleCreation(__namedParameters, callback)` + +##### Parameters + +* `__namedParameters` {HandleModuleCreationOptions} +* `callback` {Function} + * `err` {WebpackError} + * `result` {Module} + * Returns: {void} + +* Returns: {void} + +*** + +#### `patchChunksAfterReasonRemoval(module, chunk)` + +##### Parameters + +* `module` {Module} +* `chunk` {Chunk} + +* Returns: {void} + +*** + +#### `processModuleDependencies(module, callback)` + +##### Parameters + +* `module` {Module} +* `callback` {Function} + * `err` {WebpackError} + * `result` {Module} + * Returns: {void} + +* Returns: {void} + +*** + +#### `processModuleDependenciesNonRecursive(module)` + +##### Parameters + +* `module` {Module} + +* Returns: {void} + +*** + +#### `processRuntimeRequirements([__namedParameters])` + +##### Parameters + +* `__namedParameters` {object} + * `chunkGraph` {ChunkGraph} the chunk graph + * `chunkGraphEntries` {Iterable} chunkGraphEntries + * `chunks` {Iterable} chunks + * `codeGenerationResults` {CodeGenerationResults} codeGenerationResults + * `modules` {Iterable} modules + +* Returns: {void} + +*** + +#### `rebuildModule(module, callback)` + +##### Parameters + +* `module` {Module} +* `callback` {Function} + * `err` {WebpackError} + * `result` {Module} + * Returns: {void} + +* Returns: {void} + +*** + +#### `removeChunkFromDependencies(block, chunk)` + +##### Parameters + +* `block` {DependenciesBlock} +* `chunk` {Chunk} + +* Returns: {void} + +*** + +#### `removeReasonsOfDependencyBlock(module, block)` + +##### Parameters + +* `module` {Module} +* `block` {DependenciesBlockLike} + +* Returns: {void} + +*** + +#### `renameAsset(file, newFile)` + +##### Parameters + +* `file` {string} +* `newFile` {string} + +* Returns: {void} + +*** + +#### `reportDependencyErrorsAndWarnings(module, blocks)` + +##### Parameters + +* `module` {Module} +* `blocks` {DependenciesBlock[]} + +* Returns: {boolean} + +*** + +#### `seal(callback)` + +##### Parameters + +* `callback` {Function} + * `err` {WebpackError} + * Returns: {void} + +* Returns: {void} + +*** + +#### `sortItemsWithChunkIds()` + +* Returns: {void} + +*** + +#### `summarizeDependencies()` + +* Returns: {void} + +*** + +#### `unseal()` + +* Returns: {void} + +*** + +#### `updateAsset(file, newSourceOrFunction[, assetInfoUpdateOrFunction])` + +##### Parameters + +* `file` {string} +* `newSourceOrFunction` {Source|Function} +* `assetInfoUpdateOrFunction` {AssetInfo|Function} + +* Returns: {void} diff --git a/pages/v5.x/Compiler.md b/pages/v5.x/Compiler.md new file mode 100644 index 0000000..c6395ed --- /dev/null +++ b/pages/v5.x/Compiler.md @@ -0,0 +1,429 @@ +# Compiler + + + +## Class: `Compiler` + +### Constructors + +#### `new Compiler(context[, options])` + +##### Parameters + +* `context` {string} +* `options` {WebpackOptionsNormalized} + +* Returns: {Compiler} + +### Properties + +#### `cache` + +* Type: {CacheClass} + +*** + +#### `compilerPath` + +* Type: {string} + +*** + +#### `context` + +* Type: {string} + +*** + +#### `contextTimestamps` + +* Type: {Map} Optional. + +*** + +#### `fileTimestamps` + +* Type: {Map} Optional. + +*** + +#### `fsStartTime` + +* Type: {number} Optional. + +*** + +#### `hooks` + +* Type: {Readonly} + +*** + +#### `idle` + +* Type: {boolean} + +*** + +#### `immutablePaths` + +* Type: {Set} + +*** + +#### `infrastructureLogger` + +* Type: {Function} Optional. + +##### Parameters + +* `value` {string} +* `type` {LogTypeEnum} +* `args` {any[]} + +* Returns: {void} + +*** + +#### `inputFileSystem` + +* Type: {InputFileSystem} + +*** + +#### `intermediateFileSystem` + +* Type: {IntermediateFileSystem} + +*** + +#### `managedPaths` + +* Type: {Set} + +*** + +#### `modifiedFiles` + +* Type: {ReadonlySet} Optional. + +*** + +#### `moduleMemCaches` + +* Type: {Map} Optional. + +*** + +#### `name` + +* Type: {string} Optional. + +*** + +#### `options` + +* Type: {WebpackOptionsNormalized} + +*** + +#### `outputFileSystem` + +* Type: {OutputFileSystem} + +*** + +#### `outputPath` + +* Type: {string} + +*** + +#### `parentCompilation` + +* Type: {Compilation} Optional. + +*** + +#### `platform` + +* Type: {Readonly} + +*** + +#### `records` + +* Type: {Records} + +*** + +#### `recordsInputPath` + +* Type: {string} + +*** + +#### `recordsOutputPath` + +* Type: {string} + +*** + +#### `removedFiles` + +* Type: {ReadonlySet} Optional. + +*** + +#### `requestShortener` + +* Type: {RequestShortener} + +*** + +#### `resolverFactory` + +* Type: {ResolverFactory} + +*** + +#### `root` + +* Type: {Compiler} + +*** + +#### `running` + +* Type: {boolean} + +*** + +#### `unmanagedPaths` + +* Type: {Set} + +*** + +#### `watchFileSystem` + +* Type: {WatchFileSystem} + +*** + +#### `watching` + +* Type: {Watching} Optional. + +*** + +#### `watchMode` + +* Type: {boolean} + +*** + +#### `webpack` + +* Type: {webpack} + +### Methods + +#### `close(callback)` + +##### Parameters + +* `callback` {Function} + * `err` {Error} + * `result` {void} + * Returns: {void} + +* Returns: {void} + +*** + +#### `compile(callback)` + +##### Parameters + +* `callback` {CallbackWebpackFunction_2} + +* Returns: {void} + +*** + +#### `createChildCompiler(compilation, compilerName, compilerIndex[, outputOptions][, plugins])` + +##### Parameters + +* `compilation` {Compilation} +* `compilerName` {string} +* `compilerIndex` {number} +* `outputOptions` {Partial} +* `plugins` {false|""|0|WebpackPluginInstance|Function[]} + +* Returns: {Compiler} + +*** + +#### `createCompilation(params)` + +##### Parameters + +* `params` {CompilationParams} + +* Returns: {Compilation} + +*** + +#### `createContextModuleFactory()` + +* Returns: {ContextModuleFactory} + +*** + +#### `createNormalModuleFactory()` + +* Returns: {NormalModuleFactory} + +*** + +#### `emitAssets(compilation, callback)` + +##### Parameters + +* `compilation` {Compilation} +* `callback` {Function} + * `err` {Error} + * `result` {void} + * Returns: {void} + +* Returns: {void} + +*** + +#### `emitRecords(callback)` + +##### Parameters + +* `callback` {Function} + * `err` {Error} + * `result` {void} + * Returns: {void} + +* Returns: {void} + +*** + +#### `getCache(name)` + +##### Parameters + +* `name` {string} + +* Returns: {CacheFacade} + +*** + +#### `getInfrastructureLogger(name)` + +##### Parameters + +* `name` {string|Function} + +* Returns: {WebpackLogger} + +*** + +#### `isChild()` + +* Returns: {boolean} + +*** + +#### `newCompilation(params)` + +##### Parameters + +* `params` {CompilationParams} + +* Returns: {Compilation} + +*** + +#### `newCompilationParams()` + +* Returns: {object} + * `contextModuleFactory` {ContextModuleFactory} + * `normalModuleFactory` {NormalModuleFactory} + +*** + +#### `purgeInputFileSystem()` + +* Returns: {void} + +*** + +#### `readRecords(callback)` + +##### Parameters + +* `callback` {Function} + * `err` {Error} + * `result` {void} + * Returns: {void} + +* Returns: {void} + +*** + +#### `run(callback)` + +##### Parameters + +* `callback` {CallbackWebpackFunction_2} + +* Returns: {void} + +*** + +#### `runAsChild(callback)` + +##### Parameters + +* `callback` {Function} + * `err` {Error} + * `entries` {Chunk[]} + * `compilation` {Compilation} + * Returns: {void} + +* Returns: {void} + +*** + +#### `validate(schema, value[, options][, check])` + +##### Parameters + +* `schema` {JSONSchema4 & ExtendedSchema|JSONSchema6 & ExtendedSchema|JSONSchema7 & ExtendedSchema|Function} +* `value` {T} +* `options` {ValidationErrorConfiguration} +* `check` {Function} + * `value` {T} + * Returns: {boolean} + +* Returns: {void} + +Schema validation function with optional pre-compiled check + +*** + +#### `watch(watchOptions, handler)` + +##### Parameters + +* `watchOptions` {WatchOptions} +* `handler` {CallbackWebpackFunction_2} + +* Returns: {Watching} diff --git a/pages/v5.x/ConcatenationScope.md b/pages/v5.x/ConcatenationScope.md new file mode 100644 index 0000000..e68182b --- /dev/null +++ b/pages/v5.x/ConcatenationScope.md @@ -0,0 +1,129 @@ +# ConcatenationScope + + + +## Class: `ConcatenationScope` + +### Constructors + +#### `new ConcatenationScope(modulesMap, currentModule, usedNames)` + +##### Parameters + +* `modulesMap` {ModuleInfo[]|Map} +* `currentModule` {ConcatenatedModuleInfo} +* `usedNames` {Set} + +* Returns: {ConcatenationScope} + +### Properties + +#### `usedNames` + +* Type: {Set} + +*** + +#### `DEFAULT_EXPORT` + +* Type: {string} + +*** + +#### `NAMESPACE_OBJECT_EXPORT` + +* Type: {string} + +### Methods + +#### `createModuleReference(module, __namedParameters)` + +##### Parameters + +* `module` {Module} +* `__namedParameters` {Partial} + +* Returns: {string} + +*** + +#### `getRawExport(exportName)` + +##### Parameters + +* `exportName` {string} + +* Returns: {string} + +*** + +#### `isModuleInScope(module)` + +##### Parameters + +* `module` {Module} + +* Returns: {boolean} + +*** + +#### `registerExport(exportName, symbol)` + +##### Parameters + +* `exportName` {string} +* `symbol` {string} + +* Returns: {void} + +*** + +#### `registerNamespaceExport(symbol)` + +##### Parameters + +* `symbol` {string} + +* Returns: {void} + +*** + +#### `registerRawExport(exportName, expression)` + +##### Parameters + +* `exportName` {string} +* `expression` {string} + +* Returns: {void} + +*** + +#### `setRawExportMap(exportName, expression)` + +##### Parameters + +* `exportName` {string} +* `expression` {string} + +* Returns: {void} + +*** + +#### Static method: `isModuleReference(name)` + +##### Parameters + +* `name` {string} + +* Returns: {boolean} + +*** + +#### Static method: `matchModuleReference(name)` + +##### Parameters + +* `name` {string} + +* Returns: {ModuleReferenceOptions & object} diff --git a/pages/v5.x/Configuration.md b/pages/v5.x/Configuration.md new file mode 100644 index 0000000..93e1cdf --- /dev/null +++ b/pages/v5.x/Configuration.md @@ -0,0 +1,303 @@ +# Configuration + + + +## `Configuration` + +Options object as provided by the user. + +### Properties + +#### `amd` + +* Type: {false|object} Optional. + +Set the value of `require.amd` and `define.amd`. Or disable AMD support. + +*** + +#### `bail` + +* Type: {boolean} Optional. + +Report the first error as a hard error instead of tolerating it. + +*** + +#### `cache` + +* Type: {boolean|FileCacheOptions|MemoryCacheOptions} Optional. + +Cache generated modules and chunks to improve performance for multiple incremental builds. + +*** + +#### `context` + +* Type: {string} Optional. + +The base directory (absolute path!) for resolving the `entry` option. If `output.pathinfo` is set, the included pathinfo is shortened to this directory. + +*** + +#### `dependencies` + +* Type: {string[]} Optional. + +References to other configurations to depend on. + +*** + +#### `devtool` + +* Type: {string|false|object[]} Optional. + +A developer tool to enhance debugging (false | eval | [inline-|hidden-|eval-][nosources-][cheap-[module-]]source-map). + +*** + +#### `dotenv` + +* Type: {boolean|DotenvPluginOptions} Optional. + +Enable and configure the Dotenv plugin to load environment variables from .env files. + +*** + +#### `entry` + +* Type: {string|string[]|EntryObject|Function} Optional. + +The entry point(s) of the compilation. + +*** + +#### `experiments` + +* Type: {Experiments} Optional. + +Enables/Disables experiments (experimental features with relax SemVer compatibility). + +*** + +#### `extends` + +* Type: {string|string[]} Optional. + +Extend configuration from another configuration (only works when using webpack-cli). + +*** + +#### `externals` + +* Type: {string|RegExp|ExternalItemObjectKnown & ExternalItemObjectUnknown|Function|Function|ExternalItem[]} Optional. + +Specify dependencies that shouldn't be resolved by webpack, but should become dependencies of the resulting bundle. The kind of the dependency depends on `output.libraryTarget`. + +*** + +#### `externalsPresets` + +* Type: {ExternalsPresets} Optional. + +Enable presets of externals for specific targets. + +*** + +#### `externalsType` + +* Type: {"asset"|"module"|"css-import"|"css-url"|"global"|"import"|"commonjs"|"jsonp"|"promise"|"this"|"var"|"assign"|"window"|"self"|"commonjs2"|"commonjs-module"|"commonjs-static"|"amd"|"amd-require"|"umd"|"umd2"|"system"|"module-import"|"script"|"node-commonjs"} Optional. + +Specifies the default type of externals ('amd*', 'umd*', 'system' and 'jsonp' depend on output.libraryTarget set to the same value). + +*** + +#### `ignoreWarnings` + +* Type: {RegExp|object|Function[]} Optional. + +Ignore specific warnings. + +*** + +#### `infrastructureLogging` + +* Type: {InfrastructureLogging} Optional. + +Options for infrastructure level logging. + +*** + +#### `loader` + +* Type: {Loader} Optional. + +Custom values available in the loader context. + +*** + +#### `mode` + +* Type: {"development"|"none"|"production"} Optional. + +Enable production optimizations or development hints. + +*** + +#### `module` + +* Type: {ModuleOptions} Optional. + +Options affecting the normal modules (`NormalModuleFactory`). + +*** + +#### `name` + +* Type: {string} Optional. + +Name of the configuration. Used when loading multiple configurations. + +*** + +#### `node` + +* Type: {false|NodeOptions} Optional. + +Include polyfills or mocks for various node stuff. + +*** + +#### `optimization` + +* Type: {Optimization} Optional. + +Enables/Disables integrated optimizations. + +*** + +#### `output` + +* Type: {Output} Optional. + +Options affecting the output of the compilation. `output` options tell webpack how to write the compiled files to disk. + +*** + +#### `parallelism` + +* Type: {number} Optional. + +The number of parallel processed modules in the compilation. + +*** + +#### `performance` + +* Type: {false|PerformanceOptions} Optional. + +Configuration for web performance recommendations. + +*** + +#### `plugins` + +* Type: {false|""|0|WebpackPluginInstance|Function[]} Optional. + +Add additional plugins to the compiler. + +*** + +#### `profile` + +* Type: {boolean} Optional. + +Capture timing information for each module. + +*** + +#### `recordsInputPath` + +* Type: {string|false} Optional. + +Store compiler state to a json file. + +*** + +#### `recordsOutputPath` + +* Type: {string|false} Optional. + +Load compiler state from a json file. + +*** + +#### `recordsPath` + +* Type: {string|false} Optional. + +Store/Load compiler state from/to a json file. This will result in persistent ids of modules and chunks. An absolute path is expected. `recordsPath` is used for `recordsInputPath` and `recordsOutputPath` if they left undefined. + +*** + +#### `resolve` + +* Type: {ResolveOptions} Optional. + +Options for the resolver. + +*** + +#### `resolveLoader` + +* Type: {ResolveOptions} Optional. + +Options for the resolver when resolving loaders. + +*** + +#### `snapshot` + +* Type: {SnapshotOptionsWebpackOptions} Optional. + +Options affecting how file system snapshots are created and validated. + +*** + +#### `stats` + +* Type: {boolean|"verbose"|"none"|"summary"|"errors-only"|"errors-warnings"|"minimal"|"normal"|"detailed"|StatsOptions} Optional. + +Stats options object or preset name. + +*** + +#### `target` + +* Type: {string|false|string[]} Optional. + +Environment to build for. An array of environments to build for all of them when possible. + +*** + +#### `validate` + +* Type: {boolean} Optional. + +Enable validation of webpack configuration. Defaults to true in development mode. In production mode, defaults to true unless futureDefaults is enabled, then defaults to false. + +*** + +#### `watch` + +* Type: {boolean} Optional. + +Enter watch mode, which rebuilds on file change. + +*** + +#### `watchOptions` + +* Type: {WatchOptions} Optional. + +Options for the watcher. diff --git a/pages/v5.x/ConsumeShared.md b/pages/v5.x/ConsumeShared.md new file mode 100644 index 0000000..e516c3d --- /dev/null +++ b/pages/v5.x/ConsumeShared.md @@ -0,0 +1,53 @@ +# ConsumeShared + + + +## `ConsumeSharedPluginOptions` + +Options for consuming shared modules. + +### Properties + +#### `consumes` + +* Type: {Consumes} + +Modules that should be consumed from share scope. When provided, property names are used to match requested modules in this compilation. + +*** + +#### `shareScope` + +* Type: {string} Optional. + +Share scope name used for all consumed modules (defaults to 'default'). + +## Class: `ConsumeSharedPlugin` + +### Constructors + +#### `new ConsumeSharedPlugin(options)` + +##### Parameters + +* `options` {ConsumeSharedPluginOptions} + +* Returns: {ConsumeSharedPlugin} + +### Properties + +#### `options` + +* Type: {ConsumeSharedPluginOptions} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} + +Apply the plugin diff --git a/pages/v5.x/ContainerReference.md b/pages/v5.x/ContainerReference.md new file mode 100644 index 0000000..8683cdf --- /dev/null +++ b/pages/v5.x/ContainerReference.md @@ -0,0 +1,59 @@ +# ContainerReference + + + +## `ContainerReferencePluginOptions` + +### Properties + +#### `remotes` + +* Type: {Remotes} + +Container locations and request scopes from which modules should be resolved and loaded at runtime. When provided, property name is used as request scope, otherwise request scope is automatically inferred from container location. + +*** + +#### `remoteType` + +* Type: {ExternalsType} + +The external type of the remote containers. + +*** + +#### `shareScope` + +* Type: {string} Optional. + +The name of the share scope shared with all remotes (defaults to 'default'). + +## Class: `ContainerReferencePlugin` + +### Constructors + +#### `new ContainerReferencePlugin(options)` + +##### Parameters + +* `options` {ContainerReferencePluginOptions} + +* Returns: {ContainerReferencePlugin} + +### Properties + +#### `options` + +* Type: {ContainerReferencePluginOptions} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} + +Apply the plugin diff --git a/pages/v5.x/ContextExclusionPlugin.md b/pages/v5.x/ContextExclusionPlugin.md new file mode 100644 index 0000000..2e9406b --- /dev/null +++ b/pages/v5.x/ContextExclusionPlugin.md @@ -0,0 +1,33 @@ +# ContextExclusionPlugin + + + +## Class: `ContextExclusionPlugin` + +### Constructors + +#### `new ContextExclusionPlugin(negativeMatcher)` + +##### Parameters + +* `negativeMatcher` {RegExp} + +* Returns: {ContextExclusionPlugin} + +### Properties + +#### `negativeMatcher` + +* Type: {RegExp} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} + +Apply the plugin diff --git a/pages/v5.x/ContextReplacementPlugin.md b/pages/v5.x/ContextReplacementPlugin.md new file mode 100644 index 0000000..a911b0d --- /dev/null +++ b/pages/v5.x/ContextReplacementPlugin.md @@ -0,0 +1,82 @@ +# ContextReplacementPlugin + + + +## Class: `ContextReplacementPlugin` + +### Constructors + +#### `new ContextReplacementPlugin(resourceRegExp[, newContentResource][, newContentRecursive][, newContentRegExp])` + +##### Parameters + +* `resourceRegExp` {RegExp} +* `newContentResource` {string|boolean|RegExp|Function} +* `newContentRecursive` {boolean|RegExp|NewContentCreateContextMap} +* `newContentRegExp` {RegExp} + +* Returns: {ContextReplacementPlugin} + +### Properties + +#### `newContentCallback` + +* Type: {Function} Optional. + +##### Parameters + +* `context` {BeforeContextResolveData|AfterContextResolveData} + +* Returns: {void} + +*** + +#### `newContentCreateContextMap` + +* Type: {Function} Optional. + +##### Parameters + +* `fs` {InputFileSystem} +* `callback` {Function} + * `err` {Error} + * `newContentRecursive` {NewContentCreateContextMap} + * Returns: {void} + +* Returns: {void} + +*** + +#### `newContentRecursive` + +* Type: {boolean} Optional. + +*** + +#### `newContentRegExp` + +* Type: {RegExp} Optional. + +*** + +#### `newContentResource` + +* Type: {string} Optional. + +*** + +#### `resourceRegExp` + +* Type: {RegExp} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} + +Apply the plugin diff --git a/pages/v5.x/DefinePlugin.md b/pages/v5.x/DefinePlugin.md new file mode 100644 index 0000000..5f4122c --- /dev/null +++ b/pages/v5.x/DefinePlugin.md @@ -0,0 +1,61 @@ +# DefinePlugin + + + +## Class: `DefinePlugin` + +### Constructors + +#### `new DefinePlugin(definitions)` + +##### Parameters + +* `definitions` {Definitions} + +* Returns: {DefinePlugin} + +Create a new define plugin + +### Properties + +#### `definitions` + +* Type: {Definitions} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} + +Apply the plugin + +*** + +#### Static method: `getCompilationHooks(compilation)` + +##### Parameters + +* `compilation` {Compilation} + +* Returns: {DefinePluginHooks} + +*** + +#### Static method: `runtimeValue(fn[, options])` + +##### Parameters + +* `fn` {Function} + * `value` {object} + * `key` {string} + * `module` {NormalModule} + * `version` {ValueCacheVersion} + * Returns: {CodeValuePrimitive} +* `options` {true|string[]|RuntimeValueOptions} + +* Returns: {RuntimeValue} diff --git a/pages/v5.x/DelegatedPlugin.md b/pages/v5.x/DelegatedPlugin.md new file mode 100644 index 0000000..e443a02 --- /dev/null +++ b/pages/v5.x/DelegatedPlugin.md @@ -0,0 +1,33 @@ +# DelegatedPlugin + + + +## Class: `DelegatedPlugin` + +### Constructors + +#### `new DelegatedPlugin(options)` + +##### Parameters + +* `options` {Options} + +* Returns: {DelegatedPlugin} + +### Properties + +#### `options` + +* Type: {Options} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} + +Apply the plugin diff --git a/pages/v5.x/Dependency.md b/pages/v5.x/Dependency.md new file mode 100644 index 0000000..9b7d571 --- /dev/null +++ b/pages/v5.x/Dependency.md @@ -0,0 +1,246 @@ +# Dependency + + + +## Class: `Dependency` + +### Constructors + +#### `new Dependency()` + +* Returns: {Dependency} + +### Properties + +#### `category` + +* Type: {string} + +*** + +#### `disconnect` + +* Type: {any} + +*** + +#### `loc` + +* Type: {DependencyLocation} + +*** + +#### `module` + +* Type: {any} + +*** + +#### `optional` + +* Type: {boolean} Optional. + +*** + +#### `type` + +* Type: {string} + +*** + +#### `weak` + +* Type: {boolean} + +*** + +#### `EXPORTS_OBJECT_REFERENCED` + +* Type: {string[][]} + +*** + +#### `NO_EXPORTS_REFERENCED` + +* Type: {string[][]} + +*** + +#### `TRANSITIVE` + +* Type: {TRANSITIVE} + +### Methods + +#### `couldAffectReferencingModule()` + +* Returns: {boolean|TRANSITIVE} + +*** + +#### `createIgnoredModule(context)` + +##### Parameters + +* `context` {string} + +* Returns: {Module} + +*** + +#### `deserialize(__namedParameters)` + +##### Parameters + +* `__namedParameters` {ObjectDeserializerContext} + +* Returns: {void} + +*** + +#### `getCondition(moduleGraph)` + +##### Parameters + +* `moduleGraph` {ModuleGraph} + +* Returns: {false|Function} + +*** + +#### `getContext()` + +* Returns: {string} + +*** + +#### `getErrors(moduleGraph)` + +##### Parameters + +* `moduleGraph` {ModuleGraph} + +* Returns: {WebpackError[]} + +Returns errors + +*** + +#### `getExports(moduleGraph)` + +##### Parameters + +* `moduleGraph` {ModuleGraph} + +* Returns: {ExportsSpec} + +Returns the exported names + +*** + +#### `getModuleEvaluationSideEffectsState(moduleGraph)` + +##### Parameters + +* `moduleGraph` {ModuleGraph} + +* Returns: {ConnectionState} + +*** + +#### `getNumberOfIdOccurrences()` + +* Returns: {number} + +implement this method to allow the occurrence order plugin to count correctly + +*** + +#### `getReference(moduleGraph)` + +> Stability: 0 - Deprecated + +##### Parameters + +* `moduleGraph` {ModuleGraph} + +* Returns: {never} + +Returns the referenced module and export + +*** + +#### `getReferencedExports(moduleGraph, runtime)` + +##### Parameters + +* `moduleGraph` {ModuleGraph} +* `runtime` {RuntimeSpec} + +* Returns: {string[]|ReferencedExport[]} + +Returns list of exports referenced by this dependency + +*** + +#### `getResourceIdentifier()` + +* Returns: {string} + +*** + +#### `getWarnings(moduleGraph)` + +##### Parameters + +* `moduleGraph` {ModuleGraph} + +* Returns: {WebpackError[]} + +Returns warnings + +*** + +#### `serialize(__namedParameters)` + +##### Parameters + +* `__namedParameters` {ObjectSerializerContext} + +* Returns: {void} + +*** + +#### `setLoc(startLine, startColumn, endLine, endColumn)` + +##### Parameters + +* `startLine` {number} +* `startColumn` {number} +* `endLine` {number} +* `endColumn` {number} + +* Returns: {void} + +*** + +#### `updateHash(hash, context)` + +##### Parameters + +* `hash` {Hash} +* `context` {UpdateHashContextDependency} + +* Returns: {void} + +Update the hash + +*** + +#### Static method: `isLowPriorityDependency(dependency)` + +##### Parameters + +* `dependency` {Dependency} + +* Returns: {boolean} diff --git a/pages/v5.x/Dll.md b/pages/v5.x/Dll.md new file mode 100644 index 0000000..613f7a0 --- /dev/null +++ b/pages/v5.x/Dll.md @@ -0,0 +1,185 @@ +# Dll + + + +## `DllPluginOptions` + +### Properties + +#### `context` + +* Type: {string} Optional. + +Context of requests in the manifest file (defaults to the webpack context). + +*** + +#### `entryOnly` + +* Type: {boolean} Optional. + +If true, only entry points will be exposed (default: true). + +*** + +#### `format` + +* Type: {boolean} Optional. + +If true, manifest json file (output) will be formatted. + +*** + +#### `name` + +* Type: {string} Optional. + +Name of the exposed dll function (external name, use value of 'output.library'). + +*** + +#### `path` + +* Type: {string} + +Absolute path to the manifest json file (output). + +*** + +#### `type` + +* Type: {string} Optional. + +Type of the dll bundle (external type, use value of 'output.libraryTarget'). + +## Class: `DllPlugin` + +### Constructors + +#### `new DllPlugin(options)` + +##### Parameters + +* `options` {DllPluginOptions} + +* Returns: {DllPlugin} + +### Properties + +#### `options` + +* Type: {DllPluginOptions} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} + +Apply the plugin + +## Class: `DllReferencePlugin` + +### Constructors + +#### `new DllReferencePlugin(options)` + +##### Parameters + +* `options` {DllReferencePluginOptions} + +* Returns: {DllReferencePlugin} + +### Properties + +#### `options` + +* Type: {DllReferencePluginOptions} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} + +Apply the plugin + +## `DllReferencePluginOptionsContent` + +The mappings from request to module info. + +### Indexable + +> \[`k`: {string}\]: {object} + +Module info. + +## `DllReferencePluginOptionsManifest` + +An object containing content, name and type. + +### Properties + +#### `content` + +* Type: {DllReferencePluginOptionsContent} + +The mappings from request to module info. + +#### `name` + +* Type: {string} Optional. + +The name where the dll is exposed (external name). + +#### `type` + +* Type: {DllReferencePluginOptionsSourceType} Optional. + +The type how the dll is exposed (external type). + +## `DllReferencePluginOptions` + +* Type: {object|object} + +### Union Members + +#### Type Literal + +{object} + +* `context` {string} Context of requests in the manifest (or content property) as absolute path. +* `extensions` {string[]} Extensions used to resolve modules in the dll bundle (only used when using 'scope'). +* `manifest` {string|DllReferencePluginOptionsManifest} An object containing content and name or a string to the absolute path of the JSON manifest to be loaded upon compilation. +* `name` {string} The name where the dll is exposed (external name, defaults to manifest.name). +* `scope` {string} Prefix which is used for accessing the content of the dll. +* `sourceType` {DllReferencePluginOptionsSourceType} How the dll is exposed (libraryTarget, defaults to manifest.type). +* `type` {"require"|"object"} The way how the export of the dll bundle is used. + +*** + +#### Type Literal + +{object} + +* `content` {DllReferencePluginOptionsContent} The mappings from request to module info. +* `context` {string} Context of requests in the manifest (or content property) as absolute path. +* `extensions` {string[]} Extensions used to resolve modules in the dll bundle (only used when using 'scope'). +* `name` {string} The name where the dll is exposed (external name). +* `scope` {string} Prefix which is used for accessing the content of the dll. +* `sourceType` {DllReferencePluginOptionsSourceType} How the dll is exposed (libraryTarget). +* `type` {"require"|"object"} The way how the export of the dll bundle is used. + +## `DllReferencePluginOptionsSourceType` + +* Type: {"var"|"assign"|"this"|"window"|"global"|"commonjs"|"commonjs2"|"commonjs-module"|"amd"|"amd-require"|"umd"|"umd2"|"jsonp"|"system"} + +The type how the dll is exposed (external type). diff --git a/pages/v5.x/DotenvPlugin.md b/pages/v5.x/DotenvPlugin.md new file mode 100644 index 0000000..b507ed2 --- /dev/null +++ b/pages/v5.x/DotenvPlugin.md @@ -0,0 +1,31 @@ +# DotenvPlugin + + + +## Class: `DotenvPlugin` + +### Constructors + +#### `new DotenvPlugin([options])` + +##### Parameters + +* `options` {DotenvPluginOptions} + +* Returns: {DotenvPlugin} + +### Properties + +#### `options` + +* Type: {DotenvPluginOptions} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} diff --git a/pages/v5.x/DynamicEntryPlugin.md b/pages/v5.x/DynamicEntryPlugin.md new file mode 100644 index 0000000..79fc9a9 --- /dev/null +++ b/pages/v5.x/DynamicEntryPlugin.md @@ -0,0 +1,43 @@ +# DynamicEntryPlugin + + + +## Class: `DynamicEntryPlugin` + +### Constructors + +#### `new DynamicEntryPlugin(context, entry)` + +##### Parameters + +* `context` {string} +* `entry` {Function} + * Returns: {Promise} + +* Returns: {DynamicEntryPlugin} + +### Properties + +#### `context` + +* Type: {string} + +*** + +#### `entry` + +* Type: {Function} + +* Returns: {Promise} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} + +Apply the plugin diff --git a/pages/v5.x/Entry.md b/pages/v5.x/Entry.md new file mode 100644 index 0000000..e5001e3 --- /dev/null +++ b/pages/v5.x/Entry.md @@ -0,0 +1,116 @@ +# Entry + + + +## `Entry` + +* Type: {string|Function|EntryObject|string[]} + +## Class: `EntryOptionPlugin` + +### Constructors + +#### `new EntryOptionPlugin()` + +* Returns: {EntryOptionPlugin} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} + +#### Static method: `applyEntryOption(compiler, context, entry)` + +##### Parameters + +* `compiler` {Compiler} +* `context` {string} +* `entry` {EntryNormalized} + +* Returns: {void} + +#### Static method: `entryDescriptionToOptions(compiler, name, desc)` + +##### Parameters + +* `compiler` {Compiler} +* `name` {string} +* `desc` {EntryDescriptionNormalized} + +* Returns: {EntryOptions} + +## Class: `EntryPlugin` + +### Constructors + +#### `new EntryPlugin(context, entry[, options])` + +##### Parameters + +* `context` {string} +* `entry` {string} +* `options` {string|EntryOptions} + +* Returns: {EntryPlugin} + +An entry plugin which will handle creation of the EntryDependency + +### Properties + +#### `context` + +* Type: {string} + +#### `entry` + +* Type: {string} + +#### `options` + +* Type: {string|EntryOptions} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} + +Apply the plugin + +#### Static method: `createDependency(entry, options)` + +##### Parameters + +* `entry` {string} +* `options` {string|EntryOptions} + +* Returns: {EntryDependency} + +## `EntryObject` + +Multiple entry bundles are created. The key is the entry name. The value can be a string, an array or an entry description object. + +### Indexable + +> \[`index`: {string}\]: {string|string[]|EntryDescription} + +## `EntryNormalized` + +* Type: {Function|EntryStaticNormalized} + +## `EntryOptions` + +* Type: {object & Omit} + +### Type Declaration + +* `name` {string} diff --git a/pages/v5.x/Entrypoint.md b/pages/v5.x/Entrypoint.md new file mode 100644 index 0000000..799966d --- /dev/null +++ b/pages/v5.x/Entrypoint.md @@ -0,0 +1,536 @@ +# Entrypoint + + + +## Class: `Entrypoint` + +* Extends: {ChunkGroup} + +### Constructors + +#### `new Entrypoint()` + +* Returns: {Entrypoint} + +### Properties + +#### `asyncEntrypointsIterable` + +* Type: {SortableSet} + +##### Inherited from + +[`ChunkGroup`](Chunk.md#class-chunkgroup).[`asyncEntrypointsIterable`](Chunk.md#asyncentrypointsiterable) + +*** + +#### `blocksIterable` + +* Type: {Iterable} + +##### Inherited from + +[`ChunkGroup`](Chunk.md#class-chunkgroup).[`blocksIterable`](Chunk.md#blocksiterable) + +*** + +#### `childrenIterable` + +* Type: {SortableSet} + +##### Inherited from + +[`ChunkGroup`](Chunk.md#class-chunkgroup).[`childrenIterable`](Chunk.md#childreniterable) + +*** + +#### `chunks` + +* Type: {Chunk[]} + +##### Inherited from + +[`ChunkGroup`](Chunk.md#class-chunkgroup).[`chunks`](Chunk.md#chunks) + +*** + +#### `debugId` + +* Type: {string} + +get a uniqueId for ChunkGroup, made up of its member Chunk debugId's + +##### Inherited from + +[`ChunkGroup`](Chunk.md#class-chunkgroup).[`debugId`](Chunk.md#debugid-1) + +*** + +#### `getModuleIndex` + +* Type: {Function} + +##### Parameters + +* `module` {Module} + +* Returns: {number} + +##### Inherited from + +[`ChunkGroup`](Chunk.md#class-chunkgroup).[`getModuleIndex`](Chunk.md#getmoduleindex) + +*** + +#### `getModuleIndex2` + +* Type: {Function} + +##### Parameters + +* `module` {Module} + +* Returns: {number} + +##### Inherited from + +[`ChunkGroup`](Chunk.md#class-chunkgroup).[`getModuleIndex2`](Chunk.md#getmoduleindex2) + +*** + +#### `groupDebugId` + +* Type: {number} + +##### Inherited from + +[`ChunkGroup`](Chunk.md#class-chunkgroup).[`groupDebugId`](Chunk.md#groupdebugid) + +*** + +#### `id` + +* Type: {string} + +get a unique id for ChunkGroup, made up of its member Chunk id's + +##### Inherited from + +[`ChunkGroup`](Chunk.md#class-chunkgroup).[`id`](Chunk.md#id-1) + +*** + +#### `index` + +* Type: {number} Optional. + +##### Inherited from + +[`ChunkGroup`](Chunk.md#class-chunkgroup).[`index`](Chunk.md#index) + +*** + +#### `name` + +* Type: {string} Optional. + +returns the name of current ChunkGroup +sets a new name for current ChunkGroup + +##### Inherited from + +[`ChunkGroup`](Chunk.md#class-chunkgroup).[`name`](Chunk.md#name-1) + +*** + +#### `options` + +* Type: {ChunkGroupOptions} + +##### Inherited from + +[`ChunkGroup`](Chunk.md#class-chunkgroup).[`options`](Chunk.md#options) + +*** + +#### `origins` + +* Type: {OriginRecord[]} + +##### Inherited from + +[`ChunkGroup`](Chunk.md#class-chunkgroup).[`origins`](Chunk.md#origins) + +*** + +#### `parentsIterable` + +* Type: {SortableSet} + +##### Inherited from + +[`ChunkGroup`](Chunk.md#class-chunkgroup).[`parentsIterable`](Chunk.md#parentsiterable) + +### Methods + +#### `addAsyncEntrypoint(entrypoint)` + +##### Parameters + +* `entrypoint` {Entrypoint} + +* Returns: {boolean} + +*** + +#### `addBlock(block)` + +##### Parameters + +* `block` {AsyncDependenciesBlock} + +* Returns: {boolean} + +*** + +#### `addChild(group)` + +##### Parameters + +* `group` {ChunkGroup} + +* Returns: {boolean} + +*** + +#### `addDependOn(entrypoint)` + +##### Parameters + +* `entrypoint` {Entrypoint} + +* Returns: {void} + +*** + +#### `addOptions(options)` + +##### Parameters + +* `options` {ChunkGroupOptions} + +* Returns: {void} + +when a new chunk is added to a chunkGroup, addingOptions will occur. + +*** + +#### `addOrigin(module, loc, request)` + +##### Parameters + +* `module` {Module} +* `loc` {DependencyLocation} +* `request` {string} + +* Returns: {void} + +*** + +#### `addParent(parentChunk)` + +##### Parameters + +* `parentChunk` {ChunkGroup} + +* Returns: {boolean} + +*** + +#### `checkConstraints()` + +* Returns: {void} + +*** + +#### `compareTo(chunkGraph, otherGroup)` + +##### Parameters + +* `chunkGraph` {ChunkGraph} +* `otherGroup` {ChunkGroup} + +* Returns: {-1|0|1} + +Sorting predicate which allows current ChunkGroup to be compared against another. +Sorting values are based off of number of chunks in ChunkGroup. + +*** + +#### `dependOn(entrypoint)` + +##### Parameters + +* `entrypoint` {Entrypoint} + +* Returns: {boolean} + +*** + +#### `getBlocks()` + +* Returns: {AsyncDependenciesBlock[]} + +*** + +#### `getChildren()` + +* Returns: {ChunkGroup[]} + +*** + +#### `getChildrenByOrders(moduleGraph, chunkGraph)` + +##### Parameters + +* `moduleGraph` {ModuleGraph} +* `chunkGraph` {ChunkGraph} + +* Returns: {Record} + +*** + +#### `getEntrypointChunk()` + +* Returns: {Chunk} + +Returns the chunk which contains the entrypoint modules +(or at least the execution of them) + +*** + +#### `getFiles()` + +* Returns: {string[]} + +*** + +#### `getModulePostOrderIndex(module)` + +##### Parameters + +* `module` {Module} + +* Returns: {number} + +Gets the bottom-up index of a module in this ChunkGroup + +*** + +#### `getModulePreOrderIndex(module)` + +##### Parameters + +* `module` {Module} + +* Returns: {number} + +Gets the top-down index of a module in this ChunkGroup + +*** + +#### `getNumberOfBlocks()` + +* Returns: {number} + +*** + +#### `getNumberOfChildren()` + +* Returns: {number} + +*** + +#### `getNumberOfParents()` + +* Returns: {number} + +*** + +#### `getParents()` + +* Returns: {ChunkGroup[]} + +*** + +#### `getRuntimeChunk()` + +* Returns: {Chunk} + +Fetches the chunk reference containing the webpack bootstrap code + +*** + +#### `hasBlock(block)` + +##### Parameters + +* `block` {AsyncDependenciesBlock} + +* Returns: {boolean} + +*** + +#### `hasParent(parent)` + +##### Parameters + +* `parent` {ChunkGroup} + +* Returns: {boolean} + +*** + +#### `insertChunk(chunk, before)` + +##### Parameters + +* `chunk` {Chunk} +* `before` {Chunk} + +* Returns: {boolean} + +inserts a chunk before another existing chunk in group + +*** + +#### `isInitial()` + +* Returns: {boolean} + +*** + +#### `pushChunk(chunk)` + +##### Parameters + +* `chunk` {Chunk} + +* Returns: {boolean} + +add a chunk into ChunkGroup. Is pushed on or prepended + +*** + +#### `remove()` + +* Returns: {void} + +*** + +#### `removeChild(group)` + +##### Parameters + +* `group` {ChunkGroup} + +* Returns: {boolean} + +*** + +#### `removeChunk(chunk)` + +##### Parameters + +* `chunk` {Chunk} + +* Returns: {boolean} + +*** + +#### `removeParent(chunkGroup)` + +##### Parameters + +* `chunkGroup` {ChunkGroup} + +* Returns: {boolean} + +*** + +#### `replaceChunk(oldChunk, newChunk)` + +##### Parameters + +* `oldChunk` {Chunk} +* `newChunk` {Chunk} + +* Returns: {boolean} + +*** + +#### `setEntrypointChunk(chunk)` + +##### Parameters + +* `chunk` {Chunk} + +* Returns: {void} + +Sets the chunk with the entrypoint modules for an entrypoint. + +*** + +#### `setModulePostOrderIndex(module, index)` + +##### Parameters + +* `module` {Module} +* `index` {number} + +* Returns: {void} + +Sets the bottom-up index of a module in this ChunkGroup + +*** + +#### `setModulePreOrderIndex(module, index)` + +##### Parameters + +* `module` {Module} +* `index` {number} + +* Returns: {void} + +Sets the top-down index of a module in this ChunkGroup + +*** + +#### `setRuntimeChunk(chunk)` + +##### Parameters + +* `chunk` {Chunk} + +* Returns: {void} + +Sets the runtimeChunk for an entrypoint. + +*** + +#### `sortItems()` + +* Returns: {void} + +*** + +#### `unshiftChunk(chunk)` + +##### Parameters + +* `chunk` {Chunk} + +* Returns: {boolean} + +Performs an unshift of a specific chunk diff --git a/pages/v5.x/EnvironmentPlugin.md b/pages/v5.x/EnvironmentPlugin.md new file mode 100644 index 0000000..c87546e --- /dev/null +++ b/pages/v5.x/EnvironmentPlugin.md @@ -0,0 +1,39 @@ +# EnvironmentPlugin + + + +## Class: `EnvironmentPlugin` + +### Constructors + +#### `new EnvironmentPlugin(keys)` + +##### Parameters + +* `...keys` {string|string[]|Record[]} + +* Returns: {EnvironmentPlugin} + +### Properties + +#### `defaultValues` + +* Type: {Record} + +*** + +#### `keys` + +* Type: {string[]} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} + +Apply the plugin diff --git a/pages/v5.x/EvalDevToolModulePlugin.md b/pages/v5.x/EvalDevToolModulePlugin.md new file mode 100644 index 0000000..d0638b7 --- /dev/null +++ b/pages/v5.x/EvalDevToolModulePlugin.md @@ -0,0 +1,45 @@ +# EvalDevToolModulePlugin + + + +## Class: `EvalDevToolModulePlugin` + +### Constructors + +#### `new EvalDevToolModulePlugin([options])` + +##### Parameters + +* `options` {EvalDevToolModulePluginOptions} + +* Returns: {EvalDevToolModulePlugin} + +### Properties + +#### `moduleFilenameTemplate` + +* Type: {DevtoolModuleFilenameTemplate} + +*** + +#### `namespace` + +* Type: {string} + +*** + +#### `sourceUrlComment` + +* Type: {string} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} + +Apply the plugin diff --git a/pages/v5.x/EvalSourceMapDevToolPlugin.md b/pages/v5.x/EvalSourceMapDevToolPlugin.md new file mode 100644 index 0000000..01745fa --- /dev/null +++ b/pages/v5.x/EvalSourceMapDevToolPlugin.md @@ -0,0 +1,51 @@ +# EvalSourceMapDevToolPlugin + + + +## Class: `EvalSourceMapDevToolPlugin` + +### Constructors + +#### `new EvalSourceMapDevToolPlugin([inputOptions])` + +##### Parameters + +* `inputOptions` {string|SourceMapDevToolPluginOptions} + +* Returns: {EvalSourceMapDevToolPlugin} + +### Properties + +#### `moduleFilenameTemplate` + +* Type: {DevtoolModuleFilenameTemplate} + +*** + +#### `namespace` + +* Type: {string} + +*** + +#### `options` + +* Type: {SourceMapDevToolPluginOptions} + +*** + +#### `sourceMapComment` + +* Type: {string} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} + +Apply the plugin diff --git a/pages/v5.x/ExternalItem.md b/pages/v5.x/ExternalItem.md new file mode 100644 index 0000000..dc70c9e --- /dev/null +++ b/pages/v5.x/ExternalItem.md @@ -0,0 +1,136 @@ +# ExternalItem + + + +## `ExternalItem` + +* Type: {string|RegExp|ExternalItemObjectKnown & ExternalItemObjectUnknown|Function|Function} + +## `ExternalItemFunctionData` + +### Properties + +#### `context` + +* Type: {string} + +the directory in which the request is placed + +#### `contextInfo` + +* Type: {ModuleFactoryCreateDataContextInfo} + +contextual information + +#### `dependencyType` + +* Type: {string} + +the category of the referencing dependency + +#### `getResolve` + +* Type: {Function} + +get a resolve function with the current resolver options + +##### Parameters + +* `options` {ResolveOptions} + +* Returns: {Function|Function} + +#### `request` + +* Type: {string} + +the request as written by the user in the require/import expression/statement + +## `ExternalItemObjectKnown` + +If an dependency matches exactly a property of the object, the property value is used as dependency. + +### Properties + +#### `byLayer` + +* Type: {object|Function} Optional. + +Specify externals depending on the layer. + +## `ExternalItemObjectUnknown` + +If an dependency matches exactly a property of the object, the property value is used as dependency. + +### Indexable + +> \[`index`: {string}\]: {ExternalItemValue} + +## `ExternalItemFunction` + +* Type: {Function|Function} + +## `ExternalItemFunctionCallback` + +* Type: {Function} + +### Parameters + +* `data` {ExternalItemFunctionData} +* `callback` {Function} + * `err` {null|Error} + * `result` {string|boolean|string[]|object} + * Returns: {void} + +* Returns: {void} + +## `ExternalItemFunctionDataGetResolve` + +* Type: {Function} + +### Parameters + +* `options` {ResolveOptions} + +* Returns: {Function|Function} + +## `ExternalItemFunctionDataGetResolveCallbackResult` + +* Type: {Function} + +### Parameters + +* `context` {string} +* `request` {string} +* `callback` {Function} + * `err` {null|Error} + * `result` {string|false} + * `resolveRequest` {ResolveRequest} + * Returns: {void} + +* Returns: {void} + +## `ExternalItemFunctionDataGetResolveResult` + +* Type: {Function} + +### Parameters + +* `context` {string} +* `request` {string} + +* Returns: {Promise} + +## `ExternalItemFunctionPromise` + +* Type: {Function} + +### Parameters + +* `data` {ExternalItemFunctionData} + +* Returns: {Promise} + +## `ExternalItemValue` + +* Type: {string|boolean|string[]|object} diff --git a/pages/v5.x/ExternalModule.md b/pages/v5.x/ExternalModule.md new file mode 100644 index 0000000..df09383 --- /dev/null +++ b/pages/v5.x/ExternalModule.md @@ -0,0 +1,963 @@ +# ExternalModule + + + +## Class: `ExternalModule` + +* Extends: {Module} + +### Constructors + +#### `new ExternalModule(request, type, userRequest[, dependencyMeta])` + +##### Parameters + +* `request` {ExternalModuleRequest} +* `type` {ExternalsType} +* `userRequest` {string} +* `dependencyMeta` {ImportDependencyMeta|CssImportDependencyMeta|AssetDependencyMeta} + +* Returns: {ExternalModule} + +### Properties + +#### `blocks` + +* Type: {AsyncDependenciesBlock[]} + +##### Inherited from + +[`Module`](Module.md).[`blocks`](Module.md#blocks) + +*** + +#### `buildInfo` + +* Type: {BuildInfo} Optional. + +##### Inherited from + +[`Module`](Module.md).[`buildInfo`](Module.md#buildinfo) + +*** + +#### `buildMeta` + +* Type: {BuildMeta} Optional. + +##### Inherited from + +[`Module`](Module.md).[`buildMeta`](Module.md#buildmeta) + +*** + +#### `chunksIterable` + +* Type: {Iterable} + +##### Inherited from + +[`Module`](Module.md).[`chunksIterable`](Module.md#chunksiterable) + +*** + +#### `codeGenerationDependencies` + +* Type: {Dependency[]} Optional. + +##### Inherited from + +[`Module`](Module.md).[`codeGenerationDependencies`](Module.md#codegenerationdependencies) + +*** + +#### `context` + +* Type: {string} + +##### Inherited from + +[`Module`](Module.md).[`context`](Module.md#context) + +*** + +#### `debugId` + +* Type: {number} + +##### Inherited from + +[`Module`](Module.md).[`debugId`](Module.md#debugid) + +*** + +#### `dependencies` + +* Type: {Dependency[]} + +##### Inherited from + +[`Module`](Module.md).[`dependencies`](Module.md#dependencies) + +*** + +#### `dependencyMeta` + +* Type: {ImportDependencyMeta|CssImportDependencyMeta|AssetDependencyMeta} Optional. + +*** + +#### `depth` + +* Type: {number} + +##### Inherited from + +[`Module`](Module.md).[`depth`](Module.md#depth) + +*** + +#### `errors` + +* Type: {any} + +##### Inherited from + +[`Module`](Module.md).[`errors`](Module.md#errors) + +*** + +#### `exportsArgument` + +* Type: {string} + +##### Inherited from + +[`Module`](Module.md).[`exportsArgument`](Module.md#exportsargument) + +*** + +#### `externalType` + +* Type: {ExternalsType} + +*** + +#### `factoryMeta` + +* Type: {FactoryMeta} Optional. + +##### Inherited from + +[`Module`](Module.md).[`factoryMeta`](Module.md#factorymeta) + +*** + +#### `hasEqualsChunks` + +* Type: {any} + +##### Inherited from + +[`Module`](Module.md).[`hasEqualsChunks`](Module.md#hasequalschunks) + +*** + +#### `hash` + +* Type: {string} + +##### Inherited from + +[`Module`](Module.md).[`hash`](Module.md#hash) + +*** + +#### `hot` + +* Type: {boolean} + +##### Inherited from + +[`Module`](Module.md).[`hot`](Module.md#hot) + +*** + +#### `id` + +* Type: {string|number} + +##### Deprecated + +##### Inherited from + +[`Module`](Module.md).[`id`](Module.md#id) + +*** + +#### `index` + +* Type: {number} + +##### Inherited from + +[`Module`](Module.md).[`index`](Module.md#index) + +*** + +#### `index2` + +* Type: {number} + +##### Inherited from + +[`Module`](Module.md).[`index2`](Module.md#index2) + +*** + +#### `issuer` + +* Type: {Module} Optional. + +##### Inherited from + +[`Module`](Module.md).[`issuer`](Module.md#issuer) + +*** + +#### `isUsed` + +* Type: {any} + +##### Inherited from + +[`Module`](Module.md).[`isUsed`](Module.md#isused) + +*** + +#### `layer` + +* Type: {string} + +##### Inherited from + +[`Module`](Module.md).[`layer`](Module.md#layer) + +*** + +#### `moduleArgument` + +* Type: {string} + +##### Inherited from + +[`Module`](Module.md).[`moduleArgument`](Module.md#moduleargument) + +*** + +#### `needId` + +* Type: {boolean} + +##### Inherited from + +[`Module`](Module.md).[`needId`](Module.md#needid) + +*** + +#### `optimizationBailout` + +* Type: {string|Function[]} + +##### Deprecated + +##### Inherited from + +[`Module`](Module.md).[`optimizationBailout`](Module.md#optimizationbailout) + +*** + +#### `optional` + +* Type: {boolean} + +##### Inherited from + +[`Module`](Module.md).[`optional`](Module.md#optional) + +*** + +#### `parent` + +* Type: {DependenciesBlock} Optional. + +##### Inherited from + +[`Module`](Module.md).[`parent`](Module.md#parent) + +*** + +#### `presentationalDependencies` + +* Type: {Dependency[]} Optional. + +##### Inherited from + +[`Module`](Module.md).[`presentationalDependencies`](Module.md#presentationaldependencies) + +*** + +#### `profile` + +* Type: {ModuleProfile} Optional. + +##### Inherited from + +[`Module`](Module.md).[`profile`](Module.md#profile) + +*** + +#### `renderedHash` + +* Type: {string} + +##### Inherited from + +[`Module`](Module.md).[`renderedHash`](Module.md#renderedhash) + +*** + +#### `request` + +* Type: {ExternalModuleRequest} + +*** + +#### `resolveOptions` + +* Type: {ResolveOptions} Optional. + +##### Inherited from + +[`Module`](Module.md).[`resolveOptions`](Module.md#resolveoptions) + +*** + +#### `type` + +* Type: {string} + +##### Inherited from + +[`Module`](Module.md).[`type`](Module.md#type) + +*** + +#### `used` + +* Type: {any} + +##### Inherited from + +[`Module`](Module.md).[`used`](Module.md#used) + +*** + +#### `usedExports` + +* Type: {boolean|SortableSet} + +##### Inherited from + +[`Module`](Module.md).[`usedExports`](Module.md#usedexports) + +*** + +#### `userRequest` + +* Type: {string} + +*** + +#### `useSimpleSourceMap` + +* Type: {boolean} + +##### Inherited from + +[`Module`](Module.md).[`useSimpleSourceMap`](Module.md#usesimplesourcemap) + +*** + +#### `useSourceMap` + +* Type: {boolean} + +##### Inherited from + +[`Module`](Module.md).[`useSourceMap`](Module.md#usesourcemap) + +*** + +#### `warnings` + +* Type: {any} + +##### Inherited from + +[`Module`](Module.md).[`warnings`](Module.md#warnings) + +*** + +#### `getExternalModuleNodeCommonjsInitFragment` + +* Type: {Function} + +##### Parameters + +* `runtimeTemplate` {RuntimeTemplate} + +* Returns: {InitFragment} + +*** + +#### `ModuleExternalInitFragment` + +* Type: {ModuleExternalInitFragment} + +### Methods + +#### `addBlock(block)` + +##### Parameters + +* `block` {AsyncDependenciesBlock} + +* Returns: {void} + +Adds a DependencyBlock to DependencyBlock relationship. +This is used for when a Module has a AsyncDependencyBlock tie (for code-splitting) + +*** + +#### `addCacheDependencies(fileDependencies, contextDependencies, missingDependencies, buildDependencies)` + +##### Parameters + +* `fileDependencies` {LazySet} +* `contextDependencies` {LazySet} +* `missingDependencies` {LazySet} +* `buildDependencies` {LazySet} + +* Returns: {void} + +*** + +#### `addChunk(chunk)` + +##### Parameters + +* `chunk` {Chunk} + +* Returns: {boolean} + +*** + +#### `addCodeGenerationDependency(codeGenerationDependency)` + +##### Parameters + +* `codeGenerationDependency` {Dependency} + +* Returns: {void} + +*** + +#### `addDependency(dependency)` + +##### Parameters + +* `dependency` {Dependency} + +* Returns: {void} + +*** + +#### `addError(error)` + +##### Parameters + +* `error` {WebpackError} + +* Returns: {void} + +*** + +#### `addPresentationalDependency(presentationalDependency)` + +##### Parameters + +* `presentationalDependency` {Dependency} + +* Returns: {void} + +*** + +#### `addWarning(warning)` + +##### Parameters + +* `warning` {WebpackError} + +* Returns: {void} + +*** + +#### `build(options, compilation, resolver, fs, callback)` + +##### Parameters + +* `options` {WebpackOptionsNormalizedWithDefaults} +* `compilation` {Compilation} +* `resolver` {ResolverWithOptions} +* `fs` {InputFileSystem} +* `callback` {Function} + * `err` {WebpackError} + * Returns: {void} + +* Returns: {void} + +*** + +#### `chunkCondition(chunk, compilation)` + +##### Parameters + +* `chunk` {Chunk} +* `compilation` {Compilation} + +* Returns: {boolean} + +*** + +#### `cleanupForCache()` + +* Returns: {void} + +Assuming this module is in the cache. Remove internal references to allow freeing some memory. + +*** + +#### `clearDependenciesAndBlocks()` + +* Returns: {void} + +Removes all dependencies and blocks + +*** + +#### `clearWarningsAndErrors()` + +* Returns: {void} + +removes all warnings and errors + +*** + +#### `codeGeneration(context)` + +##### Parameters + +* `context` {CodeGenerationContext} + +* Returns: {CodeGenerationResult} + +*** + +#### `deserialize(__namedParameters)` + +##### Parameters + +* `__namedParameters` {ObjectDeserializerContext} + +* Returns: {void} + +*** + +#### `getChunks()` + +* Returns: {Chunk[]} + +*** + +#### `getConcatenationBailoutReason(context)` + +##### Parameters + +* `context` {ConcatenationBailoutReasonContext} + +* Returns: {string} + +*** + +#### `getErrors()` + +* Returns: {Iterable} + +*** + +#### `getExportsType(moduleGraph[, strict])` + +##### Parameters + +* `moduleGraph` {ModuleGraph} +* `strict` {boolean} + +* Returns: {ExportsType} + +*** + +#### `getNumberOfChunks()` + +* Returns: {number} + +*** + +#### `getNumberOfErrors()` + +* Returns: {number} + +*** + +#### `getNumberOfWarnings()` + +* Returns: {number} + +*** + +#### `getRootBlock()` + +* Returns: {DependenciesBlock} + +*** + +#### `getSideEffectsConnectionState(moduleGraph)` + +##### Parameters + +* `moduleGraph` {ModuleGraph} + +* Returns: {ConnectionState} + +*** + +#### `getSourceBasicTypes()` + +* Returns: {ReadonlySet} + +Basic source types are high-level categories like javascript, css, webassembly, etc. +We only have built-in knowledge about the javascript basic type here; other basic types may be +added or changed over time by generators and do not need to be handled or detected here. +Some modules, e.g. RemoteModule, may return non-basic source types like "remote" and "share-init" +from getSourceTypes(), but their generated output is still JavaScript, i.e. their basic type is JS. + +*** + +#### `getSourceTypes()` + +* Returns: {ReadonlySet} + +*** + +#### `getUnsafeCacheData()` + +* Returns: {UnsafeCacheData} + +Module should be unsafe cached. Get data that's needed for that. +This data will be passed to restoreFromUnsafeCache later. + +*** + +#### `getWarnings()` + +* Returns: {Iterable} + +*** + +#### `hasChunkCondition()` + +* Returns: {boolean} + +*** + +#### `hasReasonForChunk(chunk, moduleGraph, chunkGraph)` + +##### Parameters + +* `chunk` {Chunk} +* `moduleGraph` {ModuleGraph} +* `chunkGraph` {ChunkGraph} + +* Returns: {boolean} + +*** + +#### `hasReasons(moduleGraph, runtime)` + +##### Parameters + +* `moduleGraph` {ModuleGraph} +* `runtime` {RuntimeSpec} + +* Returns: {boolean} + +*** + +#### `identifier()` + +* Returns: {string} + +*** + +#### `invalidateBuild()` + +* Returns: {void} + +*** + +#### `isAccessibleInChunk(chunkGraph, chunk[, ignoreChunk])` + +##### Parameters + +* `chunkGraph` {ChunkGraph} +* `chunk` {Chunk} +* `ignoreChunk` {Chunk} + +* Returns: {boolean} + +*** + +#### `isAccessibleInChunkGroup(chunkGraph, chunkGroup[, ignoreChunk])` + +##### Parameters + +* `chunkGraph` {ChunkGraph} +* `chunkGroup` {ChunkGroup} +* `ignoreChunk` {Chunk} + +* Returns: {boolean} + +*** + +#### `isEntryModule()` + +* Returns: {boolean} + +*** + +#### `isInChunk(chunk)` + +##### Parameters + +* `chunk` {Chunk} + +* Returns: {boolean} + +*** + +#### `isOptional(moduleGraph)` + +##### Parameters + +* `moduleGraph` {ModuleGraph} + +* Returns: {boolean} + +*** + +#### `isProvided(exportName)` + +##### Parameters + +* `exportName` {string} + +* Returns: {boolean} + +*** + +#### `libIdent(options)` + +##### Parameters + +* `options` {LibIdentOptions} + +* Returns: {string} + +*** + +#### `nameForCondition()` + +* Returns: {string} + +*** + +#### `needBuild(context, callback)` + +##### Parameters + +* `context` {NeedBuildContext} +* `callback` {Function} + * `err` {WebpackError} + * `needBuild` {boolean} + * Returns: {void} + +* Returns: {void} + +*** + +#### `needRebuild(fileTimestamps, contextTimestamps)` + +> Stability: 0 - Deprecated + +##### Parameters + +* `fileTimestamps` {Map} +* `contextTimestamps` {Map} + +* Returns: {boolean} + +Use needBuild instead + +*** + +#### `originalSource()` + +* Returns: {Source} + +*** + +#### `readableIdentifier(requestShortener)` + +##### Parameters + +* `requestShortener` {RequestShortener} + +* Returns: {string} + +*** + +#### `removeChunk(chunk)` + +##### Parameters + +* `chunk` {Chunk} + +* Returns: {void} + +*** + +#### `removeDependency(dependency)` + +##### Parameters + +* `dependency` {Dependency} + +* Returns: {void} + +*** + +#### `restoreFromUnsafeCache(unsafeCacheData, normalModuleFactory)` + +##### Parameters + +* `unsafeCacheData` {UnsafeCacheData} +* `normalModuleFactory` {NormalModuleFactory} + +* Returns: {void} + +restore unsafe cache data + +*** + +#### `serialize(__namedParameters)` + +##### Parameters + +* `__namedParameters` {ObjectSerializerContext} + +* Returns: {void} + +*** + +#### `size([type])` + +##### Parameters + +* `type` {string} + +* Returns: {number} + +*** + +#### `source(dependencyTemplates, runtimeTemplate[, type])` + +> Stability: 0 - Deprecated + +##### Parameters + +* `dependencyTemplates` {DependencyTemplates} +* `runtimeTemplate` {RuntimeTemplate} +* `type` {string} + +* Returns: {Source} + +Use codeGeneration() instead + +*** + +#### `updateCacheModule(module)` + +##### Parameters + +* `module` {Module} + +* Returns: {void} + +Assuming this module is in the cache. Update the (cached) module with +the fresh module from the factory. Usually updates internal references +and properties. + +*** + +#### `updateHash(hash, context)` + +##### Parameters + +* `hash` {Hash} +* `context` {UpdateHashContextDependency} + +* Returns: {void} + +*** + +#### Static method: `getCompilationHooks(compilation)` + +##### Parameters + +* `compilation` {Compilation} + +* Returns: {ExternalModuleHooks} + +*** + +#### Static method: `getSourceBasicTypes(module)` + +> Stability: 0 - Deprecated + +##### Parameters + +* `module` {Module} + +* Returns: {ReadonlySet} + +In webpack 6, call getSourceBasicTypes() directly on the module instance instead of using this static method. diff --git a/pages/v5.x/Externals.md b/pages/v5.x/Externals.md new file mode 100644 index 0000000..9603653 --- /dev/null +++ b/pages/v5.x/Externals.md @@ -0,0 +1,42 @@ +# Externals + + + +## `Externals` + +* Type: {string|RegExp|ExternalItemObjectKnown & ExternalItemObjectUnknown|Function|Function|ExternalItem[]} + +## Class: `ExternalsPlugin` + +### Constructors + +#### `new ExternalsPlugin(type, externals)` + +##### Parameters + +* `type` {"asset"|"module"|"css-import"|"css-url"|"global"|"import"|"commonjs"|"jsonp"|"promise"|"this"|"var"|"assign"|"window"|"self"|"commonjs2"|"commonjs-module"|"commonjs-static"|"amd"|"amd-require"|"umd"|"umd2"|"system"|"module-import"|"script"|"node-commonjs"|Function} +* `externals` {Externals} + +* Returns: {ExternalsPlugin} + +### Properties + +#### `externals` + +* Type: {Externals} + +#### `type` + +* Type: {"asset"|"module"|"css-import"|"css-url"|"global"|"import"|"commonjs"|"jsonp"|"promise"|"this"|"var"|"assign"|"window"|"self"|"commonjs2"|"commonjs-module"|"commonjs-static"|"amd"|"amd-require"|"umd"|"umd2"|"system"|"module-import"|"script"|"node-commonjs"|Function} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} + +Apply the plugin diff --git a/pages/v5.x/FileCacheOptions.md b/pages/v5.x/FileCacheOptions.md new file mode 100644 index 0000000..d261692 --- /dev/null +++ b/pages/v5.x/FileCacheOptions.md @@ -0,0 +1,171 @@ +# FileCacheOptions + + + +## `FileCacheOptions` + +Options object for persistent file-based caching. + +### Properties + +#### `allowCollectingMemory` + +* Type: {boolean} Optional. + +Allows to collect unused memory allocated during deserialization. This requires copying data into smaller buffers and has a performance cost. + +*** + +#### `buildDependencies` + +* Type: {object} Optional. + +Dependencies the build depends on (in multiple categories, default categories: 'defaultWebpack'). + +##### Index Signature + +\[`index`: {string}\]: {string[]} + +*** + +#### `cacheDirectory` + +* Type: {string} Optional. + +Base directory for the cache (defaults to node_modules/.cache/webpack). + +*** + +#### `cacheLocation` + +* Type: {string} Optional. + +Locations for the cache (defaults to cacheDirectory / name). + +*** + +#### `compression` + +* Type: {false|"gzip"|"brotli"} Optional. + +Compression type used for the cache files. + +*** + +#### `hashAlgorithm` + +* Type: {string} Optional. + +Algorithm used for generation the hash (see node.js crypto package). + +*** + +#### `idleTimeout` + +* Type: {number} Optional. + +Time in ms after which idle period the cache storing should happen. + +*** + +#### `idleTimeoutAfterLargeChanges` + +* Type: {number} Optional. + +Time in ms after which idle period the cache storing should happen when larger changes has been detected (cumulative build time > 2 x avg cache store time). + +*** + +#### `idleTimeoutForInitialStore` + +* Type: {number} Optional. + +Time in ms after which idle period the initial cache storing should happen. + +*** + +#### `immutablePaths` + +* Type: {string|RegExp[]} Optional. + +List of paths that are managed by a package manager and contain a version or hash in its path so all files are immutable. + +*** + +#### `managedPaths` + +* Type: {string|RegExp[]} Optional. + +List of paths that are managed by a package manager and can be trusted to not be modified otherwise. + +*** + +#### `maxAge` + +* Type: {number} Optional. + +Time for which unused cache entries stay in the filesystem cache at minimum (in milliseconds). + +*** + +#### `maxMemoryGenerations` + +* Type: {number} Optional. + +Number of generations unused cache entries stay in memory cache at minimum (0 = no memory cache used, 1 = may be removed after unused for a single compilation, ..., Infinity: kept forever). Cache entries will be deserialized from disk when removed from memory cache. + +*** + +#### `memoryCacheUnaffected` + +* Type: {boolean} Optional. + +Additionally cache computation of modules that are unchanged and reference only unchanged modules in memory. + +*** + +#### `name` + +* Type: {string} Optional. + +Name for the cache. Different names will lead to different coexisting caches. + +*** + +#### `profile` + +* Type: {boolean} Optional. + +Track and log detailed timing information for individual cache items. + +*** + +#### `readonly` + +* Type: {boolean} Optional. + +Enable/disable readonly mode. + +*** + +#### `store` + +* Type: {"pack"} Optional. + +When to store data to the filesystem. (pack: Store data when compiler is idle in a single file). + +*** + +#### `type` + +* Type: {"filesystem"} + +Filesystem caching. + +*** + +#### `version` + +* Type: {string} Optional. + +Version of the cache data. Different versions won't allow to reuse the cache and override existing content. Update the version when config changed in a way which doesn't allow to reuse cache. This will invalidate the cache. diff --git a/pages/v5.x/Generator.md b/pages/v5.x/Generator.md new file mode 100644 index 0000000..c528ecc --- /dev/null +++ b/pages/v5.x/Generator.md @@ -0,0 +1,165 @@ +# Generator + + + +## Class: `Generator` + +### Constructors + +#### `new Generator()` + +* Returns: {Generator} + +### Methods + +#### `generate(module, __namedParameters)` + +##### Parameters + +* `module` {NormalModule} +* `__namedParameters` {GenerateContext} + +* Returns: {Source} + +*** + +#### `getConcatenationBailoutReason(module, context)` + +##### Parameters + +* `module` {NormalModule} +* `context` {ConcatenationBailoutReasonContext} + +* Returns: {string} + +*** + +#### `getSize(module[, type])` + +##### Parameters + +* `module` {NormalModule} +* `type` {string} + +* Returns: {number} + +*** + +#### `getTypes(module)` + +##### Parameters + +* `module` {NormalModule} + +* Returns: {ReadonlySet} + +*** + +#### `updateHash(hash, __namedParameters)` + +##### Parameters + +* `hash` {Hash} +* `__namedParameters` {UpdateHashContextGenerator} + +* Returns: {void} + +*** + +#### Static method: `byType(map)` + +##### Parameters + +* `map` {object} + +* Returns: {ByTypeGenerator} + +## `GeneratorOptionsByModuleTypeKnown` + +Specify options for each generator. + +### Properties + +#### `asset` + +* Type: {AssetGeneratorOptions} Optional. + +Generator options for asset modules. + +#### `asset/bytes` + +* Type: {EmptyGeneratorOptions} Optional. + +No generator options are supported for this module type. + +#### `asset/inline` + +* Type: {AssetInlineGeneratorOptions} Optional. + +Generator options for asset/inline modules. + +#### `asset/resource` + +* Type: {AssetResourceGeneratorOptions} Optional. + +Generator options for asset/resource modules. + +#### `asset/source` + +* Type: {EmptyGeneratorOptions} Optional. + +No generator options are supported for this module type. + +#### `css` + +* Type: {CssGeneratorOptions} Optional. + +Generator options for css modules. + +#### `css/auto` + +* Type: {CssModuleGeneratorOptions} Optional. + +Generator options for css/module modules. + +#### `css/global` + +* Type: {CssModuleGeneratorOptions} Optional. + +Generator options for css/module modules. + +#### `css/module` + +* Type: {CssModuleGeneratorOptions} Optional. + +Generator options for css/module modules. + +#### `javascript` + +* Type: {EmptyGeneratorOptions} Optional. + +No generator options are supported for this module type. + +#### `javascript/auto` + +* Type: {EmptyGeneratorOptions} Optional. + +No generator options are supported for this module type. + +#### `javascript/dynamic` + +* Type: {EmptyGeneratorOptions} Optional. + +No generator options are supported for this module type. + +#### `javascript/esm` + +* Type: {EmptyGeneratorOptions} Optional. + +No generator options are supported for this module type. + +#### `json` + +* Type: {JsonGeneratorOptions} Optional. + +Generator options for json modules. diff --git a/pages/v5.x/HASH.md b/pages/v5.x/HASH.md new file mode 100644 index 0000000..5f6a0df --- /dev/null +++ b/pages/v5.x/HASH.md @@ -0,0 +1,7 @@ +# HASH + + + +## `HASH` + +* Type: {string} diff --git a/pages/v5.x/HashedModule.md b/pages/v5.x/HashedModule.md new file mode 100644 index 0000000..04d5a9c --- /dev/null +++ b/pages/v5.x/HashedModule.md @@ -0,0 +1,67 @@ +# HashedModule + + + +## `HashedModuleIdsPluginOptions` + +### Properties + +#### `context` + +* Type: {string} Optional. + +The context directory for creating names. + +*** + +#### `hashDigest` + +* Type: {"ascii"|"utf8"|"utf-8"|"utf16le"|"utf-16le"|"ucs2"|"ucs-2"|"base64"|"base64url"|"latin1"|"binary"|"hex"} Optional. + +The encoding to use when generating the hash, defaults to 'base64'. All encodings from Node.JS' hash.digest are supported. + +*** + +#### `hashDigestLength` + +* Type: {number} Optional. + +The prefix length of the hash digest to use, defaults to 4. + +*** + +#### `hashFunction` + +* Type: {HashFunction} Optional. + +The hashing algorithm to use, defaults to 'md4'. All functions from Node.JS' crypto.createHash are supported. + +## Class: `HashedModuleIdsPlugin` + +### Constructors + +#### `new HashedModuleIdsPlugin([options])` + +##### Parameters + +* `options` {HashedModuleIdsPluginOptions} + +* Returns: {HashedModuleIdsPlugin} + +### Properties + +#### `options` + +* Type: {HashedModuleIdsPluginOptions} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} + +Apply the plugin diff --git a/pages/v5.x/HotModuleReplacementPlugin.md b/pages/v5.x/HotModuleReplacementPlugin.md new file mode 100644 index 0000000..f3afd6b --- /dev/null +++ b/pages/v5.x/HotModuleReplacementPlugin.md @@ -0,0 +1,33 @@ +# HotModuleReplacementPlugin + + + +## Class: `HotModuleReplacementPlugin` + +### Constructors + +#### `new HotModuleReplacementPlugin()` + +* Returns: {HotModuleReplacementPlugin} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} + +Apply the plugin + +*** + +#### Static method: `getParserHooks(parser)` + +##### Parameters + +* `parser` {JavascriptParser} + +* Returns: {HMRJavascriptParserHooks} diff --git a/pages/v5.x/HotUpdateChunk.md b/pages/v5.x/HotUpdateChunk.md new file mode 100644 index 0000000..f7bf8ae --- /dev/null +++ b/pages/v5.x/HotUpdateChunk.md @@ -0,0 +1,556 @@ +# HotUpdateChunk + + + +## Class: `HotUpdateChunk` + +* Extends: {Chunk} + +### Constructors + +#### `new HotUpdateChunk()` + +* Returns: {HotUpdateChunk} + +### Properties + +#### `auxiliaryFiles` + +* Type: {Set} + +##### Inherited from + +[`Chunk`](Chunk.md).[`auxiliaryFiles`](Chunk.md#auxiliaryfiles) + +*** + +#### `chunkReason` + +* Type: {string} Optional. + +##### Inherited from + +[`Chunk`](Chunk.md).[`chunkReason`](Chunk.md#chunkreason) + +*** + +#### `contentHash` + +* Type: {Record} + +##### Inherited from + +[`Chunk`](Chunk.md).[`contentHash`](Chunk.md#contenthash) + +*** + +#### `cssFilenameTemplate` + +* Type: {string|Function} Optional. + +##### Inherited from + +[`Chunk`](Chunk.md).[`cssFilenameTemplate`](Chunk.md#cssfilenametemplate) + +*** + +#### `debugId` + +* Type: {number} + +##### Inherited from + +[`Chunk`](Chunk.md).[`debugId`](Chunk.md#debugid) + +*** + +#### `entryModule` + +* Type: {Module} + +##### Deprecated + +##### Inherited from + +[`Chunk`](Chunk.md).[`entryModule`](Chunk.md#entrymodule) + +*** + +#### `extraAsync` + +* Type: {boolean} + +##### Inherited from + +[`Chunk`](Chunk.md).[`extraAsync`](Chunk.md#extraasync) + +*** + +#### `filenameTemplate` + +* Type: {string|Function} Optional. + +##### Inherited from + +[`Chunk`](Chunk.md).[`filenameTemplate`](Chunk.md#filenametemplate) + +*** + +#### `files` + +* Type: {Set} + +##### Inherited from + +[`Chunk`](Chunk.md).[`files`](Chunk.md#files) + +*** + +#### `groupsIterable` + +* Type: {SortableSet} + +##### Inherited from + +[`Chunk`](Chunk.md).[`groupsIterable`](Chunk.md#groupsiterable) + +*** + +#### `hash` + +* Type: {string} Optional. + +##### Inherited from + +[`Chunk`](Chunk.md).[`hash`](Chunk.md#hash) + +*** + +#### `id` + +* Type: {string|number} + +##### Inherited from + +[`Chunk`](Chunk.md).[`id`](Chunk.md#id) + +*** + +#### `idNameHints` + +* Type: {SortableSet} + +##### Inherited from + +[`Chunk`](Chunk.md).[`idNameHints`](Chunk.md#idnamehints) + +*** + +#### `ids` + +* Type: {ChunkId[]} + +##### Inherited from + +[`Chunk`](Chunk.md).[`ids`](Chunk.md#ids) + +*** + +#### `modulesIterable` + +* Type: {Iterable} + +##### Inherited from + +[`Chunk`](Chunk.md).[`modulesIterable`](Chunk.md#modulesiterable) + +*** + +#### `name` + +* Type: {string} Optional. + +##### Inherited from + +[`Chunk`](Chunk.md).[`name`](Chunk.md#name) + +*** + +#### `preventIntegration` + +* Type: {boolean} + +##### Inherited from + +[`Chunk`](Chunk.md).[`preventIntegration`](Chunk.md#preventintegration) + +*** + +#### `rendered` + +* Type: {boolean} + +##### Inherited from + +[`Chunk`](Chunk.md).[`rendered`](Chunk.md#rendered) + +*** + +#### `renderedHash` + +* Type: {string} Optional. + +##### Inherited from + +[`Chunk`](Chunk.md).[`renderedHash`](Chunk.md#renderedhash) + +*** + +#### `runtime` + +* Type: {RuntimeSpec} + +##### Inherited from + +[`Chunk`](Chunk.md).[`runtime`](Chunk.md#runtime) + +### Methods + +#### `addGroup(chunkGroup)` + +##### Parameters + +* `chunkGroup` {ChunkGroup} + +* Returns: {void} + +*** + +#### `addModule(module)` + +##### Parameters + +* `module` {Module} + +* Returns: {boolean} + +*** + +#### `canBeInitial()` + +* Returns: {boolean} + +*** + +#### `canBeIntegrated(otherChunk)` + +##### Parameters + +* `otherChunk` {Chunk} + +* Returns: {boolean} + +*** + +#### `compareTo(otherChunk)` + +##### Parameters + +* `otherChunk` {Chunk} + +* Returns: {-1|0|1} + +*** + +#### `containsModule(module)` + +##### Parameters + +* `module` {Module} + +* Returns: {boolean} + +*** + +#### `disconnectFromGroups()` + +* Returns: {void} + +*** + +#### `getAllAsyncChunks()` + +* Returns: {Set} + +*** + +#### `getAllInitialChunks()` + +* Returns: {Set} + +*** + +#### `getAllReferencedAsyncEntrypoints()` + +* Returns: {Set} + +*** + +#### `getAllReferencedChunks()` + +* Returns: {Set} + +*** + +#### `getChildIdsByOrders(chunkGraph[, filterFn])` + +##### Parameters + +* `chunkGraph` {ChunkGraph} +* `filterFn` {Function} + * `c` {Chunk} + * `chunkGraph` {ChunkGraph} + * Returns: {boolean} + +* Returns: {Record} + +*** + +#### `getChildIdsByOrdersMap(chunkGraph[, includeDirectChildren][, filterFn])` + +##### Parameters + +* `chunkGraph` {ChunkGraph} +* `includeDirectChildren` {boolean} +* `filterFn` {Function} + * `c` {Chunk} + * `chunkGraph` {ChunkGraph} + * Returns: {boolean} + +* Returns: {ChunkChildIdsByOrdersMapByData} + +*** + +#### `getChildrenOfTypeInOrder(chunkGraph, type)` + +##### Parameters + +* `chunkGraph` {ChunkGraph} +* `type` {string} + +* Returns: {ChunkChildOfTypeInOrder[]} + +*** + +#### `getChunkMaps(realHash)` + +> Stability: 0 - Deprecated + +##### Parameters + +* `realHash` {boolean} + +* Returns: {ChunkMaps} + +*** + +#### `getChunkModuleMaps(filterFn)` + +##### Parameters + +* `filterFn` {Function} + * `m` {Module} + * Returns: {boolean} + +* Returns: {ChunkModuleMaps} + +*** + +#### `getEntryOptions()` + +* Returns: {EntryOptions} + +*** + +#### `getModules()` + +* Returns: {Module[]} + +*** + +#### `getNumberOfGroups()` + +* Returns: {number} + +*** + +#### `getNumberOfModules()` + +* Returns: {number} + +*** + +#### `hasAsyncChunks()` + +* Returns: {boolean} + +*** + +#### `hasChildByOrder(chunkGraph, type[, includeDirectChildren][, filterFn])` + +##### Parameters + +* `chunkGraph` {ChunkGraph} +* `type` {string} +* `includeDirectChildren` {boolean} +* `filterFn` {Function} + * `c` {Chunk} + * `chunkGraph` {ChunkGraph} + * Returns: {boolean} + +* Returns: {boolean} + +*** + +#### `hasEntryModule()` + +* Returns: {boolean} + +*** + +#### `hasModuleInGraph(filterFn[, filterChunkFn])` + +##### Parameters + +* `filterFn` {Function} + * `m` {Module} + * Returns: {boolean} +* `filterChunkFn` {Function} + * `c` {Chunk} + * `chunkGraph` {ChunkGraph} + * Returns: {boolean} + +* Returns: {boolean} + +*** + +#### `hasRuntime()` + +* Returns: {boolean} + +*** + +#### `integrate(otherChunk)` + +##### Parameters + +* `otherChunk` {Chunk} + +* Returns: {boolean} + +*** + +#### `integratedSize(otherChunk, options)` + +##### Parameters + +* `otherChunk` {Chunk} +* `options` {ChunkSizeOptions} + +* Returns: {number} + +*** + +#### `isEmpty()` + +* Returns: {boolean} + +*** + +#### `isInGroup(chunkGroup)` + +##### Parameters + +* `chunkGroup` {ChunkGroup} + +* Returns: {boolean} + +*** + +#### `isOnlyInitial()` + +* Returns: {boolean} + +*** + +#### `modulesSize()` + +* Returns: {number} + +*** + +#### `moveModule(module, otherChunk)` + +##### Parameters + +* `module` {Module} +* `otherChunk` {Chunk} + +* Returns: {void} + +*** + +#### `remove()` + +* Returns: {void} + +*** + +#### `removeGroup(chunkGroup)` + +##### Parameters + +* `chunkGroup` {ChunkGroup} + +* Returns: {void} + +*** + +#### `removeModule(module)` + +##### Parameters + +* `module` {Module} + +* Returns: {void} + +*** + +#### `size([options])` + +##### Parameters + +* `options` {ChunkSizeOptions} + +* Returns: {number} + +*** + +#### `split(newChunk)` + +##### Parameters + +* `newChunk` {Chunk} + +* Returns: {void} + +*** + +#### `updateHash(hash, chunkGraph)` + +##### Parameters + +* `hash` {Hash} +* `chunkGraph` {ChunkGraph} + +* Returns: {void} diff --git a/pages/v5.x/ID.md b/pages/v5.x/ID.md new file mode 100644 index 0000000..8a2a065 --- /dev/null +++ b/pages/v5.x/ID.md @@ -0,0 +1,7 @@ +# ID + + + +## `ID` + +* Type: {string} diff --git a/pages/v5.x/IgnorePlugin.md b/pages/v5.x/IgnorePlugin.md new file mode 100644 index 0000000..5e95202 --- /dev/null +++ b/pages/v5.x/IgnorePlugin.md @@ -0,0 +1,66 @@ +# IgnorePlugin + + + +## Class: `IgnorePlugin` + +### Constructors + +#### `new IgnorePlugin(options)` + +##### Parameters + +* `options` {IgnorePluginOptions} + +* Returns: {IgnorePlugin} + +### Properties + +#### `options` + +* Type: {IgnorePluginOptions} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} + +Apply the plugin + +*** + +#### `checkIgnore(resolveData)` + +##### Parameters + +* `resolveData` {BeforeContextResolveData|ResolveData} + +* Returns: {false} + +Note that if "contextRegExp" is given, both the "resourceRegExp" and "contextRegExp" have to match. + +## `IgnorePluginOptions` + +* Type: {object|object} + +### Union Members + +#### Type Literal + +{object} + +* `contextRegExp` {RegExp} A RegExp to test the context (directory) against. +* `resourceRegExp` {RegExp} A RegExp to test the request against. + +*** + +#### Type Literal + +{object} + +* `checkResource` {CheckResourceFn} A filter function for resource and context. diff --git a/pages/v5.x/InitFragment.md b/pages/v5.x/InitFragment.md new file mode 100644 index 0000000..fc46b16 --- /dev/null +++ b/pages/v5.x/InitFragment.md @@ -0,0 +1,145 @@ +# InitFragment + + + +## Class: `InitFragment` + +### Type Parameters + +### Constructors + +#### `new InitFragment(content, stage, position[, key][, endContent])` + +##### Parameters + +* `content` {string|Source} +* `stage` {number} +* `position` {number} +* `key` {string} +* `endContent` {string|Source} + +* Returns: {InitFragment} + +### Properties + +#### `content` + +* Type: {string|Source} Optional. + +*** + +#### `endContent` + +* Type: {string|Source} Optional. + +*** + +#### `key` + +* Type: {string} Optional. + +*** + +#### `position` + +* Type: {number} + +*** + +#### `stage` + +* Type: {number} + +*** + +#### `STAGE_ASYNC_BOUNDARY` + +* Type: {number} + +*** + +#### `STAGE_ASYNC_DEPENDENCIES` + +* Type: {number} + +*** + +#### `STAGE_ASYNC_HARMONY_IMPORTS` + +* Type: {number} + +*** + +#### `STAGE_CONSTANTS` + +* Type: {number} + +*** + +#### `STAGE_HARMONY_EXPORTS` + +* Type: {number} + +*** + +#### `STAGE_HARMONY_IMPORTS` + +* Type: {number} + +*** + +#### `STAGE_PROVIDES` + +* Type: {number} + +### Methods + +#### `deserialize(context)` + +##### Parameters + +* `context` {ObjectDeserializerContext} + +* Returns: {void} + +*** + +#### `getContent(context)` + +##### Parameters + +* `context` {GenerateContext} + +* Returns: {string|Source} + +*** + +#### `getEndContent(context)` + +##### Parameters + +* `context` {GenerateContext} + +* Returns: {string|Source} + +*** + +#### `serialize(context)` + +##### Parameters + +* `context` {ObjectSerializerContext} + +* Returns: {void} + +*** + +#### Static method: `addToSource(source, initFragments, context)` + +##### Parameters + +* `source` {Source} +* `initFragments` {MaybeMergeableInitFragment[]} +* `context` {Context} + +* Returns: {Source} diff --git a/pages/v5.x/InputFileSystem.md b/pages/v5.x/InputFileSystem.md new file mode 100644 index 0000000..ff17a50 --- /dev/null +++ b/pages/v5.x/InputFileSystem.md @@ -0,0 +1,155 @@ +# InputFileSystem + + + +## `InputFileSystem` + +### Properties + +#### `dirname` + +* Type: {Function} Optional. + +##### Parameters + +* `dirname` {string} + +* Returns: {string} + +*** + +#### `join` + +* Type: {Function} Optional. + +##### Parameters + +* `path1` {string} +* `path2` {string} + +* Returns: {string} + +*** + +#### `lstat` + +* Type: {LStatFs} Optional. + +*** + +#### `lstatSync` + +* Type: {LStatSync} Optional. + +*** + +#### `purge` + +* Type: {Function} Optional. + +##### Parameters + +* `value` {string|string[]|Set} + +* Returns: {void} + +*** + +#### `readdir` + +* Type: {ReaddirFs} + +*** + +#### `readdirSync` + +* Type: {ReaddirSync} Optional. + +*** + +#### `readFile` + +* Type: {ReadFileFs} + +*** + +#### `readFileSync` + +* Type: {ReadFileSync} Optional. + +*** + +#### `readJson` + +* Type: {Function} Optional. + +##### Parameters + +* `pathOrFileDescriptor` {PathOrFileDescriptorFs} +* `callback` {Function} + * `err` {Error|ErrnoException} + * `result` {JsonObjectFs} + * Returns: {void} + +* Returns: {void} + +*** + +#### `readJsonSync` + +* Type: {Function} Optional. + +##### Parameters + +* `pathOrFileDescriptor` {PathOrFileDescriptorFs} + +* Returns: {JsonObjectFs} + +*** + +#### `readlink` + +* Type: {ReadlinkFs} + +*** + +#### `readlinkSync` + +* Type: {ReadlinkSync} Optional. + +*** + +#### `realpath` + +* Type: {RealPathFs} Optional. + +*** + +#### `realpathSync` + +* Type: {RealPathSync} Optional. + +*** + +#### `relative` + +* Type: {Function} Optional. + +##### Parameters + +* `from` {string} +* `to` {string} + +* Returns: {string} + +*** + +#### `stat` + +* Type: {StatFs} + +*** + +#### `statSync` + +* Type: {StatSync} Optional. diff --git a/pages/v5.x/JsonModules.md b/pages/v5.x/JsonModules.md new file mode 100644 index 0000000..aa0fd39 --- /dev/null +++ b/pages/v5.x/JsonModules.md @@ -0,0 +1,45 @@ +# JsonModules + + + +## `JsonModulesPluginParserOptions` + +### Properties + +#### `exportsDepth` + +* Type: {number} Optional. + +The depth of json dependency flagged as `exportInfo`. + +*** + +#### `namedExports` + +* Type: {boolean} Optional. + +Allow named exports for json of object type + +*** + +#### `parse` + +* Type: {Function} Optional. + +Function that executes for a module source string and should return json-compatible data. + +##### Parameters + +* `input` {string} + +* Returns: {any} + +## `JsonModulesPluginGeneratorOptions` + +### Properties + +#### `JSONParse` + +* Type: {boolean} Optional. + +Use `JSON.parse` when the JSON string is longer than 20 characters. diff --git a/pages/v5.x/LOADERS.md b/pages/v5.x/LOADERS.md new file mode 100644 index 0000000..4156ce8 --- /dev/null +++ b/pages/v5.x/LOADERS.md @@ -0,0 +1,7 @@ +# LOADERS + + + +## `LOADERS` + +* Type: {string} diff --git a/pages/v5.x/LibManifestPlugin.md b/pages/v5.x/LibManifestPlugin.md new file mode 100644 index 0000000..10a72a7 --- /dev/null +++ b/pages/v5.x/LibManifestPlugin.md @@ -0,0 +1,33 @@ +# LibManifestPlugin + + + +## Class: `LibManifestPlugin` + +### Constructors + +#### `new LibManifestPlugin(options)` + +##### Parameters + +* `options` {LibManifestPluginOptions} + +* Returns: {LibManifestPlugin} + +### Properties + +#### `options` + +* Type: {LibManifestPluginOptions} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} + +Apply the plugin diff --git a/pages/v5.x/LibraryOptions.md b/pages/v5.x/LibraryOptions.md new file mode 100644 index 0000000..4459cc9 --- /dev/null +++ b/pages/v5.x/LibraryOptions.md @@ -0,0 +1,55 @@ +# LibraryOptions + + + +## `LibraryOptions` + +Options for library. + +### Properties + +#### `amdContainer` + +* Type: {string} Optional. + +Add a container for define/require functions in the AMD module. + +*** + +#### `auxiliaryComment` + +* Type: {string|LibraryCustomUmdCommentObject} Optional. + +Add a comment in the UMD wrapper. + +*** + +#### `export` + +* Type: {string|string[]} Optional. + +Specify which export should be exposed as library. + +*** + +#### `name` + +* Type: {string|string[]|LibraryCustomUmdObject} Optional. + +The name of the library (some types allow unnamed libraries too). + +*** + +#### `type` + +* Type: {string} + +Type of library (types included by default are 'var', 'module', 'assign', 'assign-properties', 'this', 'window', 'self', 'global', 'commonjs', 'commonjs2', 'commonjs-module', 'commonjs-static', 'amd', 'amd-require', 'umd', 'umd2', 'jsonp', 'system', but others might be added by plugins). + +*** + +#### `umdNamedDefine` + +* Type: {boolean} Optional. + +If `output.libraryTarget` is set to umd and `output.library` is set, setting this to true will name the AMD module. diff --git a/pages/v5.x/LibraryTemplatePlugin.md b/pages/v5.x/LibraryTemplatePlugin.md new file mode 100644 index 0000000..c83904f --- /dev/null +++ b/pages/v5.x/LibraryTemplatePlugin.md @@ -0,0 +1,43 @@ +# LibraryTemplatePlugin + + + +## Class: `LibraryTemplatePlugin` + +### Constructors + +#### `new LibraryTemplatePlugin(name, target, umdNamedDefine, auxiliaryComment, exportProperty)` + +##### Parameters + +* `name` {LibraryName} +* `target` {string} +* `umdNamedDefine` {boolean} +* `auxiliaryComment` {AuxiliaryComment} +* `exportProperty` {LibraryExport} + +* Returns: {LibraryTemplatePlugin} + +### Properties + +#### `library` + +* Type: {object} + +* `auxiliaryComment` {AuxiliaryComment} +* `export` {LibraryExport} +* `name` {LibraryName} +* `type` {string} +* `umdNamedDefine` {boolean} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} + +Apply the plugin diff --git a/pages/v5.x/LimitChunk.md b/pages/v5.x/LimitChunk.md new file mode 100644 index 0000000..32f5b91 --- /dev/null +++ b/pages/v5.x/LimitChunk.md @@ -0,0 +1,57 @@ +# LimitChunk + + + +## `LimitChunkCountPluginOptions` + +### Properties + +#### `chunkOverhead` + +* Type: {number} Optional. + +Constant overhead for a chunk. + +*** + +#### `entryChunkMultiplicator` + +* Type: {number} Optional. + +Multiplicator for initial chunks. + +*** + +#### `maxChunks` + +* Type: {number} + +Limit the maximum number of chunks using a value greater than or equal to 1. + +## Class: `LimitChunkCountPlugin` + +### Constructors + +#### `new LimitChunkCountPlugin([options])` + +##### Parameters + +* `options` {LimitChunkCountPluginOptions} + +* Returns: {LimitChunkCountPlugin} + +### Properties + +#### `options` + +* Type: {LimitChunkCountPluginOptions} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} diff --git a/pages/v5.x/Loader.md b/pages/v5.x/Loader.md new file mode 100644 index 0000000..a64f1f8 --- /dev/null +++ b/pages/v5.x/Loader.md @@ -0,0 +1,147 @@ +# Loader + + + +## `LoaderModule` + +### Type Parameters + +### Properties + +#### `default` + +* Type: {RawLoaderDefinitionFunction|LoaderDefinitionFunction} Optional. + +*** + +#### `pitch` + +* Type: {PitchLoaderDefinitionFunction} Optional. + +*** + +#### `raw` + +* Type: {false} Optional. + +## Class: `LoaderOptionsPlugin` + +### Constructors + +#### `new LoaderOptionsPlugin([options])` + +##### Parameters + +* `options` {LoaderOptionsPluginOptions & MatchObject} + +* Returns: {LoaderOptionsPlugin} + +### Properties + +#### `options` + +* Type: {LoaderOptionsPluginOptions & MatchObject} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} + +Apply the plugin + +## Class: `LoaderTargetPlugin` + +### Constructors + +#### `new LoaderTargetPlugin(target)` + +##### Parameters + +* `target` {string} + +* Returns: {LoaderTargetPlugin} + +### Properties + +#### `target` + +* Type: {string} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} + +Apply the plugin + +## `LoaderDefinitionFunction(this, content[, sourceMap][, additionalData])` + +### Type Parameters + +### Parameters + +* `this` {NormalModuleLoaderContext & LoaderRunnerLoaderContext & LoaderPluginLoaderContext & HotModuleReplacementPluginLoaderContext & ContextAdditions} +* `content` {string} +* `sourceMap` {string|RawSourceMap} +* `additionalData` {AdditionalData} + +* Returns: {string|void|Buffer|Promise>} + +## `LoaderOptionsPluginOptions` + +### Indexable + +> \[`k`: {string}\]: {any} + +### Properties + +#### `debug` + +* Type: {boolean} Optional. + +Whether loaders should be in debug mode or not. debug will be removed as of webpack 3. + +#### `minimize` + +* Type: {boolean} Optional. + +Where loaders can be switched to minimize mode. + +#### `options` + +* Type: {object} Optional. + +A configuration object that can be used to configure older loaders. + +##### Index Signature + +\[`k`: {string}\]: {any} + +* `context` {string} The context that can be used to configure older loaders. + +## `LoaderContext` + +* Type: {NormalModuleLoaderContext & LoaderRunnerLoaderContext & LoaderPluginLoaderContext & HotModuleReplacementPluginLoaderContext} + +### Type Parameters + +## `LoaderDefinition` + +* Type: {LoaderDefinitionFunction & object} + +### Type Declaration + +* `pitch` {PitchLoaderDefinitionFunction} +* `raw` {false} + +### Type Parameters diff --git a/pages/v5.x/ManifestPlugin.md b/pages/v5.x/ManifestPlugin.md new file mode 100644 index 0000000..1e71627 --- /dev/null +++ b/pages/v5.x/ManifestPlugin.md @@ -0,0 +1,73 @@ +# ManifestPlugin + + + +## Class: `ManifestPlugin` + +### Constructors + +#### `new ManifestPlugin([options])` + +##### Parameters + +* `options` {ManifestPluginOptions} + +* Returns: {ManifestPlugin} + +### Properties + +#### `options` + +* Type: {ManifestPluginOptions} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} + +Apply the plugin + +## `ManifestPluginOptions` + +### Properties + +#### `entrypoints` + +* Type: {boolean} Optional. + +Enables/disables generation of the entrypoints manifest section. + +#### `filename` + +* Type: {string} Optional. + +Specifies the filename of the output file on disk. By default the plugin will emit `manifest.json` inside the 'output.path' directory. + +#### `filter` + +* Type: {Filter} Optional. + +Allows filtering the files which make up the manifest. + +#### `generate` + +* Type: {Generate} Optional. + +A function that receives the manifest object, modifies it, and returns the modified manifest. + +#### `prefix` + +* Type: {string} Optional. + +Specifies a path prefix for all keys in the manifest. + +#### `serialize` + +* Type: {Serialize} Optional. + +A function that receives the manifest object and returns the manifest string. diff --git a/pages/v5.x/MemoryCache.md b/pages/v5.x/MemoryCache.md new file mode 100644 index 0000000..a3b9218 --- /dev/null +++ b/pages/v5.x/MemoryCache.md @@ -0,0 +1,51 @@ +# MemoryCache + + + +## `MemoryCacheOptions` + +Options object for in-memory caching. + +### Properties + +#### `cacheUnaffected` + +* Type: {boolean} Optional. + +Additionally cache computation of modules that are unchanged and reference only unchanged modules. + +*** + +#### `maxGenerations` + +* Type: {number} Optional. + +Number of generations unused cache entries stay in memory cache at minimum (1 = may be removed after unused for a single compilation, ..., Infinity: kept forever). + +*** + +#### `type` + +* Type: {"memory"} + +In memory caching. + +## Class: `MemoryCachePlugin` + +### Constructors + +#### `new MemoryCachePlugin()` + +* Returns: {MemoryCachePlugin} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} + +Apply the plugin diff --git a/pages/v5.x/MergeDuplicate.md b/pages/v5.x/MergeDuplicate.md new file mode 100644 index 0000000..fb5c93c --- /dev/null +++ b/pages/v5.x/MergeDuplicate.md @@ -0,0 +1,41 @@ +# MergeDuplicate + + + +## `MergeDuplicateChunksPluginOptions` + +### Properties + +#### `stage` + +* Type: {number} Optional. + +Specifies the stage for merging duplicate chunks. + +## Class: `MergeDuplicateChunksPlugin` + +### Constructors + +#### `new MergeDuplicateChunksPlugin([options])` + +##### Parameters + +* `options` {MergeDuplicateChunksPluginOptions} + +* Returns: {MergeDuplicateChunksPlugin} + +### Properties + +#### `options` + +* Type: {MergeDuplicateChunksPluginOptions} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} diff --git a/pages/v5.x/MinChunk.md b/pages/v5.x/MinChunk.md new file mode 100644 index 0000000..46e8950 --- /dev/null +++ b/pages/v5.x/MinChunk.md @@ -0,0 +1,59 @@ +# MinChunk + + + +## `MinChunkSizePluginOptions` + +### Properties + +#### `chunkOverhead` + +* Type: {number} Optional. + +Constant overhead for a chunk. + +*** + +#### `entryChunkMultiplicator` + +* Type: {number} Optional. + +Multiplicator for initial chunks. + +*** + +#### `minChunkSize` + +* Type: {number} + +Minimum number of characters. + +## Class: `MinChunkSizePlugin` + +### Constructors + +#### `new MinChunkSizePlugin(options)` + +##### Parameters + +* `options` {MinChunkSizePluginOptions} + +* Returns: {MinChunkSizePlugin} + +### Properties + +#### `options` + +* Type: {MinChunkSizePluginOptions} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} + +Apply the plugin diff --git a/pages/v5.x/Module.md b/pages/v5.x/Module.md new file mode 100644 index 0000000..c3bb4fe --- /dev/null +++ b/pages/v5.x/Module.md @@ -0,0 +1,3235 @@ +# Module + + + +## Class: `Module` + +* Extends: {DependenciesBlock} + +### Constructors + +#### `new Module(type[, context][, layer])` + +##### Parameters + +* `type` {string} +* `context` {string} +* `layer` {string} + +* Returns: {Module} + +### Properties + +#### `blocks` + +* Type: {AsyncDependenciesBlock[]} + +##### Inherited from + +`DependenciesBlock.blocks` + +*** + +#### `buildInfo` + +* Type: {BuildInfo} Optional. + +*** + +#### `buildMeta` + +* Type: {BuildMeta} Optional. + +*** + +#### `chunksIterable` + +* Type: {Iterable} + +*** + +#### `codeGenerationDependencies` + +* Type: {Dependency[]} Optional. + +*** + +#### `context` + +* Type: {string} + +*** + +#### `debugId` + +* Type: {number} + +*** + +#### `dependencies` + +* Type: {Dependency[]} + +##### Inherited from + +`DependenciesBlock.dependencies` + +*** + +#### `depth` + +* Type: {number} + +*** + +#### `errors` + +* Type: {any} + +*** + +#### `exportsArgument` + +* Type: {string} + +*** + +#### `factoryMeta` + +* Type: {FactoryMeta} Optional. + +*** + +#### `hasEqualsChunks` + +* Type: {any} + +*** + +#### `hash` + +* Type: {string} + +*** + +#### `hot` + +* Type: {boolean} + +*** + +#### `id` + +* Type: {string|number} + +##### Deprecated + +*** + +#### `index` + +* Type: {number} + +*** + +#### `index2` + +* Type: {number} + +*** + +#### `issuer` + +* Type: {Module} Optional. + +*** + +#### `isUsed` + +* Type: {any} + +*** + +#### `layer` + +* Type: {string} + +*** + +#### `moduleArgument` + +* Type: {string} + +*** + +#### `needId` + +* Type: {boolean} + +*** + +#### `optimizationBailout` + +* Type: {string|Function[]} + +##### Deprecated + +*** + +#### `optional` + +* Type: {boolean} + +*** + +#### `parent` + +* Type: {DependenciesBlock} Optional. + +##### Inherited from + +`DependenciesBlock.parent` + +*** + +#### `presentationalDependencies` + +* Type: {Dependency[]} Optional. + +*** + +#### `profile` + +* Type: {ModuleProfile} Optional. + +*** + +#### `renderedHash` + +* Type: {string} + +*** + +#### `resolveOptions` + +* Type: {ResolveOptions} Optional. + +*** + +#### `type` + +* Type: {string} + +*** + +#### `used` + +* Type: {any} + +*** + +#### `usedExports` + +* Type: {boolean|SortableSet} + +*** + +#### `useSimpleSourceMap` + +* Type: {boolean} + +*** + +#### `useSourceMap` + +* Type: {boolean} + +*** + +#### `warnings` + +* Type: {any} + +### Methods + +#### `addBlock(block)` + +##### Parameters + +* `block` {AsyncDependenciesBlock} + +* Returns: {void} + +Adds a DependencyBlock to DependencyBlock relationship. +This is used for when a Module has a AsyncDependencyBlock tie (for code-splitting) + +*** + +#### `addCacheDependencies(fileDependencies, contextDependencies, missingDependencies, buildDependencies)` + +##### Parameters + +* `fileDependencies` {LazySet} +* `contextDependencies` {LazySet} +* `missingDependencies` {LazySet} +* `buildDependencies` {LazySet} + +* Returns: {void} + +*** + +#### `addChunk(chunk)` + +##### Parameters + +* `chunk` {Chunk} + +* Returns: {boolean} + +*** + +#### `addCodeGenerationDependency(codeGenerationDependency)` + +##### Parameters + +* `codeGenerationDependency` {Dependency} + +* Returns: {void} + +*** + +#### `addDependency(dependency)` + +##### Parameters + +* `dependency` {Dependency} + +* Returns: {void} + +*** + +#### `addError(error)` + +##### Parameters + +* `error` {WebpackError} + +* Returns: {void} + +*** + +#### `addPresentationalDependency(presentationalDependency)` + +##### Parameters + +* `presentationalDependency` {Dependency} + +* Returns: {void} + +*** + +#### `addWarning(warning)` + +##### Parameters + +* `warning` {WebpackError} + +* Returns: {void} + +*** + +#### `build(options, compilation, resolver, fs, callback)` + +##### Parameters + +* `options` {WebpackOptionsNormalizedWithDefaults} +* `compilation` {Compilation} +* `resolver` {ResolverWithOptions} +* `fs` {InputFileSystem} +* `callback` {Function} + * `err` {WebpackError} + * Returns: {void} + +* Returns: {void} + +*** + +#### `chunkCondition(chunk, compilation)` + +##### Parameters + +* `chunk` {Chunk} +* `compilation` {Compilation} + +* Returns: {boolean} + +*** + +#### `cleanupForCache()` + +* Returns: {void} + +Assuming this module is in the cache. Remove internal references to allow freeing some memory. + +*** + +#### `clearDependenciesAndBlocks()` + +* Returns: {void} + +Removes all dependencies and blocks + +*** + +#### `clearWarningsAndErrors()` + +* Returns: {void} + +removes all warnings and errors + +*** + +#### `codeGeneration(context)` + +##### Parameters + +* `context` {CodeGenerationContext} + +* Returns: {CodeGenerationResult} + +*** + +#### `deserialize(__namedParameters)` + +##### Parameters + +* `__namedParameters` {ObjectDeserializerContext} + +* Returns: {void} + +*** + +#### `getChunks()` + +* Returns: {Chunk[]} + +*** + +#### `getConcatenationBailoutReason(context)` + +##### Parameters + +* `context` {ConcatenationBailoutReasonContext} + +* Returns: {string} + +*** + +#### `getErrors()` + +* Returns: {Iterable} + +*** + +#### `getExportsType(moduleGraph[, strict])` + +##### Parameters + +* `moduleGraph` {ModuleGraph} +* `strict` {boolean} + +* Returns: {ExportsType} + +*** + +#### `getNumberOfChunks()` + +* Returns: {number} + +*** + +#### `getNumberOfErrors()` + +* Returns: {number} + +*** + +#### `getNumberOfWarnings()` + +* Returns: {number} + +*** + +#### `getRootBlock()` + +* Returns: {DependenciesBlock} + +*** + +#### `getSideEffectsConnectionState(moduleGraph)` + +##### Parameters + +* `moduleGraph` {ModuleGraph} + +* Returns: {ConnectionState} + +*** + +#### `getSourceBasicTypes()` + +* Returns: {ReadonlySet} + +Basic source types are high-level categories like javascript, css, webassembly, etc. +We only have built-in knowledge about the javascript basic type here; other basic types may be +added or changed over time by generators and do not need to be handled or detected here. +Some modules, e.g. RemoteModule, may return non-basic source types like "remote" and "share-init" +from getSourceTypes(), but their generated output is still JavaScript, i.e. their basic type is JS. + +*** + +#### `getSourceTypes()` + +* Returns: {ReadonlySet} + +*** + +#### `getUnsafeCacheData()` + +* Returns: {UnsafeCacheData} + +Module should be unsafe cached. Get data that's needed for that. +This data will be passed to restoreFromUnsafeCache later. + +*** + +#### `getWarnings()` + +* Returns: {Iterable} + +*** + +#### `hasChunkCondition()` + +* Returns: {boolean} + +*** + +#### `hasReasonForChunk(chunk, moduleGraph, chunkGraph)` + +##### Parameters + +* `chunk` {Chunk} +* `moduleGraph` {ModuleGraph} +* `chunkGraph` {ChunkGraph} + +* Returns: {boolean} + +*** + +#### `hasReasons(moduleGraph, runtime)` + +##### Parameters + +* `moduleGraph` {ModuleGraph} +* `runtime` {RuntimeSpec} + +* Returns: {boolean} + +*** + +#### `identifier()` + +* Returns: {string} + +*** + +#### `invalidateBuild()` + +* Returns: {void} + +*** + +#### `isAccessibleInChunk(chunkGraph, chunk[, ignoreChunk])` + +##### Parameters + +* `chunkGraph` {ChunkGraph} +* `chunk` {Chunk} +* `ignoreChunk` {Chunk} + +* Returns: {boolean} + +*** + +#### `isAccessibleInChunkGroup(chunkGraph, chunkGroup[, ignoreChunk])` + +##### Parameters + +* `chunkGraph` {ChunkGraph} +* `chunkGroup` {ChunkGroup} +* `ignoreChunk` {Chunk} + +* Returns: {boolean} + +*** + +#### `isEntryModule()` + +* Returns: {boolean} + +*** + +#### `isInChunk(chunk)` + +##### Parameters + +* `chunk` {Chunk} + +* Returns: {boolean} + +*** + +#### `isOptional(moduleGraph)` + +##### Parameters + +* `moduleGraph` {ModuleGraph} + +* Returns: {boolean} + +*** + +#### `isProvided(exportName)` + +##### Parameters + +* `exportName` {string} + +* Returns: {boolean} + +*** + +#### `libIdent(options)` + +##### Parameters + +* `options` {LibIdentOptions} + +* Returns: {string} + +*** + +#### `nameForCondition()` + +* Returns: {string} + +*** + +#### `needBuild(context, callback)` + +##### Parameters + +* `context` {NeedBuildContext} +* `callback` {Function} + * `err` {WebpackError} + * `needBuild` {boolean} + * Returns: {void} + +* Returns: {void} + +*** + +#### `needRebuild(fileTimestamps, contextTimestamps)` + +> Stability: 0 - Deprecated + +##### Parameters + +* `fileTimestamps` {Map} +* `contextTimestamps` {Map} + +* Returns: {boolean} + +Use needBuild instead + +*** + +#### `originalSource()` + +* Returns: {Source} + +*** + +#### `readableIdentifier(requestShortener)` + +##### Parameters + +* `requestShortener` {RequestShortener} + +* Returns: {string} + +*** + +#### `removeChunk(chunk)` + +##### Parameters + +* `chunk` {Chunk} + +* Returns: {void} + +*** + +#### `removeDependency(dependency)` + +##### Parameters + +* `dependency` {Dependency} + +* Returns: {void} + +*** + +#### `serialize(__namedParameters)` + +##### Parameters + +* `__namedParameters` {ObjectSerializerContext} + +* Returns: {void} + +*** + +#### `size([type])` + +##### Parameters + +* `type` {string} + +* Returns: {number} + +*** + +#### `source(dependencyTemplates, runtimeTemplate[, type])` + +> Stability: 0 - Deprecated + +##### Parameters + +* `dependencyTemplates` {DependencyTemplates} +* `runtimeTemplate` {RuntimeTemplate} +* `type` {string} + +* Returns: {Source} + +Use codeGeneration() instead + +*** + +#### `updateCacheModule(module)` + +##### Parameters + +* `module` {Module} + +* Returns: {void} + +Assuming this module is in the cache. Update the (cached) module with +the fresh module from the factory. Usually updates internal references +and properties. + +*** + +#### `updateHash(hash, context)` + +##### Parameters + +* `hash` {Hash} +* `context` {UpdateHashContextDependency} + +* Returns: {void} + +*** + +#### Static method: `getSourceBasicTypes(module)` + +> Stability: 0 - Deprecated + +##### Parameters + +* `module` {Module} + +* Returns: {ReadonlySet} + +In webpack 6, call getSourceBasicTypes() directly on the module instance instead of using this static method. + +## `ModuleFilenameHelpers` + +## `ABSOLUTE_RESOURCE_PATH` + +* Type: {string} + +## `ALL_LOADERS` + +* Type: {string} + +## `ALL_LOADERS_RESOURCE` + +* Type: {string} + +## `createFilename` + +* Type: {Function} + +### Parameters + +* `module` {string|Module} +* `options` {object} + * `moduleFilenameTemplate` {string|Function} + * `namespace` {string} +* `__namedParameters` {object} + * `chunkGraph` {ChunkGraph} + * `hashFunction` {string|Hash} + * `requestShortener` {RequestShortener} + +* Returns: {string} + +## `HASH` + +* Type: {string} + +## `ID` + +* Type: {string} + +## `LOADERS` + +* Type: {string} + +## `LOADERS_RESOURCE` + +* Type: {string} + +## `matchObject` + +* Type: {Function} + +### Parameters + +* `obj` {MatchObject} +* `str` {string} + +* Returns: {boolean} + +## `matchPart` + +* Type: {Function} + +### Parameters + +* `str` {string} +* `test` {Matcher} + +* Returns: {boolean} + +## `NAMESPACE` + +* Type: {string} + +## `QUERY` + +* Type: {string} + +## `REGEXP_ABSOLUTE_RESOURCE_PATH` + +* Type: {RegExp} + +## `REGEXP_ALL_LOADERS` + +* Type: {RegExp} + +## `REGEXP_ALL_LOADERS_RESOURCE` + +* Type: {RegExp} + +## `REGEXP_HASH` + +* Type: {RegExp} + +## `REGEXP_ID` + +* Type: {RegExp} + +## `REGEXP_LOADERS` + +* Type: {RegExp} + +## `REGEXP_LOADERS_RESOURCE` + +* Type: {RegExp} + +## `REGEXP_NAMESPACE` + +* Type: {RegExp} + +## `REGEXP_QUERY` + +* Type: {RegExp} + +## `REGEXP_RESOURCE` + +* Type: {RegExp} + +## `REGEXP_RESOURCE_PATH` + +* Type: {RegExp} + +## `replaceDuplicates` + +* Type: {Function} + +### Parameters + +* `array` {T[]} +* `fn` {Function} + * `duplicateItem` {T} + * `duplicateItemIndex` {number} + * `numberOfTimesReplaced` {number} + * Returns: {T} +* `comparator` {Function} + * `firstElement` {T} + * `nextElement` {T} + * Returns: {0|1|-1} + +* Returns: {T[]} + +## `RESOURCE` + +* Type: {string} + +## `RESOURCE_PATH` + +* Type: {string} + +## `ModuleFederationPluginOptions` + +### Properties + +#### `exposes` + +* Type: {Exposes} Optional. + +Modules that should be exposed by this container. When provided, property name is used as public name, otherwise public name is automatically inferred from request. + +#### `filename` + +* Type: {string} Optional. + +The filename of the container as relative path inside the `output.path` directory. + +#### `library` + +* Type: {LibraryOptions} Optional. + +Options for library. + +#### `name` + +* Type: {string} Optional. + +The name of the container. + +#### `remotes` + +* Type: {Remotes} Optional. + +Container locations and request scopes from which modules should be resolved and loaded at runtime. When provided, property name is used as request scope, otherwise request scope is automatically inferred from container location. + +#### `remoteType` + +* Type: {ExternalsType} Optional. + +The external type of the remote containers. + +#### `runtime` + +* Type: {EntryRuntime} Optional. + +The name of the runtime chunk. If set a runtime chunk with this name is created or an existing entrypoint is used as runtime. + +#### `shared` + +* Type: {Shared} Optional. + +Modules that should be shared in the share scope. When provided, property names are used to match requested modules in this compilation. + +#### `shareScope` + +* Type: {string} Optional. + +Share scope name used for all shared modules (defaults to 'default'). + +## `ModuleOptions` + +Options affecting the normal modules (`NormalModuleFactory`). + +### Properties + +#### `defaultRules` + +* Type: {false|""|0|"..."|RuleSetRule[]} Optional. + +An array of rules applied by default for modules. + +#### `exprContextCritical` + +* Type: {boolean} Optional. + +Enable warnings for full dynamic dependencies. + +#### `exprContextRecursive` + +* Type: {boolean} Optional. + +Enable recursive directory lookup for full dynamic dependencies. Deprecated: This option has moved to 'module.parser.javascript.exprContextRecursive'. + +##### Deprecated + +#### `exprContextRegExp` + +* Type: {boolean|RegExp} Optional. + +Sets the default regular expression for full dynamic dependencies. Deprecated: This option has moved to 'module.parser.javascript.exprContextRegExp'. + +##### Deprecated + +#### `exprContextRequest` + +* Type: {string} Optional. + +Set the default request for full dynamic dependencies. Deprecated: This option has moved to 'module.parser.javascript.exprContextRequest'. + +##### Deprecated + +#### `generator` + +* Type: {GeneratorOptionsByModuleType} Optional. + +Specify options for each generator. + +#### `noParse` + +* Type: {string|RegExp|Function|string|RegExp|Function[]} Optional. + +Don't parse files matching. It's matched against the full resolved request. + +#### `parser` + +* Type: {ParserOptionsByModuleType} Optional. + +Specify options for each parser. + +#### `rules` + +* Type: {false|""|0|"..."|RuleSetRule[]} Optional. + +An array of rules applied for modules. + +#### `strictExportPresence` + +* Type: {boolean} Optional. + +Emit errors instead of warnings when imported names don't exist in imported module. Deprecated: This option has moved to 'module.parser.javascript.strictExportPresence'. + +##### Deprecated + +#### `strictThisContextOnImports` + +* Type: {boolean} Optional. + +Handle the this context correctly according to the spec for namespace objects. Deprecated: This option has moved to 'module.parser.javascript.strictThisContextOnImports'. + +##### Deprecated + +#### `unknownContextCritical` + +* Type: {boolean} Optional. + +Enable warnings when using the require function in a not statically analyse-able way. Deprecated: This option has moved to 'module.parser.javascript.unknownContextCritical'. + +##### Deprecated + +#### `unknownContextRecursive` + +* Type: {boolean} Optional. + +Enable recursive directory lookup when using the require function in a not statically analyse-able way. Deprecated: This option has moved to 'module.parser.javascript.unknownContextRecursive'. + +##### Deprecated + +#### `unknownContextRegExp` + +* Type: {boolean|RegExp} Optional. + +Sets the regular expression when using the require function in a not statically analyse-able way. Deprecated: This option has moved to 'module.parser.javascript.unknownContextRegExp'. + +##### Deprecated + +#### `unknownContextRequest` + +* Type: {string} Optional. + +Sets the request when using the require function in a not statically analyse-able way. Deprecated: This option has moved to 'module.parser.javascript.unknownContextRequest'. + +##### Deprecated + +#### `unsafeCache` + +* Type: {boolean|Function} Optional. + +Cache the resolving of module requests. + +#### `wrappedContextCritical` + +* Type: {boolean} Optional. + +Enable warnings for partial dynamic dependencies. Deprecated: This option has moved to 'module.parser.javascript.wrappedContextCritical'. + +##### Deprecated + +#### `wrappedContextRecursive` + +* Type: {boolean} Optional. + +Enable recursive directory lookup for partial dynamic dependencies. Deprecated: This option has moved to 'module.parser.javascript.wrappedContextRecursive'. + +##### Deprecated + +#### `wrappedContextRegExp` + +* Type: {RegExp} Optional. + +Set the inner regular expression for partial dynamic dependencies. Deprecated: This option has moved to 'module.parser.javascript.wrappedContextRegExp'. + +##### Deprecated + +## Class: `ModuleChunkLoadingRuntimeModule` + +* Extends: {RuntimeModule} + +### Constructors + +#### `new ModuleChunkLoadingRuntimeModule(runtimeRequirements)` + +##### Parameters + +* `runtimeRequirements` {ReadonlySet} + +* Returns: {ModuleChunkLoadingRuntimeModule} + +### Properties + +#### `blocks` + +* Type: {AsyncDependenciesBlock[]} + +##### Inherited from + +[`RuntimeModule`](Runtime.md).[`blocks`](Runtime.md#blocks) + +*** + +#### `buildInfo` + +* Type: {BuildInfo} Optional. + +##### Inherited from + +[`RuntimeModule`](Runtime.md).[`buildInfo`](Runtime.md#buildinfo) + +*** + +#### `buildMeta` + +* Type: {BuildMeta} Optional. + +##### Inherited from + +[`RuntimeModule`](Runtime.md).[`buildMeta`](Runtime.md#buildmeta) + +*** + +#### `chunk` + +* Type: {Chunk} Optional. + +##### Inherited from + +[`RuntimeModule`](Runtime.md).[`chunk`](Runtime.md#chunk) + +*** + +#### `chunkGraph` + +* Type: {ChunkGraph} Optional. + +##### Inherited from + +[`RuntimeModule`](Runtime.md).[`chunkGraph`](Runtime.md#chunkgraph) + +*** + +#### `chunksIterable` + +* Type: {Iterable} + +##### Inherited from + +[`RuntimeModule`](Runtime.md).[`chunksIterable`](Runtime.md#chunksiterable) + +*** + +#### `codeGenerationDependencies` + +* Type: {Dependency[]} Optional. + +##### Inherited from + +[`RuntimeModule`](Runtime.md).[`codeGenerationDependencies`](Runtime.md#codegenerationdependencies) + +*** + +#### `compilation` + +* Type: {Compilation} Optional. + +##### Inherited from + +[`RuntimeModule`](Runtime.md).[`compilation`](Runtime.md#compilation) + +*** + +#### `context` + +* Type: {string} + +##### Inherited from + +[`RuntimeModule`](Runtime.md).[`context`](Runtime.md#context) + +*** + +#### `debugId` + +* Type: {number} + +##### Inherited from + +[`RuntimeModule`](Runtime.md).[`debugId`](Runtime.md#debugid) + +*** + +#### `dependencies` + +* Type: {Dependency[]} + +##### Inherited from + +[`RuntimeModule`](Runtime.md).[`dependencies`](Runtime.md#dependencies) + +*** + +#### `dependentHash` + +* Type: {boolean} + +##### Inherited from + +[`RuntimeModule`](Runtime.md).[`dependentHash`](Runtime.md#dependenthash) + +*** + +#### `depth` + +* Type: {number} + +##### Inherited from + +[`RuntimeModule`](Runtime.md).[`depth`](Runtime.md#depth) + +*** + +#### `errors` + +* Type: {any} + +##### Inherited from + +[`RuntimeModule`](Runtime.md).[`errors`](Runtime.md#errors) + +*** + +#### `exportsArgument` + +* Type: {string} + +##### Inherited from + +[`RuntimeModule`](Runtime.md).[`exportsArgument`](Runtime.md#exportsargument) + +*** + +#### `factoryMeta` + +* Type: {FactoryMeta} Optional. + +##### Inherited from + +[`RuntimeModule`](Runtime.md).[`factoryMeta`](Runtime.md#factorymeta) + +*** + +#### `fullHash` + +* Type: {boolean} + +##### Inherited from + +[`RuntimeModule`](Runtime.md).[`fullHash`](Runtime.md#fullhash) + +*** + +#### `hasEqualsChunks` + +* Type: {any} + +##### Inherited from + +[`RuntimeModule`](Runtime.md).[`hasEqualsChunks`](Runtime.md#hasequalschunks) + +*** + +#### `hash` + +* Type: {string} + +##### Inherited from + +[`RuntimeModule`](Runtime.md).[`hash`](Runtime.md#hash) + +*** + +#### `hot` + +* Type: {boolean} + +##### Inherited from + +[`RuntimeModule`](Runtime.md).[`hot`](Runtime.md#hot) + +*** + +#### `id` + +* Type: {string|number} + +##### Deprecated + +##### Inherited from + +[`RuntimeModule`](Runtime.md).[`id`](Runtime.md#id) + +*** + +#### `index` + +* Type: {number} + +##### Inherited from + +[`RuntimeModule`](Runtime.md).[`index`](Runtime.md#index) + +*** + +#### `index2` + +* Type: {number} + +##### Inherited from + +[`RuntimeModule`](Runtime.md).[`index2`](Runtime.md#index2) + +*** + +#### `issuer` + +* Type: {Module} Optional. + +##### Inherited from + +[`RuntimeModule`](Runtime.md).[`issuer`](Runtime.md#issuer) + +*** + +#### `isUsed` + +* Type: {any} + +##### Inherited from + +[`RuntimeModule`](Runtime.md).[`isUsed`](Runtime.md#isused) + +*** + +#### `layer` + +* Type: {string} + +##### Inherited from + +[`RuntimeModule`](Runtime.md).[`layer`](Runtime.md#layer) + +*** + +#### `moduleArgument` + +* Type: {string} + +##### Inherited from + +[`RuntimeModule`](Runtime.md).[`moduleArgument`](Runtime.md#moduleargument) + +*** + +#### `name` + +* Type: {string} + +##### Inherited from + +[`RuntimeModule`](Runtime.md).[`name`](Runtime.md#name) + +*** + +#### `needId` + +* Type: {boolean} + +##### Inherited from + +[`RuntimeModule`](Runtime.md).[`needId`](Runtime.md#needid) + +*** + +#### `optimizationBailout` + +* Type: {string|Function[]} + +##### Deprecated + +##### Inherited from + +[`RuntimeModule`](Runtime.md).[`optimizationBailout`](Runtime.md#optimizationbailout) + +*** + +#### `optional` + +* Type: {boolean} + +##### Inherited from + +[`RuntimeModule`](Runtime.md).[`optional`](Runtime.md#optional) + +*** + +#### `parent` + +* Type: {DependenciesBlock} Optional. + +##### Inherited from + +[`RuntimeModule`](Runtime.md).[`parent`](Runtime.md#parent) + +*** + +#### `presentationalDependencies` + +* Type: {Dependency[]} Optional. + +##### Inherited from + +[`RuntimeModule`](Runtime.md).[`presentationalDependencies`](Runtime.md#presentationaldependencies) + +*** + +#### `profile` + +* Type: {ModuleProfile} Optional. + +##### Inherited from + +[`RuntimeModule`](Runtime.md).[`profile`](Runtime.md#profile) + +*** + +#### `renderedHash` + +* Type: {string} + +##### Inherited from + +[`RuntimeModule`](Runtime.md).[`renderedHash`](Runtime.md#renderedhash) + +*** + +#### `resolveOptions` + +* Type: {ResolveOptions} Optional. + +##### Inherited from + +[`RuntimeModule`](Runtime.md).[`resolveOptions`](Runtime.md#resolveoptions) + +*** + +#### `stage` + +* Type: {number} + +##### Inherited from + +[`RuntimeModule`](Runtime.md).[`stage`](Runtime.md#stage) + +*** + +#### `type` + +* Type: {string} + +##### Inherited from + +[`RuntimeModule`](Runtime.md).[`type`](Runtime.md#type) + +*** + +#### `used` + +* Type: {any} + +##### Inherited from + +[`RuntimeModule`](Runtime.md).[`used`](Runtime.md#used) + +*** + +#### `usedExports` + +* Type: {boolean|SortableSet} + +##### Inherited from + +[`RuntimeModule`](Runtime.md).[`usedExports`](Runtime.md#usedexports) + +*** + +#### `useSimpleSourceMap` + +* Type: {boolean} + +##### Inherited from + +[`RuntimeModule`](Runtime.md).[`useSimpleSourceMap`](Runtime.md#usesimplesourcemap) + +*** + +#### `useSourceMap` + +* Type: {boolean} + +##### Inherited from + +[`RuntimeModule`](Runtime.md).[`useSourceMap`](Runtime.md#usesourcemap) + +*** + +#### `warnings` + +* Type: {any} + +##### Inherited from + +[`RuntimeModule`](Runtime.md).[`warnings`](Runtime.md#warnings) + +*** + +#### `STAGE_ATTACH` + +* Type: {number} + +Runtime modules which attach to handlers of other runtime modules + +##### Overrides + +[`RuntimeModule`](Runtime.md).[`STAGE_ATTACH`](Runtime.md#stage-attach) + +*** + +#### `STAGE_BASIC` + +* Type: {number} + +Runtime modules with simple dependencies on other runtime modules + +##### Overrides + +[`RuntimeModule`](Runtime.md).[`STAGE_BASIC`](Runtime.md#stage-basic) + +*** + +#### `STAGE_NORMAL` + +* Type: {number} + +Runtime modules without any dependencies to other runtime modules + +##### Overrides + +[`RuntimeModule`](Runtime.md).[`STAGE_NORMAL`](Runtime.md#stage-normal) + +*** + +#### `STAGE_TRIGGER` + +* Type: {number} + +Runtime modules which trigger actions on bootstrap + +##### Overrides + +[`RuntimeModule`](Runtime.md).[`STAGE_TRIGGER`](Runtime.md#stage-trigger) + +### Methods + +#### `addBlock(block)` + +##### Parameters + +* `block` {AsyncDependenciesBlock} + +* Returns: {void} + +Adds a DependencyBlock to DependencyBlock relationship. +This is used for when a Module has a AsyncDependencyBlock tie (for code-splitting) + +*** + +#### `addCacheDependencies(fileDependencies, contextDependencies, missingDependencies, buildDependencies)` + +##### Parameters + +* `fileDependencies` {LazySet} +* `contextDependencies` {LazySet} +* `missingDependencies` {LazySet} +* `buildDependencies` {LazySet} + +* Returns: {void} + +*** + +#### `addChunk(chunk)` + +##### Parameters + +* `chunk` {Chunk} + +* Returns: {boolean} + +*** + +#### `addCodeGenerationDependency(codeGenerationDependency)` + +##### Parameters + +* `codeGenerationDependency` {Dependency} + +* Returns: {void} + +*** + +#### `addDependency(dependency)` + +##### Parameters + +* `dependency` {Dependency} + +* Returns: {void} + +*** + +#### `addError(error)` + +##### Parameters + +* `error` {WebpackError} + +* Returns: {void} + +*** + +#### `addPresentationalDependency(presentationalDependency)` + +##### Parameters + +* `presentationalDependency` {Dependency} + +* Returns: {void} + +*** + +#### `addWarning(warning)` + +##### Parameters + +* `warning` {WebpackError} + +* Returns: {void} + +*** + +#### `attach(compilation, chunk[, chunkGraph])` + +##### Parameters + +* `compilation` {Compilation} +* `chunk` {Chunk} +* `chunkGraph` {ChunkGraph} + +* Returns: {void} + +*** + +#### `build(options, compilation, resolver, fs, callback)` + +##### Parameters + +* `options` {WebpackOptionsNormalizedWithDefaults} +* `compilation` {Compilation} +* `resolver` {ResolverWithOptions} +* `fs` {InputFileSystem} +* `callback` {Function} + * `err` {WebpackError} + * Returns: {void} + +* Returns: {void} + +*** + +#### `chunkCondition(chunk, compilation)` + +##### Parameters + +* `chunk` {Chunk} +* `compilation` {Compilation} + +* Returns: {boolean} + +*** + +#### `cleanupForCache()` + +* Returns: {void} + +Assuming this module is in the cache. Remove internal references to allow freeing some memory. + +*** + +#### `clearDependenciesAndBlocks()` + +* Returns: {void} + +Removes all dependencies and blocks + +*** + +#### `clearWarningsAndErrors()` + +* Returns: {void} + +removes all warnings and errors + +*** + +#### `codeGeneration(context)` + +##### Parameters + +* `context` {CodeGenerationContext} + +* Returns: {CodeGenerationResult} + +*** + +#### `deserialize(__namedParameters)` + +##### Parameters + +* `__namedParameters` {ObjectDeserializerContext} + +* Returns: {void} + +*** + +#### `generate()` + +* Returns: {string} + +*** + +#### `getChunks()` + +* Returns: {Chunk[]} + +*** + +#### `getConcatenationBailoutReason(context)` + +##### Parameters + +* `context` {ConcatenationBailoutReasonContext} + +* Returns: {string} + +*** + +#### `getErrors()` + +* Returns: {Iterable} + +*** + +#### `getExportsType(moduleGraph[, strict])` + +##### Parameters + +* `moduleGraph` {ModuleGraph} +* `strict` {boolean} + +* Returns: {ExportsType} + +*** + +#### `getGeneratedCode()` + +* Returns: {string} + +*** + +#### `getNumberOfChunks()` + +* Returns: {number} + +*** + +#### `getNumberOfErrors()` + +* Returns: {number} + +*** + +#### `getNumberOfWarnings()` + +* Returns: {number} + +*** + +#### `getRootBlock()` + +* Returns: {DependenciesBlock} + +*** + +#### `getSideEffectsConnectionState(moduleGraph)` + +##### Parameters + +* `moduleGraph` {ModuleGraph} + +* Returns: {ConnectionState} + +*** + +#### `getSourceBasicTypes()` + +* Returns: {ReadonlySet} + +Basic source types are high-level categories like javascript, css, webassembly, etc. +We only have built-in knowledge about the javascript basic type here; other basic types may be +added or changed over time by generators and do not need to be handled or detected here. +Some modules, e.g. RemoteModule, may return non-basic source types like "remote" and "share-init" +from getSourceTypes(), but their generated output is still JavaScript, i.e. their basic type is JS. + +*** + +#### `getSourceTypes()` + +* Returns: {ReadonlySet} + +*** + +#### `getUnsafeCacheData()` + +* Returns: {UnsafeCacheData} + +Module should be unsafe cached. Get data that's needed for that. +This data will be passed to restoreFromUnsafeCache later. + +*** + +#### `getWarnings()` + +* Returns: {Iterable} + +*** + +#### `hasChunkCondition()` + +* Returns: {boolean} + +*** + +#### `hasReasonForChunk(chunk, moduleGraph, chunkGraph)` + +##### Parameters + +* `chunk` {Chunk} +* `moduleGraph` {ModuleGraph} +* `chunkGraph` {ChunkGraph} + +* Returns: {boolean} + +*** + +#### `hasReasons(moduleGraph, runtime)` + +##### Parameters + +* `moduleGraph` {ModuleGraph} +* `runtime` {RuntimeSpec} + +* Returns: {boolean} + +*** + +#### `identifier()` + +* Returns: {string} + +*** + +#### `invalidateBuild()` + +* Returns: {void} + +*** + +#### `isAccessibleInChunk(chunkGraph, chunk[, ignoreChunk])` + +##### Parameters + +* `chunkGraph` {ChunkGraph} +* `chunk` {Chunk} +* `ignoreChunk` {Chunk} + +* Returns: {boolean} + +*** + +#### `isAccessibleInChunkGroup(chunkGraph, chunkGroup[, ignoreChunk])` + +##### Parameters + +* `chunkGraph` {ChunkGraph} +* `chunkGroup` {ChunkGroup} +* `ignoreChunk` {Chunk} + +* Returns: {boolean} + +*** + +#### `isEntryModule()` + +* Returns: {boolean} + +*** + +#### `isInChunk(chunk)` + +##### Parameters + +* `chunk` {Chunk} + +* Returns: {boolean} + +*** + +#### `isOptional(moduleGraph)` + +##### Parameters + +* `moduleGraph` {ModuleGraph} + +* Returns: {boolean} + +*** + +#### `isProvided(exportName)` + +##### Parameters + +* `exportName` {string} + +* Returns: {boolean} + +*** + +#### `libIdent(options)` + +##### Parameters + +* `options` {LibIdentOptions} + +* Returns: {string} + +*** + +#### `nameForCondition()` + +* Returns: {string} + +*** + +#### `needBuild(context, callback)` + +##### Parameters + +* `context` {NeedBuildContext} +* `callback` {Function} + * `err` {WebpackError} + * `needBuild` {boolean} + * Returns: {void} + +* Returns: {void} + +*** + +#### `needRebuild(fileTimestamps, contextTimestamps)` + +> Stability: 0 - Deprecated + +##### Parameters + +* `fileTimestamps` {Map} +* `contextTimestamps` {Map} + +* Returns: {boolean} + +Use needBuild instead + +*** + +#### `originalSource()` + +* Returns: {Source} + +*** + +#### `readableIdentifier(requestShortener)` + +##### Parameters + +* `requestShortener` {RequestShortener} + +* Returns: {string} + +*** + +#### `removeChunk(chunk)` + +##### Parameters + +* `chunk` {Chunk} + +* Returns: {void} + +*** + +#### `removeDependency(dependency)` + +##### Parameters + +* `dependency` {Dependency} + +* Returns: {void} + +*** + +#### `serialize(__namedParameters)` + +##### Parameters + +* `__namedParameters` {ObjectSerializerContext} + +* Returns: {void} + +*** + +#### `shouldIsolate()` + +* Returns: {boolean} + +*** + +#### `size([type])` + +##### Parameters + +* `type` {string} + +* Returns: {number} + +*** + +#### `source(dependencyTemplates, runtimeTemplate[, type])` + +> Stability: 0 - Deprecated + +##### Parameters + +* `dependencyTemplates` {DependencyTemplates} +* `runtimeTemplate` {RuntimeTemplate} +* `type` {string} + +* Returns: {Source} + +Use codeGeneration() instead + +*** + +#### `updateCacheModule(module)` + +##### Parameters + +* `module` {Module} + +* Returns: {void} + +Assuming this module is in the cache. Update the (cached) module with +the fresh module from the factory. Usually updates internal references +and properties. + +*** + +#### `updateHash(hash, context)` + +##### Parameters + +* `hash` {Hash} +* `context` {UpdateHashContextDependency} + +* Returns: {void} + +*** + +#### Static method: `getCompilationHooks(compilation)` + +##### Parameters + +* `compilation` {Compilation} + +* Returns: {JsonpCompilationPluginHooks} + +*** + +#### Static method: `getSourceBasicTypes(module)` + +> Stability: 0 - Deprecated + +##### Parameters + +* `module` {Module} + +* Returns: {ReadonlySet} + +In webpack 6, call getSourceBasicTypes() directly on the module instance instead of using this static method. + +## Class: `ModuleConcatenationPlugin` + +### Constructors + +#### `new ModuleConcatenationPlugin()` + +* Returns: {ModuleConcatenationPlugin} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} + +Apply the plugin + +## Class: `ModuleDependency` + +* Extends: {Dependency} + +### Constructors + +#### `new ModuleDependency(request[, sourceOrder])` + +##### Parameters + +* `request` {string} +* `sourceOrder` {number} + +* Returns: {ModuleDependency} + +### Properties + +#### `category` + +* Type: {string} + +##### Inherited from + +[`Dependency`](Dependency.md).[`category`](Dependency.md#category) + +*** + +#### `disconnect` + +* Type: {any} + +##### Inherited from + +[`Dependency`](Dependency.md).[`disconnect`](Dependency.md#disconnect) + +*** + +#### `loc` + +* Type: {DependencyLocation} + +##### Inherited from + +[`Dependency`](Dependency.md).[`loc`](Dependency.md#loc) + +*** + +#### `module` + +* Type: {any} + +##### Inherited from + +[`Dependency`](Dependency.md).[`module`](Dependency.md#module) + +*** + +#### `optional` + +* Type: {boolean} Optional. + +##### Inherited from + +[`Dependency`](Dependency.md).[`optional`](Dependency.md#optional) + +*** + +#### `range` + +* Type: {[number, number]} Optional. + +*** + +#### `request` + +* Type: {string} + +*** + +#### `sourceOrder` + +* Type: {number} Optional. + +*** + +#### `type` + +* Type: {string} + +##### Inherited from + +[`Dependency`](Dependency.md).[`type`](Dependency.md#type) + +*** + +#### `userRequest` + +* Type: {string} + +*** + +#### `weak` + +* Type: {boolean} + +##### Inherited from + +[`Dependency`](Dependency.md).[`weak`](Dependency.md#weak) + +*** + +#### `EXPORTS_OBJECT_REFERENCED` + +* Type: {string[][]} + +##### Overrides + +[`Dependency`](Dependency.md).[`EXPORTS_OBJECT_REFERENCED`](Dependency.md#exports-object-referenced) + +*** + +#### `NO_EXPORTS_REFERENCED` + +* Type: {string[][]} + +##### Overrides + +[`Dependency`](Dependency.md).[`NO_EXPORTS_REFERENCED`](Dependency.md#no-exports-referenced) + +*** + +#### `Template` + +* Type: {DependencyTemplate} + +*** + +#### `TRANSITIVE` + +* Type: {TRANSITIVE} + +##### Overrides + +[`Dependency`](Dependency.md).[`TRANSITIVE`](Dependency.md#transitive) + +### Methods + +#### `couldAffectReferencingModule()` + +* Returns: {boolean|TRANSITIVE} + +*** + +#### `createIgnoredModule(context)` + +##### Parameters + +* `context` {string} + +* Returns: {Module} + +*** + +#### `deserialize(__namedParameters)` + +##### Parameters + +* `__namedParameters` {ObjectDeserializerContext} + +* Returns: {void} + +*** + +#### `getCondition(moduleGraph)` + +##### Parameters + +* `moduleGraph` {ModuleGraph} + +* Returns: {false|Function} + +*** + +#### `getContext()` + +* Returns: {string} + +*** + +#### `getErrors(moduleGraph)` + +##### Parameters + +* `moduleGraph` {ModuleGraph} + +* Returns: {WebpackError[]} + +Returns errors + +*** + +#### `getExports(moduleGraph)` + +##### Parameters + +* `moduleGraph` {ModuleGraph} + +* Returns: {ExportsSpec} + +Returns the exported names + +*** + +#### `getModuleEvaluationSideEffectsState(moduleGraph)` + +##### Parameters + +* `moduleGraph` {ModuleGraph} + +* Returns: {ConnectionState} + +*** + +#### `getNumberOfIdOccurrences()` + +* Returns: {number} + +implement this method to allow the occurrence order plugin to count correctly + +*** + +#### `getReference(moduleGraph)` + +> Stability: 0 - Deprecated + +##### Parameters + +* `moduleGraph` {ModuleGraph} + +* Returns: {never} + +Returns the referenced module and export + +*** + +#### `getReferencedExports(moduleGraph, runtime)` + +##### Parameters + +* `moduleGraph` {ModuleGraph} +* `runtime` {RuntimeSpec} + +* Returns: {string[]|ReferencedExport[]} + +Returns list of exports referenced by this dependency + +*** + +#### `getResourceIdentifier()` + +* Returns: {string} + +*** + +#### `getWarnings(moduleGraph)` + +##### Parameters + +* `moduleGraph` {ModuleGraph} + +* Returns: {WebpackError[]} + +Returns warnings + +*** + +#### `serialize(__namedParameters)` + +##### Parameters + +* `__namedParameters` {ObjectSerializerContext} + +* Returns: {void} + +*** + +#### `setLoc(startLine, startColumn, endLine, endColumn)` + +##### Parameters + +* `startLine` {number} +* `startColumn` {number} +* `endLine` {number} +* `endColumn` {number} + +* Returns: {void} + +*** + +#### `updateHash(hash, context)` + +##### Parameters + +* `hash` {Hash} +* `context` {UpdateHashContextDependency} + +* Returns: {void} + +Update the hash + +*** + +#### Static method: `isLowPriorityDependency(dependency)` + +##### Parameters + +* `dependency` {Dependency} + +* Returns: {boolean} + +## Class: `ModuleFactory` + +### Constructors + +#### `new ModuleFactory()` + +* Returns: {ModuleFactory} + +### Methods + +#### `create(data, callback)` + +##### Parameters + +* `data` {ModuleFactoryCreateData} +* `callback` {Function} + * `err` {Error} + * `result` {ModuleFactoryResult} + * Returns: {void} + +* Returns: {void} + +## Class: `ModuleFederationPlugin` + +### Constructors + +#### `new ModuleFederationPlugin(options)` + +##### Parameters + +* `options` {ModuleFederationPluginOptions} + +* Returns: {ModuleFederationPlugin} + +### Properties + +#### `options` + +* Type: {ModuleFederationPluginOptions} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} + +Apply the plugin + +*** + +#### Static method: `getCompilationHooks(compilation)` + +##### Parameters + +* `compilation` {Compilation} + +* Returns: {CompilationHooksModuleFederationPlugin} + +Get the compilation hooks associated with this plugin. + +## Class: `ModuleGraph` + +### Constructors + +#### `new ModuleGraph()` + +* Returns: {ModuleGraph} + +### Properties + +#### `ModuleGraphConnection` + +* Type: {ModuleGraphConnection} + +### Methods + +#### `addExplanation(dependency, explanation)` + +##### Parameters + +* `dependency` {Dependency} +* `explanation` {string} + +* Returns: {void} + +#### `addExtraReason(module, explanation)` + +##### Parameters + +* `module` {Module} +* `explanation` {string} + +* Returns: {void} + +#### `cached(fn, args)` + +##### Parameters + +* `fn` {Function} + * `moduleGraph` {ModuleGraph} + * `...args` {T} + * Returns: {R} +* `...args` {T} + +* Returns: {R} + +#### `cloneModuleAttributes(sourceModule, targetModule)` + +##### Parameters + +* `sourceModule` {Module} +* `targetModule` {Module} + +* Returns: {void} + +#### `copyOutgoingModuleConnections(oldModule, newModule, filterConnection)` + +##### Parameters + +* `oldModule` {Module} +* `newModule` {Module} +* `filterConnection` {Function} + * `moduleGraphConnection` {ModuleGraphConnection} + * Returns: {boolean} + +* Returns: {void} + +#### `dependencyCacheProvide(dependency, args)` + +##### Parameters + +* `dependency` {D} +* `...args` {[ARGS, unknown]} + +* Returns: {R} + +#### `finishUpdateParent()` + +* Returns: {void} + +#### `freeze([cacheStage])` + +##### Parameters + +* `cacheStage` {string} + +* Returns: {void} + +#### `getConnection(dependency)` + +##### Parameters + +* `dependency` {Dependency} + +* Returns: {ModuleGraphConnection} + +#### `getDepth(module)` + +##### Parameters + +* `module` {Module} + +* Returns: {number} + +#### `getExportInfo(module, exportName)` + +##### Parameters + +* `module` {Module} +* `exportName` {string} + +* Returns: {ExportInfo} + +#### `getExportsInfo(module)` + +##### Parameters + +* `module` {Module} + +* Returns: {ExportsInfo} + +#### `getIncomingConnections(module)` + +##### Parameters + +* `module` {Module} + +* Returns: {Iterable} + +#### `getIncomingConnectionsByOriginModule(module)` + +##### Parameters + +* `module` {Module} + +* Returns: {ReadonlyMap} + +#### `getIssuer(module)` + +##### Parameters + +* `module` {Module} + +* Returns: {Module} + +#### `getMeta(thing)` + +##### Parameters + +* `thing` {object} + +* Returns: {Meta} + +#### `getMetaIfExisting(thing)` + +##### Parameters + +* `thing` {object} + +* Returns: {Meta} + +#### `getModule(dependency)` + +##### Parameters + +* `dependency` {Dependency} + +* Returns: {Module} + +#### `getOptimizationBailout(module)` + +##### Parameters + +* `module` {Module} + +* Returns: {string|Function[]} + +#### `getOrigin(dependency)` + +##### Parameters + +* `dependency` {Dependency} + +* Returns: {Module} + +#### `getOutgoingConnections(module)` + +##### Parameters + +* `module` {Module} + +* Returns: {Iterable} + +#### `getOutgoingConnectionsByModule(module)` + +##### Parameters + +* `module` {Module} + +* Returns: {ReadonlyMap} + +#### `getParentBlock(dependency)` + +##### Parameters + +* `dependency` {Dependency} + +* Returns: {DependenciesBlock} + +#### `getParentBlockIndex(dependency)` + +##### Parameters + +* `dependency` {Dependency} + +* Returns: {number} + +#### `getParentModule(dependency)` + +##### Parameters + +* `dependency` {Dependency} + +* Returns: {Module} + +#### `getPostOrderIndex(module)` + +##### Parameters + +* `module` {Module} + +* Returns: {number} + +#### `getPreOrderIndex(module)` + +##### Parameters + +* `module` {Module} + +* Returns: {number} + +#### `getProfile(module)` + +##### Parameters + +* `module` {Module} + +* Returns: {ModuleProfile} + +#### `getProvidedExports(module)` + +##### Parameters + +* `module` {Module} + +* Returns: {true|string[]} + +#### `getReadOnlyExportInfo(module, exportName)` + +##### Parameters + +* `module` {Module} +* `exportName` {string} + +* Returns: {ExportInfo} + +#### `getResolvedModule(dependency)` + +##### Parameters + +* `dependency` {Dependency} + +* Returns: {Module} + +#### `getResolvedOrigin(dependency)` + +##### Parameters + +* `dependency` {Dependency} + +* Returns: {Module} + +#### `getUsedExports(module, runtime)` + +##### Parameters + +* `module` {Module} +* `runtime` {RuntimeSpec} + +* Returns: {boolean|SortableSet} + +#### `isAsync(module)` + +##### Parameters + +* `module` {Module} + +* Returns: {boolean} + +#### `isDeferred(module)` + +##### Parameters + +* `module` {Module} + +* Returns: {boolean} + +#### `isExportProvided(module, exportName)` + +##### Parameters + +* `module` {Module} +* `exportName` {string|string[]} + +* Returns: {boolean} + +#### `moveModuleConnections(oldModule, newModule, filterConnection)` + +##### Parameters + +* `oldModule` {Module} +* `newModule` {Module} +* `filterConnection` {Function} + * `moduleGraphConnection` {ModuleGraphConnection} + * Returns: {boolean} + +* Returns: {void} + +#### `removeAllModuleAttributes()` + +* Returns: {void} + +#### `removeConnection(dependency)` + +##### Parameters + +* `dependency` {Dependency} + +* Returns: {void} + +#### `removeModuleAttributes(module)` + +##### Parameters + +* `module` {Module} + +* Returns: {void} + +#### `setAsync(module)` + +##### Parameters + +* `module` {Module} + +* Returns: {void} + +#### `setDepth(module, depth)` + +##### Parameters + +* `module` {Module} +* `depth` {number} + +* Returns: {void} + +#### `setDepthIfLower(module, depth)` + +##### Parameters + +* `module` {Module} +* `depth` {number} + +* Returns: {boolean} + +#### `setIssuer(module, issuer)` + +##### Parameters + +* `module` {Module} +* `issuer` {Module} + +* Returns: {void} + +#### `setIssuerIfUnset(module, issuer)` + +##### Parameters + +* `module` {Module} +* `issuer` {Module} + +* Returns: {void} + +#### `setModuleMemCaches(moduleMemCaches)` + +##### Parameters + +* `moduleMemCaches` {Map>} + +* Returns: {void} + +#### `setParentDependenciesBlockIndex(dependency, index)` + +##### Parameters + +* `dependency` {Dependency} +* `index` {number} + +* Returns: {void} + +#### `setParents(dependency, block, module[, indexInBlock])` + +##### Parameters + +* `dependency` {Dependency} +* `block` {DependenciesBlock} +* `module` {Module} +* `indexInBlock` {number} + +* Returns: {void} + +#### `setPostOrderIndex(module, index)` + +##### Parameters + +* `module` {Module} +* `index` {number} + +* Returns: {void} + +#### `setPostOrderIndexIfUnset(module, index)` + +##### Parameters + +* `module` {Module} +* `index` {number} + +* Returns: {boolean} + +#### `setPreOrderIndex(module, index)` + +##### Parameters + +* `module` {Module} +* `index` {number} + +* Returns: {void} + +#### `setPreOrderIndexIfUnset(module, index)` + +##### Parameters + +* `module` {Module} +* `index` {number} + +* Returns: {boolean} + +#### `setProfile(module[, profile])` + +##### Parameters + +* `module` {Module} +* `profile` {ModuleProfile} + +* Returns: {void} + +#### `setResolvedModule(originModule, dependency, module)` + +##### Parameters + +* `originModule` {Module} +* `dependency` {Dependency} +* `module` {Module} + +* Returns: {void} + +#### `unfreeze()` + +* Returns: {void} + +#### `updateModule(dependency, module)` + +##### Parameters + +* `dependency` {Dependency} +* `module` {Module} + +* Returns: {void} + +#### `updateParent(dependency[, connection][, parentModule])` + +##### Parameters + +* `dependency` {Dependency} +* `connection` {ModuleGraphConnection} +* `parentModule` {Module} + +* Returns: {void} + +#### Static method: `clearModuleGraphForModule(module)` + +> Stability: 0 - Deprecated + +##### Parameters + +* `module` {Module} + +* Returns: {void} + +#### Static method: `getModuleGraphForModule(module, deprecateMessage, deprecationCode)` + +> Stability: 0 - Deprecated + +##### Parameters + +* `module` {Module} +* `deprecateMessage` {string} +* `deprecationCode` {string} + +* Returns: {ModuleGraph} + +#### Static method: `setModuleGraphForModule(module, moduleGraph)` + +> Stability: 0 - Deprecated + +##### Parameters + +* `module` {Module} +* `moduleGraph` {ModuleGraph} + +* Returns: {void} + +## Class: `ModuleGraphConnection` + +### Constructors + +#### `new ModuleGraphConnection(originModule, dependency, module[, explanation][, weak][, condition])` + +##### Parameters + +* `originModule` {Module} +* `dependency` {Dependency} +* `module` {Module} +* `explanation` {string} +* `weak` {boolean} +* `condition` {false|Function} + +* Returns: {ModuleGraphConnection} + +### Properties + +#### `condition` + +* Type: {false|Function} Optional. + +#### `conditional` + +* Type: {boolean} + +#### `dependency` + +* Type: {Dependency} + +#### `explanation` + +* Type: {string} + +#### `explanations` + +* Type: {Set} Optional. + +#### `module` + +* Type: {Module} + +#### `originModule` + +* Type: {Module} + +#### `resolvedModule` + +* Type: {Module} + +#### `resolvedOriginModule` + +* Type: {Module} + +#### `weak` + +* Type: {boolean} Optional. + +#### `addConnectionStates` + +* Type: {Function} + +##### Parameters + +* `a` {ConnectionState} +* `b` {ConnectionState} + +* Returns: {ConnectionState} + +#### `CIRCULAR_CONNECTION` + +* Type: {CIRCULAR_CONNECTION} + +#### `TRANSITIVE_ONLY` + +* Type: {TRANSITIVE_ONLY} + +### Methods + +#### `addCondition(condition)` + +##### Parameters + +* `condition` {Function} + * `moduleGraphConnection` {ModuleGraphConnection} + * `runtime` {RuntimeSpec} + * Returns: {ConnectionState} + +* Returns: {void} + +#### `addExplanation(explanation)` + +##### Parameters + +* `explanation` {string} + +* Returns: {void} + +#### `clone()` + +* Returns: {ModuleGraphConnection} + +#### `getActiveState(runtime)` + +##### Parameters + +* `runtime` {RuntimeSpec} + +* Returns: {ConnectionState} + +#### `isActive(runtime)` + +##### Parameters + +* `runtime` {RuntimeSpec} + +* Returns: {boolean} + +#### `isTargetActive(runtime)` + +##### Parameters + +* `runtime` {RuntimeSpec} + +* Returns: {boolean} + +#### `setActive(value)` + +##### Parameters + +* `value` {boolean} + +* Returns: {void} diff --git a/pages/v5.x/MultiCompiler.md b/pages/v5.x/MultiCompiler.md new file mode 100644 index 0000000..5ab1ee8 --- /dev/null +++ b/pages/v5.x/MultiCompiler.md @@ -0,0 +1,176 @@ +# MultiCompiler + + + +## Class: `MultiCompiler` + +### Constructors + +#### `new MultiCompiler(compilers, options)` + +##### Parameters + +* `compilers` {Compiler[]|Record} +* `options` {MultiCompilerOptions} + +* Returns: {MultiCompiler} + +### Properties + +#### `compilers` + +* Type: {Compiler[]} + +*** + +#### `dependencies` + +* Type: {WeakMap} + +*** + +#### `hooks` + +* Type: {Readonly} + +*** + +#### `inputFileSystem` + +* Type: {InputFileSystem} + +*** + +#### `intermediateFileSystem` + +* Type: {IntermediateFileSystem} + +*** + +#### `options` + +* Type: {WebpackOptionsNormalized[] & MultiCompilerOptions} + +*** + +#### `outputFileSystem` + +* Type: {OutputFileSystem} + +*** + +#### `outputPath` + +* Type: {string} + +*** + +#### `running` + +* Type: {boolean} + +*** + +#### `watchFileSystem` + +* Type: {WatchFileSystem} + +### Methods + +#### `close(callback)` + +##### Parameters + +* `callback` {Function} + * `err` {Error} + * `result` {void} + * Returns: {void} + +* Returns: {void} + +*** + +#### `getInfrastructureLogger(name)` + +##### Parameters + +* `name` {string|Function} + +* Returns: {WebpackLogger} + +*** + +#### `purgeInputFileSystem()` + +* Returns: {void} + +*** + +#### `run(callback)` + +##### Parameters + +* `callback` {CallbackWebpackFunction_2} + +* Returns: {void} + +*** + +#### `runWithDependencies(compilers, fn, callback)` + +> Stability: 0 - Deprecated + +##### Parameters + +* `compilers` {Compiler[]} +* `fn` {Function} + * `compiler` {Compiler} + * `callback` {CallbackWebpackFunction_2} + * Returns: {void} +* `callback` {CallbackWebpackFunction_2} + +* Returns: {void} + +This method should have been private + +*** + +#### `setDependencies(compiler, dependencies)` + +##### Parameters + +* `compiler` {Compiler} +* `dependencies` {string[]} + +* Returns: {void} + +*** + +#### `validateDependencies(callback)` + +##### Parameters + +* `callback` {CallbackWebpackFunction_2} + +* Returns: {boolean} + +*** + +#### `watch(watchOptions, handler)` + +##### Parameters + +* `watchOptions` {WatchOptions|WatchOptions[]} +* `handler` {CallbackWebpackFunction_2} + +* Returns: {MultiWatching} + +## `MultiCompilerOptions` + +### Properties + +#### `parallelism` + +* Type: {number} Optional. + +how many Compilers are allows to run at the same time in parallel diff --git a/pages/v5.x/MultiConfiguration.md b/pages/v5.x/MultiConfiguration.md new file mode 100644 index 0000000..238bb0f --- /dev/null +++ b/pages/v5.x/MultiConfiguration.md @@ -0,0 +1,7 @@ +# MultiConfiguration + + + +## `MultiConfiguration` + +* Type: {ReadonlyArray & MultiCompilerOptions} diff --git a/pages/v5.x/MultiStats.md b/pages/v5.x/MultiStats.md new file mode 100644 index 0000000..acf4b77 --- /dev/null +++ b/pages/v5.x/MultiStats.md @@ -0,0 +1,55 @@ +# MultiStats + + + +## Class: `MultiStats` + +### Constructors + +#### `new MultiStats()` + +* Returns: {MultiStats} + +### Properties + +#### `hash` + +* Type: {string} + +*** + +#### `stats` + +* Type: {Stats[]} + +### Methods + +#### `hasErrors()` + +* Returns: {boolean} + +*** + +#### `hasWarnings()` + +* Returns: {boolean} + +*** + +#### `toJson([options])` + +##### Parameters + +* `options` {boolean|"verbose"|"none"|"summary"|"errors-only"|"errors-warnings"|"minimal"|"normal"|"detailed"|StatsOptions} + +* Returns: {StatsCompilation} + +*** + +#### `toString([options])` + +##### Parameters + +* `options` {boolean|"verbose"|"none"|"summary"|"errors-only"|"errors-warnings"|"minimal"|"normal"|"detailed"|StatsOptions} + +* Returns: {string} diff --git a/pages/v5.x/NAMESPACE.md b/pages/v5.x/NAMESPACE.md new file mode 100644 index 0000000..e5c2096 --- /dev/null +++ b/pages/v5.x/NAMESPACE.md @@ -0,0 +1,7 @@ +# NAMESPACE + + + +## `NAMESPACE` + +* Type: {string} diff --git a/pages/v5.x/NoEmitOnErrorsPlugin.md b/pages/v5.x/NoEmitOnErrorsPlugin.md new file mode 100644 index 0000000..09d42f2 --- /dev/null +++ b/pages/v5.x/NoEmitOnErrorsPlugin.md @@ -0,0 +1,23 @@ +# NoEmitOnErrorsPlugin + + + +## Class: `NoEmitOnErrorsPlugin` + +### Constructors + +#### `new NoEmitOnErrorsPlugin()` + +* Returns: {NoEmitOnErrorsPlugin} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} + +Apply the plugin diff --git a/pages/v5.x/NormalModule.md b/pages/v5.x/NormalModule.md new file mode 100644 index 0000000..f796765 --- /dev/null +++ b/pages/v5.x/NormalModule.md @@ -0,0 +1,1125 @@ +# NormalModule + + + +## Class: `NormalModule` + +* Extends: {Module} + +### Constructors + +#### `new NormalModule(__namedParameters)` + +##### Parameters + +* `__namedParameters` {NormalModuleCreateData} + +* Returns: {NormalModule} + +### Properties + +#### `binary` + +* Type: {boolean} + +*** + +#### `blocks` + +* Type: {AsyncDependenciesBlock[]} + +##### Inherited from + +[`Module`](Module.md).[`blocks`](Module.md#blocks) + +*** + +#### `buildInfo` + +* Type: {BuildInfo} Optional. + +##### Inherited from + +[`Module`](Module.md).[`buildInfo`](Module.md#buildinfo) + +*** + +#### `buildMeta` + +* Type: {BuildMeta} Optional. + +##### Inherited from + +[`Module`](Module.md).[`buildMeta`](Module.md#buildmeta) + +*** + +#### `chunksIterable` + +* Type: {Iterable} + +##### Inherited from + +[`Module`](Module.md).[`chunksIterable`](Module.md#chunksiterable) + +*** + +#### `codeGenerationDependencies` + +* Type: {Dependency[]} Optional. + +##### Inherited from + +[`Module`](Module.md).[`codeGenerationDependencies`](Module.md#codegenerationdependencies) + +*** + +#### `context` + +* Type: {string} + +##### Inherited from + +[`Module`](Module.md).[`context`](Module.md#context) + +*** + +#### `debugId` + +* Type: {number} + +##### Inherited from + +[`Module`](Module.md).[`debugId`](Module.md#debugid) + +*** + +#### `dependencies` + +* Type: {Dependency[]} + +##### Inherited from + +[`Module`](Module.md).[`dependencies`](Module.md#dependencies) + +*** + +#### `depth` + +* Type: {number} + +##### Inherited from + +[`Module`](Module.md).[`depth`](Module.md#depth) + +*** + +#### `error` + +* Type: {WebpackError} + +*** + +#### `errors` + +* Type: {any} + +##### Inherited from + +[`Module`](Module.md).[`errors`](Module.md#errors) + +*** + +#### `exportsArgument` + +* Type: {string} + +##### Inherited from + +[`Module`](Module.md).[`exportsArgument`](Module.md#exportsargument) + +*** + +#### `extractSourceMap` + +* Type: {boolean} + +*** + +#### `factoryMeta` + +* Type: {FactoryMeta} Optional. + +##### Inherited from + +[`Module`](Module.md).[`factoryMeta`](Module.md#factorymeta) + +*** + +#### `generator` + +* Type: {Generator} Optional. + +*** + +#### `generatorOptions` + +* Type: {GeneratorOptions} Optional. + +*** + +#### `hasEqualsChunks` + +* Type: {any} + +##### Inherited from + +[`Module`](Module.md).[`hasEqualsChunks`](Module.md#hasequalschunks) + +*** + +#### `hash` + +* Type: {string} + +##### Inherited from + +[`Module`](Module.md).[`hash`](Module.md#hash) + +*** + +#### `hot` + +* Type: {boolean} + +##### Inherited from + +[`Module`](Module.md).[`hot`](Module.md#hot) + +*** + +#### `id` + +* Type: {string|number} + +##### Deprecated + +##### Inherited from + +[`Module`](Module.md).[`id`](Module.md#id) + +*** + +#### `index` + +* Type: {number} + +##### Inherited from + +[`Module`](Module.md).[`index`](Module.md#index) + +*** + +#### `index2` + +* Type: {number} + +##### Inherited from + +[`Module`](Module.md).[`index2`](Module.md#index2) + +*** + +#### `issuer` + +* Type: {Module} Optional. + +##### Inherited from + +[`Module`](Module.md).[`issuer`](Module.md#issuer) + +*** + +#### `isUsed` + +* Type: {any} + +##### Inherited from + +[`Module`](Module.md).[`isUsed`](Module.md#isused) + +*** + +#### `layer` + +* Type: {string} + +##### Inherited from + +[`Module`](Module.md).[`layer`](Module.md#layer) + +*** + +#### `loaders` + +* Type: {LoaderItem[]} + +*** + +#### `matchResource` + +* Type: {string} Optional. + +*** + +#### `moduleArgument` + +* Type: {string} + +##### Inherited from + +[`Module`](Module.md).[`moduleArgument`](Module.md#moduleargument) + +*** + +#### `needId` + +* Type: {boolean} + +##### Inherited from + +[`Module`](Module.md).[`needId`](Module.md#needid) + +*** + +#### `optimizationBailout` + +* Type: {string|Function[]} + +##### Deprecated + +##### Inherited from + +[`Module`](Module.md).[`optimizationBailout`](Module.md#optimizationbailout) + +*** + +#### `optional` + +* Type: {boolean} + +##### Inherited from + +[`Module`](Module.md).[`optional`](Module.md#optional) + +*** + +#### `parent` + +* Type: {DependenciesBlock} Optional. + +##### Inherited from + +[`Module`](Module.md).[`parent`](Module.md#parent) + +*** + +#### `parser` + +* Type: {ParserClass} Optional. + +*** + +#### `parserOptions` + +* Type: {ParserOptions} Optional. + +*** + +#### `presentationalDependencies` + +* Type: {Dependency[]} Optional. + +##### Inherited from + +[`Module`](Module.md).[`presentationalDependencies`](Module.md#presentationaldependencies) + +*** + +#### `profile` + +* Type: {ModuleProfile} Optional. + +##### Inherited from + +[`Module`](Module.md).[`profile`](Module.md#profile) + +*** + +#### `rawRequest` + +* Type: {string} + +*** + +#### `renderedHash` + +* Type: {string} + +##### Inherited from + +[`Module`](Module.md).[`renderedHash`](Module.md#renderedhash) + +*** + +#### `request` + +* Type: {string} + +*** + +#### `resolveOptions` + +* Type: {ResolveOptions} Optional. + +##### Inherited from + +[`Module`](Module.md).[`resolveOptions`](Module.md#resolveoptions) + +*** + +#### `resource` + +* Type: {string} + +*** + +#### `resourceResolveData` + +* Type: {ResourceSchemeData & Partial} Optional. + +*** + +#### `type` + +* Type: {string} + +##### Inherited from + +[`Module`](Module.md).[`type`](Module.md#type) + +*** + +#### `used` + +* Type: {any} + +##### Inherited from + +[`Module`](Module.md).[`used`](Module.md#used) + +*** + +#### `usedExports` + +* Type: {boolean|SortableSet} + +##### Inherited from + +[`Module`](Module.md).[`usedExports`](Module.md#usedexports) + +*** + +#### `userRequest` + +* Type: {string} + +*** + +#### `useSimpleSourceMap` + +* Type: {boolean} + +##### Inherited from + +[`Module`](Module.md).[`useSimpleSourceMap`](Module.md#usesimplesourcemap) + +*** + +#### `useSourceMap` + +* Type: {boolean} + +##### Inherited from + +[`Module`](Module.md).[`useSourceMap`](Module.md#usesourcemap) + +*** + +#### `warnings` + +* Type: {any} + +##### Inherited from + +[`Module`](Module.md).[`warnings`](Module.md#warnings) + +### Methods + +#### `addBlock(block)` + +##### Parameters + +* `block` {AsyncDependenciesBlock} + +* Returns: {void} + +Adds a DependencyBlock to DependencyBlock relationship. +This is used for when a Module has a AsyncDependencyBlock tie (for code-splitting) + +*** + +#### `addCacheDependencies(fileDependencies, contextDependencies, missingDependencies, buildDependencies)` + +##### Parameters + +* `fileDependencies` {LazySet} +* `contextDependencies` {LazySet} +* `missingDependencies` {LazySet} +* `buildDependencies` {LazySet} + +* Returns: {void} + +*** + +#### `addChunk(chunk)` + +##### Parameters + +* `chunk` {Chunk} + +* Returns: {boolean} + +*** + +#### `addCodeGenerationDependency(codeGenerationDependency)` + +##### Parameters + +* `codeGenerationDependency` {Dependency} + +* Returns: {void} + +*** + +#### `addDependency(dependency)` + +##### Parameters + +* `dependency` {Dependency} + +* Returns: {void} + +*** + +#### `addError(error)` + +##### Parameters + +* `error` {WebpackError} + +* Returns: {void} + +*** + +#### `addPresentationalDependency(presentationalDependency)` + +##### Parameters + +* `presentationalDependency` {Dependency} + +* Returns: {void} + +*** + +#### `addWarning(warning)` + +##### Parameters + +* `warning` {WebpackError} + +* Returns: {void} + +*** + +#### `applyNoParseRule(rule, content)` + +##### Parameters + +* `rule` {string|RegExp|Function} +* `content` {string} + +* Returns: {boolean} + +*** + +#### `build(options, compilation, resolver, fs, callback)` + +##### Parameters + +* `options` {WebpackOptionsNormalizedWithDefaults} +* `compilation` {Compilation} +* `resolver` {ResolverWithOptions} +* `fs` {InputFileSystem} +* `callback` {Function} + * `err` {WebpackError} + * Returns: {void} + +* Returns: {void} + +*** + +#### `chunkCondition(chunk, compilation)` + +##### Parameters + +* `chunk` {Chunk} +* `compilation` {Compilation} + +* Returns: {boolean} + +*** + +#### `cleanupForCache()` + +* Returns: {void} + +Assuming this module is in the cache. Remove internal references to allow freeing some memory. + +*** + +#### `clearDependenciesAndBlocks()` + +* Returns: {void} + +Removes all dependencies and blocks + +*** + +#### `clearWarningsAndErrors()` + +* Returns: {void} + +removes all warnings and errors + +*** + +#### `codeGeneration(context)` + +##### Parameters + +* `context` {CodeGenerationContext} + +* Returns: {CodeGenerationResult} + +*** + +#### `createSource(context, content[, sourceMap][, associatedObjectForCache])` + +##### Parameters + +* `context` {string} +* `content` {string|Buffer} +* `sourceMap` {string|RawSourceMap} +* `associatedObjectForCache` {object} + +* Returns: {Source} + +*** + +#### `createSourceForAsset(context, name, content[, sourceMap][, associatedObjectForCache])` + +##### Parameters + +* `context` {string} +* `name` {string} +* `content` {string|Buffer} +* `sourceMap` {string|RawSourceMap} +* `associatedObjectForCache` {object} + +* Returns: {Source} + +*** + +#### `deserialize(__namedParameters)` + +##### Parameters + +* `__namedParameters` {ObjectDeserializerContext} + +* Returns: {void} + +*** + +#### `getChunks()` + +* Returns: {Chunk[]} + +*** + +#### `getConcatenationBailoutReason(context)` + +##### Parameters + +* `context` {ConcatenationBailoutReasonContext} + +* Returns: {string} + +*** + +#### `getCurrentLoader(loaderContext[, index])` + +##### Parameters + +* `loaderContext` {AnyLoaderContext} +* `index` {number} + +* Returns: {LoaderItem} + +*** + +#### `getErrors()` + +* Returns: {Iterable} + +*** + +#### `getExportsType(moduleGraph[, strict])` + +##### Parameters + +* `moduleGraph` {ModuleGraph} +* `strict` {boolean} + +* Returns: {ExportsType} + +*** + +#### `getNumberOfChunks()` + +* Returns: {number} + +*** + +#### `getNumberOfErrors()` + +* Returns: {number} + +*** + +#### `getNumberOfWarnings()` + +* Returns: {number} + +*** + +#### `getResource()` + +* Returns: {string} + +*** + +#### `getRootBlock()` + +* Returns: {DependenciesBlock} + +*** + +#### `getSideEffectsConnectionState(moduleGraph)` + +##### Parameters + +* `moduleGraph` {ModuleGraph} + +* Returns: {ConnectionState} + +*** + +#### `getSourceBasicTypes()` + +* Returns: {ReadonlySet} + +Basic source types are high-level categories like javascript, css, webassembly, etc. +We only have built-in knowledge about the javascript basic type here; other basic types may be +added or changed over time by generators and do not need to be handled or detected here. +Some modules, e.g. RemoteModule, may return non-basic source types like "remote" and "share-init" +from getSourceTypes(), but their generated output is still JavaScript, i.e. their basic type is JS. + +*** + +#### `getSourceTypes()` + +* Returns: {ReadonlySet} + +*** + +#### `getUnsafeCacheData()` + +* Returns: {UnsafeCacheData} + +Module should be unsafe cached. Get data that's needed for that. +This data will be passed to restoreFromUnsafeCache later. + +*** + +#### `getWarnings()` + +* Returns: {Iterable} + +*** + +#### `hasChunkCondition()` + +* Returns: {boolean} + +*** + +#### `hasReasonForChunk(chunk, moduleGraph, chunkGraph)` + +##### Parameters + +* `chunk` {Chunk} +* `moduleGraph` {ModuleGraph} +* `chunkGraph` {ChunkGraph} + +* Returns: {boolean} + +*** + +#### `hasReasons(moduleGraph, runtime)` + +##### Parameters + +* `moduleGraph` {ModuleGraph} +* `runtime` {RuntimeSpec} + +* Returns: {boolean} + +*** + +#### `identifier()` + +* Returns: {string} + +*** + +#### `invalidateBuild()` + +* Returns: {void} + +*** + +#### `isAccessibleInChunk(chunkGraph, chunk[, ignoreChunk])` + +##### Parameters + +* `chunkGraph` {ChunkGraph} +* `chunk` {Chunk} +* `ignoreChunk` {Chunk} + +* Returns: {boolean} + +*** + +#### `isAccessibleInChunkGroup(chunkGraph, chunkGroup[, ignoreChunk])` + +##### Parameters + +* `chunkGraph` {ChunkGraph} +* `chunkGroup` {ChunkGroup} +* `ignoreChunk` {Chunk} + +* Returns: {boolean} + +*** + +#### `isEntryModule()` + +* Returns: {boolean} + +*** + +#### `isInChunk(chunk)` + +##### Parameters + +* `chunk` {Chunk} + +* Returns: {boolean} + +*** + +#### `isOptional(moduleGraph)` + +##### Parameters + +* `moduleGraph` {ModuleGraph} + +* Returns: {boolean} + +*** + +#### `isProvided(exportName)` + +##### Parameters + +* `exportName` {string} + +* Returns: {boolean} + +*** + +#### `libIdent(options)` + +##### Parameters + +* `options` {LibIdentOptions} + +* Returns: {string} + +*** + +#### `markModuleAsErrored(error)` + +##### Parameters + +* `error` {WebpackError} + +* Returns: {void} + +*** + +#### `nameForCondition()` + +* Returns: {string} + +*** + +#### `needBuild(context, callback)` + +##### Parameters + +* `context` {NeedBuildContext} +* `callback` {Function} + * `err` {WebpackError} + * `needBuild` {boolean} + * Returns: {void} + +* Returns: {void} + +*** + +#### `needRebuild(fileTimestamps, contextTimestamps)` + +> Stability: 0 - Deprecated + +##### Parameters + +* `fileTimestamps` {Map} +* `contextTimestamps` {Map} + +* Returns: {boolean} + +Use needBuild instead + +*** + +#### `originalSource()` + +* Returns: {Source} + +*** + +#### `readableIdentifier(requestShortener)` + +##### Parameters + +* `requestShortener` {RequestShortener} + +* Returns: {string} + +*** + +#### `removeChunk(chunk)` + +##### Parameters + +* `chunk` {Chunk} + +* Returns: {void} + +*** + +#### `removeDependency(dependency)` + +##### Parameters + +* `dependency` {Dependency} + +* Returns: {void} + +*** + +#### `restoreFromUnsafeCache(unsafeCacheData, normalModuleFactory)` + +##### Parameters + +* `unsafeCacheData` {UnsafeCacheData} +* `normalModuleFactory` {NormalModuleFactory} + +* Returns: {void} + +restore unsafe cache data + +*** + +#### `serialize(__namedParameters)` + +##### Parameters + +* `__namedParameters` {ObjectSerializerContext} + +* Returns: {void} + +*** + +#### `shouldPreventParsing(noParseRule, request)` + +##### Parameters + +* `noParseRule` {string|RegExp|Function|string|RegExp|Function[]} +* `request` {string} + +* Returns: {boolean} + +*** + +#### `size([type])` + +##### Parameters + +* `type` {string} + +* Returns: {number} + +*** + +#### `source(dependencyTemplates, runtimeTemplate[, type])` + +> Stability: 0 - Deprecated + +##### Parameters + +* `dependencyTemplates` {DependencyTemplates} +* `runtimeTemplate` {RuntimeTemplate} +* `type` {string} + +* Returns: {Source} + +Use codeGeneration() instead + +*** + +#### `updateCacheModule(module)` + +##### Parameters + +* `module` {Module} + +* Returns: {void} + +Assuming this module is in the cache. Update the (cached) module with +the fresh module from the factory. Usually updates internal references +and properties. + +*** + +#### `updateHash(hash, context)` + +##### Parameters + +* `hash` {Hash} +* `context` {UpdateHashContextDependency} + +* Returns: {void} + +*** + +#### Static method: `deserialize(context)` + +##### Parameters + +* `context` {ObjectDeserializerContext} + +* Returns: {NormalModule} + +*** + +#### Static method: `getCompilationHooks(compilation)` + +##### Parameters + +* `compilation` {Compilation} + +* Returns: {NormalModuleCompilationHooks} + +*** + +#### Static method: `getSourceBasicTypes(module)` + +> Stability: 0 - Deprecated + +##### Parameters + +* `module` {Module} + +* Returns: {ReadonlySet} + +In webpack 6, call getSourceBasicTypes() directly on the module instance instead of using this static method. + +## Class: `NormalModuleReplacementPlugin` + +### Constructors + +#### `new NormalModuleReplacementPlugin(resourceRegExp, newResource)` + +##### Parameters + +* `resourceRegExp` {RegExp} +* `newResource` {string|Function} + +* Returns: {NormalModuleReplacementPlugin} + +Create an instance of the plugin + +### Properties + +#### `newResource` + +* Type: {string|Function} + +#### `resourceRegExp` + +* Type: {RegExp} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} + +Apply the plugin diff --git a/pages/v5.x/ObjectDeserializerContext.md b/pages/v5.x/ObjectDeserializerContext.md new file mode 100644 index 0000000..b91ef2b --- /dev/null +++ b/pages/v5.x/ObjectDeserializerContext.md @@ -0,0 +1,25 @@ +# ObjectDeserializerContext + + + +## `ObjectDeserializerContext` + +### Properties + +#### `read` + +* Type: {Function} + +* Returns: {any} + +*** + +#### `setCircularReference` + +* Type: {Function} + +##### Parameters + +* `value` {ReferenceableItem} + +* Returns: {void} diff --git a/pages/v5.x/ObjectSerializerContext.md b/pages/v5.x/ObjectSerializerContext.md new file mode 100644 index 0000000..01144b8 --- /dev/null +++ b/pages/v5.x/ObjectSerializerContext.md @@ -0,0 +1,74 @@ +# ObjectSerializerContext + + + +## `ObjectSerializerContext` + +### Properties + +#### `rollback` + +* Type: {Function} + +##### Parameters + +* `snapshot` {ObjectSerializerSnapshot} + +* Returns: {void} + +*** + +#### `setCircularReference` + +* Type: {Function} + +##### Parameters + +* `value` {ReferenceableItem} + +* Returns: {void} + +*** + +#### `snapshot` + +* Type: {Function} + +* Returns: {ObjectSerializerSnapshot} + +*** + +#### `write` + +* Type: {Function} + +##### Parameters + +* `value` {any} + +* Returns: {void} + +*** + +#### `writeLazy` + +* Type: {Function} Optional. + +##### Parameters + +* `item` {any} + +* Returns: {void} + +*** + +#### `writeSeparate` + +* Type: {Function} Optional. + +##### Parameters + +* `item` {any} +* `obj` {LazyOptions} + +* Returns: {LazyFunction} diff --git a/pages/v5.x/OccurrenceChunk.md b/pages/v5.x/OccurrenceChunk.md new file mode 100644 index 0000000..8b45a9c --- /dev/null +++ b/pages/v5.x/OccurrenceChunk.md @@ -0,0 +1,43 @@ +# OccurrenceChunk + + + +## `OccurrenceChunkIdsPluginOptions` + +### Properties + +#### `prioritiseInitial` + +* Type: {boolean} Optional. + +Prioritise initial size over total size. + +## Class: `OccurrenceChunkIdsPlugin` + +### Constructors + +#### `new OccurrenceChunkIdsPlugin([options])` + +##### Parameters + +* `options` {OccurrenceChunkIdsPluginOptions} + +* Returns: {OccurrenceChunkIdsPlugin} + +### Properties + +#### `options` + +* Type: {OccurrenceChunkIdsPluginOptions} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} + +Apply the plugin diff --git a/pages/v5.x/OccurrenceModule.md b/pages/v5.x/OccurrenceModule.md new file mode 100644 index 0000000..76083b4 --- /dev/null +++ b/pages/v5.x/OccurrenceModule.md @@ -0,0 +1,43 @@ +# OccurrenceModule + + + +## `OccurrenceModuleIdsPluginOptions` + +### Properties + +#### `prioritiseInitial` + +* Type: {boolean} Optional. + +Prioritise initial size over total size. + +## Class: `OccurrenceModuleIdsPlugin` + +### Constructors + +#### `new OccurrenceModuleIdsPlugin([options])` + +##### Parameters + +* `options` {OccurrenceModuleIdsPluginOptions} + +* Returns: {OccurrenceModuleIdsPlugin} + +### Properties + +#### `options` + +* Type: {OccurrenceModuleIdsPluginOptions} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} + +Apply the plugin diff --git a/pages/v5.x/OptimizationStages.md b/pages/v5.x/OptimizationStages.md new file mode 100644 index 0000000..272417d --- /dev/null +++ b/pages/v5.x/OptimizationStages.md @@ -0,0 +1,17 @@ +# OptimizationStages + + + +## `OptimizationStages` + +## `STAGE_ADVANCED` + +* Type: {10} + +## `STAGE_BASIC` + +* Type: {-10} + +## `STAGE_DEFAULT` + +* Type: {0} diff --git a/pages/v5.x/OutputFileSystem.md b/pages/v5.x/OutputFileSystem.md new file mode 100644 index 0000000..bf747dc --- /dev/null +++ b/pages/v5.x/OutputFileSystem.md @@ -0,0 +1,122 @@ +# OutputFileSystem + + + +## `OutputFileSystem` + +### Properties + +#### `createReadStream` + +* Type: {Function} Optional. + +##### Parameters + +* `path` {PathLikeFs} +* `options` {"ascii"|"utf8"|"utf-8"|"utf16le"|"utf-16le"|"ucs2"|"ucs-2"|"base64"|"base64url"|"latin1"|"binary"|"hex"|ReadStreamOptions} + +* Returns: {ReadableStream} + +*** + +#### `dirname` + +* Type: {Function} Optional. + +##### Parameters + +* `dirname` {string} + +* Returns: {string} + +*** + +#### `join` + +* Type: {Function} Optional. + +##### Parameters + +* `path1` {string} +* `path2` {string} + +* Returns: {string} + +*** + +#### `lstat` + +* Type: {LStatFs} Optional. + +*** + +#### `mkdir` + +* Type: {Mkdir} + +*** + +#### `readdir` + +* Type: {ReaddirFs} Optional. + +*** + +#### `readFile` + +* Type: {ReadFileFs} + +*** + +#### `relative` + +* Type: {Function} Optional. + +##### Parameters + +* `from` {string} +* `to` {string} + +* Returns: {string} + +*** + +#### `rmdir` + +* Type: {Function} Optional. + +##### Parameters + +* `file` {PathLikeFs} +* `callback` {Function} + * `err` {ErrnoException} + * Returns: {void} + +* Returns: {void} + +*** + +#### `stat` + +* Type: {StatFs} + +*** + +#### `unlink` + +* Type: {Function} Optional. + +##### Parameters + +* `pathLike` {PathLikeFs} +* `callback` {Function} + * `err` {ErrnoException} + * Returns: {void} + +* Returns: {void} + +*** + +#### `writeFile` + +* Type: {WriteFile} diff --git a/pages/v5.x/Parser.md b/pages/v5.x/Parser.md new file mode 100644 index 0000000..9aa43ea --- /dev/null +++ b/pages/v5.x/Parser.md @@ -0,0 +1,116 @@ +# Parser + + + +## Class: `Parser` + +### Constructors + +#### `new Parser()` + +* Returns: {ParserClass} + +### Methods + +#### `parse(source, state)` + +##### Parameters + +* `source` {string|Buffer|PreparsedAst} +* `state` {ParserState} + +* Returns: {ParserState} + +## `ParserOptionsByModuleTypeKnown` + +Specify options for each parser. + +### Properties + +#### `asset` + +* Type: {AssetParserOptions} Optional. + +Parser options for asset modules. + +#### `asset/bytes` + +* Type: {EmptyParserOptions} Optional. + +No parser options are supported for this module type. + +#### `asset/inline` + +* Type: {EmptyParserOptions} Optional. + +No parser options are supported for this module type. + +#### `asset/resource` + +* Type: {EmptyParserOptions} Optional. + +No parser options are supported for this module type. + +#### `asset/source` + +* Type: {EmptyParserOptions} Optional. + +No parser options are supported for this module type. + +#### `css` + +* Type: {CssParserOptions} Optional. + +Parser options for css modules. + +#### `css/auto` + +* Type: {CssModuleParserOptions} Optional. + +Parser options for css/module modules. + +#### `css/global` + +* Type: {CssModuleParserOptions} Optional. + +Parser options for css/module modules. + +#### `css/module` + +* Type: {CssModuleParserOptions} Optional. + +Parser options for css/module modules. + +#### `javascript` + +* Type: {JavascriptParserOptions} Optional. + +Parser options for javascript modules. + +#### `javascript/auto` + +* Type: {JavascriptParserOptions} Optional. + +Parser options for javascript modules. + +#### `javascript/dynamic` + +* Type: {JavascriptParserOptions} Optional. + +Parser options for javascript modules. + +#### `javascript/esm` + +* Type: {JavascriptParserOptions} Optional. + +Parser options for javascript modules. + +#### `json` + +* Type: {JsonParserOptions} Optional. + +Parser options for JSON modules. + +## `ParserState` + +* Type: {ParserStateBase & Record} diff --git a/pages/v5.x/PathData.md b/pages/v5.x/PathData.md new file mode 100644 index 0000000..4b37ba3 --- /dev/null +++ b/pages/v5.x/PathData.md @@ -0,0 +1,119 @@ +# PathData + + + +## `PathData` + +### Properties + +#### `basename` + +* Type: {string} Optional. + +*** + +#### `chunk` + +* Type: {Chunk|ChunkPathData} Optional. + +*** + +#### `chunkGraph` + +* Type: {ChunkGraph} Optional. + +*** + +#### `contentHash` + +* Type: {string} Optional. + +*** + +#### `contentHashType` + +* Type: {string} Optional. + +*** + +#### `contentHashWithLength` + +* Type: {Function} Optional. + +##### Parameters + +* `length` {number} + +* Returns: {string} + +*** + +#### `filename` + +* Type: {string} Optional. + +*** + +#### `hash` + +* Type: {string} Optional. + +*** + +#### `hashWithLength` + +* Type: {Function} Optional. + +##### Parameters + +* `length` {number} + +* Returns: {string} + +*** + +#### `local` + +* Type: {string} Optional. + +*** + +#### `module` + +* Type: {Module|ModulePathData} Optional. + +*** + +#### `noChunkHash` + +* Type: {boolean} Optional. + +*** + +#### `prepareId` + +* Type: {Function} Optional. + +##### Parameters + +* `id` {string|number} + +* Returns: {string|number} + +*** + +#### `query` + +* Type: {string} Optional. + +*** + +#### `runtime` + +* Type: {RuntimeSpec} Optional. + +*** + +#### `url` + +* Type: {string} Optional. diff --git a/pages/v5.x/PitchLoaderDefinitionFunction.md b/pages/v5.x/PitchLoaderDefinitionFunction.md new file mode 100644 index 0000000..e6fd9cd --- /dev/null +++ b/pages/v5.x/PitchLoaderDefinitionFunction.md @@ -0,0 +1,16 @@ +# PitchLoaderDefinitionFunction + + + +## `PitchLoaderDefinitionFunction(this, remainingRequest, previousRequest, data)` + +### Type Parameters + +### Parameters + +* `this` {NormalModuleLoaderContext & LoaderRunnerLoaderContext & LoaderPluginLoaderContext & HotModuleReplacementPluginLoaderContext & ContextAdditions} +* `remainingRequest` {string} +* `previousRequest` {string} +* `data` {object} + +* Returns: {string|void|Buffer|Promise>} diff --git a/pages/v5.x/PlatformPlugin.md b/pages/v5.x/PlatformPlugin.md new file mode 100644 index 0000000..6a0c8b6 --- /dev/null +++ b/pages/v5.x/PlatformPlugin.md @@ -0,0 +1,33 @@ +# PlatformPlugin + + + +## Class: `PlatformPlugin` + +### Constructors + +#### `new PlatformPlugin(platform)` + +##### Parameters + +* `platform` {Partial} + +* Returns: {PlatformPlugin} + +### Properties + +#### `platform` + +* Type: {Partial} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} + +Apply the plugin diff --git a/pages/v5.x/PrefetchPlugin.md b/pages/v5.x/PrefetchPlugin.md new file mode 100644 index 0000000..f275101 --- /dev/null +++ b/pages/v5.x/PrefetchPlugin.md @@ -0,0 +1,40 @@ +# PrefetchPlugin + + + +## Class: `PrefetchPlugin` + +### Constructors + +#### `new PrefetchPlugin(context[, request])` + +##### Parameters + +* `context` {string} +* `request` {string} + +* Returns: {PrefetchPlugin} + +### Properties + +#### `context` + +* Type: {string} + +*** + +#### `request` + +* Type: {string} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} + +Apply the plugin diff --git a/pages/v5.x/Problem.md b/pages/v5.x/Problem.md new file mode 100644 index 0000000..50481e2 --- /dev/null +++ b/pages/v5.x/Problem.md @@ -0,0 +1,41 @@ +# Problem + + + +## `Problem` + +### Properties + +#### `argument` + +* Type: {string} + +*** + +#### `expected` + +* Type: {string} Optional. + +*** + +#### `index` + +* Type: {number} Optional. + +*** + +#### `path` + +* Type: {string} + +*** + +#### `type` + +* Type: {ProblemType} + +*** + +#### `value` + +* Type: {string|number|boolean|RegExp} Optional. diff --git a/pages/v5.x/ProgressPlugin.md b/pages/v5.x/ProgressPlugin.md new file mode 100644 index 0000000..a083831 --- /dev/null +++ b/pages/v5.x/ProgressPlugin.md @@ -0,0 +1,193 @@ +# ProgressPlugin + + + +## Class: `ProgressPlugin` + +### Constructors + +#### `new ProgressPlugin([options])` + +##### Parameters + +* `options` {ProgressPluginArgument} + +* Returns: {ProgressPlugin} + +### Properties + +#### `dependenciesCount` + +* Type: {number} + +*** + +#### `handler` + +* Type: {Function} Optional. + +##### Parameters + +* `percentage` {number} +* `msg` {string} +* `...args` {string[]} + +* Returns: {void} + +*** + +#### `modulesCount` + +* Type: {number} + +*** + +#### `options` + +* Type: {ProgressPluginOptions} + +*** + +#### `percentBy` + +* Type: {"entries"|"modules"|"dependencies"} + +*** + +#### `profile` + +* Type: {boolean} + +*** + +#### `showActiveModules` + +* Type: {boolean} + +*** + +#### `showDependencies` + +* Type: {boolean} + +*** + +#### `showEntries` + +* Type: {boolean} + +*** + +#### `showModules` + +* Type: {boolean} + +*** + +#### `createDefaultHandler` + +* Type: {Function} + +##### Parameters + +* `profile` {boolean} +* `logger` {WebpackLogger} + +* Returns: {Function} + * `percentage` {number} + * `msg` {string} + * `...args` {string[]} + * Returns: {void} + +*** + +#### `defaultOptions` + +* Type: {Required>} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler|MultiCompiler} + +* Returns: {void} + +*** + +#### Static method: `getReporter(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {Function} + * `p` {number} + * `...args` {string[]} + * Returns: {void} + +## `ProgressPluginOptions` + +Options object for the ProgressPlugin. + +### Properties + +#### `activeModules` + +* Type: {boolean} Optional. + +Show active modules count and one active module in progress message. + +#### `dependencies` + +* Type: {boolean} Optional. + +Show dependencies count in progress message. + +#### `dependenciesCount` + +* Type: {number} Optional. + +Minimum dependencies count to start with. For better progress calculation. Default: 10000. + +#### `entries` + +* Type: {boolean} Optional. + +Show entries count in progress message. + +#### `handler` + +* Type: {HandlerFn} Optional. + +Function that executes for every progress step. + +#### `modules` + +* Type: {boolean} Optional. + +Show modules count in progress message. + +#### `modulesCount` + +* Type: {number} Optional. + +Minimum modules count to start with. For better progress calculation. Default: 5000. + +#### `percentBy` + +* Type: {"entries"|"modules"|"dependencies"} Optional. + +Collect percent algorithm. By default it calculates by a median from modules, entries and dependencies percent. + +#### `profile` + +* Type: {boolean} Optional. + +Collect profile data for progress steps. Default: false. + +## `ProgressPluginArgument` + +* Type: {ProgressPluginOptions|HandlerFunction} diff --git a/pages/v5.x/ProvidePlugin.md b/pages/v5.x/ProvidePlugin.md new file mode 100644 index 0000000..47453a8 --- /dev/null +++ b/pages/v5.x/ProvidePlugin.md @@ -0,0 +1,33 @@ +# ProvidePlugin + + + +## Class: `ProvidePlugin` + +### Constructors + +#### `new ProvidePlugin(definitions)` + +##### Parameters + +* `definitions` {Record} + +* Returns: {ProvidePlugin} + +### Properties + +#### `definitions` + +* Type: {Record} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} + +Apply the plugin diff --git a/pages/v5.x/ProvideShared.md b/pages/v5.x/ProvideShared.md new file mode 100644 index 0000000..4bf81e2 --- /dev/null +++ b/pages/v5.x/ProvideShared.md @@ -0,0 +1,51 @@ +# ProvideShared + + + +## `ProvideSharedPluginOptions` + +### Properties + +#### `provides` + +* Type: {Provides} + +Modules that should be provided as shared modules to the share scope. When provided, property name is used to match modules, otherwise this is automatically inferred from share key. + +*** + +#### `shareScope` + +* Type: {string} Optional. + +Share scope name used for all provided modules (defaults to 'default'). + +## Class: `ProvideSharedPlugin` + +### Constructors + +#### `new ProvideSharedPlugin(options)` + +##### Parameters + +* `options` {ProvideSharedPluginOptions} + +* Returns: {ProvideSharedPlugin} + +### Properties + +#### `options` + +* Type: {ProvideSharedPluginOptions} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} + +Apply the plugin diff --git a/pages/v5.x/QUERY.md b/pages/v5.x/QUERY.md new file mode 100644 index 0000000..77b17e9 --- /dev/null +++ b/pages/v5.x/QUERY.md @@ -0,0 +1,7 @@ +# QUERY + + + +## `QUERY` + +* Type: {string} diff --git a/pages/v5.x/RESOURCE.md b/pages/v5.x/RESOURCE.md new file mode 100644 index 0000000..8ee86d3 --- /dev/null +++ b/pages/v5.x/RESOURCE.md @@ -0,0 +1,7 @@ +# RESOURCE + + + +## `RESOURCE` + +* Type: {string} diff --git a/pages/v5.x/RawLoader.md b/pages/v5.x/RawLoader.md new file mode 100644 index 0000000..e77f1ff --- /dev/null +++ b/pages/v5.x/RawLoader.md @@ -0,0 +1,27 @@ +# RawLoader + + + +## `RawLoaderDefinitionFunction(this, content[, sourceMap][, additionalData])` + +### Type Parameters + +### Parameters + +* `this` {NormalModuleLoaderContext & LoaderRunnerLoaderContext & LoaderPluginLoaderContext & HotModuleReplacementPluginLoaderContext & ContextAdditions} +* `content` {Buffer} +* `sourceMap` {string|RawSourceMap} +* `additionalData` {AdditionalData} + +* Returns: {string|void|Buffer|Promise>} + +## `RawLoaderDefinition` + +* Type: {RawLoaderDefinitionFunction & object} + +### Type Declaration + +* `pitch` {PitchLoaderDefinitionFunction} +* `raw` {true} + +### Type Parameters diff --git a/pages/v5.x/RenderManifest.md b/pages/v5.x/RenderManifest.md new file mode 100644 index 0000000..4c218de --- /dev/null +++ b/pages/v5.x/RenderManifest.md @@ -0,0 +1,73 @@ +# RenderManifest + + + +## `RenderManifestOptions` + +### Properties + +#### `chunk` + +* Type: {Chunk} + +the chunk used to render + +*** + +#### `chunkGraph` + +* Type: {ChunkGraph} + +*** + +#### `codeGenerationResults` + +* Type: {CodeGenerationResults} + +*** + +#### `dependencyTemplates` + +* Type: {DependencyTemplates} + +*** + +#### `fullHash` + +* Type: {string} + +*** + +#### `hash` + +* Type: {string} + +*** + +#### `moduleGraph` + +* Type: {ModuleGraph} + +*** + +#### `moduleTemplates` + +* Type: {object} + +* `javascript` {ModuleTemplate} + +*** + +#### `outputOptions` + +* Type: {OutputNormalizedWithDefaults} + +*** + +#### `runtimeTemplate` + +* Type: {RuntimeTemplate} + +## `RenderManifestEntry` + +* Type: {RenderManifestEntryTemplated|RenderManifestEntryStatic} diff --git a/pages/v5.x/ResolveData.md b/pages/v5.x/ResolveData.md new file mode 100644 index 0000000..944d65c --- /dev/null +++ b/pages/v5.x/ResolveData.md @@ -0,0 +1,85 @@ +# ResolveData + + + +## `ResolveData` + +### Properties + +#### `attributes` + +* Type: {ImportAttributes} Optional. + +*** + +#### `cacheable` + +* Type: {boolean} + +allow to use the unsafe cache + +*** + +#### `context` + +* Type: {string} + +*** + +#### `contextDependencies` + +* Type: {LazySet} + +*** + +#### `contextInfo` + +* Type: {ModuleFactoryCreateDataContextInfo} + +*** + +#### `createData` + +* Type: {Partial} + +*** + +#### `dependencies` + +* Type: {ModuleDependency[]} + +*** + +#### `dependencyType` + +* Type: {string} + +*** + +#### `fileDependencies` + +* Type: {LazySet} + +*** + +#### `ignoredModule` + +* Type: {Module} Optional. + +*** + +#### `missingDependencies` + +* Type: {LazySet} + +*** + +#### `request` + +* Type: {string} + +*** + +#### `resolveOptions` + +* Type: {ResolveOptions} Optional. diff --git a/pages/v5.x/ResolveOptions.md b/pages/v5.x/ResolveOptions.md new file mode 100644 index 0000000..82cf0ad --- /dev/null +++ b/pages/v5.x/ResolveOptions.md @@ -0,0 +1,290 @@ +# ResolveOptions + + + +## `ResolveOptions` + +Options object for resolving requests. + +### Properties + +#### `alias` + +* Type: {object[]|object} Optional. + +Redirect module requests. + +##### Union Members + +{object[]} + +*** + +###### Type Literal + +{object} + +*** + +#### `aliasFields` + +* Type: {string|string[][]} Optional. + +Fields in the description file (usually package.json) which are used to redirect requests inside the module. + +*** + +#### `byDependency` + +* Type: {object} Optional. + +Extra resolve options per dependency category. Typical categories are "commonjs", "amd", "esm". + +##### Index Signature + +\[`index`: {string}\]: {ResolveOptions} + +*** + +#### `cache` + +* Type: {boolean} Optional. + +Enable caching of successfully resolved requests (cache entries are revalidated). + +*** + +#### `cachePredicate` + +* Type: {Function} Optional. + +Predicate function to decide which requests should be cached. + +##### Parameters + +* `request` {ResolveRequest} + +* Returns: {boolean} + +*** + +#### `cacheWithContext` + +* Type: {boolean} Optional. + +Include the context information in the cache identifier when caching. + +*** + +#### `conditionNames` + +* Type: {string[]} Optional. + +Condition names for exports field entry point. + +*** + +#### `descriptionFiles` + +* Type: {string[]} Optional. + +Filenames used to find a description file (like a package.json). + +*** + +#### `enforceExtension` + +* Type: {boolean} Optional. + +Enforce the resolver to use one of the extensions from the extensions option (User must specify requests without extension). + +*** + +#### `exportsFields` + +* Type: {string[]} Optional. + +Field names from the description file (usually package.json) which are used to provide entry points of a package. + +*** + +#### `extensionAlias` + +* Type: {object} Optional. + +An object which maps extension to extension aliases. + +##### Index Signature + +\[`index`: {string}\]: {string|string[]} + +*** + +#### `extensions` + +* Type: {string[]} Optional. + +Extensions added to the request when trying to find the file. + +*** + +#### `fallback` + +* Type: {object[]|object} Optional. + +Redirect module requests when normal resolving fails. + +##### Union Members + +{object[]} + +*** + +###### Type Literal + +{object} + +*** + +#### `fileSystem` + +* Type: {InputFileSystem} Optional. + +Filesystem for the resolver. + +*** + +#### `fullySpecified` + +* Type: {boolean} Optional. + +Treats the request specified by the user as fully specified, meaning no extensions are added and the mainFiles in directories are not resolved (This doesn't affect requests from mainFields, aliasFields or aliases). + +*** + +#### `importsFields` + +* Type: {string[]} Optional. + +Field names from the description file (usually package.json) which are used to provide internal request of a package (requests starting with # are considered as internal). + +*** + +#### `mainFields` + +* Type: {string|string[][]} Optional. + +Field names from the description file (package.json) which are used to find the default entry point. + +*** + +#### `mainFiles` + +* Type: {string[]} Optional. + +Filenames used to find the default entry point if there is no description file or main field. + +*** + +#### `modules` + +* Type: {string[]} Optional. + +Folder names or directory paths where to find modules. + +*** + +#### `plugins` + +* Type: {false|""|0|"..."|object|Function[]} Optional. + +Plugins for the resolver. + +*** + +#### `preferAbsolute` + +* Type: {boolean} Optional. + +Prefer to resolve server-relative URLs (starting with '/') as absolute paths before falling back to resolve in 'resolve.roots'. + +*** + +#### `preferRelative` + +* Type: {boolean} Optional. + +Prefer to resolve module requests as relative request and fallback to resolving as module. + +*** + +#### `resolver` + +* Type: {Resolver} Optional. + +Custom resolver. + +*** + +#### `restrictions` + +* Type: {string|RegExp[]} Optional. + +A list of resolve restrictions. Resolve results must fulfill all of these restrictions to resolve successfully. Other resolve paths are taken when restrictions are not met. + +*** + +#### `roots` + +* Type: {string[]} Optional. + +A list of directories in which requests that are server-relative URLs (starting with '/') are resolved. + +*** + +#### `symlinks` + +* Type: {boolean} Optional. + +Enable resolving symlinks to the original location. + +*** + +#### `tsconfig` + +* Type: {string|boolean|object} Optional. + +TypeScript config for paths mapping. Can be `false` (disabled), `true` (use default `tsconfig.json`), a string path to `tsconfig.json`, or an object with `configFile` and `references` options. + +##### Union Members + +{string} + +*** + +{boolean} + +*** + +###### Type Literal + +{object} + +* `configFile` {string} A path to the tsconfig file. +* `references` {string} References to other tsconfig files. 'auto' inherits from TypeScript config, or an array of relative/absolute paths. + +*** + +#### `unsafeCache` + +* Type: {boolean|object} Optional. + +Enable caching of successfully resolved requests (cache entries are not revalidated). + +*** + +#### `useSyncFileSystemCalls` + +* Type: {boolean} Optional. + +Use synchronous filesystem calls for the resolver. diff --git a/pages/v5.x/ResolvePluginInstance.md b/pages/v5.x/ResolvePluginInstance.md new file mode 100644 index 0000000..fd446f8 --- /dev/null +++ b/pages/v5.x/ResolvePluginInstance.md @@ -0,0 +1,27 @@ +# ResolvePluginInstance + + + +## `ResolvePluginInstance` + +* Type: {object|Function} + +### Union Members + +#### Type Literal + +{object} + +#### Index Signature + +\[`index`: {string}\]: {any} + +* `apply` {Function} The run point of the plugin, required method. + * `arg0` {Resolver} + * Returns: {void} + +*** + +#### Function + +{Function} diff --git a/pages/v5.x/Resolver.md b/pages/v5.x/Resolver.md new file mode 100644 index 0000000..47e365b --- /dev/null +++ b/pages/v5.x/Resolver.md @@ -0,0 +1,157 @@ +# Resolver + + + +## Class: `Resolver` + +### Constructors + +#### `new Resolver()` + +* Returns: {Resolver} + +### Properties + +#### `fileSystem` + +* Type: {FileSystem} + +*** + +#### `hooks` + +* Type: {KnownHooks} + +*** + +#### `options` + +* Type: {ResolveOptionsResolverFactoryObject1} + +### Methods + +#### `doResolve(hook, request, message, resolveContext, callback)` + +##### Parameters + +* `hook` {AsyncSeriesBailHook<[ResolveRequest, ResolveContext], ResolveRequest>} +* `request` {ResolveRequest} +* `message` {string} +* `resolveContext` {ResolveContext} +* `callback` {Function} + * `err` {Error} + * `result` {ResolveRequest} + * Returns: {void} + +* Returns: {void} + +*** + +#### `ensureHook(name)` + +##### Parameters + +* `name` {string|AsyncSeriesBailHook<[ResolveRequest, ResolveContext], ResolveRequest, UnsetAdditionalOptions>} + +* Returns: {AsyncSeriesBailHook<[ResolveRequest, ResolveContext], ResolveRequest>} + +*** + +#### `getHook(name)` + +##### Parameters + +* `name` {string|AsyncSeriesBailHook<[ResolveRequest, ResolveContext], ResolveRequest, UnsetAdditionalOptions>} + +* Returns: {AsyncSeriesBailHook<[ResolveRequest, ResolveContext], ResolveRequest>} + +*** + +#### `isDirectory(path)` + +##### Parameters + +* `path` {string} + +* Returns: {boolean} + +*** + +#### `isModule(path)` + +##### Parameters + +* `path` {string} + +* Returns: {boolean} + +*** + +#### `isPrivate(path)` + +##### Parameters + +* `path` {string} + +* Returns: {boolean} + +*** + +#### `join(path, request)` + +##### Parameters + +* `path` {string} +* `request` {string} + +* Returns: {string} + +*** + +#### `normalize(path)` + +##### Parameters + +* `path` {string} + +* Returns: {string} + +*** + +#### `parse(identifier)` + +##### Parameters + +* `identifier` {string} + +* Returns: {ParsedIdentifier} + +*** + +#### `resolve(context, path, request, resolveContext, callback)` + +##### Parameters + +* `context` {ContextTypes} +* `path` {string} +* `request` {string} +* `resolveContext` {ResolveContext} +* `callback` {Function} + * `err` {ErrorWithDetail} + * `res` {string|false} + * `req` {ResolveRequest} + * Returns: {void} + +* Returns: {void} + +*** + +#### `resolveSync(context, path, request)` + +##### Parameters + +* `context` {ContextTypes} +* `path` {string} +* `request` {string} + +* Returns: {string|false} diff --git a/pages/v5.x/RuleSet.md b/pages/v5.x/RuleSet.md new file mode 100644 index 0000000..955624d --- /dev/null +++ b/pages/v5.x/RuleSet.md @@ -0,0 +1,347 @@ +# RuleSet + + + +## `RuleSetRule` + +A rule description with conditions and effects for modules. + +### Properties + +#### `assert` + +* Type: {object} Optional. + +Match on import assertions of the dependency. + +##### Index Signature + +\[`index`: {string}\]: {RuleSetConditionOrConditions} + +*** + +#### `compiler` + +* Type: {string|RegExp|RuleSetLogicalConditions|Function|RuleSetCondition[]} Optional. + +Match the child compiler name. + +*** + +#### `dependency` + +* Type: {string|RegExp|RuleSetLogicalConditions|RuleSetCondition[]|Function} Optional. + +Match dependency type. + +*** + +#### `descriptionData` + +* Type: {object} Optional. + +Match values of properties in the description file (usually package.json). + +##### Index Signature + +\[`index`: {string}\]: {RuleSetConditionOrConditions} + +*** + +#### `enforce` + +* Type: {"pre"|"post"} Optional. + +Enforce this rule as pre or post step. + +*** + +#### `exclude` + +* Type: {string|RegExp|RuleSetLogicalConditionsAbsolute|Function|RuleSetConditionAbsolute[]} Optional. + +Shortcut for resource.exclude. + +*** + +#### `extractSourceMap` + +* Type: {boolean} Optional. + +Enable/Disable extracting source map. + +*** + +#### `generator` + +* Type: {object} Optional. + +The options for the module generator. + +##### Index Signature + +\[`index`: {string}\]: {any} + +*** + +#### `include` + +* Type: {string|RegExp|RuleSetLogicalConditionsAbsolute|RuleSetConditionAbsolute[]|Function} Optional. + +Shortcut for resource.include. + +*** + +#### `issuer` + +* Type: {string|RegExp|RuleSetLogicalConditionsAbsolute|RuleSetConditionAbsolute[]|Function} Optional. + +Match the issuer of the module (The module pointing to this module). + +*** + +#### `issuerLayer` + +* Type: {string|RegExp|RuleSetLogicalConditions|RuleSetCondition[]|Function} Optional. + +Match layer of the issuer of this module (The module pointing to this module). + +*** + +#### `layer` + +* Type: {string} Optional. + +Specifies the layer in which the module should be placed in. + +*** + +#### `loader` + +* Type: {string} Optional. + +Shortcut for use.loader. + +*** + +#### `mimetype` + +* Type: {string|RegExp|RuleSetLogicalConditions|RuleSetCondition[]|Function} Optional. + +Match module mimetype when load from Data URI. + +*** + +#### `oneOf` + +* Type: {false|""|0|RuleSetRule[]} Optional. + +Only execute the first matching rule in this array. + +*** + +#### `options` + +* Type: {string|object} Optional. + +Shortcut for use.options. + +*** + +#### `parser` + +* Type: {object} Optional. + +Options for parsing. + +##### Index Signature + +\[`index`: {string}\]: {any} + +*** + +#### `realResource` + +* Type: {string|RegExp|RuleSetLogicalConditionsAbsolute|RuleSetConditionAbsolute[]|Function} Optional. + +Match the real resource path of the module. + +*** + +#### `resolve` + +* Type: {ResolveOptions} Optional. + +Options for the resolver. + +*** + +#### `resource` + +* Type: {string|RegExp|RuleSetLogicalConditionsAbsolute|RuleSetConditionAbsolute[]|Function} Optional. + +Match the resource path of the module. + +*** + +#### `resourceFragment` + +* Type: {string|RegExp|RuleSetLogicalConditions|RuleSetCondition[]|Function} Optional. + +Match the resource fragment of the module. + +*** + +#### `resourceQuery` + +* Type: {string|RegExp|RuleSetLogicalConditions|RuleSetCondition[]|Function} Optional. + +Match the resource query of the module. + +*** + +#### `rules` + +* Type: {false|""|0|RuleSetRule[]} Optional. + +Match and execute these rules when this rule is matched. + +*** + +#### `scheme` + +* Type: {string|RegExp|RuleSetLogicalConditions|RuleSetCondition[]|Function} Optional. + +Match module scheme. + +*** + +#### `sideEffects` + +* Type: {boolean} Optional. + +Flags a module as with or without side effects. + +*** + +#### `test` + +* Type: {string|RegExp|RuleSetLogicalConditionsAbsolute|RuleSetConditionAbsolute[]|Function} Optional. + +Shortcut for resource.test. + +*** + +#### `type` + +* Type: {string} Optional. + +Module type to use for the module. + +*** + +#### `use` + +* Type: {string|RuleSetUseFunction|string|false|0|RuleSetUseFunction|object[]|object} Optional. + +Modifiers applied to the module when rule is matched. + +##### Union Members + +{string} + +*** + +{RuleSetUseFunction} + +*** + +{string|false|0|RuleSetUseFunction|object[]} + +*** + +###### Type Literal + +{object} + +* `ident` {string} Unique loader options identifier. +* `loader` {string} Loader name. +* `options` {string|object} Loader options. + +*** + +#### `with` + +* Type: {object} Optional. + +Match on import attributes of the dependency. + +##### Index Signature + +\[`index`: {string}\]: {RuleSetConditionOrConditions} + +## `RuleSetCondition` + +* Type: {string|RegExp|Function|RuleSetLogicalConditions|RuleSetCondition[]} + +## `RuleSetConditionAbsolute` + +* Type: {string|RegExp|Function|RuleSetLogicalConditionsAbsolute|RuleSetConditionAbsolute[]} + +## `RuleSetUse` + +* Type: {string|undefined|null|string|false|0|RuleSetUseFunction|object[]|RuleSetUseFunction|object} + +### Union Members + +{string} + +*** + +{undefined|null|string|false|0|RuleSetUseFunction|object[]} + +*** + +{RuleSetUseFunction} + +*** + +#### Type Literal + +{object} + +* `ident` {string} Unique loader options identifier. +* `loader` {string} Loader name. +* `options` {string|object} Loader options. + +## `RuleSetUseFunction` + +* Type: {Function} + +### Parameters + +* `data` {EffectData} + +* Returns: {string|RuleSetUseFunction|object|undefined|null|string|false|0|RuleSetUseFunction|object[]} + +## `RuleSetUseItem` + +* Type: {string|RuleSetUseFunction|object} + +### Union Members + +{string} + +*** + +{RuleSetUseFunction} + +*** + +#### Type Literal + +{object} + +* `ident` {string} Unique loader options identifier. +* `loader` {string} Loader name. +* `options` {string|object} Loader options. diff --git a/pages/v5.x/Runtime.md b/pages/v5.x/Runtime.md new file mode 100644 index 0000000..61d0053 --- /dev/null +++ b/pages/v5.x/Runtime.md @@ -0,0 +1,1512 @@ +# Runtime + + + +## Class: `RuntimeModule` + +* Extends: {Module} + +### Constructors + +#### `new RuntimeModule(name[, stage])` + +##### Parameters + +* `name` {string} +* `stage` {number} + +* Returns: {RuntimeModule} + +### Properties + +#### `blocks` + +* Type: {AsyncDependenciesBlock[]} + +##### Inherited from + +[`Module`](Module.md).[`blocks`](Module.md#blocks) + +*** + +#### `buildInfo` + +* Type: {BuildInfo} Optional. + +##### Inherited from + +[`Module`](Module.md).[`buildInfo`](Module.md#buildinfo) + +*** + +#### `buildMeta` + +* Type: {BuildMeta} Optional. + +##### Inherited from + +[`Module`](Module.md).[`buildMeta`](Module.md#buildmeta) + +*** + +#### `chunk` + +* Type: {Chunk} Optional. + +*** + +#### `chunkGraph` + +* Type: {ChunkGraph} Optional. + +*** + +#### `chunksIterable` + +* Type: {Iterable} + +##### Inherited from + +[`Module`](Module.md).[`chunksIterable`](Module.md#chunksiterable) + +*** + +#### `codeGenerationDependencies` + +* Type: {Dependency[]} Optional. + +##### Inherited from + +[`Module`](Module.md).[`codeGenerationDependencies`](Module.md#codegenerationdependencies) + +*** + +#### `compilation` + +* Type: {Compilation} Optional. + +*** + +#### `context` + +* Type: {string} + +##### Inherited from + +[`Module`](Module.md).[`context`](Module.md#context) + +*** + +#### `debugId` + +* Type: {number} + +##### Inherited from + +[`Module`](Module.md).[`debugId`](Module.md#debugid) + +*** + +#### `dependencies` + +* Type: {Dependency[]} + +##### Inherited from + +[`Module`](Module.md).[`dependencies`](Module.md#dependencies) + +*** + +#### `dependentHash` + +* Type: {boolean} + +*** + +#### `depth` + +* Type: {number} + +##### Inherited from + +[`Module`](Module.md).[`depth`](Module.md#depth) + +*** + +#### `errors` + +* Type: {any} + +##### Inherited from + +[`Module`](Module.md).[`errors`](Module.md#errors) + +*** + +#### `exportsArgument` + +* Type: {string} + +##### Inherited from + +[`Module`](Module.md).[`exportsArgument`](Module.md#exportsargument) + +*** + +#### `factoryMeta` + +* Type: {FactoryMeta} Optional. + +##### Inherited from + +[`Module`](Module.md).[`factoryMeta`](Module.md#factorymeta) + +*** + +#### `fullHash` + +* Type: {boolean} + +*** + +#### `hasEqualsChunks` + +* Type: {any} + +##### Inherited from + +[`Module`](Module.md).[`hasEqualsChunks`](Module.md#hasequalschunks) + +*** + +#### `hash` + +* Type: {string} + +##### Inherited from + +[`Module`](Module.md).[`hash`](Module.md#hash) + +*** + +#### `hot` + +* Type: {boolean} + +##### Inherited from + +[`Module`](Module.md).[`hot`](Module.md#hot) + +*** + +#### `id` + +* Type: {string|number} + +##### Deprecated + +##### Inherited from + +[`Module`](Module.md).[`id`](Module.md#id) + +*** + +#### `index` + +* Type: {number} + +##### Inherited from + +[`Module`](Module.md).[`index`](Module.md#index) + +*** + +#### `index2` + +* Type: {number} + +##### Inherited from + +[`Module`](Module.md).[`index2`](Module.md#index2) + +*** + +#### `issuer` + +* Type: {Module} Optional. + +##### Inherited from + +[`Module`](Module.md).[`issuer`](Module.md#issuer) + +*** + +#### `isUsed` + +* Type: {any} + +##### Inherited from + +[`Module`](Module.md).[`isUsed`](Module.md#isused) + +*** + +#### `layer` + +* Type: {string} + +##### Inherited from + +[`Module`](Module.md).[`layer`](Module.md#layer) + +*** + +#### `moduleArgument` + +* Type: {string} + +##### Inherited from + +[`Module`](Module.md).[`moduleArgument`](Module.md#moduleargument) + +*** + +#### `name` + +* Type: {string} + +*** + +#### `needId` + +* Type: {boolean} + +##### Inherited from + +[`Module`](Module.md).[`needId`](Module.md#needid) + +*** + +#### `optimizationBailout` + +* Type: {string|Function[]} + +##### Deprecated + +##### Inherited from + +[`Module`](Module.md).[`optimizationBailout`](Module.md#optimizationbailout) + +*** + +#### `optional` + +* Type: {boolean} + +##### Inherited from + +[`Module`](Module.md).[`optional`](Module.md#optional) + +*** + +#### `parent` + +* Type: {DependenciesBlock} Optional. + +##### Inherited from + +[`Module`](Module.md).[`parent`](Module.md#parent) + +*** + +#### `presentationalDependencies` + +* Type: {Dependency[]} Optional. + +##### Inherited from + +[`Module`](Module.md).[`presentationalDependencies`](Module.md#presentationaldependencies) + +*** + +#### `profile` + +* Type: {ModuleProfile} Optional. + +##### Inherited from + +[`Module`](Module.md).[`profile`](Module.md#profile) + +*** + +#### `renderedHash` + +* Type: {string} + +##### Inherited from + +[`Module`](Module.md).[`renderedHash`](Module.md#renderedhash) + +*** + +#### `resolveOptions` + +* Type: {ResolveOptions} Optional. + +##### Inherited from + +[`Module`](Module.md).[`resolveOptions`](Module.md#resolveoptions) + +*** + +#### `stage` + +* Type: {number} + +*** + +#### `type` + +* Type: {string} + +##### Inherited from + +[`Module`](Module.md).[`type`](Module.md#type) + +*** + +#### `used` + +* Type: {any} + +##### Inherited from + +[`Module`](Module.md).[`used`](Module.md#used) + +*** + +#### `usedExports` + +* Type: {boolean|SortableSet} + +##### Inherited from + +[`Module`](Module.md).[`usedExports`](Module.md#usedexports) + +*** + +#### `useSimpleSourceMap` + +* Type: {boolean} + +##### Inherited from + +[`Module`](Module.md).[`useSimpleSourceMap`](Module.md#usesimplesourcemap) + +*** + +#### `useSourceMap` + +* Type: {boolean} + +##### Inherited from + +[`Module`](Module.md).[`useSourceMap`](Module.md#usesourcemap) + +*** + +#### `warnings` + +* Type: {any} + +##### Inherited from + +[`Module`](Module.md).[`warnings`](Module.md#warnings) + +*** + +#### `STAGE_ATTACH` + +* Type: {number} + +Runtime modules which attach to handlers of other runtime modules + +*** + +#### `STAGE_BASIC` + +* Type: {number} + +Runtime modules with simple dependencies on other runtime modules + +*** + +#### `STAGE_NORMAL` + +* Type: {number} + +Runtime modules without any dependencies to other runtime modules + +*** + +#### `STAGE_TRIGGER` + +* Type: {number} + +Runtime modules which trigger actions on bootstrap + +### Methods + +#### `addBlock(block)` + +##### Parameters + +* `block` {AsyncDependenciesBlock} + +* Returns: {void} + +Adds a DependencyBlock to DependencyBlock relationship. +This is used for when a Module has a AsyncDependencyBlock tie (for code-splitting) + +*** + +#### `addCacheDependencies(fileDependencies, contextDependencies, missingDependencies, buildDependencies)` + +##### Parameters + +* `fileDependencies` {LazySet} +* `contextDependencies` {LazySet} +* `missingDependencies` {LazySet} +* `buildDependencies` {LazySet} + +* Returns: {void} + +*** + +#### `addChunk(chunk)` + +##### Parameters + +* `chunk` {Chunk} + +* Returns: {boolean} + +*** + +#### `addCodeGenerationDependency(codeGenerationDependency)` + +##### Parameters + +* `codeGenerationDependency` {Dependency} + +* Returns: {void} + +*** + +#### `addDependency(dependency)` + +##### Parameters + +* `dependency` {Dependency} + +* Returns: {void} + +*** + +#### `addError(error)` + +##### Parameters + +* `error` {WebpackError} + +* Returns: {void} + +*** + +#### `addPresentationalDependency(presentationalDependency)` + +##### Parameters + +* `presentationalDependency` {Dependency} + +* Returns: {void} + +*** + +#### `addWarning(warning)` + +##### Parameters + +* `warning` {WebpackError} + +* Returns: {void} + +*** + +#### `attach(compilation, chunk[, chunkGraph])` + +##### Parameters + +* `compilation` {Compilation} +* `chunk` {Chunk} +* `chunkGraph` {ChunkGraph} + +* Returns: {void} + +*** + +#### `build(options, compilation, resolver, fs, callback)` + +##### Parameters + +* `options` {WebpackOptionsNormalizedWithDefaults} +* `compilation` {Compilation} +* `resolver` {ResolverWithOptions} +* `fs` {InputFileSystem} +* `callback` {Function} + * `err` {WebpackError} + * Returns: {void} + +* Returns: {void} + +*** + +#### `chunkCondition(chunk, compilation)` + +##### Parameters + +* `chunk` {Chunk} +* `compilation` {Compilation} + +* Returns: {boolean} + +*** + +#### `cleanupForCache()` + +* Returns: {void} + +Assuming this module is in the cache. Remove internal references to allow freeing some memory. + +*** + +#### `clearDependenciesAndBlocks()` + +* Returns: {void} + +Removes all dependencies and blocks + +*** + +#### `clearWarningsAndErrors()` + +* Returns: {void} + +removes all warnings and errors + +*** + +#### `codeGeneration(context)` + +##### Parameters + +* `context` {CodeGenerationContext} + +* Returns: {CodeGenerationResult} + +*** + +#### `deserialize(__namedParameters)` + +##### Parameters + +* `__namedParameters` {ObjectDeserializerContext} + +* Returns: {void} + +*** + +#### `generate()` + +* Returns: {string} + +*** + +#### `getChunks()` + +* Returns: {Chunk[]} + +*** + +#### `getConcatenationBailoutReason(context)` + +##### Parameters + +* `context` {ConcatenationBailoutReasonContext} + +* Returns: {string} + +*** + +#### `getErrors()` + +* Returns: {Iterable} + +*** + +#### `getExportsType(moduleGraph[, strict])` + +##### Parameters + +* `moduleGraph` {ModuleGraph} +* `strict` {boolean} + +* Returns: {ExportsType} + +*** + +#### `getGeneratedCode()` + +* Returns: {string} + +*** + +#### `getNumberOfChunks()` + +* Returns: {number} + +*** + +#### `getNumberOfErrors()` + +* Returns: {number} + +*** + +#### `getNumberOfWarnings()` + +* Returns: {number} + +*** + +#### `getRootBlock()` + +* Returns: {DependenciesBlock} + +*** + +#### `getSideEffectsConnectionState(moduleGraph)` + +##### Parameters + +* `moduleGraph` {ModuleGraph} + +* Returns: {ConnectionState} + +*** + +#### `getSourceBasicTypes()` + +* Returns: {ReadonlySet} + +Basic source types are high-level categories like javascript, css, webassembly, etc. +We only have built-in knowledge about the javascript basic type here; other basic types may be +added or changed over time by generators and do not need to be handled or detected here. +Some modules, e.g. RemoteModule, may return non-basic source types like "remote" and "share-init" +from getSourceTypes(), but their generated output is still JavaScript, i.e. their basic type is JS. + +*** + +#### `getSourceTypes()` + +* Returns: {ReadonlySet} + +*** + +#### `getUnsafeCacheData()` + +* Returns: {UnsafeCacheData} + +Module should be unsafe cached. Get data that's needed for that. +This data will be passed to restoreFromUnsafeCache later. + +*** + +#### `getWarnings()` + +* Returns: {Iterable} + +*** + +#### `hasChunkCondition()` + +* Returns: {boolean} + +*** + +#### `hasReasonForChunk(chunk, moduleGraph, chunkGraph)` + +##### Parameters + +* `chunk` {Chunk} +* `moduleGraph` {ModuleGraph} +* `chunkGraph` {ChunkGraph} + +* Returns: {boolean} + +*** + +#### `hasReasons(moduleGraph, runtime)` + +##### Parameters + +* `moduleGraph` {ModuleGraph} +* `runtime` {RuntimeSpec} + +* Returns: {boolean} + +*** + +#### `identifier()` + +* Returns: {string} + +*** + +#### `invalidateBuild()` + +* Returns: {void} + +*** + +#### `isAccessibleInChunk(chunkGraph, chunk[, ignoreChunk])` + +##### Parameters + +* `chunkGraph` {ChunkGraph} +* `chunk` {Chunk} +* `ignoreChunk` {Chunk} + +* Returns: {boolean} + +*** + +#### `isAccessibleInChunkGroup(chunkGraph, chunkGroup[, ignoreChunk])` + +##### Parameters + +* `chunkGraph` {ChunkGraph} +* `chunkGroup` {ChunkGroup} +* `ignoreChunk` {Chunk} + +* Returns: {boolean} + +*** + +#### `isEntryModule()` + +* Returns: {boolean} + +*** + +#### `isInChunk(chunk)` + +##### Parameters + +* `chunk` {Chunk} + +* Returns: {boolean} + +*** + +#### `isOptional(moduleGraph)` + +##### Parameters + +* `moduleGraph` {ModuleGraph} + +* Returns: {boolean} + +*** + +#### `isProvided(exportName)` + +##### Parameters + +* `exportName` {string} + +* Returns: {boolean} + +*** + +#### `libIdent(options)` + +##### Parameters + +* `options` {LibIdentOptions} + +* Returns: {string} + +*** + +#### `nameForCondition()` + +* Returns: {string} + +*** + +#### `needBuild(context, callback)` + +##### Parameters + +* `context` {NeedBuildContext} +* `callback` {Function} + * `err` {WebpackError} + * `needBuild` {boolean} + * Returns: {void} + +* Returns: {void} + +*** + +#### `needRebuild(fileTimestamps, contextTimestamps)` + +> Stability: 0 - Deprecated + +##### Parameters + +* `fileTimestamps` {Map} +* `contextTimestamps` {Map} + +* Returns: {boolean} + +Use needBuild instead + +*** + +#### `originalSource()` + +* Returns: {Source} + +*** + +#### `readableIdentifier(requestShortener)` + +##### Parameters + +* `requestShortener` {RequestShortener} + +* Returns: {string} + +*** + +#### `removeChunk(chunk)` + +##### Parameters + +* `chunk` {Chunk} + +* Returns: {void} + +*** + +#### `removeDependency(dependency)` + +##### Parameters + +* `dependency` {Dependency} + +* Returns: {void} + +*** + +#### `serialize(__namedParameters)` + +##### Parameters + +* `__namedParameters` {ObjectSerializerContext} + +* Returns: {void} + +*** + +#### `shouldIsolate()` + +* Returns: {boolean} + +*** + +#### `size([type])` + +##### Parameters + +* `type` {string} + +* Returns: {number} + +*** + +#### `source(dependencyTemplates, runtimeTemplate[, type])` + +> Stability: 0 - Deprecated + +##### Parameters + +* `dependencyTemplates` {DependencyTemplates} +* `runtimeTemplate` {RuntimeTemplate} +* `type` {string} + +* Returns: {Source} + +Use codeGeneration() instead + +*** + +#### `updateCacheModule(module)` + +##### Parameters + +* `module` {Module} + +* Returns: {void} + +Assuming this module is in the cache. Update the (cached) module with +the fresh module from the factory. Usually updates internal references +and properties. + +*** + +#### `updateHash(hash, context)` + +##### Parameters + +* `hash` {Hash} +* `context` {UpdateHashContextDependency} + +* Returns: {void} + +*** + +#### Static method: `getSourceBasicTypes(module)` + +> Stability: 0 - Deprecated + +##### Parameters + +* `module` {Module} + +* Returns: {ReadonlySet} + +In webpack 6, call getSourceBasicTypes() directly on the module instance instead of using this static method. + +## `RuntimeGlobals` + +## `amdDefine` + +* Type: {"__webpack_require__.amdD"} + +## `amdOptions` + +* Type: {"__webpack_require__.amdO"} + +## `asyncModule` + +* Type: {"__webpack_require__.a"} + +## `asyncModuleDoneSymbol` + +* Type: {"__webpack_require__.aD"} + +## `asyncModuleExportSymbol` + +* Type: {"__webpack_require__.aE"} + +## `baseURI` + +* Type: {"__webpack_require__.b"} + +## `chunkCallback` + +* Type: {"webpackChunk"} + +## `chunkName` + +* Type: {"__webpack_require__.cn"} + +## `compatGetDefaultExport` + +* Type: {"__webpack_require__.n"} + +## `createFakeNamespaceObject` + +* Type: {"__webpack_require__.t"} + +## `createScript` + +* Type: {"__webpack_require__.ts"} + +## `createScriptUrl` + +* Type: {"__webpack_require__.tu"} + +## `cssInjectStyle` + +* Type: {"__webpack_require__.is"} + +## `cssMergeStyleSheets` + +* Type: {"__webpack_require__.mcs"} + +## `currentRemoteGetScope` + +* Type: {"__webpack_require__.R"} + +## `deferredModuleAsyncTransitiveDependencies` + +* Type: {"__webpack_require__.zT"} + +## `deferredModuleAsyncTransitiveDependenciesSymbol` + +* Type: {"__webpack_require__.zS"} + +## `definePropertyGetters` + +* Type: {"__webpack_require__.d"} + +## `ensureChunk` + +* Type: {"__webpack_require__.e"} + +## `ensureChunkHandlers` + +* Type: {"__webpack_require__.f"} + +## `ensureChunkIncludeEntries` + +* Type: {"__webpack_require__.f (include entries)"} + +## `entryModuleId` + +* Type: {"__webpack_require__.s"} + +## `esmId` + +* Type: {"__webpack_esm_id__"} + +## `esmIds` + +* Type: {"__webpack_esm_ids__"} + +## `esmModules` + +* Type: {"__webpack_esm_modules__"} + +## `esmRuntime` + +* Type: {"__webpack_esm_runtime__"} + +## `exports` + +* Type: {"__webpack_exports__"} + +## `externalInstallChunk` + +* Type: {"__webpack_require__.C"} + +## `getChunkCssFilename` + +* Type: {"__webpack_require__.k"} + +## `getChunkScriptFilename` + +* Type: {"__webpack_require__.u"} + +## `getChunkUpdateCssFilename` + +* Type: {"__webpack_require__.hk"} + +## `getChunkUpdateScriptFilename` + +* Type: {"__webpack_require__.hu"} + +## `getFullHash` + +* Type: {"__webpack_require__.h"} + +## `getTrustedTypesPolicy` + +* Type: {"__webpack_require__.tt"} + +## `getUpdateManifestFilename` + +* Type: {"__webpack_require__.hmrF"} + +## `global` + +* Type: {"__webpack_require__.g"} + +## `harmonyModuleDecorator` + +* Type: {"__webpack_require__.hmd"} + +## `hasCssModules` + +* Type: {"has css modules"} + +## `hasFetchPriority` + +* Type: {"has fetch priority"} + +## `hasOwnProperty` + +* Type: {"__webpack_require__.o"} + +## `hmrDownloadManifest` + +* Type: {"__webpack_require__.hmrM"} + +## `hmrDownloadUpdateHandlers` + +* Type: {"__webpack_require__.hmrC"} + +## `hmrInvalidateModuleHandlers` + +* Type: {"__webpack_require__.hmrI"} + +## `hmrModuleData` + +* Type: {"__webpack_require__.hmrD"} + +## `hmrRuntimeStatePrefix` + +* Type: {"__webpack_require__.hmrS"} + +## `initializeSharing` + +* Type: {"__webpack_require__.I"} + +## `instantiateWasm` + +* Type: {"__webpack_require__.v"} + +## `interceptModuleExecution` + +* Type: {"__webpack_require__.i"} + +## `loadScript` + +* Type: {"__webpack_require__.l"} + +## `makeDeferredNamespaceObject` + +* Type: {"__webpack_require__.z"} + +## `makeNamespaceObject` + +* Type: {"__webpack_require__.r"} + +## `makeOptimizedDeferredNamespaceObject` + +* Type: {"__webpack_require__.zO"} + +## `module` + +* Type: {"module"} + +## `moduleCache` + +* Type: {"__webpack_require__.c"} + +## `moduleFactories` + +* Type: {"__webpack_require__.m"} + +## `moduleFactoriesAddOnly` + +* Type: {"__webpack_require__.m (add only)"} + +## `moduleId` + +* Type: {"module.id"} + +## `moduleLoaded` + +* Type: {"module.loaded"} + +## `nodeModuleDecorator` + +* Type: {"__webpack_require__.nmd"} + +## `onChunksLoaded` + +* Type: {"__webpack_require__.O"} + +## `prefetchChunk` + +* Type: {"__webpack_require__.E"} + +## `prefetchChunkHandlers` + +* Type: {"__webpack_require__.F"} + +## `preloadChunk` + +* Type: {"__webpack_require__.G"} + +## `preloadChunkHandlers` + +* Type: {"__webpack_require__.H"} + +## `publicPath` + +* Type: {"__webpack_require__.p"} + +## `relativeUrl` + +* Type: {"__webpack_require__.U"} + +## `require` + +* Type: {"__webpack_require__"} + +## `requireScope` + +* Type: {"__webpack_require__.*"} + +## `returnExportsFromRuntime` + +* Type: {"return-exports-from-runtime"} + +## `runtimeId` + +* Type: {"__webpack_require__.j"} + +## `scriptNonce` + +* Type: {"__webpack_require__.nc"} + +## `shareScopeMap` + +* Type: {"__webpack_require__.S"} + +## `startup` + +* Type: {"__webpack_require__.x"} + +## `startupEntrypoint` + +* Type: {"__webpack_require__.X"} + +## `startupNoDefault` + +* Type: {"__webpack_require__.x (no default handler)"} + +## `startupOnlyAfter` + +* Type: {"__webpack_require__.x (only after)"} + +## `startupOnlyBefore` + +* Type: {"__webpack_require__.x (only before)"} + +## `system` + +* Type: {"__webpack_require__.System"} + +## `systemContext` + +* Type: {"__webpack_require__.y"} + +## `thisAsExports` + +* Type: {"top-level-this-exports"} + +## `toBinary` + +* Type: {"__webpack_require__.tb"} + +## `uncaughtErrorHandler` + +* Type: {"__webpack_require__.oe"} + +## `wasmInstances` + +* Type: {"__webpack_require__.w"} + +## Class: `RuntimeChunkPlugin` + +### Constructors + +#### `new RuntimeChunkPlugin([options])` + +##### Parameters + +* `options` {object} + * `name` {Function} The name factory for the runtime chunks. + * `entrypoint` {object} + * `name` {string} + * Returns: {string} + +* Returns: {RuntimeChunkPlugin} + +### Properties + +#### `options` + +* Type: {object} + +* `name` {string|Function} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} + +Apply the plugin + +## Class: `RuntimeSpecMap` + +### Type Parameters + +### Constructors + +#### `new RuntimeSpecMap([clone])` + +##### Parameters + +* `clone` {RuntimeSpecMap} + +* Returns: {RuntimeSpecMap} + +### Properties + +#### `size` + +* Type: {number} + +### Methods + +#### `delete(runtime)` + +##### Parameters + +* `runtime` {RuntimeSpec} + +* Returns: {void} + +*** + +#### `get(runtime)` + +##### Parameters + +* `runtime` {RuntimeSpec} + +* Returns: {R} + +*** + +#### `has(runtime)` + +##### Parameters + +* `runtime` {RuntimeSpec} + +* Returns: {boolean} + +*** + +#### `keys()` + +* Returns: {RuntimeSpec[]} + +*** + +#### `provide(runtime, computer)` + +##### Parameters + +* `runtime` {RuntimeSpec} +* `computer` {Function} + * Returns: {R} + +* Returns: {R} + +*** + +#### `set(runtime, value)` + +##### Parameters + +* `runtime` {RuntimeSpec} +* `value` {R} + +* Returns: {void} + +*** + +#### `update(runtime, fn)` + +##### Parameters + +* `runtime` {RuntimeSpec} +* `fn` {Function} + * `value` {R} + * Returns: {R} + +* Returns: {void} + +*** + +#### `values()` + +* Returns: {IterableIterator} + +## Class: `RuntimeSpecSet` + +### Constructors + +#### `new RuntimeSpecSet([iterable])` + +##### Parameters + +* `iterable` {Iterable} + +* Returns: {RuntimeSpecSet} + +### Properties + +#### `size` + +* Type: {number} + +### Methods + +#### `[iterator]()` + +* Returns: {IterableIterator} + +*** + +#### `add(runtime)` + +##### Parameters + +* `runtime` {RuntimeSpec} + +* Returns: {void} + +*** + +#### `has(runtime)` + +##### Parameters + +* `runtime` {RuntimeSpec} + +* Returns: {boolean} diff --git a/pages/v5.x/Stats.md b/pages/v5.x/Stats.md new file mode 100644 index 0000000..f94f92d --- /dev/null +++ b/pages/v5.x/Stats.md @@ -0,0 +1,628 @@ +# Stats + + + +## Class: `Stats` + +### Constructors + +#### `new Stats(compilation)` + +##### Parameters + +* `compilation` {Compilation} + +* Returns: {Stats} + +### Properties + +#### `compilation` + +* Type: {Compilation} + +*** + +#### `endTime` + +* Type: {number} + +*** + +#### `hash` + +* Type: {string} + +*** + +#### `startTime` + +* Type: {number} + +### Methods + +#### `hasErrors()` + +* Returns: {boolean} + +*** + +#### `hasWarnings()` + +* Returns: {boolean} + +*** + +#### `toJson([options])` + +##### Parameters + +* `options` {boolean|"verbose"|"none"|"summary"|"errors-only"|"errors-warnings"|"minimal"|"normal"|"detailed"|StatsOptions} + +* Returns: {StatsCompilation} + +*** + +#### `toString([options])` + +##### Parameters + +* `options` {boolean|"verbose"|"none"|"summary"|"errors-only"|"errors-warnings"|"minimal"|"normal"|"detailed"|StatsOptions} + +* Returns: {string} + +## `StatsOptions` + +Stats options object. + +### Properties + +#### `all` + +* Type: {boolean} Optional. + +Fallback value for stats options when an option is not defined (has precedence over local webpack defaults). + +#### `assets` + +* Type: {boolean} Optional. + +Add assets information. + +#### `assetsSort` + +* Type: {string|false} Optional. + +Sort the assets by that field. + +#### `assetsSpace` + +* Type: {number} Optional. + +Space to display assets (groups will be collapsed to fit this space). + +#### `builtAt` + +* Type: {boolean} Optional. + +Add built at time information. + +#### `cached` + +* Type: {boolean} Optional. + +Add information about cached (not built) modules (deprecated: use 'cachedModules' instead). + +##### Deprecated + +#### `cachedAssets` + +* Type: {boolean} Optional. + +Show cached assets (setting this to `false` only shows emitted files). + +#### `cachedModules` + +* Type: {boolean} Optional. + +Add information about cached (not built) modules. + +#### `children` + +* Type: {boolean|"verbose"|"none"|"summary"|"errors-only"|"errors-warnings"|"minimal"|"normal"|"detailed"|StatsOptions|StatsValue[]} Optional. + +Add children information. + +#### `chunkGroupAuxiliary` + +* Type: {boolean} Optional. + +Display auxiliary assets in chunk groups. + +#### `chunkGroupChildren` + +* Type: {boolean} Optional. + +Display children of chunk groups. + +#### `chunkGroupMaxAssets` + +* Type: {number} Optional. + +Limit of assets displayed in chunk groups. + +#### `chunkGroups` + +* Type: {boolean} Optional. + +Display all chunk groups with the corresponding bundles. + +#### `chunkModules` + +* Type: {boolean} Optional. + +Add built modules information to chunk information. + +#### `chunkModulesSpace` + +* Type: {number} Optional. + +Space to display chunk modules (groups will be collapsed to fit this space, value is in number of modules/group). + +#### `chunkOrigins` + +* Type: {boolean} Optional. + +Add the origins of chunks and chunk merging info. + +#### `chunkRelations` + +* Type: {boolean} Optional. + +Add information about parent, children and sibling chunks to chunk information. + +#### `chunks` + +* Type: {boolean} Optional. + +Add chunk information. + +#### `chunksSort` + +* Type: {string|false} Optional. + +Sort the chunks by that field. + +#### `colors` + +* Type: {boolean|object} Optional. + +Enables/Disables colorful output. + +##### Union Members + +{boolean} + +*** + +###### Type Literal + +{object} + +* `bold` {string} Custom color for bold text. +* `cyan` {string} Custom color for cyan text. +* `green` {string} Custom color for green text. +* `magenta` {string} Custom color for magenta text. +* `red` {string} Custom color for red text. +* `yellow` {string} Custom color for yellow text. + +#### `context` + +* Type: {string} Optional. + +Context directory for request shortening. + +#### `dependentModules` + +* Type: {boolean} Optional. + +Show chunk modules that are dependencies of other modules of the chunk. + +#### `depth` + +* Type: {boolean} Optional. + +Add module depth in module graph. + +#### `entrypoints` + +* Type: {boolean|"auto"} Optional. + +Display the entry points with the corresponding bundles. + +#### `env` + +* Type: {boolean} Optional. + +Add --env information. + +#### `errorCause` + +* Type: {boolean|"auto"} Optional. + +Add cause to errors. + +#### `errorDetails` + +* Type: {boolean|"auto"} Optional. + +Add details to errors (like resolving log). + +#### `errorErrors` + +* Type: {boolean|"auto"} Optional. + +Add nested errors to errors (like in AggregateError). + +#### `errors` + +* Type: {boolean} Optional. + +Add errors. + +#### `errorsCount` + +* Type: {boolean} Optional. + +Add errors count. + +#### `errorsSpace` + +* Type: {number} Optional. + +Space to display errors (value is in number of lines). + +#### `errorStack` + +* Type: {boolean} Optional. + +Add internal stack trace to errors. + +#### `exclude` + +* Type: {string|boolean|RegExp|ModuleFilterItemTypes[]|Function} Optional. + +Please use excludeModules instead. + +#### `excludeAssets` + +* Type: {string|RegExp|AssetFilterItemTypes[]|Function} Optional. + +Suppress assets that match the specified filters. Filters can be Strings, RegExps or Functions. + +#### `excludeModules` + +* Type: {string|boolean|RegExp|ModuleFilterItemTypes[]|Function} Optional. + +Suppress modules that match the specified filters. Filters can be Strings, RegExps, Booleans or Functions. + +#### `groupAssetsByChunk` + +* Type: {boolean} Optional. + +Group assets by how their are related to chunks. + +#### `groupAssetsByEmitStatus` + +* Type: {boolean} Optional. + +Group assets by their status (emitted, compared for emit or cached). + +#### `groupAssetsByExtension` + +* Type: {boolean} Optional. + +Group assets by their extension. + +#### `groupAssetsByInfo` + +* Type: {boolean} Optional. + +Group assets by their asset info (immutable, development, hotModuleReplacement, etc). + +#### `groupAssetsByPath` + +* Type: {boolean} Optional. + +Group assets by their path. + +#### `groupModulesByAttributes` + +* Type: {boolean} Optional. + +Group modules by their attributes (errors, warnings, assets, optional, orphan, or dependent). + +#### `groupModulesByCacheStatus` + +* Type: {boolean} Optional. + +Group modules by their status (cached or built and cacheable). + +#### `groupModulesByExtension` + +* Type: {boolean} Optional. + +Group modules by their extension. + +#### `groupModulesByLayer` + +* Type: {boolean} Optional. + +Group modules by their layer. + +#### `groupModulesByPath` + +* Type: {boolean} Optional. + +Group modules by their path. + +#### `groupModulesByType` + +* Type: {boolean} Optional. + +Group modules by their type. + +#### `groupReasonsByOrigin` + +* Type: {boolean} Optional. + +Group reasons by their origin module. + +#### `hash` + +* Type: {boolean} Optional. + +Add the hash of the compilation. + +#### `ids` + +* Type: {boolean} Optional. + +Add ids. + +#### `logging` + +* Type: {boolean|"error"|"warn"|"info"|"log"|"verbose"|"none"} Optional. + +Add logging output. + +#### `loggingDebug` + +* Type: {string|boolean|RegExp|FilterItemTypes[]|Function} Optional. + +Include debug logging of specified loggers (i. e. for plugins or loaders). Filters can be Strings, RegExps or Functions. + +#### `loggingTrace` + +* Type: {boolean} Optional. + +Add stack traces to logging output. + +#### `moduleAssets` + +* Type: {boolean} Optional. + +Add information about assets inside modules. + +#### `modules` + +* Type: {boolean} Optional. + +Add built modules information. + +#### `modulesSort` + +* Type: {string|false} Optional. + +Sort the modules by that field. + +#### `modulesSpace` + +* Type: {number} Optional. + +Space to display modules (groups will be collapsed to fit this space, value is in number of modules/groups). + +#### `moduleTrace` + +* Type: {boolean} Optional. + +Add dependencies and origin of warnings/errors. + +#### `nestedModules` + +* Type: {boolean} Optional. + +Add information about modules nested in other modules (like with module concatenation). + +#### `nestedModulesSpace` + +* Type: {number} Optional. + +Space to display modules nested within other modules (groups will be collapsed to fit this space, value is in number of modules/group). + +#### `optimizationBailout` + +* Type: {boolean} Optional. + +Show reasons why optimization bailed out for modules. + +#### `orphanModules` + +* Type: {boolean} Optional. + +Add information about orphan modules. + +#### `outputPath` + +* Type: {boolean} Optional. + +Add output path information. + +#### `performance` + +* Type: {boolean} Optional. + +Add performance hint flags. + +#### `preset` + +* Type: {string|boolean} Optional. + +Preset for the default values. + +#### `providedExports` + +* Type: {boolean} Optional. + +Show exports provided by modules. + +#### `publicPath` + +* Type: {boolean} Optional. + +Add public path information. + +#### `reasons` + +* Type: {boolean} Optional. + +Add information about the reasons why modules are included. + +#### `reasonsSpace` + +* Type: {number} Optional. + +Space to display reasons (groups will be collapsed to fit this space). + +#### `relatedAssets` + +* Type: {boolean} Optional. + +Add information about assets that are related to other assets (like SourceMaps for assets). + +#### `runtime` + +* Type: {boolean} Optional. + +Add information about runtime modules (deprecated: use 'runtimeModules' instead). + +##### Deprecated + +#### `runtimeModules` + +* Type: {boolean} Optional. + +Add information about runtime modules. + +#### `source` + +* Type: {boolean} Optional. + +Add the source code of modules. + +#### `timings` + +* Type: {boolean} Optional. + +Add timing information. + +#### `usedExports` + +* Type: {boolean} Optional. + +Show exports used by modules. + +#### `version` + +* Type: {boolean} Optional. + +Add webpack version information. + +#### `warnings` + +* Type: {boolean} Optional. + +Add warnings. + +#### `warningsCount` + +* Type: {boolean} Optional. + +Add warnings count. + +#### `warningsFilter` + +* Type: {string|RegExp|WarningFilterItemTypes[]|Function} Optional. + +Suppress listing warnings that match the specified filters (they will still be counted). Filters can be Strings, RegExps or Functions. + +#### `warningsSpace` + +* Type: {number} Optional. + +Space to display warnings (value is in number of lines). + +## `StatsAsset` + +* Type: {KnownStatsAsset & Record} + +## `StatsChunk` + +* Type: {KnownStatsChunk & Record} + +## `StatsChunkGroup` + +* Type: {KnownStatsChunkGroup & Record} + +## `StatsChunkOrigin` + +* Type: {KnownStatsChunkOrigin & Record} + +## `StatsCompilation` + +* Type: {KnownStatsCompilation & Record} + +## `StatsError` + +* Type: {KnownStatsError & Record} + +## `StatsLogging` + +* Type: {KnownStatsLogging & Record} + +## `StatsLoggingEntry` + +* Type: {KnownStatsLoggingEntry & Record} + +## `StatsModule` + +* Type: {KnownStatsModule & Record} + +## `StatsModuleIssuer` + +* Type: {KnownStatsModuleIssuer & Record} + +## `StatsModuleReason` + +* Type: {KnownStatsModuleReason & Record} + +## `StatsModuleTraceDependency` + +* Type: {KnownStatsModuleTraceDependency & Record} + +## `StatsModuleTraceItem` + +* Type: {KnownStatsModuleTraceItem & Record} + +## `StatsProfile` + +* Type: {KnownStatsProfile & Record} diff --git a/pages/v5.x/Template.md b/pages/v5.x/Template.md new file mode 100644 index 0000000..514d500 --- /dev/null +++ b/pages/v5.x/Template.md @@ -0,0 +1,176 @@ +# Template + + + +## Class: `Template` + +### Constructors + +#### `new Template()` + +* Returns: {Template} + +### Properties + +#### `NUMBER_OF_IDENTIFIER_CONTINUATION_CHARS` + +* Type: {number} + +*** + +#### `NUMBER_OF_IDENTIFIER_START_CHARS` + +* Type: {number} + +### Methods + +#### Static method: `asString(str)` + +##### Parameters + +* `str` {string|string[]} + +* Returns: {string} + +*** + +#### Static method: `getFunctionContent(fn)` + +##### Parameters + +* `fn` {Stringable} + +* Returns: {string} + +*** + +#### Static method: `getModulesArrayBounds(modules)` + +##### Parameters + +* `modules` {WithId[]} + +* Returns: {false|[number, number]} + +*** + +#### Static method: `indent(s)` + +##### Parameters + +* `s` {string|string[]} + +* Returns: {string} + +*** + +#### Static method: `numberToIdentifier(n)` + +##### Parameters + +* `n` {number} + +* Returns: {string} + +*** + +#### Static method: `numberToIdentifierContinuation(n)` + +##### Parameters + +* `n` {number} + +* Returns: {string} + +*** + +#### Static method: `prefix(s, prefix)` + +##### Parameters + +* `s` {string|string[]} +* `prefix` {string} + +* Returns: {string} + +*** + +#### Static method: `renderChunkModules(renderContext, modules, renderModule[, prefix])` + +##### Parameters + +* `renderContext` {ChunkRenderContextJavascriptModulesPlugin} +* `modules` {Module[]} +* `renderModule` {Function} + * `module` {Module} + * `renderInArray` {boolean} + * Returns: {Source} +* `prefix` {string} + +* Returns: {Source} + +*** + +#### Static method: `renderChunkRuntimeModules(runtimeModules, renderContext)` + +##### Parameters + +* `runtimeModules` {RuntimeModule[]} +* `renderContext` {RenderContextJavascriptModulesPlugin} + +* Returns: {Source} + +*** + +#### Static method: `renderRuntimeModules(runtimeModules, renderContext)` + +##### Parameters + +* `runtimeModules` {RuntimeModule[]} +* `renderContext` {RenderContextJavascriptModulesPlugin & object} + +* Returns: {Source} + +*** + +#### Static method: `toComment(str)` + +##### Parameters + +* `str` {string} + +* Returns: {string} + +*** + +#### Static method: `toIdentifier(str)` + +##### Parameters + +* `str` {string} + +* Returns: {string} + +*** + +#### Static method: `toNormalComment(str)` + +##### Parameters + +* `str` {string} + +* Returns: {string} + +*** + +#### Static method: `toPath(str)` + +##### Parameters + +* `str` {string} + +* Returns: {string} + +## `TemplatePath` + +* Type: {string|Function} diff --git a/pages/v5.x/UsageState.md b/pages/v5.x/UsageState.md new file mode 100644 index 0000000..0660581 --- /dev/null +++ b/pages/v5.x/UsageState.md @@ -0,0 +1,7 @@ +# UsageState + + + +## `UsageState` + +* Type: {Readonly} diff --git a/pages/v5.x/WatchIgnore.md b/pages/v5.x/WatchIgnore.md new file mode 100644 index 0000000..35097da --- /dev/null +++ b/pages/v5.x/WatchIgnore.md @@ -0,0 +1,43 @@ +# WatchIgnore + + + +## `WatchIgnorePluginOptions` + +### Properties + +#### `paths` + +* Type: {string|RegExp[]} + +A list of RegExps or absolute paths to directories or files that should be ignored. + +## Class: `WatchIgnorePlugin` + +### Constructors + +#### `new WatchIgnorePlugin(options)` + +##### Parameters + +* `options` {WatchIgnorePluginOptions} + +* Returns: {WatchIgnorePlugin} + +### Properties + +#### `options` + +* Type: {WatchIgnorePluginOptions} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} + +Apply the plugin diff --git a/pages/v5.x/Watching.md b/pages/v5.x/Watching.md new file mode 100644 index 0000000..c99ac7f --- /dev/null +++ b/pages/v5.x/Watching.md @@ -0,0 +1,146 @@ +# Watching + + + +## Class: `Watching` + +### Constructors + +#### `new Watching()` + +* Returns: {Watching} + +### Properties + +#### `blocked` + +* Type: {boolean} + +*** + +#### `callbacks` + +* Type: {Function[]} + +##### Parameters + +* `err` {Error} +* `result` {void} + +* Returns: {void} + +*** + +#### `closed` + +* Type: {boolean} + +*** + +#### `compiler` + +* Type: {Compiler} + +*** + +#### `handler` + +* Type: {CallbackWebpackFunction_2} + +*** + +#### `invalid` + +* Type: {boolean} + +*** + +#### `lastWatcherStartTime` + +* Type: {number} Optional. + +*** + +#### `pausedWatcher` + +* Type: {Watcher} Optional. + +*** + +#### `running` + +* Type: {boolean} + +*** + +#### `startTime` + +* Type: {number} + +*** + +#### `suspended` + +* Type: {boolean} + +*** + +#### `watcher` + +* Type: {Watcher} Optional. + +*** + +#### `watchOptions` + +* Type: {WatchOptions} + +### Methods + +#### `close(callback)` + +##### Parameters + +* `callback` {Function} + * `err` {Error} + * `result` {void} + * Returns: {void} + +* Returns: {void} + +*** + +#### `invalidate([callback])` + +##### Parameters + +* `callback` {Function} + * `err` {Error} + * `result` {void} + * Returns: {void} + +* Returns: {void} + +*** + +#### `resume()` + +* Returns: {void} + +*** + +#### `suspend()` + +* Returns: {void} + +*** + +#### `watch(files, dirs, missing)` + +##### Parameters + +* `files` {Iterable} +* `dirs` {Iterable} +* `missing` {Iterable} + +* Returns: {void} diff --git a/pages/v5.x/Webpack.md b/pages/v5.x/Webpack.md new file mode 100644 index 0000000..d740ea9 --- /dev/null +++ b/pages/v5.x/Webpack.md @@ -0,0 +1,661 @@ +# Webpack + + + +## `WebpackPluginInstance` + +Plugin instance. + +### Indexable + +> \[`index`: {string}\]: {any} + +### Properties + +#### `apply` + +* Type: {Function} + +The run point of the plugin, required method. + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} + +## Class: `WebpackError` + +* Extends: {Error} + +### Indexable + +> \[`index`: {number}\]: {Function} + +### Constructors + +#### `new WebpackError([message][, options])` + +##### Parameters + +* `message` {string} +* `options` {object} + * `cause` {unknown} + +* Returns: {WebpackError} + +Creates an instance of WebpackError. + +### Properties + +#### `chunk` + +* Type: {Chunk} Optional. + +#### `details` + +* Type: {string} Optional. + +#### `file` + +* Type: {string} Optional. + +#### `hideStack` + +* Type: {boolean} Optional. + +#### `loc` + +* Type: {SyntheticDependencyLocation|RealDependencyLocation} Optional. + +#### `message` + +* Type: {string} + +##### Inherited from + +`Error.message` + +#### `module` + +* Type: {Module} Optional. + +#### `name` + +* Type: {string} + +##### Inherited from + +`Error.name` + +#### `stack` + +* Type: {string} Optional. + +##### Inherited from + +`Error.stack` + +#### `stackTraceLimit` + +* Type: {number} + +The `Error.stackTraceLimit` property specifies the number of stack frames +collected by a stack trace (whether generated by `new Error().stack` or +`Error.captureStackTrace(obj)`). +The default value is `10` but may be set to any valid JavaScript number. Changes +will affect any stack trace captured _after_ the value has been changed. +If set to a non-number value, or set to a negative number, stack traces will +not capture any frames. + +##### Overrides + +`Error.stackTraceLimit` + +### Methods + +#### `deserialize(__namedParameters)` + +##### Parameters + +* `__namedParameters` {ObjectDeserializerContext} + +* Returns: {void} + +#### `serialize(__namedParameters)` + +##### Parameters + +* `__namedParameters` {ObjectSerializerContext} + +* Returns: {void} + +#### Static method: `captureStackTrace(targetObject[, constructorOpt])` + +##### Parameters + +* `targetObject` {object} +* `constructorOpt` {Function} + +* Returns: {void} + +Creates a `.stack` property on `targetObject`, which when accessed returns +a string representing the location in the code at which +`Error.captureStackTrace()` was called. +```js +const myObject = {}; +Error.captureStackTrace(myObject); +myObject.stack; // Similar to `new Error().stack` +``` +The first line of the trace will be prefixed with +`${myObject.name}: ${myObject.message}`. +The optional `constructorOpt` argument accepts a function. If given, all frames +above `constructorOpt`, including `constructorOpt`, will be omitted from the +generated stack trace. +The `constructorOpt` argument is useful for hiding implementation +details of error generation from the user. For instance: +```js +function a() { + b(); +} +function b() { + c(); +} +function c() { + // Create an error without stack trace to avoid calculating the stack trace twice. + const { stackTraceLimit } = Error; + Error.stackTraceLimit = 0; + const error = new Error(); + Error.stackTraceLimit = stackTraceLimit; + // Capture the stack trace above function b + Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace + throw error; +} +a(); +``` + +#### Static method: `prepareStackTrace(err, stackTraces)` + +##### Parameters + +* `err` {Error} +* `stackTraces` {CallSite[]} + +* Returns: {any} + +## Class: `WebpackOptionsApply` + +* Extends: {OptionsApply} + +### Constructors + +#### `new WebpackOptionsApply()` + +* Returns: {WebpackOptionsApply} + +### Methods + +#### `process(options, compiler[, interception])` + +##### Parameters + +* `options` {WebpackOptionsNormalizedWithDefaults} +* `compiler` {Compiler} +* `interception` {WebpackOptionsInterception} + +* Returns: {WebpackOptionsNormalizedWithDefaults} + +## Class: `WebpackOptionsDefaulter` + +### Constructors + +#### `new WebpackOptionsDefaulter()` + +* Returns: {WebpackOptionsDefaulter} + +### Methods + +#### `process(options)` + +##### Parameters + +* `options` {Configuration} + +* Returns: {WebpackOptionsNormalized} + +## Class: `WebpackOptionsValidationError` + +* Extends: {Error} + +### Constructors + +#### `new WebpackOptionsValidationError(errors, schema[, configuration])` + +##### Parameters + +* `errors` {SchemaUtilErrorObject[]} array of error objects +* `schema` {Schema} schema +* `configuration` {ValidationErrorConfiguration} configuration + +* Returns: {ValidationError} + +### Properties + +#### `baseDataPath` + +* Type: {string} + +#### `errors` + +* Type: {SchemaUtilErrorObject[]} + +#### `headerName` + +* Type: {string} + +#### `message` + +* Type: {string} + +##### Inherited from + +`Error.message` + +#### `name` + +* Type: {string} + +##### Inherited from + +`Error.name` + +#### `postFormatter` + +* Type: {PostFormatter} + +#### `schema` + +* Type: {Schema} + +#### `stack` + +* Type: {string} Optional. + +##### Inherited from + +`Error.stack` + +#### `stackTraceLimit` + +* Type: {number} + +The `Error.stackTraceLimit` property specifies the number of stack frames +collected by a stack trace (whether generated by `new Error().stack` or +`Error.captureStackTrace(obj)`). + +The default value is `10` but may be set to any valid JavaScript number. Changes +will affect any stack trace captured _after_ the value has been changed. + +If set to a non-number value, or set to a negative number, stack traces will +not capture any frames. + +##### Inherited from + +`Error.stackTraceLimit` + +### Methods + +#### `formatSchema(schema[, logic][, prevSchemas])` + +##### Parameters + +* `schema` {Schema} schema +* `logic` {boolean} logic +* `prevSchemas` {object[]} prev schemas + +* Returns: {string} formatted schema + +#### `formatValidationError(error)` + +##### Parameters + +* `error` {SchemaUtilErrorObject} error object + +* Returns: {string} formatted error object + +#### `formatValidationErrors(errors)` + +##### Parameters + +* `errors` {SchemaUtilErrorObject[]} errors + +* Returns: {string} formatted errors + +#### `getSchemaPart(path)` + +##### Parameters + +* `path` {string} path + +* Returns: {Schema} schema + +#### `getSchemaPartDescription([schemaPart])` + +##### Parameters + +* `schemaPart` {Schema} schema part + +* Returns: {string} schema part description + +#### `getSchemaPartText([schemaPart][, additionalPath][, needDot][, logic])` + +##### Parameters + +* `schemaPart` {Schema} schema part +* `additionalPath` {boolean|string[]} additional path +* `needDot` {boolean} true when need dot +* `logic` {boolean} logic + +* Returns: {string} schema part text + +#### Static method: `captureStackTrace(targetObject[, constructorOpt])` + +##### Parameters + +* `targetObject` {object} +* `constructorOpt` {Function} + +* Returns: {void} + +Creates a `.stack` property on `targetObject`, which when accessed returns +a string representing the location in the code at which +`Error.captureStackTrace()` was called. + +```js +const myObject = {}; +Error.captureStackTrace(myObject); +myObject.stack; // Similar to `new Error().stack` +``` + +The first line of the trace will be prefixed with +`${myObject.name}: ${myObject.message}`. + +The optional `constructorOpt` argument accepts a function. If given, all frames +above `constructorOpt`, including `constructorOpt`, will be omitted from the +generated stack trace. + +The `constructorOpt` argument is useful for hiding implementation +details of error generation from the user. For instance: + +```js +function a() { + b(); +} + +function b() { + c(); +} + +function c() { + // Create an error without stack trace to avoid calculating the stack trace twice. + const { stackTraceLimit } = Error; + Error.stackTraceLimit = 0; + const error = new Error(); + Error.stackTraceLimit = stackTraceLimit; + + // Capture the stack trace above function b + Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace + throw error; +} + +a(); +``` + +#### Static method: `prepareStackTrace(err, stackTraces)` + +##### Parameters + +* `err` {Error} +* `stackTraces` {CallSite[]} + +* Returns: {any} + +## `WebpackOptionsNormalized` + +Normalized webpack options object. + +### Properties + +#### `amd` + +* Type: {false|object} Optional. + +Set the value of `require.amd` and `define.amd`. Or disable AMD support. + +#### `bail` + +* Type: {boolean} Optional. + +Report the first error as a hard error instead of tolerating it. + +#### `cache` + +* Type: {CacheOptionsNormalized} + +Cache generated modules and chunks to improve performance for multiple incremental builds. + +#### `context` + +* Type: {string} Optional. + +The base directory (absolute path!) for resolving the `entry` option. If `output.pathinfo` is set, the included pathinfo is shortened to this directory. + +#### `dependencies` + +* Type: {string[]} Optional. + +References to other configurations to depend on. + +#### `devServer` + +* Type: {false|object} Optional. + +Options for the webpack-dev-server. + +#### `devtool` + +* Type: {string|false|object[]} Optional. + +A developer tool to enhance debugging (false | eval | [inline-|hidden-|eval-][nosources-][cheap-[module-]]source-map). + +#### `dotenv` + +* Type: {boolean|DotenvPluginOptions} Optional. + +Enable and configure the Dotenv plugin to load environment variables from .env files. + +#### `entry` + +* Type: {EntryNormalized} + +The entry point(s) of the compilation. + +#### `experiments` + +* Type: {ExperimentsNormalized} + +Enables/Disables experiments (experimental features with relax SemVer compatibility). + +#### `externals` + +* Type: {Externals} + +Specify dependencies that shouldn't be resolved by webpack, but should become dependencies of the resulting bundle. The kind of the dependency depends on `output.libraryTarget`. + +#### `externalsPresets` + +* Type: {ExternalsPresets} + +Enable presets of externals for specific targets. + +#### `externalsType` + +* Type: {"asset"|"module"|"css-import"|"css-url"|"global"|"import"|"commonjs"|"jsonp"|"promise"|"this"|"var"|"assign"|"window"|"self"|"commonjs2"|"commonjs-module"|"commonjs-static"|"amd"|"amd-require"|"umd"|"umd2"|"system"|"module-import"|"script"|"node-commonjs"} Optional. + +Specifies the default type of externals ('amd*', 'umd*', 'system' and 'jsonp' depend on output.libraryTarget set to the same value). + +#### `ignoreWarnings` + +* Type: {Function[]} Optional. + +Ignore specific warnings. + +##### Parameters + +* `warning` {Error} +* `compilation` {Compilation} + +* Returns: {boolean} + +#### `infrastructureLogging` + +* Type: {InfrastructureLogging} + +Options for infrastructure level logging. + +#### `loader` + +* Type: {Loader} Optional. + +Custom values available in the loader context. + +#### `mode` + +* Type: {"development"|"none"|"production"} Optional. + +Enable production optimizations or development hints. + +#### `module` + +* Type: {ModuleOptionsNormalized} + +Options affecting the normal modules (`NormalModuleFactory`). + +#### `name` + +* Type: {string} Optional. + +Name of the configuration. Used when loading multiple configurations. + +#### `node` + +* Type: {Node} + +Include polyfills or mocks for various node stuff. + +#### `optimization` + +* Type: {OptimizationNormalized} + +Enables/Disables integrated optimizations. + +#### `output` + +* Type: {OutputNormalized} + +Normalized options affecting the output of the compilation. `output` options tell webpack how to write the compiled files to disk. + +#### `parallelism` + +* Type: {number} Optional. + +The number of parallel processed modules in the compilation. + +#### `performance` + +* Type: {false|PerformanceOptions} Optional. + +Configuration for web performance recommendations. + +#### `plugins` + +* Type: {WebpackPluginInstance|Function[]} + +Add additional plugins to the compiler. + +#### `profile` + +* Type: {boolean} Optional. + +Capture timing information for each module. + +#### `recordsInputPath` + +* Type: {string|false} Optional. + +Store compiler state to a json file. + +#### `recordsOutputPath` + +* Type: {string|false} Optional. + +Load compiler state from a json file. + +#### `resolve` + +* Type: {ResolveOptions} + +Options for the resolver. + +#### `resolveLoader` + +* Type: {ResolveOptions} + +Options for the resolver when resolving loaders. + +#### `snapshot` + +* Type: {SnapshotOptionsWebpackOptions} + +Options affecting how file system snapshots are created and validated. + +#### `stats` + +* Type: {StatsValue} + +Stats options object or preset name. + +#### `target` + +* Type: {string|false|string[]} Optional. + +Environment to build for. An array of environments to build for all of them when possible. + +#### `validate` + +* Type: {boolean} Optional. + +Enable validation of webpack configuration. Defaults to true in development mode. In production mode, defaults to true unless futureDefaults is enabled, then defaults to false. + +#### `watch` + +* Type: {boolean} Optional. + +Enter watch mode, which rebuilds on file change. + +#### `watchOptions` + +* Type: {WatchOptions} + +Options for the watcher. + +## `WebpackPluginFunction` + +* Type: {Function} + +### Parameters + +* `this` {Compiler} +* `compiler` {Compiler} + +* Returns: {void} diff --git a/pages/v5.x/_media/GOVERNANCE.md b/pages/v5.x/_media/GOVERNANCE.md deleted file mode 100644 index 6d004f5..0000000 --- a/pages/v5.x/_media/GOVERNANCE.md +++ /dev/null @@ -1,3 +0,0 @@ -# webpack Project Governance - -The webpack project (and organization) follows the webpack's governance model defined within [the webpack governance repository](https://github.com/webpack/governance/blob/main/README.md). diff --git a/pages/v5.x/_media/WORKING_GROUP.md b/pages/v5.x/_media/WORKING_GROUP.md deleted file mode 100644 index 3578afb..0000000 --- a/pages/v5.x/_media/WORKING_GROUP.md +++ /dev/null @@ -1,48 +0,0 @@ -# Webpack Core Working Group - -This document outlines the webpack core working group. - ---- - -## Working Group Name - -Webpack Core Working Group - -## Purpose and Responsibilities - -The purpose of this working group is to facilitate, implement and fix problems and features within the core of webpack. This core includes tasking such as bugfixes, feature implementation and in general maintaining the main logic of webpack. - -Each member of the working group is required to adhere to the [governance model of webpack](https://github.com/webpack/governance). In addition to having responsibility of the main part of webpack, the working group will manage other parts of the webpack organization repositories in such way they see fit. - -## Goals & Objectives - -- Develop features within the webpack organization and core areas. -- Fix bugs within webpack organization and core areas. -- Maintain and steer webpack in general together with the Technical Steering Committee. -- Ensure performance and code coverage is sustained and top-notch. - -## Members - -- [snitin315](https://github.com/snitin315) - - **Nitin Kumar** <> (he/him) -- [thelarkinn](https://github.com/thelarkinn) - - **Sean Larkin** <> (he/him) -- [jhnns](https://github.com/jhnns) - - **Johannes Ewald** <> -- [sokra](https://github.com/sokra) - - **Tobias Koppers** <> -- [spacek33z](https://github.com/spacek33z) - - **Kees Kluskens** <> - -## Communication - -Meetings are hosted on an as-needed basis and private discussions are held in the #core-wg channel. For public feedback and communication, please use an appropriate channel within the webpack discord (e.g `#development-general`). - -## Resources - -- https://github.com/webpack -- https://github.com/webpack/governance - -## Reporting & Updates - -- The working group can choose to involve the webpack TSC for feedback and updates, but has full autonomy of making changes to any codebase within webpack. diff --git a/pages/v5.x/webpack/namespaces/cache.md b/pages/v5.x/cache/MemoryCachePlugin.md similarity index 78% rename from pages/v5.x/webpack/namespaces/cache.md rename to pages/v5.x/cache/MemoryCachePlugin.md index 2f38301..63509a7 100644 --- a/pages/v5.x/webpack/namespaces/cache.md +++ b/pages/v5.x/cache/MemoryCachePlugin.md @@ -1,4 +1,6 @@ -# cache +# MemoryCachePlugin + + ## Class: `MemoryCachePlugin` @@ -12,7 +14,10 @@ #### `apply(compiler)` +##### Parameters + * `compiler` {Compiler} + * Returns: {void} Apply the plugin diff --git a/pages/v5.x/cache/index.md b/pages/v5.x/cache/index.md new file mode 100644 index 0000000..2e5e64a --- /dev/null +++ b/pages/v5.x/cache/index.md @@ -0,0 +1,9 @@ +# cache + + + +## `cache` + +* Type: {object} + +* `MemoryCachePlugin` {MemoryCachePlugin} diff --git a/pages/v5.x/cli/index.md b/pages/v5.x/cli/index.md new file mode 100644 index 0000000..a445f7d --- /dev/null +++ b/pages/v5.x/cli/index.md @@ -0,0 +1,7 @@ +# cli + + + +## `cli` + +* Type: {cli} diff --git a/pages/v5.x/config/index.md b/pages/v5.x/config/index.md new file mode 100644 index 0000000..74ff85f --- /dev/null +++ b/pages/v5.x/config/index.md @@ -0,0 +1,15 @@ +# config + + + +## `config` + +* Type: {object} + +* `applyWebpackOptionsDefaults` {Function} + * `options` {WebpackOptionsNormalized} options to be modified + * `compilerIndex` {number} index of compiler + * Returns: {ResolvedOptions} Resolved options after apply defaults +* `getNormalizedWebpackOptions` {Function} + * `config` {WebpackOptions} input config + * Returns: {WebpackOptionsNormalized} normalized options diff --git a/pages/v5.x/container/ContainerPlugin.md b/pages/v5.x/container/ContainerPlugin.md new file mode 100644 index 0000000..25980fa --- /dev/null +++ b/pages/v5.x/container/ContainerPlugin.md @@ -0,0 +1,73 @@ +# ContainerPlugin + + + +## Class: `ContainerPlugin` + +### Constructors + +#### `new ContainerPlugin(options)` + +##### Parameters + +* `options` {ContainerPluginOptions} + +* Returns: {ContainerPlugin} + +### Properties + +#### `options` + +* Type: {ContainerPluginOptions} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} + +Apply the plugin + +## `ContainerPluginOptions` + +### Properties + +#### `exposes` + +* Type: {Exposes} + +Modules that should be exposed by this container. When provided, property name is used as public name, otherwise public name is automatically inferred from request. + +#### `filename` + +* Type: {string} Optional. + +The filename for this container relative path inside the `output.path` directory. + +#### `library` + +* Type: {LibraryOptions} Optional. + +Options for library. + +#### `name` + +* Type: {string} + +The name for this container. + +#### `runtime` + +* Type: {EntryRuntime} Optional. + +The name of the runtime chunk. If set a runtime chunk with this name is created or an existing entrypoint is used as runtime. + +#### `shareScope` + +* Type: {string} Optional. + +The name of the share scope which is shared with the host (defaults to 'default'). diff --git a/pages/v5.x/container/ContainerReferencePlugin.md b/pages/v5.x/container/ContainerReferencePlugin.md new file mode 100644 index 0000000..1be04dc --- /dev/null +++ b/pages/v5.x/container/ContainerReferencePlugin.md @@ -0,0 +1,33 @@ +# ContainerReferencePlugin + + + +## Class: `ContainerReferencePlugin` + +### Constructors + +#### `new ContainerReferencePlugin(options)` + +##### Parameters + +* `options` {ContainerReferencePluginOptions} + +* Returns: {ContainerReferencePlugin} + +### Properties + +#### `options` + +* Type: {ContainerReferencePluginOptions} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} + +Apply the plugin diff --git a/pages/v5.x/container/ModuleFederationPlugin.md b/pages/v5.x/container/ModuleFederationPlugin.md new file mode 100644 index 0000000..fcadfa9 --- /dev/null +++ b/pages/v5.x/container/ModuleFederationPlugin.md @@ -0,0 +1,45 @@ +# ModuleFederationPlugin + + + +## Class: `ModuleFederationPlugin` + +### Constructors + +#### `new ModuleFederationPlugin(options)` + +##### Parameters + +* `options` {ModuleFederationPluginOptions} + +* Returns: {ModuleFederationPlugin} + +### Properties + +#### `options` + +* Type: {ModuleFederationPluginOptions} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} + +Apply the plugin + +*** + +#### Static method: `getCompilationHooks(compilation)` + +##### Parameters + +* `compilation` {Compilation} + +* Returns: {CompilationHooksModuleFederationPlugin} + +Get the compilation hooks associated with this plugin. diff --git a/pages/v5.x/container/index.md b/pages/v5.x/container/index.md new file mode 100644 index 0000000..3354295 --- /dev/null +++ b/pages/v5.x/container/index.md @@ -0,0 +1,15 @@ +# container + + + +## `container` + +* Type: {object} + +* `ContainerPlugin` {ContainerPlugin} +* `ContainerReferencePlugin` {ContainerReferencePlugin} +* `ModuleFederationPlugin` {ModuleFederationPlugin} +* `scope` {Function} + * `scope` {string} scope name + * `options` {ContainerOptionsFormat} options passed by the user + * Returns: {Record} options to spread or pass diff --git a/pages/v5.x/webpack/namespaces/css.md b/pages/v5.x/css/CssModulesPlugin.md similarity index 85% rename from pages/v5.x/webpack/namespaces/css.md rename to pages/v5.x/css/CssModulesPlugin.md index ab5ccb8..b4967ef 100644 --- a/pages/v5.x/webpack/namespaces/css.md +++ b/pages/v5.x/css/CssModulesPlugin.md @@ -1,4 +1,6 @@ -# css +# CssModulesPlugin + + ## Class: `CssModulesPlugin` @@ -12,51 +14,89 @@ #### `apply(compiler)` +##### Parameters + * `compiler` {Compiler} + * Returns: {void} Apply the plugin +*** + #### `getModulesInOrder(chunk, modules, compilation)` +##### Parameters + * `chunk` {Chunk} * `modules` {Iterable} * `compilation` {Compilation} + * Returns: {Module[]} +*** + #### `getOrderedChunkCssModules(chunk, chunkGraph, compilation)` +##### Parameters + * `chunk` {Chunk} * `chunkGraph` {ChunkGraph} * `compilation` {Compilation} + * Returns: {CssModule[]} +*** + #### `renderChunk(__namedParameters, hooks)` +##### Parameters + * `__namedParameters` {RenderContextCssModulesPlugin} * `hooks` {CompilationHooksCssModulesPlugin} + * Returns: {Source} +*** + #### Static method: `chunkHasCss(chunk, chunkGraph)` +##### Parameters + * `chunk` {Chunk} * `chunkGraph` {ChunkGraph} + * Returns: {boolean} +*** + #### Static method: `getChunkFilenameTemplate(chunk, outputOptions)` +##### Parameters + * `chunk` {Chunk} * `outputOptions` {OutputNormalizedWithDefaults} + * Returns: {TemplatePath} +*** + #### Static method: `getCompilationHooks(compilation)` +##### Parameters + * `compilation` {Compilation} + * Returns: {CompilationHooksCssModulesPlugin} +*** + #### Static method: `renderModule(module, renderContext, hooks)` +##### Parameters + * `module` {CssModule} * `renderContext` {ChunkRenderContextCssModulesPlugin} * `hooks` {CompilationHooksCssModulesPlugin} + * Returns: {Source} diff --git a/pages/v5.x/css/index.md b/pages/v5.x/css/index.md new file mode 100644 index 0000000..9711ca4 --- /dev/null +++ b/pages/v5.x/css/index.md @@ -0,0 +1,9 @@ +# css + + + +## `css` + +* Type: {object} + +* `CssModulesPlugin` {CssModulesPlugin} diff --git a/pages/v5.x/debug/ProfilingPlugin.md b/pages/v5.x/debug/ProfilingPlugin.md new file mode 100644 index 0000000..48ca1f1 --- /dev/null +++ b/pages/v5.x/debug/ProfilingPlugin.md @@ -0,0 +1,49 @@ +# ProfilingPlugin + + + +## Class: `ProfilingPlugin` + +### Constructors + +#### `new ProfilingPlugin([options])` + +##### Parameters + +* `options` {ProfilingPluginOptions} + +* Returns: {ProfilingPlugin} + +### Properties + +#### `options` + +* Type: {ProfilingPluginOptions} + +*** + +#### `Profiler` + +* Type: {Profiler} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} + +Apply the plugin + +## `ProfilingPluginOptions` + +### Properties + +#### `outputPath` + +* Type: {string} Optional. + +Path to the output file e.g. `path.resolve(__dirname, 'profiling/events.json')`. Defaults to `events.json`. diff --git a/pages/v5.x/debug/index.md b/pages/v5.x/debug/index.md new file mode 100644 index 0000000..325c950 --- /dev/null +++ b/pages/v5.x/debug/index.md @@ -0,0 +1,9 @@ +# debug + + + +## `debug` + +* Type: {object} + +* `ProfilingPlugin` {ProfilingPlugin} diff --git a/pages/v5.x/dependencies/ConstDependency.md b/pages/v5.x/dependencies/ConstDependency.md new file mode 100644 index 0000000..285d92d --- /dev/null +++ b/pages/v5.x/dependencies/ConstDependency.md @@ -0,0 +1,322 @@ +# ConstDependency + + + +## Class: `ConstDependency` + +* Extends: {NullDependency} + +### Constructors + +#### `new ConstDependency(expression, range[, runtimeRequirements])` + +##### Parameters + +* `expression` {string} +* `range` {number|[number, number]} +* `runtimeRequirements` {string[]} + +* Returns: {ConstDependency} + +### Properties + +#### `category` + +* Type: {string} + +##### Inherited from + +[`NullDependency`](NullDependency.md).[`category`](NullDependency.md#category) + +*** + +#### `disconnect` + +* Type: {any} + +##### Inherited from + +[`NullDependency`](NullDependency.md).[`disconnect`](NullDependency.md#disconnect) + +*** + +#### `expression` + +* Type: {string} + +*** + +#### `loc` + +* Type: {DependencyLocation} + +##### Inherited from + +[`NullDependency`](NullDependency.md).[`loc`](NullDependency.md#loc) + +*** + +#### `module` + +* Type: {any} + +##### Inherited from + +[`NullDependency`](NullDependency.md).[`module`](NullDependency.md#module) + +*** + +#### `optional` + +* Type: {boolean} Optional. + +##### Inherited from + +[`NullDependency`](NullDependency.md).[`optional`](NullDependency.md#optional) + +*** + +#### `range` + +* Type: {number|[number, number]} + +*** + +#### `runtimeRequirements` + +* Type: {Set} + +*** + +#### `type` + +* Type: {string} + +##### Inherited from + +[`NullDependency`](NullDependency.md).[`type`](NullDependency.md#type) + +*** + +#### `weak` + +* Type: {boolean} + +##### Inherited from + +[`NullDependency`](NullDependency.md).[`weak`](NullDependency.md#weak) + +*** + +#### `EXPORTS_OBJECT_REFERENCED` + +* Type: {string[][]} + +##### Overrides + +[`NullDependency`](NullDependency.md).[`EXPORTS_OBJECT_REFERENCED`](NullDependency.md#exports-object-referenced) + +*** + +#### `NO_EXPORTS_REFERENCED` + +* Type: {string[][]} + +##### Overrides + +[`NullDependency`](NullDependency.md).[`NO_EXPORTS_REFERENCED`](NullDependency.md#no-exports-referenced) + +*** + +#### `Template` + +* Type: {ConstDependencyTemplate} + +##### Overrides + +[`NullDependency`](NullDependency.md).[`Template`](NullDependency.md#template) + +*** + +#### `TRANSITIVE` + +* Type: {TRANSITIVE} + +##### Overrides + +[`NullDependency`](NullDependency.md).[`TRANSITIVE`](NullDependency.md#transitive) + +### Methods + +#### `couldAffectReferencingModule()` + +* Returns: {boolean|TRANSITIVE} + +*** + +#### `createIgnoredModule(context)` + +##### Parameters + +* `context` {string} + +* Returns: {Module} + +*** + +#### `deserialize(__namedParameters)` + +##### Parameters + +* `__namedParameters` {ObjectDeserializerContext} + +* Returns: {void} + +*** + +#### `getCondition(moduleGraph)` + +##### Parameters + +* `moduleGraph` {ModuleGraph} + +* Returns: {false|Function} + +*** + +#### `getContext()` + +* Returns: {string} + +*** + +#### `getErrors(moduleGraph)` + +##### Parameters + +* `moduleGraph` {ModuleGraph} + +* Returns: {WebpackError[]} + +Returns errors + +*** + +#### `getExports(moduleGraph)` + +##### Parameters + +* `moduleGraph` {ModuleGraph} + +* Returns: {ExportsSpec} + +Returns the exported names + +*** + +#### `getModuleEvaluationSideEffectsState(moduleGraph)` + +##### Parameters + +* `moduleGraph` {ModuleGraph} + +* Returns: {ConnectionState} + +*** + +#### `getNumberOfIdOccurrences()` + +* Returns: {number} + +implement this method to allow the occurrence order plugin to count correctly + +*** + +#### `getReference(moduleGraph)` + +> Stability: 0 - Deprecated + +##### Parameters + +* `moduleGraph` {ModuleGraph} + +* Returns: {never} + +Returns the referenced module and export + +*** + +#### `getReferencedExports(moduleGraph, runtime)` + +##### Parameters + +* `moduleGraph` {ModuleGraph} +* `runtime` {RuntimeSpec} + +* Returns: {string[]|ReferencedExport[]} + +Returns list of exports referenced by this dependency + +*** + +#### `getResourceIdentifier()` + +* Returns: {string} + +*** + +#### `getWarnings(moduleGraph)` + +##### Parameters + +* `moduleGraph` {ModuleGraph} + +* Returns: {WebpackError[]} + +Returns warnings + +*** + +#### `serialize(__namedParameters)` + +##### Parameters + +* `__namedParameters` {ObjectSerializerContext} + +* Returns: {void} + +*** + +#### `setLoc(startLine, startColumn, endLine, endColumn)` + +##### Parameters + +* `startLine` {number} +* `startColumn` {number} +* `endLine` {number} +* `endColumn` {number} + +* Returns: {void} + +*** + +#### `updateHash(hash, context)` + +##### Parameters + +* `hash` {Hash} +* `context` {UpdateHashContextDependency} + +* Returns: {void} + +Update the hash + +*** + +#### Static method: `isLowPriorityDependency(dependency)` + +##### Parameters + +* `dependency` {Dependency} + +* Returns: {boolean} diff --git a/pages/v5.x/dependencies/HarmonyImportDependency.md b/pages/v5.x/dependencies/HarmonyImportDependency.md new file mode 100644 index 0000000..c5357d6 --- /dev/null +++ b/pages/v5.x/dependencies/HarmonyImportDependency.md @@ -0,0 +1,426 @@ +# HarmonyImportDependency + + + +## Class: `HarmonyImportDependency` + +* Extends: {ModuleDependency} + +### Constructors + +#### `new HarmonyImportDependency(request, sourceOrder[, phase][, attributes])` + +##### Parameters + +* `request` {string} +* `sourceOrder` {number} +* `phase` {0|1|2} +* `attributes` {ImportAttributes} + +* Returns: {HarmonyImportDependency} + +### Properties + +#### `attributes` + +* Type: {ImportAttributes} Optional. + +*** + +#### `category` + +* Type: {string} + +##### Inherited from + +[`ModuleDependency`](ModuleDependency.md).[`category`](ModuleDependency.md#category) + +*** + +#### `disconnect` + +* Type: {any} + +##### Inherited from + +[`ModuleDependency`](ModuleDependency.md).[`disconnect`](ModuleDependency.md#disconnect) + +*** + +#### `loc` + +* Type: {DependencyLocation} + +##### Inherited from + +[`ModuleDependency`](ModuleDependency.md).[`loc`](ModuleDependency.md#loc) + +*** + +#### `module` + +* Type: {any} + +##### Inherited from + +[`ModuleDependency`](ModuleDependency.md).[`module`](ModuleDependency.md#module) + +*** + +#### `optional` + +* Type: {boolean} Optional. + +##### Inherited from + +[`ModuleDependency`](ModuleDependency.md).[`optional`](ModuleDependency.md#optional) + +*** + +#### `phase` + +* Type: {ImportPhaseType} + +*** + +#### `range` + +* Type: {[number, number]} Optional. + +##### Inherited from + +[`ModuleDependency`](ModuleDependency.md).[`range`](ModuleDependency.md#range) + +*** + +#### `request` + +* Type: {string} + +##### Inherited from + +[`ModuleDependency`](ModuleDependency.md).[`request`](ModuleDependency.md#request) + +*** + +#### `sourceOrder` + +* Type: {number} Optional. + +##### Inherited from + +[`ModuleDependency`](ModuleDependency.md).[`sourceOrder`](ModuleDependency.md#sourceorder) + +*** + +#### `type` + +* Type: {string} + +##### Inherited from + +[`ModuleDependency`](ModuleDependency.md).[`type`](ModuleDependency.md#type) + +*** + +#### `userRequest` + +* Type: {string} + +##### Inherited from + +[`ModuleDependency`](ModuleDependency.md).[`userRequest`](ModuleDependency.md#userrequest) + +*** + +#### `weak` + +* Type: {boolean} + +##### Inherited from + +[`ModuleDependency`](ModuleDependency.md).[`weak`](ModuleDependency.md#weak) + +*** + +#### `ExportPresenceModes` + +* Type: {object} + +* `AUTO` {ExportPresenceMode} +* `ERROR` {ExportPresenceMode} +* `NONE` {ExportPresenceMode} +* `WARN` {ExportPresenceMode} +* `fromUserOption` +* `resolveFromOptions` + +*** + +#### `EXPORTS_OBJECT_REFERENCED` + +* Type: {string[][]} + +##### Overrides + +[`ModuleDependency`](ModuleDependency.md).[`EXPORTS_OBJECT_REFERENCED`](ModuleDependency.md#exports-object-referenced) + +*** + +#### `getNonOptionalPart` + +* Type: {Function} + +##### Parameters + +* `members` {string[]} +* `membersOptionals` {boolean[]} + +* Returns: {string[]} + +*** + +#### `NO_EXPORTS_REFERENCED` + +* Type: {string[][]} + +##### Overrides + +[`ModuleDependency`](ModuleDependency.md).[`NO_EXPORTS_REFERENCED`](ModuleDependency.md#no-exports-referenced) + +*** + +#### `Template` + +* Type: {HarmonyImportDependencyTemplate} + +##### Overrides + +[`ModuleDependency`](ModuleDependency.md).[`Template`](ModuleDependency.md#template) + +*** + +#### `TRANSITIVE` + +* Type: {TRANSITIVE} + +##### Overrides + +`ModuleDependency.TRANSITIVE` + +### Methods + +#### `couldAffectReferencingModule()` + +* Returns: {boolean|TRANSITIVE} + +*** + +#### `createIgnoredModule(context)` + +##### Parameters + +* `context` {string} + +* Returns: {Module} + +*** + +#### `deserialize(__namedParameters)` + +##### Parameters + +* `__namedParameters` {ObjectDeserializerContext} + +* Returns: {void} + +*** + +#### `getCondition(moduleGraph)` + +##### Parameters + +* `moduleGraph` {ModuleGraph} + +* Returns: {false|Function} + +*** + +#### `getContext()` + +* Returns: {string} + +*** + +#### `getErrors(moduleGraph)` + +##### Parameters + +* `moduleGraph` {ModuleGraph} + +* Returns: {WebpackError[]} + +Returns errors + +*** + +#### `getExports(moduleGraph)` + +##### Parameters + +* `moduleGraph` {ModuleGraph} + +* Returns: {ExportsSpec} + +Returns the exported names + +*** + +#### `getImportStatement(update, __namedParameters)` + +##### Parameters + +* `update` {boolean} +* `__namedParameters` {DependencyTemplateContext} + +* Returns: {[string, string]} + +*** + +#### `getImportVar(moduleGraph)` + +##### Parameters + +* `moduleGraph` {ModuleGraph} + +* Returns: {string} + +*** + +#### `getLinkingErrors(moduleGraph, ids, additionalMessage)` + +##### Parameters + +* `moduleGraph` {ModuleGraph} +* `ids` {string[]} +* `additionalMessage` {string} + +* Returns: {WebpackError[]} + +*** + +#### `getModuleEvaluationSideEffectsState(moduleGraph)` + +##### Parameters + +* `moduleGraph` {ModuleGraph} + +* Returns: {ConnectionState} + +*** + +#### `getModuleExports(__namedParameters)` + +##### Parameters + +* `__namedParameters` {DependencyTemplateContext} + +* Returns: {string} + +*** + +#### `getNumberOfIdOccurrences()` + +* Returns: {number} + +implement this method to allow the occurrence order plugin to count correctly + +*** + +#### `getReference(moduleGraph)` + +> Stability: 0 - Deprecated + +##### Parameters + +* `moduleGraph` {ModuleGraph} + +* Returns: {never} + +Returns the referenced module and export + +*** + +#### `getReferencedExports(moduleGraph, runtime)` + +##### Parameters + +* `moduleGraph` {ModuleGraph} +* `runtime` {RuntimeSpec} + +* Returns: {string[]|ReferencedExport[]} + +Returns list of exports referenced by this dependency + +*** + +#### `getResourceIdentifier()` + +* Returns: {string} + +*** + +#### `getWarnings(moduleGraph)` + +##### Parameters + +* `moduleGraph` {ModuleGraph} + +* Returns: {WebpackError[]} + +Returns warnings + +*** + +#### `serialize(__namedParameters)` + +##### Parameters + +* `__namedParameters` {ObjectSerializerContext} + +* Returns: {void} + +*** + +#### `setLoc(startLine, startColumn, endLine, endColumn)` + +##### Parameters + +* `startLine` {number} +* `startColumn` {number} +* `endLine` {number} +* `endColumn` {number} + +* Returns: {void} + +*** + +#### `updateHash(hash, context)` + +##### Parameters + +* `hash` {Hash} +* `context` {UpdateHashContextDependency} + +* Returns: {void} + +Update the hash + +*** + +#### Static method: `isLowPriorityDependency(dependency)` + +##### Parameters + +* `dependency` {Dependency} + +* Returns: {boolean} diff --git a/pages/v5.x/dependencies/ModuleDependency.md b/pages/v5.x/dependencies/ModuleDependency.md new file mode 100644 index 0000000..95bb568 --- /dev/null +++ b/pages/v5.x/dependencies/ModuleDependency.md @@ -0,0 +1,323 @@ +# ModuleDependency + + + +## Class: `ModuleDependency` + +* Extends: {Dependency} + +### Constructors + +#### `new ModuleDependency(request[, sourceOrder])` + +##### Parameters + +* `request` {string} +* `sourceOrder` {number} + +* Returns: {ModuleDependency} + +### Properties + +#### `category` + +* Type: {string} + +##### Inherited from + +[`Dependency`](../Dependency.md).[`category`](../Dependency.md#category) + +*** + +#### `disconnect` + +* Type: {any} + +##### Inherited from + +[`Dependency`](../Dependency.md).[`disconnect`](../Dependency.md#disconnect) + +*** + +#### `loc` + +* Type: {DependencyLocation} + +##### Inherited from + +[`Dependency`](../Dependency.md).[`loc`](../Dependency.md#loc) + +*** + +#### `module` + +* Type: {any} + +##### Inherited from + +[`Dependency`](../Dependency.md).[`module`](../Dependency.md#module) + +*** + +#### `optional` + +* Type: {boolean} Optional. + +##### Inherited from + +[`Dependency`](../Dependency.md).[`optional`](../Dependency.md#optional) + +*** + +#### `range` + +* Type: {[number, number]} Optional. + +*** + +#### `request` + +* Type: {string} + +*** + +#### `sourceOrder` + +* Type: {number} Optional. + +*** + +#### `type` + +* Type: {string} + +##### Inherited from + +[`Dependency`](../Dependency.md).[`type`](../Dependency.md#type) + +*** + +#### `userRequest` + +* Type: {string} + +*** + +#### `weak` + +* Type: {boolean} + +##### Inherited from + +[`Dependency`](../Dependency.md).[`weak`](../Dependency.md#weak) + +*** + +#### `EXPORTS_OBJECT_REFERENCED` + +* Type: {string[][]} + +##### Overrides + +[`Dependency`](../Dependency.md).[`EXPORTS_OBJECT_REFERENCED`](../Dependency.md#exports-object-referenced) + +*** + +#### `NO_EXPORTS_REFERENCED` + +* Type: {string[][]} + +##### Overrides + +[`Dependency`](../Dependency.md).[`NO_EXPORTS_REFERENCED`](../Dependency.md#no-exports-referenced) + +*** + +#### `Template` + +* Type: {DependencyTemplate} + +*** + +#### `TRANSITIVE` + +* Type: {TRANSITIVE} + +##### Overrides + +[`Dependency`](../Dependency.md).[`TRANSITIVE`](../Dependency.md#transitive) + +### Methods + +#### `couldAffectReferencingModule()` + +* Returns: {boolean|TRANSITIVE} + +*** + +#### `createIgnoredModule(context)` + +##### Parameters + +* `context` {string} + +* Returns: {Module} + +*** + +#### `deserialize(__namedParameters)` + +##### Parameters + +* `__namedParameters` {ObjectDeserializerContext} + +* Returns: {void} + +*** + +#### `getCondition(moduleGraph)` + +##### Parameters + +* `moduleGraph` {ModuleGraph} + +* Returns: {false|Function} + +*** + +#### `getContext()` + +* Returns: {string} + +*** + +#### `getErrors(moduleGraph)` + +##### Parameters + +* `moduleGraph` {ModuleGraph} + +* Returns: {WebpackError[]} + +Returns errors + +*** + +#### `getExports(moduleGraph)` + +##### Parameters + +* `moduleGraph` {ModuleGraph} + +* Returns: {ExportsSpec} + +Returns the exported names + +*** + +#### `getModuleEvaluationSideEffectsState(moduleGraph)` + +##### Parameters + +* `moduleGraph` {ModuleGraph} + +* Returns: {ConnectionState} + +*** + +#### `getNumberOfIdOccurrences()` + +* Returns: {number} + +implement this method to allow the occurrence order plugin to count correctly + +*** + +#### `getReference(moduleGraph)` + +> Stability: 0 - Deprecated + +##### Parameters + +* `moduleGraph` {ModuleGraph} + +* Returns: {never} + +Returns the referenced module and export + +*** + +#### `getReferencedExports(moduleGraph, runtime)` + +##### Parameters + +* `moduleGraph` {ModuleGraph} +* `runtime` {RuntimeSpec} + +* Returns: {string[]|ReferencedExport[]} + +Returns list of exports referenced by this dependency + +*** + +#### `getResourceIdentifier()` + +* Returns: {string} + +*** + +#### `getWarnings(moduleGraph)` + +##### Parameters + +* `moduleGraph` {ModuleGraph} + +* Returns: {WebpackError[]} + +Returns warnings + +*** + +#### `serialize(__namedParameters)` + +##### Parameters + +* `__namedParameters` {ObjectSerializerContext} + +* Returns: {void} + +*** + +#### `setLoc(startLine, startColumn, endLine, endColumn)` + +##### Parameters + +* `startLine` {number} +* `startColumn` {number} +* `endLine` {number} +* `endColumn` {number} + +* Returns: {void} + +*** + +#### `updateHash(hash, context)` + +##### Parameters + +* `hash` {Hash} +* `context` {UpdateHashContextDependency} + +* Returns: {void} + +Update the hash + +*** + +#### Static method: `isLowPriorityDependency(dependency)` + +##### Parameters + +* `dependency` {Dependency} + +* Returns: {boolean} diff --git a/pages/v5.x/dependencies/NullDependency.md b/pages/v5.x/dependencies/NullDependency.md new file mode 100644 index 0000000..769a55b --- /dev/null +++ b/pages/v5.x/dependencies/NullDependency.md @@ -0,0 +1,294 @@ +# NullDependency + + + +## Class: `NullDependency` + +* Extends: {Dependency} + +### Constructors + +#### `new NullDependency()` + +* Returns: {NullDependency} + +### Properties + +#### `category` + +* Type: {string} + +##### Inherited from + +[`Dependency`](../Dependency.md).[`category`](../Dependency.md#category) + +*** + +#### `disconnect` + +* Type: {any} + +##### Inherited from + +[`Dependency`](../Dependency.md).[`disconnect`](../Dependency.md#disconnect) + +*** + +#### `loc` + +* Type: {DependencyLocation} + +##### Inherited from + +[`Dependency`](../Dependency.md).[`loc`](../Dependency.md#loc) + +*** + +#### `module` + +* Type: {any} + +##### Inherited from + +[`Dependency`](../Dependency.md).[`module`](../Dependency.md#module) + +*** + +#### `optional` + +* Type: {boolean} Optional. + +##### Inherited from + +[`Dependency`](../Dependency.md).[`optional`](../Dependency.md#optional) + +*** + +#### `type` + +* Type: {string} + +##### Inherited from + +[`Dependency`](../Dependency.md).[`type`](../Dependency.md#type) + +*** + +#### `weak` + +* Type: {boolean} + +##### Inherited from + +[`Dependency`](../Dependency.md).[`weak`](../Dependency.md#weak) + +*** + +#### `EXPORTS_OBJECT_REFERENCED` + +* Type: {string[][]} + +##### Overrides + +[`Dependency`](../Dependency.md).[`EXPORTS_OBJECT_REFERENCED`](../Dependency.md#exports-object-referenced) + +*** + +#### `NO_EXPORTS_REFERENCED` + +* Type: {string[][]} + +##### Overrides + +[`Dependency`](../Dependency.md).[`NO_EXPORTS_REFERENCED`](../Dependency.md#no-exports-referenced) + +*** + +#### `Template` + +* Type: {NullDependencyTemplate} + +*** + +#### `TRANSITIVE` + +* Type: {TRANSITIVE} + +##### Overrides + +[`Dependency`](../Dependency.md).[`TRANSITIVE`](../Dependency.md#transitive) + +### Methods + +#### `couldAffectReferencingModule()` + +* Returns: {boolean|TRANSITIVE} + +*** + +#### `createIgnoredModule(context)` + +##### Parameters + +* `context` {string} + +* Returns: {Module} + +*** + +#### `deserialize(__namedParameters)` + +##### Parameters + +* `__namedParameters` {ObjectDeserializerContext} + +* Returns: {void} + +*** + +#### `getCondition(moduleGraph)` + +##### Parameters + +* `moduleGraph` {ModuleGraph} + +* Returns: {false|Function} + +*** + +#### `getContext()` + +* Returns: {string} + +*** + +#### `getErrors(moduleGraph)` + +##### Parameters + +* `moduleGraph` {ModuleGraph} + +* Returns: {WebpackError[]} + +Returns errors + +*** + +#### `getExports(moduleGraph)` + +##### Parameters + +* `moduleGraph` {ModuleGraph} + +* Returns: {ExportsSpec} + +Returns the exported names + +*** + +#### `getModuleEvaluationSideEffectsState(moduleGraph)` + +##### Parameters + +* `moduleGraph` {ModuleGraph} + +* Returns: {ConnectionState} + +*** + +#### `getNumberOfIdOccurrences()` + +* Returns: {number} + +implement this method to allow the occurrence order plugin to count correctly + +*** + +#### `getReference(moduleGraph)` + +> Stability: 0 - Deprecated + +##### Parameters + +* `moduleGraph` {ModuleGraph} + +* Returns: {never} + +Returns the referenced module and export + +*** + +#### `getReferencedExports(moduleGraph, runtime)` + +##### Parameters + +* `moduleGraph` {ModuleGraph} +* `runtime` {RuntimeSpec} + +* Returns: {string[]|ReferencedExport[]} + +Returns list of exports referenced by this dependency + +*** + +#### `getResourceIdentifier()` + +* Returns: {string} + +*** + +#### `getWarnings(moduleGraph)` + +##### Parameters + +* `moduleGraph` {ModuleGraph} + +* Returns: {WebpackError[]} + +Returns warnings + +*** + +#### `serialize(__namedParameters)` + +##### Parameters + +* `__namedParameters` {ObjectSerializerContext} + +* Returns: {void} + +*** + +#### `setLoc(startLine, startColumn, endLine, endColumn)` + +##### Parameters + +* `startLine` {number} +* `startColumn` {number} +* `endLine` {number} +* `endColumn` {number} + +* Returns: {void} + +*** + +#### `updateHash(hash, context)` + +##### Parameters + +* `hash` {Hash} +* `context` {UpdateHashContextDependency} + +* Returns: {void} + +Update the hash + +*** + +#### Static method: `isLowPriorityDependency(dependency)` + +##### Parameters + +* `dependency` {Dependency} + +* Returns: {boolean} diff --git a/pages/v5.x/dependencies/index.md b/pages/v5.x/dependencies/index.md new file mode 100644 index 0000000..4b3c53f --- /dev/null +++ b/pages/v5.x/dependencies/index.md @@ -0,0 +1,12 @@ +# dependencies + + + +## `dependencies` + +* Type: {object} + +* `ConstDependency` {ConstDependency} +* `HarmonyImportDependency` {HarmonyImportDependency} +* `ModuleDependency` {ModuleDependency} +* `NullDependency` {NullDependency} diff --git a/pages/v5.x/webpack/namespaces/electron.md b/pages/v5.x/electron/ElectronTargetPlugin.md similarity index 76% rename from pages/v5.x/webpack/namespaces/electron.md rename to pages/v5.x/electron/ElectronTargetPlugin.md index c187fe5..d80a530 100644 --- a/pages/v5.x/webpack/namespaces/electron.md +++ b/pages/v5.x/electron/ElectronTargetPlugin.md @@ -1,4 +1,6 @@ -# electron +# ElectronTargetPlugin + + ## Class: `ElectronTargetPlugin` @@ -6,14 +8,20 @@ #### `new ElectronTargetPlugin([context])` +##### Parameters + * `context` {"main"|"preload"|"renderer"} + * Returns: {ElectronTargetPlugin} ### Methods #### `apply(compiler)` +##### Parameters + * `compiler` {Compiler} + * Returns: {void} Apply the plugin diff --git a/pages/v5.x/electron/index.md b/pages/v5.x/electron/index.md new file mode 100644 index 0000000..1458043 --- /dev/null +++ b/pages/v5.x/electron/index.md @@ -0,0 +1,9 @@ +# electron + + + +## `electron` + +* Type: {object} + +* `ElectronTargetPlugin` {ElectronTargetPlugin} diff --git a/pages/v5.x/esm/ModuleChunkLoadingRuntimeModule.md b/pages/v5.x/esm/ModuleChunkLoadingRuntimeModule.md new file mode 100644 index 0000000..0117aed --- /dev/null +++ b/pages/v5.x/esm/ModuleChunkLoadingRuntimeModule.md @@ -0,0 +1,1053 @@ +# ModuleChunkLoadingRuntimeModule + + + +## Class: `ModuleChunkLoadingRuntimeModule` + +* Extends: {RuntimeModule} + +### Constructors + +#### `new ModuleChunkLoadingRuntimeModule(runtimeRequirements)` + +##### Parameters + +* `runtimeRequirements` {ReadonlySet} + +* Returns: {ModuleChunkLoadingRuntimeModule} + +### Properties + +#### `blocks` + +* Type: {AsyncDependenciesBlock[]} + +##### Inherited from + +[`RuntimeModule`](../Runtime.md).[`blocks`](../Runtime.md#blocks) + +*** + +#### `buildInfo` + +* Type: {BuildInfo} Optional. + +##### Inherited from + +[`RuntimeModule`](../Runtime.md).[`buildInfo`](../Runtime.md#buildinfo) + +*** + +#### `buildMeta` + +* Type: {BuildMeta} Optional. + +##### Inherited from + +[`RuntimeModule`](../Runtime.md).[`buildMeta`](../Runtime.md#buildmeta) + +*** + +#### `chunk` + +* Type: {Chunk} Optional. + +##### Inherited from + +[`RuntimeModule`](../Runtime.md).[`chunk`](../Runtime.md#chunk) + +*** + +#### `chunkGraph` + +* Type: {ChunkGraph} Optional. + +##### Inherited from + +[`RuntimeModule`](../Runtime.md).[`chunkGraph`](../Runtime.md#chunkgraph) + +*** + +#### `chunksIterable` + +* Type: {Iterable} + +##### Inherited from + +[`RuntimeModule`](../Runtime.md).[`chunksIterable`](../Runtime.md#chunksiterable) + +*** + +#### `codeGenerationDependencies` + +* Type: {Dependency[]} Optional. + +##### Inherited from + +[`RuntimeModule`](../Runtime.md).[`codeGenerationDependencies`](../Runtime.md#codegenerationdependencies) + +*** + +#### `compilation` + +* Type: {Compilation} Optional. + +##### Inherited from + +[`RuntimeModule`](../Runtime.md).[`compilation`](../Runtime.md#compilation) + +*** + +#### `context` + +* Type: {string} + +##### Inherited from + +[`RuntimeModule`](../Runtime.md).[`context`](../Runtime.md#context) + +*** + +#### `debugId` + +* Type: {number} + +##### Inherited from + +[`RuntimeModule`](../Runtime.md).[`debugId`](../Runtime.md#debugid) + +*** + +#### `dependencies` + +* Type: {Dependency[]} + +##### Inherited from + +[`RuntimeModule`](../Runtime.md).[`dependencies`](../Runtime.md#dependencies) + +*** + +#### `dependentHash` + +* Type: {boolean} + +##### Inherited from + +[`RuntimeModule`](../Runtime.md).[`dependentHash`](../Runtime.md#dependenthash) + +*** + +#### `depth` + +* Type: {number} + +##### Inherited from + +[`RuntimeModule`](../Runtime.md).[`depth`](../Runtime.md#depth) + +*** + +#### `errors` + +* Type: {any} + +##### Inherited from + +[`RuntimeModule`](../Runtime.md).[`errors`](../Runtime.md#errors) + +*** + +#### `exportsArgument` + +* Type: {string} + +##### Inherited from + +[`RuntimeModule`](../Runtime.md).[`exportsArgument`](../Runtime.md#exportsargument) + +*** + +#### `factoryMeta` + +* Type: {FactoryMeta} Optional. + +##### Inherited from + +[`RuntimeModule`](../Runtime.md).[`factoryMeta`](../Runtime.md#factorymeta) + +*** + +#### `fullHash` + +* Type: {boolean} + +##### Inherited from + +[`RuntimeModule`](../Runtime.md).[`fullHash`](../Runtime.md#fullhash) + +*** + +#### `hasEqualsChunks` + +* Type: {any} + +##### Inherited from + +[`RuntimeModule`](../Runtime.md).[`hasEqualsChunks`](../Runtime.md#hasequalschunks) + +*** + +#### `hash` + +* Type: {string} + +##### Inherited from + +[`RuntimeModule`](../Runtime.md).[`hash`](../Runtime.md#hash) + +*** + +#### `hot` + +* Type: {boolean} + +##### Inherited from + +[`RuntimeModule`](../Runtime.md).[`hot`](../Runtime.md#hot) + +*** + +#### `id` + +* Type: {string|number} + +##### Deprecated + +##### Inherited from + +[`RuntimeModule`](../Runtime.md).[`id`](../Runtime.md#id) + +*** + +#### `index` + +* Type: {number} + +##### Inherited from + +[`RuntimeModule`](../Runtime.md).[`index`](../Runtime.md#index) + +*** + +#### `index2` + +* Type: {number} + +##### Inherited from + +[`RuntimeModule`](../Runtime.md).[`index2`](../Runtime.md#index2) + +*** + +#### `issuer` + +* Type: {Module} Optional. + +##### Inherited from + +[`RuntimeModule`](../Runtime.md).[`issuer`](../Runtime.md#issuer) + +*** + +#### `isUsed` + +* Type: {any} + +##### Inherited from + +[`RuntimeModule`](../Runtime.md).[`isUsed`](../Runtime.md#isused) + +*** + +#### `layer` + +* Type: {string} + +##### Inherited from + +[`RuntimeModule`](../Runtime.md).[`layer`](../Runtime.md#layer) + +*** + +#### `moduleArgument` + +* Type: {string} + +##### Inherited from + +[`RuntimeModule`](../Runtime.md).[`moduleArgument`](../Runtime.md#moduleargument) + +*** + +#### `name` + +* Type: {string} + +##### Inherited from + +[`RuntimeModule`](../Runtime.md).[`name`](../Runtime.md#name) + +*** + +#### `needId` + +* Type: {boolean} + +##### Inherited from + +[`RuntimeModule`](../Runtime.md).[`needId`](../Runtime.md#needid) + +*** + +#### `optimizationBailout` + +* Type: {string|Function[]} + +##### Deprecated + +##### Inherited from + +[`RuntimeModule`](../Runtime.md).[`optimizationBailout`](../Runtime.md#optimizationbailout) + +*** + +#### `optional` + +* Type: {boolean} + +##### Inherited from + +[`RuntimeModule`](../Runtime.md).[`optional`](../Runtime.md#optional) + +*** + +#### `parent` + +* Type: {DependenciesBlock} Optional. + +##### Inherited from + +[`RuntimeModule`](../Runtime.md).[`parent`](../Runtime.md#parent) + +*** + +#### `presentationalDependencies` + +* Type: {Dependency[]} Optional. + +##### Inherited from + +[`RuntimeModule`](../Runtime.md).[`presentationalDependencies`](../Runtime.md#presentationaldependencies) + +*** + +#### `profile` + +* Type: {ModuleProfile} Optional. + +##### Inherited from + +[`RuntimeModule`](../Runtime.md).[`profile`](../Runtime.md#profile) + +*** + +#### `renderedHash` + +* Type: {string} + +##### Inherited from + +[`RuntimeModule`](../Runtime.md).[`renderedHash`](../Runtime.md#renderedhash) + +*** + +#### `resolveOptions` + +* Type: {ResolveOptions} Optional. + +##### Inherited from + +[`RuntimeModule`](../Runtime.md).[`resolveOptions`](../Runtime.md#resolveoptions) + +*** + +#### `stage` + +* Type: {number} + +##### Inherited from + +[`RuntimeModule`](../Runtime.md).[`stage`](../Runtime.md#stage) + +*** + +#### `type` + +* Type: {string} + +##### Inherited from + +[`RuntimeModule`](../Runtime.md).[`type`](../Runtime.md#type) + +*** + +#### `used` + +* Type: {any} + +##### Inherited from + +[`RuntimeModule`](../Runtime.md).[`used`](../Runtime.md#used) + +*** + +#### `usedExports` + +* Type: {boolean|SortableSet} + +##### Inherited from + +[`RuntimeModule`](../Runtime.md).[`usedExports`](../Runtime.md#usedexports) + +*** + +#### `useSimpleSourceMap` + +* Type: {boolean} + +##### Inherited from + +[`RuntimeModule`](../Runtime.md).[`useSimpleSourceMap`](../Runtime.md#usesimplesourcemap) + +*** + +#### `useSourceMap` + +* Type: {boolean} + +##### Inherited from + +[`RuntimeModule`](../Runtime.md).[`useSourceMap`](../Runtime.md#usesourcemap) + +*** + +#### `warnings` + +* Type: {any} + +##### Inherited from + +[`RuntimeModule`](../Runtime.md).[`warnings`](../Runtime.md#warnings) + +*** + +#### `STAGE_ATTACH` + +* Type: {number} + +Runtime modules which attach to handlers of other runtime modules + +##### Overrides + +[`RuntimeModule`](../Runtime.md).[`STAGE_ATTACH`](../Runtime.md#stage-attach) + +*** + +#### `STAGE_BASIC` + +* Type: {number} + +Runtime modules with simple dependencies on other runtime modules + +##### Overrides + +[`RuntimeModule`](../Runtime.md).[`STAGE_BASIC`](../Runtime.md#stage-basic) + +*** + +#### `STAGE_NORMAL` + +* Type: {number} + +Runtime modules without any dependencies to other runtime modules + +##### Overrides + +[`RuntimeModule`](../Runtime.md).[`STAGE_NORMAL`](../Runtime.md#stage-normal) + +*** + +#### `STAGE_TRIGGER` + +* Type: {number} + +Runtime modules which trigger actions on bootstrap + +##### Overrides + +[`RuntimeModule`](../Runtime.md).[`STAGE_TRIGGER`](../Runtime.md#stage-trigger) + +### Methods + +#### `addBlock(block)` + +##### Parameters + +* `block` {AsyncDependenciesBlock} + +* Returns: {void} + +Adds a DependencyBlock to DependencyBlock relationship. +This is used for when a Module has a AsyncDependencyBlock tie (for code-splitting) + +*** + +#### `addCacheDependencies(fileDependencies, contextDependencies, missingDependencies, buildDependencies)` + +##### Parameters + +* `fileDependencies` {LazySet} +* `contextDependencies` {LazySet} +* `missingDependencies` {LazySet} +* `buildDependencies` {LazySet} + +* Returns: {void} + +*** + +#### `addChunk(chunk)` + +##### Parameters + +* `chunk` {Chunk} + +* Returns: {boolean} + +*** + +#### `addCodeGenerationDependency(codeGenerationDependency)` + +##### Parameters + +* `codeGenerationDependency` {Dependency} + +* Returns: {void} + +*** + +#### `addDependency(dependency)` + +##### Parameters + +* `dependency` {Dependency} + +* Returns: {void} + +*** + +#### `addError(error)` + +##### Parameters + +* `error` {WebpackError} + +* Returns: {void} + +*** + +#### `addPresentationalDependency(presentationalDependency)` + +##### Parameters + +* `presentationalDependency` {Dependency} + +* Returns: {void} + +*** + +#### `addWarning(warning)` + +##### Parameters + +* `warning` {WebpackError} + +* Returns: {void} + +*** + +#### `attach(compilation, chunk[, chunkGraph])` + +##### Parameters + +* `compilation` {Compilation} +* `chunk` {Chunk} +* `chunkGraph` {ChunkGraph} + +* Returns: {void} + +*** + +#### `build(options, compilation, resolver, fs, callback)` + +##### Parameters + +* `options` {WebpackOptionsNormalizedWithDefaults} +* `compilation` {Compilation} +* `resolver` {ResolverWithOptions} +* `fs` {InputFileSystem} +* `callback` {Function} + * `err` {WebpackError} + * Returns: {void} + +* Returns: {void} + +*** + +#### `chunkCondition(chunk, compilation)` + +##### Parameters + +* `chunk` {Chunk} +* `compilation` {Compilation} + +* Returns: {boolean} + +*** + +#### `cleanupForCache()` + +* Returns: {void} + +Assuming this module is in the cache. Remove internal references to allow freeing some memory. + +*** + +#### `clearDependenciesAndBlocks()` + +* Returns: {void} + +Removes all dependencies and blocks + +*** + +#### `clearWarningsAndErrors()` + +* Returns: {void} + +removes all warnings and errors + +*** + +#### `codeGeneration(context)` + +##### Parameters + +* `context` {CodeGenerationContext} + +* Returns: {CodeGenerationResult} + +*** + +#### `deserialize(__namedParameters)` + +##### Parameters + +* `__namedParameters` {ObjectDeserializerContext} + +* Returns: {void} + +*** + +#### `generate()` + +* Returns: {string} + +*** + +#### `getChunks()` + +* Returns: {Chunk[]} + +*** + +#### `getConcatenationBailoutReason(context)` + +##### Parameters + +* `context` {ConcatenationBailoutReasonContext} + +* Returns: {string} + +*** + +#### `getErrors()` + +* Returns: {Iterable} + +*** + +#### `getExportsType(moduleGraph[, strict])` + +##### Parameters + +* `moduleGraph` {ModuleGraph} +* `strict` {boolean} + +* Returns: {ExportsType} + +*** + +#### `getGeneratedCode()` + +* Returns: {string} + +*** + +#### `getNumberOfChunks()` + +* Returns: {number} + +*** + +#### `getNumberOfErrors()` + +* Returns: {number} + +*** + +#### `getNumberOfWarnings()` + +* Returns: {number} + +*** + +#### `getRootBlock()` + +* Returns: {DependenciesBlock} + +*** + +#### `getSideEffectsConnectionState(moduleGraph)` + +##### Parameters + +* `moduleGraph` {ModuleGraph} + +* Returns: {ConnectionState} + +*** + +#### `getSourceBasicTypes()` + +* Returns: {ReadonlySet} + +Basic source types are high-level categories like javascript, css, webassembly, etc. +We only have built-in knowledge about the javascript basic type here; other basic types may be +added or changed over time by generators and do not need to be handled or detected here. +Some modules, e.g. RemoteModule, may return non-basic source types like "remote" and "share-init" +from getSourceTypes(), but their generated output is still JavaScript, i.e. their basic type is JS. + +*** + +#### `getSourceTypes()` + +* Returns: {ReadonlySet} + +*** + +#### `getUnsafeCacheData()` + +* Returns: {UnsafeCacheData} + +Module should be unsafe cached. Get data that's needed for that. +This data will be passed to restoreFromUnsafeCache later. + +*** + +#### `getWarnings()` + +* Returns: {Iterable} + +*** + +#### `hasChunkCondition()` + +* Returns: {boolean} + +*** + +#### `hasReasonForChunk(chunk, moduleGraph, chunkGraph)` + +##### Parameters + +* `chunk` {Chunk} +* `moduleGraph` {ModuleGraph} +* `chunkGraph` {ChunkGraph} + +* Returns: {boolean} + +*** + +#### `hasReasons(moduleGraph, runtime)` + +##### Parameters + +* `moduleGraph` {ModuleGraph} +* `runtime` {RuntimeSpec} + +* Returns: {boolean} + +*** + +#### `identifier()` + +* Returns: {string} + +*** + +#### `invalidateBuild()` + +* Returns: {void} + +*** + +#### `isAccessibleInChunk(chunkGraph, chunk[, ignoreChunk])` + +##### Parameters + +* `chunkGraph` {ChunkGraph} +* `chunk` {Chunk} +* `ignoreChunk` {Chunk} + +* Returns: {boolean} + +*** + +#### `isAccessibleInChunkGroup(chunkGraph, chunkGroup[, ignoreChunk])` + +##### Parameters + +* `chunkGraph` {ChunkGraph} +* `chunkGroup` {ChunkGroup} +* `ignoreChunk` {Chunk} + +* Returns: {boolean} + +*** + +#### `isEntryModule()` + +* Returns: {boolean} + +*** + +#### `isInChunk(chunk)` + +##### Parameters + +* `chunk` {Chunk} + +* Returns: {boolean} + +*** + +#### `isOptional(moduleGraph)` + +##### Parameters + +* `moduleGraph` {ModuleGraph} + +* Returns: {boolean} + +*** + +#### `isProvided(exportName)` + +##### Parameters + +* `exportName` {string} + +* Returns: {boolean} + +*** + +#### `libIdent(options)` + +##### Parameters + +* `options` {LibIdentOptions} + +* Returns: {string} + +*** + +#### `nameForCondition()` + +* Returns: {string} + +*** + +#### `needBuild(context, callback)` + +##### Parameters + +* `context` {NeedBuildContext} +* `callback` {Function} + * `err` {WebpackError} + * `needBuild` {boolean} + * Returns: {void} + +* Returns: {void} + +*** + +#### `needRebuild(fileTimestamps, contextTimestamps)` + +> Stability: 0 - Deprecated + +##### Parameters + +* `fileTimestamps` {Map} +* `contextTimestamps` {Map} + +* Returns: {boolean} + +Use needBuild instead + +*** + +#### `originalSource()` + +* Returns: {Source} + +*** + +#### `readableIdentifier(requestShortener)` + +##### Parameters + +* `requestShortener` {RequestShortener} + +* Returns: {string} + +*** + +#### `removeChunk(chunk)` + +##### Parameters + +* `chunk` {Chunk} + +* Returns: {void} + +*** + +#### `removeDependency(dependency)` + +##### Parameters + +* `dependency` {Dependency} + +* Returns: {void} + +*** + +#### `serialize(__namedParameters)` + +##### Parameters + +* `__namedParameters` {ObjectSerializerContext} + +* Returns: {void} + +*** + +#### `shouldIsolate()` + +* Returns: {boolean} + +*** + +#### `size([type])` + +##### Parameters + +* `type` {string} + +* Returns: {number} + +*** + +#### `source(dependencyTemplates, runtimeTemplate[, type])` + +> Stability: 0 - Deprecated + +##### Parameters + +* `dependencyTemplates` {DependencyTemplates} +* `runtimeTemplate` {RuntimeTemplate} +* `type` {string} + +* Returns: {Source} + +Use codeGeneration() instead + +*** + +#### `updateCacheModule(module)` + +##### Parameters + +* `module` {Module} + +* Returns: {void} + +Assuming this module is in the cache. Update the (cached) module with +the fresh module from the factory. Usually updates internal references +and properties. + +*** + +#### `updateHash(hash, context)` + +##### Parameters + +* `hash` {Hash} +* `context` {UpdateHashContextDependency} + +* Returns: {void} + +*** + +#### Static method: `getCompilationHooks(compilation)` + +##### Parameters + +* `compilation` {Compilation} + +* Returns: {JsonpCompilationPluginHooks} + +*** + +#### Static method: `getSourceBasicTypes(module)` + +> Stability: 0 - Deprecated + +##### Parameters + +* `module` {Module} + +* Returns: {ReadonlySet} + +In webpack 6, call getSourceBasicTypes() directly on the module instance instead of using this static method. diff --git a/pages/v5.x/esm/index.md b/pages/v5.x/esm/index.md new file mode 100644 index 0000000..18d4ccd --- /dev/null +++ b/pages/v5.x/esm/index.md @@ -0,0 +1,9 @@ +# esm + + + +## `esm` + +* Type: {object} + +* `ModuleChunkLoadingRuntimeModule` {ModuleChunkLoadingRuntimeModule} diff --git a/pages/v5.x/webpack/namespaces/experiments/namespaces/ids.md b/pages/v5.x/experiments/ids/SyncModuleIdsPlugin.md similarity index 67% rename from pages/v5.x/webpack/namespaces/experiments/namespaces/ids.md rename to pages/v5.x/experiments/ids/SyncModuleIdsPlugin.md index dcf8042..bcb82c3 100644 --- a/pages/v5.x/webpack/namespaces/experiments/namespaces/ids.md +++ b/pages/v5.x/experiments/ids/SyncModuleIdsPlugin.md @@ -1,4 +1,6 @@ -# ids +# SyncModuleIdsPlugin + + ## Class: `SyncModuleIdsPlugin` @@ -6,18 +8,26 @@ #### `new SyncModuleIdsPlugin(options)` +##### Parameters + * `options` {SyncModuleIdsPluginOptions} + * Returns: {SyncModuleIdsPlugin} ### Properties -* `options` {SyncModuleIdsPluginOptions} +#### `options` + +* Type: {SyncModuleIdsPluginOptions} ### Methods #### `apply(compiler)` +##### Parameters + * `compiler` {Compiler} + * Returns: {void} Apply the plugin diff --git a/pages/v5.x/experiments/ids/index.md b/pages/v5.x/experiments/ids/index.md new file mode 100644 index 0000000..80a662b --- /dev/null +++ b/pages/v5.x/experiments/ids/index.md @@ -0,0 +1,9 @@ +# ids + + + +## `ids` + +* Type: {object} + +* `SyncModuleIdsPlugin` {SyncModuleIdsPlugin} diff --git a/pages/v5.x/experiments/index.md b/pages/v5.x/experiments/index.md new file mode 100644 index 0000000..831a0c2 --- /dev/null +++ b/pages/v5.x/experiments/index.md @@ -0,0 +1,13 @@ +# experiments + + + +## `experiments` + +* Type: {object} + +* `ids` {object} + * `SyncModuleIdsPlugin` {SyncModuleIdsPlugin} +* `schemes` {object} + * `HttpUriPlugin` {HttpUriPlugin} + * `VirtualUrlPlugin` {VirtualUrlPlugin} diff --git a/pages/v5.x/experiments/schemes/HttpUriPlugin.md b/pages/v5.x/experiments/schemes/HttpUriPlugin.md new file mode 100644 index 0000000..f3fe444 --- /dev/null +++ b/pages/v5.x/experiments/schemes/HttpUriPlugin.md @@ -0,0 +1,37 @@ +# HttpUriPlugin + + + +## Class: `HttpUriPlugin` + +### Constructors + +#### `new HttpUriPlugin(options)` + +##### Parameters + +* `options` {HttpUriOptions} + +* Returns: {HttpUriPlugin} + +### Properties + +#### `options` + +* Type: {HttpUriOptions} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} + +Apply the plugin + +## `HttpUriPluginOptions` + +* Type: {HttpUriOptions} diff --git a/pages/v5.x/webpack/namespaces/experiments/namespaces/schemes.md b/pages/v5.x/experiments/schemes/VirtualUrlPlugin.md similarity index 54% rename from pages/v5.x/webpack/namespaces/experiments/namespaces/schemes.md rename to pages/v5.x/experiments/schemes/VirtualUrlPlugin.md index f804941..9649f94 100644 --- a/pages/v5.x/webpack/namespaces/experiments/namespaces/schemes.md +++ b/pages/v5.x/experiments/schemes/VirtualUrlPlugin.md @@ -1,64 +1,84 @@ -# schemes +# VirtualUrlPlugin -## Class: `HttpUriPlugin` + + +## Class: `VirtualUrlPlugin` ### Constructors -#### `new HttpUriPlugin(options)` +#### `new VirtualUrlPlugin(modules[, schemeOrOptions])` + +##### Parameters + +* `modules` {VirtualModules} +* `schemeOrOptions` {string|Omit} -* `options` {HttpUriOptions} -* Returns: {HttpUriPlugin} +* Returns: {VirtualUrlPlugin} ### Properties -* `options` {HttpUriOptions} +#### `context` -### Methods +* Type: {string} Optional. -#### `apply(compiler)` +*** -* `compiler` {Compiler} -* Returns: {void} +#### `modules` -Apply the plugin +* Type: {NormalizedModules} *** -## Class: `VirtualUrlPlugin` +#### `options` -### Constructors +* Type: {VirtualUrlOptions} -#### `new VirtualUrlPlugin(modules[, schemeOrOptions])` +*** -* `modules` {VirtualModules} -* `schemeOrOptions` {string|Omit} -* Returns: {VirtualUrlPlugin} +#### `scheme` -### Properties +* Type: {string} + +*** -* `context` {string} -* `modules` {NormalizedModules} -* `options` {VirtualUrlOptions} -* `scheme` {string} -* `DEFAULT_SCHEME` {string} +#### `DEFAULT_SCHEME` + +* Type: {string} ### Methods #### `apply(compiler)` +##### Parameters + * `compiler` {Compiler} + * Returns: {void} Apply the plugin +*** + #### `findVirtualModuleConfigById(id)` +##### Parameters + * `id` {string} + * Returns: {VirtualModule} +*** + #### `getCacheVersion(version)` -* `version` {string|true|object} +##### Parameters + +* `version` {string|true|Function} + * Returns: {string} Get the cache version for a given version value + +## `VirtualUrlPluginOptions` + +* Type: {VirtualUrlOptions} diff --git a/pages/v5.x/experiments/schemes/index.md b/pages/v5.x/experiments/schemes/index.md new file mode 100644 index 0000000..00ba5cc --- /dev/null +++ b/pages/v5.x/experiments/schemes/index.md @@ -0,0 +1,10 @@ +# schemes + + + +## `schemes` + +* Type: {object} + +* `HttpUriPlugin` {HttpUriPlugin} +* `VirtualUrlPlugin` {VirtualUrlPlugin} diff --git a/pages/v5.x/globals.md b/pages/v5.x/globals.md deleted file mode 100644 index afd8ee8..0000000 --- a/pages/v5.x/globals.md +++ /dev/null @@ -1,7404 +0,0 @@ -# webpack - -## Namespaces - -- [cache](webpack/namespaces/cache.md) -- [cli](webpack/namespaces/cli.md) -- [config](webpack/namespaces/config.md) -- [container](webpack/namespaces/container.md) -- [css](webpack/namespaces/css.md) -- [debug](webpack/namespaces/debug.md) -- [dependencies](webpack/namespaces/dependencies.md) -- [electron](webpack/namespaces/electron.md) -- [esm](webpack/namespaces/esm.md) -- [experiments](webpack/namespaces/experiments/index.md) -- [ids](webpack/namespaces/ids.md) -- [javascript](webpack/namespaces/javascript.md) -- [library](webpack/namespaces/library.md) -- [ModuleFilenameHelpers](webpack/namespaces/ModuleFilenameHelpers.md) -- [node](webpack/namespaces/node.md) -- [OptimizationStages](webpack/namespaces/OptimizationStages.md) -- [optimize](webpack/namespaces/optimize/index.md) -- [prefetch](webpack/namespaces/prefetch.md) -- [runtime](webpack/namespaces/runtime.md) -- [RuntimeGlobals](webpack/namespaces/RuntimeGlobals.md) -- [sharing](webpack/namespaces/sharing.md) -- [sources](webpack/namespaces/sources.md) -- [util](webpack/namespaces/util/index.md) -- [wasm](webpack/namespaces/wasm.md) -- [web](webpack/namespaces/web.md) -- [webworker](webpack/namespaces/webworker.md) - -## Class: `AsyncDependenciesBlock` - -### Extends - -- {DependenciesBlock} - -### Constructors - -#### `new AsyncDependenciesBlock(groupOptions[, loc][, request])` - -* `groupOptions` {string|GroupOptionsAsyncDependenciesBlock} -* `loc` {SyntheticDependencyLocation|RealDependencyLocation} -* `request` {string} -* Returns: {AsyncDependenciesBlock} - -### Properties - -* `blocks` {AsyncDependenciesBlock[]} -* `chunkName` {string} -* `circular` {boolean} -* `dependencies` {Dependency[]} -* `groupOptions` {GroupOptionsAsyncDependenciesBlock} -* `loc` {SyntheticDependencyLocation|RealDependencyLocation} -* `module` {any} -* `parent` {DependenciesBlock} -* `request` {string} - -### Methods - -#### `addBlock(block)` - -* `block` {AsyncDependenciesBlock} -* Returns: {void} - -Adds a DependencyBlock to DependencyBlock relationship. -This is used for when a Module has a AsyncDependencyBlock tie (for code-splitting) - -#### `addDependency(dependency)` - -* `dependency` {Dependency} -* Returns: {void} - -#### `clearDependenciesAndBlocks()` - -* Returns: {void} - -Removes all dependencies and blocks - -#### `deserialize(__namedParameters)` - -* `__namedParameters` {ObjectDeserializerContext} -* Returns: {void} - -#### `getRootBlock()` - -* Returns: {DependenciesBlock} - -#### `removeDependency(dependency)` - -* `dependency` {Dependency} -* Returns: {void} - -#### `serialize(__namedParameters)` - -* `__namedParameters` {ObjectSerializerContext} -* Returns: {void} - -#### `updateHash(hash, context)` - -* `hash` {Hash} -* `context` {UpdateHashContextDependency} -* Returns: {void} - -*** - -## Class: `AutomaticPrefetchPlugin` - -### Constructors - -#### `new AutomaticPrefetchPlugin()` - -* Returns: {AutomaticPrefetchPlugin} - -### Methods - -#### `apply(compiler)` - -* `compiler` {Compiler} -* Returns: {void} - -Apply the plugin - -*** - -## Class: `BannerPlugin` - -### Constructors - -#### `new BannerPlugin(options)` - -* `options` {BannerPluginArgument} -* Returns: {BannerPlugin} - -### Properties - -* `banner` {object} -* `options` {BannerPluginOptions} - -### Methods - -#### `apply(compiler)` - -* `compiler` {Compiler} -* Returns: {void} - -Apply the plugin - -*** - -## Class: `Cache` - -### Constructors - -#### `new Cache()` - -* Returns: {CacheClass} - -### Properties - -* `hooks` {object} -* `STAGE_DEFAULT` {number} -* `STAGE_DISK` {number} -* `STAGE_MEMORY` {number} -* `STAGE_NETWORK` {number} - -### Methods - -#### `beginIdle()` - -* Returns: {void} - -#### `endIdle(callback)` - -* `callback` {CallbackCacheCache} -* Returns: {void} - -#### `get(identifier, etag, callback)` - -###### T - -`T` -* `identifier` {string} -* `etag` {Etag} -* `callback` {CallbackCacheCache} -* Returns: {void} - -#### `shutdown(callback)` - -* `callback` {CallbackCacheCache} -* Returns: {void} - -#### `store(identifier, etag, data, callback)` - -###### T - -`T` -* `identifier` {string} -* `etag` {Etag} -* `data` {T} -* `callback` {CallbackCacheCache} -* Returns: {void} - -#### `storeBuildDependencies(dependencies, callback)` - -* `dependencies` {Iterable} -* `callback` {CallbackCacheCache} -* Returns: {void} - -After this method has succeeded the cache can only be restored when build dependencies are - -*** - -## Class: `Chunk` - -### Extended by - -- {HotUpdateChunk} - -### Constructors - -#### `new Chunk([name][, backCompat])` - -* `name` {string} -* `backCompat` {boolean} -* Returns: {Chunk} - -### Properties - -* `auxiliaryFiles` {Set} -* `chunkReason` {string} -* `contentHash` {Record} -* `cssFilenameTemplate` {string|object} -* `debugId` {number} -* `entryModule` {Module} -* `extraAsync` {boolean} -* `filenameTemplate` {string|object} -* `files` {Set} -* `groupsIterable` {SortableSet} -* `hash` {string} -* `id` {string|number} -* `idNameHints` {SortableSet} -* `ids` {ChunkId[]} -* `modulesIterable` {Iterable} -* `name` {string} -* `preventIntegration` {boolean} -* `rendered` {boolean} -* `renderedHash` {string} -* `runtime` {RuntimeSpec} - -### Methods - -#### `addGroup(chunkGroup)` - -* `chunkGroup` {ChunkGroup} -* Returns: {void} - -#### `addModule(module)` - -* `module` {Module} -* Returns: {boolean} - -#### `canBeInitial()` - -* Returns: {boolean} - -#### `canBeIntegrated(otherChunk)` - -* `otherChunk` {Chunk} -* Returns: {boolean} - -#### `compareTo(otherChunk)` - -* `otherChunk` {Chunk} -* Returns: {-1|0|1} - -#### `containsModule(module)` - -* `module` {Module} -* Returns: {boolean} - -#### `disconnectFromGroups()` - -* Returns: {void} - -#### `getAllAsyncChunks()` - -* Returns: {Set} - -#### `getAllInitialChunks()` - -* Returns: {Set} - -#### `getAllReferencedAsyncEntrypoints()` - -* Returns: {Set} - -#### `getAllReferencedChunks()` - -* Returns: {Set} - -#### `getChildIdsByOrders(chunkGraph[, filterFn])` - -* `chunkGraph` {ChunkGraph} -* `filterFn` {object} -* Returns: {Record} - -#### `getChildIdsByOrdersMap(chunkGraph[, includeDirectChildren][, filterFn])` - -* `chunkGraph` {ChunkGraph} -* `includeDirectChildren` {boolean} -* `filterFn` {object} -* Returns: {ChunkChildIdsByOrdersMapByData} - -#### `getChildrenOfTypeInOrder(chunkGraph, type)` - -* `chunkGraph` {ChunkGraph} -* `type` {string} -* Returns: {ChunkChildOfTypeInOrder[]} - -#### `getChunkMaps(realHash)` - -> Stability: 0 - Deprecated - -* `realHash` {boolean} -* Returns: {ChunkMaps} - -#### `getChunkModuleMaps(filterFn)` - -* `filterFn` {object} -* Returns: {ChunkModuleMaps} - -#### `getEntryOptions()` - -* Returns: {EntryOptions} - -#### `getModules()` - -* Returns: {Module[]} - -#### `getNumberOfGroups()` - -* Returns: {number} - -#### `getNumberOfModules()` - -* Returns: {number} - -#### `hasAsyncChunks()` - -* Returns: {boolean} - -#### `hasChildByOrder(chunkGraph, type[, includeDirectChildren][, filterFn])` - -* `chunkGraph` {ChunkGraph} -* `type` {string} -* `includeDirectChildren` {boolean} -* `filterFn` {object} -* Returns: {boolean} - -#### `hasEntryModule()` - -* Returns: {boolean} - -#### `hasModuleInGraph(filterFn[, filterChunkFn])` - -* `filterFn` {object} -* `filterChunkFn` {object} -* Returns: {boolean} - -#### `hasRuntime()` - -* Returns: {boolean} - -#### `integrate(otherChunk)` - -* `otherChunk` {Chunk} -* Returns: {boolean} - -#### `integratedSize(otherChunk, options)` - -* `otherChunk` {Chunk} -* `options` {ChunkSizeOptions} -* Returns: {number} - -#### `isEmpty()` - -* Returns: {boolean} - -#### `isInGroup(chunkGroup)` - -* `chunkGroup` {ChunkGroup} -* Returns: {boolean} - -#### `isOnlyInitial()` - -* Returns: {boolean} - -#### `modulesSize()` - -* Returns: {number} - -#### `moveModule(module, otherChunk)` - -* `module` {Module} -* `otherChunk` {Chunk} -* Returns: {void} - -#### `remove()` - -* Returns: {void} - -#### `removeGroup(chunkGroup)` - -* `chunkGroup` {ChunkGroup} -* Returns: {void} - -#### `removeModule(module)` - -* `module` {Module} -* Returns: {void} - -#### `size([options])` - -* `options` {ChunkSizeOptions} -* Returns: {number} - -#### `split(newChunk)` - -* `newChunk` {Chunk} -* Returns: {void} - -#### `updateHash(hash, chunkGraph)` - -* `hash` {Hash} -* `chunkGraph` {ChunkGraph} -* Returns: {void} - -*** - -## Class: `ChunkGraph` - -### Constructors - -#### `new ChunkGraph(moduleGraph[, hashFunction])` - -* `moduleGraph` {ModuleGraph} -* `hashFunction` {HashFunction} -* Returns: {ChunkGraph} - -### Properties - -* `moduleGraph` {ModuleGraph} - -### Methods - -#### `addChunkRuntimeRequirements(chunk, items)` - -* `chunk` {Chunk} -* `items` {Set} -* Returns: {void} - -#### `addDependentHashModuleToChunk(chunk, module)` - -* `chunk` {Chunk} -* `module` {RuntimeModule} -* Returns: {void} - -#### `addFullHashModuleToChunk(chunk, module)` - -* `chunk` {Chunk} -* `module` {RuntimeModule} -* Returns: {void} - -#### `addModuleRuntimeRequirements(module, runtime, items[, transferOwnership])` - -* `module` {Module} -* `runtime` {RuntimeSpec} -* `items` {Set} -* `transferOwnership` {boolean} -* Returns: {void} - -#### `addTreeRuntimeRequirements(chunk, items)` - -* `chunk` {Chunk} -* `items` {Iterable} -* Returns: {void} - -#### `attachDependentHashModules(chunk, modules)` - -* `chunk` {Chunk} -* `modules` {Iterable} -* Returns: {void} - -#### `attachFullHashModules(chunk, modules)` - -* `chunk` {Chunk} -* `modules` {Iterable} -* Returns: {void} - -#### `attachModules(chunk, modules)` - -* `chunk` {Chunk} -* `modules` {Iterable} -* Returns: {void} - -#### `attachRuntimeModules(chunk, modules)` - -* `chunk` {Chunk} -* `modules` {Iterable} -* Returns: {void} - -#### `canChunksBeIntegrated(chunkA, chunkB)` - -* `chunkA` {Chunk} -* `chunkB` {Chunk} -* Returns: {boolean} - -#### `compareChunks(chunkA, chunkB)` - -* `chunkA` {Chunk} -* `chunkB` {Chunk} -* Returns: {-1|0|1} - -#### `connectBlockAndChunkGroup(depBlock, chunkGroup)` - -* `depBlock` {AsyncDependenciesBlock} -* `chunkGroup` {ChunkGroup} -* Returns: {void} - -#### `connectChunkAndEntryModule(chunk, module, entrypoint)` - -* `chunk` {Chunk} -* `module` {Module} -* `entrypoint` {Entrypoint} -* Returns: {void} - -#### `connectChunkAndModule(chunk, module)` - -* `chunk` {Chunk} -* `module` {Module} -* Returns: {void} - -#### `connectChunkAndRuntimeModule(chunk, module)` - -* `chunk` {Chunk} -* `module` {RuntimeModule} -* Returns: {void} - -#### `disconnectChunk(chunk)` - -* `chunk` {Chunk} -* Returns: {void} - -#### `disconnectChunkAndEntryModule(chunk, module)` - -* `chunk` {Chunk} -* `module` {Module} -* Returns: {void} - -#### `disconnectChunkAndModule(chunk, module)` - -* `chunk` {Chunk} -* `module` {Module} -* Returns: {void} - -#### `disconnectChunkAndRuntimeModule(chunk, module)` - -* `chunk` {Chunk} -* `module` {RuntimeModule} -* Returns: {void} - -#### `disconnectChunkGroup(chunkGroup)` - -* `chunkGroup` {ChunkGroup} -* Returns: {void} - -#### `disconnectEntries(chunk)` - -* `chunk` {Chunk} -* Returns: {void} - -#### `disconnectEntryModule(module)` - -* `module` {Module} -* Returns: {void} - -#### `getBlockChunkGroup(depBlock)` - -* `depBlock` {AsyncDependenciesBlock} -* Returns: {ChunkGroup} - -#### `getChunkConditionMap(chunk, filterFn)` - -* `chunk` {Chunk} -* `filterFn` {object} -* Returns: {ChunkConditionMap} - -#### `getChunkDependentHashModulesIterable(chunk)` - -* `chunk` {Chunk} -* Returns: {Iterable} - -#### `getChunkEntryDependentChunksIterable(chunk)` - -* `chunk` {Chunk} -* Returns: {Iterable} - -#### `getChunkEntryModulesIterable(chunk)` - -* `chunk` {Chunk} -* Returns: {Iterable} - -#### `getChunkEntryModulesWithChunkGroupIterable(chunk)` - -* `chunk` {Chunk} -* Returns: {Iterable>} - -#### `getChunkFullHashModulesIterable(chunk)` - -* `chunk` {Chunk} -* Returns: {Iterable} - -#### `getChunkFullHashModulesSet(chunk)` - -* `chunk` {Chunk} -* Returns: {ReadonlySet} - -#### `getChunkModuleIdMap(chunk, filterFn[, includeAllChunks])` - -* `chunk` {Chunk} -* `filterFn` {object} -* `includeAllChunks` {boolean} -* Returns: {ChunkModuleIdMapEs5Alias_2} - -#### `getChunkModuleRenderedHashMap(chunk, filterFn[, hashLength][, includeAllChunks])` - -* `chunk` {Chunk} -* `filterFn` {object} -* `hashLength` {number} -* `includeAllChunks` {boolean} -* Returns: {ChunkModuleHashMap} - -#### `getChunkModules(chunk)` - -* `chunk` {Chunk} -* Returns: {Module[]} - -#### `getChunkModulesIterable(chunk)` - -* `chunk` {Chunk} -* Returns: {Iterable} - -#### `getChunkModulesIterableBySourceType(chunk, sourceType)` - -* `chunk` {Chunk} -* `sourceType` {string} -* Returns: {Iterable} - -#### `getChunkModuleSourceTypes(chunk, module)` - -* `chunk` {Chunk} -* `module` {Module} -* Returns: {ReadonlySet} - -#### `getChunkModulesSize(chunk)` - -* `chunk` {Chunk} -* Returns: {number} - -#### `getChunkModulesSizes(chunk)` - -* `chunk` {Chunk} -* Returns: {Record} - -#### `getChunkRootModules(chunk)` - -* `chunk` {Chunk} -* Returns: {Module[]} - -#### `getChunkRuntimeModulesInOrder(chunk)` - -* `chunk` {Chunk} -* Returns: {RuntimeModule[]} - -#### `getChunkRuntimeModulesIterable(chunk)` - -* `chunk` {Chunk} -* Returns: {Iterable} - -#### `getChunkRuntimeRequirements(chunk)` - -* `chunk` {Chunk} -* Returns: {ReadonlySet} - -#### `getChunkSize(chunk[, options])` - -* `chunk` {Chunk} -* `options` {ChunkSizeOptions} -* Returns: {number} - -#### `getIntegratedChunksSize(chunkA, chunkB[, options])` - -* `chunkA` {Chunk} -* `chunkB` {Chunk} -* `options` {ChunkSizeOptions} -* Returns: {number} - -#### `getModuleChunks(module)` - -* `module` {Module} -* Returns: {Chunk[]} - -#### `getModuleChunksIterable(module)` - -* `module` {Module} -* Returns: {Iterable} - -#### `getModuleGraphHash(module, runtime[, withConnections])` - -* `module` {Module} -* `runtime` {RuntimeSpec} -* `withConnections` {boolean} -* Returns: {string} - -#### `getModuleGraphHashBigInt(module, runtime[, withConnections])` - -* `module` {Module} -* `runtime` {RuntimeSpec} -* `withConnections` {boolean} -* Returns: {bigint} - -#### `getModuleHash(module, runtime)` - -* `module` {Module} -* `runtime` {RuntimeSpec} -* Returns: {string} - -#### `getModuleId(module)` - -* `module` {Module} -* Returns: {string|number} - -#### `getModuleRuntimeRequirements(module, runtime)` - -* `module` {Module} -* `runtime` {RuntimeSpec} -* Returns: {ReadonlySet} - -#### `getModuleRuntimes(module)` - -* `module` {Module} -* Returns: {RuntimeSpecSet} - -#### `getModuleSourceTypes(module)` - -* `module` {Module} -* Returns: {ReadonlySet} - -#### `getNumberOfChunkFullHashModules(chunk)` - -* `chunk` {Chunk} -* Returns: {number} - -#### `getNumberOfChunkModules(chunk)` - -* `chunk` {Chunk} -* Returns: {number} - -#### `getNumberOfEntryModules(chunk)` - -* `chunk` {Chunk} -* Returns: {number} - -#### `getNumberOfModuleChunks(module)` - -* `module` {Module} -* Returns: {number} - -#### `getNumberOfRuntimeModules(chunk)` - -* `chunk` {Chunk} -* Returns: {number} - -#### `getOrderedChunkModules(chunk, comparator)` - -* `chunk` {Chunk} -* `comparator` {object} -* Returns: {Module[]} - -#### `getOrderedChunkModulesIterable(chunk, comparator)` - -* `chunk` {Chunk} -* `comparator` {object} -* Returns: {Iterable} - -#### `getOrderedChunkModulesIterableBySourceType(chunk, sourceType, comparator)` - -* `chunk` {Chunk} -* `sourceType` {string} -* `comparator` {object} -* Returns: {Iterable} - -#### `getOrderedModuleChunksIterable(module, sortFn)` - -* `module` {Module} -* `sortFn` {object} -* Returns: {Iterable} - -#### `getRenderedModuleHash(module, runtime)` - -* `module` {Module} -* `runtime` {RuntimeSpec} -* Returns: {string} - -#### `getRuntimeChunkDependentChunksIterable(chunk)` - -* `chunk` {Chunk} -* Returns: {Iterable} - -#### `getRuntimeId(runtime)` - -* `runtime` {string} -* Returns: {RuntimeId} - -#### `getTreeRuntimeRequirements(chunk)` - -* `chunk` {Chunk} -* Returns: {ReadonlySet} - -#### `hasChunkEntryDependentChunks(chunk)` - -* `chunk` {Chunk} -* Returns: {boolean} - -#### `hasModuleHashes(module, runtime)` - -* `module` {Module} -* `runtime` {RuntimeSpec} -* Returns: {boolean} - -#### `hasModuleInGraph(chunk, filterFn[, filterChunkFn])` - -* `chunk` {Chunk} -* `filterFn` {object} -* `filterChunkFn` {object} -* Returns: {boolean} - -#### `integrateChunks(chunkA, chunkB)` - -* `chunkA` {Chunk} -* `chunkB` {Chunk} -* Returns: {void} - -#### `isEntryModule(module)` - -* `module` {Module} -* Returns: {boolean} - -#### `isEntryModuleInChunk(module, chunk)` - -* `module` {Module} -* `chunk` {Chunk} -* Returns: {boolean} - -#### `isModuleInChunk(module, chunk)` - -* `module` {Module} -* `chunk` {Chunk} -* Returns: {boolean} - -#### `isModuleInChunkGroup(module, chunkGroup)` - -* `module` {Module} -* `chunkGroup` {ChunkGroup} -* Returns: {boolean} - -#### `replaceModule(oldModule, newModule)` - -* `oldModule` {Module} -* `newModule` {Module} -* Returns: {void} - -#### `setChunkModuleSourceTypes(chunk, module, sourceTypes)` - -* `chunk` {Chunk} -* `module` {Module} -* `sourceTypes` {ReadonlySet} -* Returns: {void} - -#### `setModuleHashes(module, runtime, hash, renderedHash)` - -* `module` {Module} -* `runtime` {RuntimeSpec} -* `hash` {string} -* `renderedHash` {string} -* Returns: {void} - -#### `setModuleId(module, id)` - -* `module` {Module} -* `id` {ModuleId} -* Returns: {void} - -#### `setRuntimeId(runtime, id)` - -* `runtime` {string} -* `id` {RuntimeId} -* Returns: {void} - -#### `upgradeDependentToFullHashModules(chunk)` - -* `chunk` {Chunk} -* Returns: {void} - -#### Static method: `clearChunkGraphForChunk(chunk)` - -> Stability: 0 - Deprecated - -* `chunk` {Chunk} -* Returns: {void} - -#### Static method: `clearChunkGraphForModule(module)` - -> Stability: 0 - Deprecated - -* `module` {Module} -* Returns: {void} - -#### Static method: `getChunkGraphForChunk(chunk, deprecateMessage, deprecationCode)` - -> Stability: 0 - Deprecated - -* `chunk` {Chunk} -* `deprecateMessage` {string} -* `deprecationCode` {string} -* Returns: {ChunkGraph} - -#### Static method: `getChunkGraphForModule(module, deprecateMessage, deprecationCode)` - -> Stability: 0 - Deprecated - -* `module` {Module} -* `deprecateMessage` {string} -* `deprecationCode` {string} -* Returns: {ChunkGraph} - -#### Static method: `setChunkGraphForChunk(chunk, chunkGraph)` - -> Stability: 0 - Deprecated - -* `chunk` {Chunk} -* `chunkGraph` {ChunkGraph} -* Returns: {void} - -#### Static method: `setChunkGraphForModule(module, chunkGraph)` - -> Stability: 0 - Deprecated - -* `module` {Module} -* `chunkGraph` {ChunkGraph} -* Returns: {void} - -*** - -## Class: `ChunkGroup` - -### Extended by - -- {Entrypoint} - -### Constructors - -#### `new ChunkGroup()` - -* Returns: {ChunkGroup} - -### Properties - -* `asyncEntrypointsIterable` {SortableSet} -* `blocksIterable` {Iterable} -* `childrenIterable` {SortableSet} -* `chunks` {Chunk[]} -* `debugId` {string} get a uniqueId for ChunkGroup, made up of its member Chunk debugId's -* `getModuleIndex` {object} -* `getModuleIndex2` {object} -* `groupDebugId` {number} -* `id` {string} get a unique id for ChunkGroup, made up of its member Chunk id's -* `index` {number} -* `name` {string} returns the name of current ChunkGroup -sets a new name for current ChunkGroup -* `options` {ChunkGroupOptions} -* `origins` {OriginRecord[]} -* `parentsIterable` {SortableSet} - -### Methods - -#### `addAsyncEntrypoint(entrypoint)` - -* `entrypoint` {Entrypoint} -* Returns: {boolean} - -#### `addBlock(block)` - -* `block` {AsyncDependenciesBlock} -* Returns: {boolean} - -#### `addChild(group)` - -* `group` {ChunkGroup} -* Returns: {boolean} - -#### `addOptions(options)` - -* `options` {ChunkGroupOptions} -* Returns: {void} - -when a new chunk is added to a chunkGroup, addingOptions will occur. - -#### `addOrigin(module, loc, request)` - -* `module` {Module} -* `loc` {DependencyLocation} -* `request` {string} -* Returns: {void} - -#### `addParent(parentChunk)` - -* `parentChunk` {ChunkGroup} -* Returns: {boolean} - -#### `checkConstraints()` - -* Returns: {void} - -#### `compareTo(chunkGraph, otherGroup)` - -* `chunkGraph` {ChunkGraph} -* `otherGroup` {ChunkGroup} -* Returns: {-1|0|1} - -Sorting predicate which allows current ChunkGroup to be compared against another. -Sorting values are based off of number of chunks in ChunkGroup. - -#### `getBlocks()` - -* Returns: {AsyncDependenciesBlock[]} - -#### `getChildren()` - -* Returns: {ChunkGroup[]} - -#### `getChildrenByOrders(moduleGraph, chunkGraph)` - -* `moduleGraph` {ModuleGraph} -* `chunkGraph` {ChunkGraph} -* Returns: {Record} - -#### `getFiles()` - -* Returns: {string[]} - -#### `getModulePostOrderIndex(module)` - -* `module` {Module} -* Returns: {number} - -Gets the bottom-up index of a module in this ChunkGroup - -#### `getModulePreOrderIndex(module)` - -* `module` {Module} -* Returns: {number} - -Gets the top-down index of a module in this ChunkGroup - -#### `getNumberOfBlocks()` - -* Returns: {number} - -#### `getNumberOfChildren()` - -* Returns: {number} - -#### `getNumberOfParents()` - -* Returns: {number} - -#### `getParents()` - -* Returns: {ChunkGroup[]} - -#### `hasBlock(block)` - -* `block` {AsyncDependenciesBlock} -* Returns: {boolean} - -#### `hasParent(parent)` - -* `parent` {ChunkGroup} -* Returns: {boolean} - -#### `insertChunk(chunk, before)` - -* `chunk` {Chunk} -* `before` {Chunk} -* Returns: {boolean} - -inserts a chunk before another existing chunk in group - -#### `isInitial()` - -* Returns: {boolean} - -#### `pushChunk(chunk)` - -* `chunk` {Chunk} -* Returns: {boolean} - -add a chunk into ChunkGroup. Is pushed on or prepended - -#### `remove()` - -* Returns: {void} - -#### `removeChild(group)` - -* `group` {ChunkGroup} -* Returns: {boolean} - -#### `removeChunk(chunk)` - -* `chunk` {Chunk} -* Returns: {boolean} - -#### `removeParent(chunkGroup)` - -* `chunkGroup` {ChunkGroup} -* Returns: {boolean} - -#### `replaceChunk(oldChunk, newChunk)` - -* `oldChunk` {Chunk} -* `newChunk` {Chunk} -* Returns: {boolean} - -#### `setModulePostOrderIndex(module, index)` - -* `module` {Module} -* `index` {number} -* Returns: {void} - -Sets the bottom-up index of a module in this ChunkGroup - -#### `setModulePreOrderIndex(module, index)` - -* `module` {Module} -* `index` {number} -* Returns: {void} - -Sets the top-down index of a module in this ChunkGroup - -#### `sortItems()` - -* Returns: {void} - -#### `unshiftChunk(chunk)` - -* `chunk` {Chunk} -* Returns: {boolean} - -Performs an unshift of a specific chunk - -*** - -## Class: `CleanPlugin` - -### Constructors - -#### `new CleanPlugin([options])` - -* `options` {CleanOptions} -* Returns: {CleanPlugin} - -### Properties - -* `options` {CleanOptions} - -### Methods - -#### `apply(compiler)` - -* `compiler` {Compiler} -* Returns: {void} - -Apply the plugin - -#### Static method: `getCompilationHooks(compilation)` - -* `compilation` {Compilation} -* Returns: {CleanPluginCompilationHooks} - -*** - -## Class: `CodeGenerationResults` - -### Constructors - -#### `new CodeGenerationResults()` - -* Returns: {CodeGenerationResults} - -### Properties - -* `map` {Map>} - -### Methods - -#### `add(module, runtime, result)` - -* `module` {Module} -* `runtime` {RuntimeSpec} -* `result` {CodeGenerationResult} -* Returns: {void} - -#### `get(module, runtime)` - -* `module` {Module} -* `runtime` {RuntimeSpec} -* Returns: {CodeGenerationResult} - -#### `getData(module, runtime, key)` - -* `module` {Module} -* `runtime` {RuntimeSpec} -* `key` {string} -* Returns: {any} - -#### `getHash(module, runtime)` - -* `module` {Module} -* `runtime` {RuntimeSpec} -* Returns: {string} - -#### `getRuntimeRequirements(module, runtime)` - -* `module` {Module} -* `runtime` {RuntimeSpec} -* Returns: {ReadonlySet} - -#### `getSource(module, runtime, sourceType)` - -* `module` {Module} -* `runtime` {RuntimeSpec} -* `sourceType` {string} -* Returns: {Source} - -#### `has(module, runtime)` - -* `module` {Module} -* `runtime` {RuntimeSpec} -* Returns: {boolean} - -*** - -## Class: `Compilation` - -### Constructors - -#### `new Compilation(compiler, params)` - -* `compiler` {Compiler} -* `params` {CompilationParams} -* Returns: {Compilation} - -Creates an instance of Compilation. - -### Properties - -* `additionalChunkAssets` {string[]} -* `addModuleQueue` {AsyncQueue} -* `assets` {CompilationAssets} -* `assetsInfo` {Map} -* `asyncEntrypoints` {Entrypoint[]} -* `bail` {boolean} -* `buildDependencies` {LazySet} -* `buildQueue` {AsyncQueue} -* `buildTimeExecutedModules` {WeakSet} -* `builtModules` {WeakSet} -* `children` {Compilation[]} -* `childrenCounters` {Record} -* `chunkGraph` {ChunkGraph} -* `chunkGroups` {ChunkGroup[]} -* `chunks` {Set} -* `chunkTemplate` {ChunkTemplate} -* `codeGeneratedModules` {WeakSet} -* `codeGenerationResults` {CodeGenerationResults} -* `comparedForEmitAssets` {Set} -* `compilationDependencies` {object} -* `compiler` {Compiler} -* `compilerPath` {string} -* `contextDependencies` {LazySet} -* `creatingModuleDuringBuild` {WeakMap>} Modules in value are building during the build of Module in key. -Means value blocking key from finishing. -Needed to detect build cycles. -* `dependencyFactories` {Map} -* `dependencyTemplates` {DependencyTemplates} -* `emittedAssets` {Set} -* `endTime` {number} -* `entries` {Map} -* `entrypoints` {Map} -* `errors` {Error[]} -* `factorizeQueue` {AsyncQueue} -* `fileDependencies` {LazySet} -* `fileSystemInfo` {FileSystemInfo} -* `fullHash` {string} -* `globalEntry` {EntryData} -* `hash` {string} -* `hooks` {Readonly} -* `inputFileSystem` {InputFileSystem} -* `logger` {WebpackLogger} -* `logging` {Map} -* `mainTemplate` {MainTemplate} -* `missingDependencies` {LazySet} -* `moduleGraph` {ModuleGraph} -* `moduleMemCaches` {Map>} -* `moduleMemCaches2` {Map>} -* `modules` {Set} -* `moduleTemplates` {ModuleTemplates} -* `name` {string} -* `namedChunkGroups` {Map} -* `namedChunks` {Map} -* `needAdditionalPass` {boolean} -* `options` {WebpackOptionsNormalizedWithDefaults} -* `outputOptions` {OutputNormalizedWithDefaults} -* `params` {CompilationParams} -* `processDependenciesQueue` {AsyncQueue} -* `profile` {boolean} -* `rebuildQueue` {AsyncQueue} -* `records` {Records} -* `requestShortener` {RequestShortener} -* `resolverFactory` {ResolverFactory} -* `runtimeTemplate` {RuntimeTemplate} -* `startTime` {number} -* `usedChunkIds` {Set} -* `usedModuleIds` {Set} -* `valueCacheVersions` {Map} -* `warnings` {Error[]} -* `PROCESS_ASSETS_STAGE_ADDITIONAL` {number} Add additional assets to the compilation. -* `PROCESS_ASSETS_STAGE_ADDITIONS` {number} Add additional sections to existing assets, like a banner or initialization code. -* `PROCESS_ASSETS_STAGE_ANALYSE` {number} Analyse existing assets. -* `PROCESS_ASSETS_STAGE_DERIVED` {number} Derive new assets from existing assets. -Existing assets should not be treated as complete. -* `PROCESS_ASSETS_STAGE_DEV_TOOLING` {number} Add development tooling to assets, e. g. by extracting a SourceMap. -* `PROCESS_ASSETS_STAGE_OPTIMIZE` {number} Optimize existing assets in a general way. -* `PROCESS_ASSETS_STAGE_OPTIMIZE_COMPATIBILITY` {number} Optimize the compatibility of existing assets, e. g. add polyfills or vendor-prefixes. -* `PROCESS_ASSETS_STAGE_OPTIMIZE_COUNT` {number} Optimize the count of existing assets, e. g. by merging them. -Only assets of the same type should be merged. -For assets of different types see PROCESS_ASSETS_STAGE_OPTIMIZE_INLINE. -* `PROCESS_ASSETS_STAGE_OPTIMIZE_HASH` {number} Optimize the hashes of the assets, e. g. by generating real hashes of the asset content. -* `PROCESS_ASSETS_STAGE_OPTIMIZE_INLINE` {number} Optimize the count of existing assets, e. g. by inlining assets of into other assets. -Only assets of different types should be inlined. -For assets of the same type see PROCESS_ASSETS_STAGE_OPTIMIZE_COUNT. -* `PROCESS_ASSETS_STAGE_OPTIMIZE_SIZE` {number} Optimize the size of existing assets, e. g. by minimizing or omitting whitespace. -* `PROCESS_ASSETS_STAGE_OPTIMIZE_TRANSFER` {number} Optimize the transfer of existing assets, e. g. by preparing a compressed (gzip) file as separate asset. -* `PROCESS_ASSETS_STAGE_PRE_PROCESS` {number} Basic preprocessing of assets. -* `PROCESS_ASSETS_STAGE_REPORT` {number} Creating assets for reporting purposes. -* `PROCESS_ASSETS_STAGE_SUMMARIZE` {number} Summarize the list of existing assets -e. g. creating an assets manifest of Service Workers. - -### Methods - -#### `addAsyncEntrypoint(options, module, loc, request)` - -* `options` {EntryOptions} -* `module` {Module} -* `loc` {DependencyLocation} -* `request` {string} -* Returns: {Entrypoint} - -#### `addChunk([name])` - -* `name` {string} -* Returns: {Chunk} - -This method first looks to see if a name is provided for a new chunk, -and first looks to see if any named chunks already exist and reuse that chunk instead. - -#### `addChunkInGroup(groupOptions[, module][, loc][, request])` - -* `groupOptions` {string|ChunkGroupOptions} -* `module` {Module} -* `loc` {SyntheticDependencyLocation|RealDependencyLocation} -* `request` {string} -* Returns: {ChunkGroup} - -If `module` is passed, `loc` and `request` must also be passed. - -#### `addEntry(context, entry, optionsOrName, callback)` - -* `context` {string} -* `entry` {Dependency} -* `optionsOrName` {string|EntryOptions} -* `callback` {object} -* Returns: {void} - -#### `addInclude(context, dependency, options, callback)` - -* `context` {string} -* `dependency` {Dependency} -* `options` {EntryOptions} -* `callback` {object} -* Returns: {void} - -#### `addModule(module, callback)` - -* `module` {Module} -* `callback` {object} -* Returns: {void} - -#### `addModuleChain(context, dependency, callback)` - -* `context` {string} -* `dependency` {Dependency} -* `callback` {object} -* Returns: {void} - -#### `addModuleTree(__namedParameters, callback)` - -* `__namedParameters` {object} -* `callback` {object} -* Returns: {void} - -#### `addRuntimeModule(chunk, module[, chunkGraph])` - -* `chunk` {Chunk} -* `module` {RuntimeModule} -* `chunkGraph` {ChunkGraph} -* Returns: {void} - -#### `assignDepth(module)` - -> Stability: 0 - Deprecated - -* `module` {Module} -* Returns: {void} - -#### `assignDepths(modules)` - -* `modules` {Set} -* Returns: {void} - -#### `assignRuntimeIds()` - -* Returns: {void} - -#### `buildModule(module, callback)` - -* `module` {Module} -* `callback` {object} -* Returns: {void} - -Schedules a build of the module object - -#### `checkConstraints()` - -* Returns: {void} - -#### `clearAssets()` - -* Returns: {void} - -#### `codeGeneration(callback)` - -* `callback` {object} -* Returns: {void} - -#### `createChildCompiler(name[, outputOptions][, plugins])` - -* `name` {string} -* `outputOptions` {Partial} -* `plugins` {false|""|0|object|WebpackPluginInstance[]} -* Returns: {Compiler} - -This function allows you to run another instance of webpack inside of webpack however as -a child with different settings and configurations (if desired) applied. It copies all hooks, plugins -from parent (or top level compiler) and creates a child Compilation - -#### `createChunkAssets(callback)` - -* `callback` {object} -* Returns: {void} - -#### `createHash()` - -* Returns: {CodeGenerationJob[]} - -#### `createModuleAssets()` - -* Returns: {void} - -#### `createModuleHashes()` - -* Returns: {void} - -#### `createStatsFactory(options)` - -* `options` {NormalizedStatsOptions} -* Returns: {StatsFactory} - -#### `createStatsOptions([optionsOrPreset][, context])` - -* `optionsOrPreset` {string|boolean|StatsOptions} -* `context` {CreateStatsOptionsContext} -* Returns: {NormalizedStatsOptions} - -#### `createStatsPrinter(options)` - -* `options` {NormalizedStatsOptions} -* Returns: {StatsPrinter} - -#### `deleteAsset(file)` - -* `file` {string} -* Returns: {void} - -#### `emitAsset(file, source[, assetInfo])` - -* `file` {string} -* `source` {Source} -* `assetInfo` {AssetInfo} -* Returns: {void} - -#### `executeModule(module, options, callback)` - -* `module` {Module} -* `options` {ExecuteModuleOptions} -* `callback` {object} -* Returns: {void} - -#### `factorizeModule(options, callback)` - -##### Call Signature - -* `options` {FactorizeModuleOptions|object} -* `callback` {object} -* Returns: {void} - -##### Call Signature - -* `options` {FactorizeModuleOptions|object} -* `callback` {object} -* Returns: {void} - -#### `findModule(identifier)` - -* `identifier` {string} -* Returns: {Module} - -Attempts to search for a module by its identifier - -#### `finish(callback)` - -* `callback` {object} -* Returns: {void} - -#### `getAsset(name)` - -* `name` {string} -* Returns: {Readonly} - -#### `getAssetPath(filename, data)` - -* `filename` {TemplatePath} -* `data` {PathData} -* Returns: {string} - -#### `getAssetPathWithInfo(filename, data)` - -* `filename` {TemplatePath} -* `data` {PathData} -* Returns: {InterpolatedPathAndAssetInfo} - -#### `getAssets()` - -* Returns: {Readonly[]} - -#### `getCache(name)` - -* `name` {string} -* Returns: {CacheFacade} - -#### `getDependencyReferencedExports(dependency, runtime)` - -* `dependency` {Dependency} -* `runtime` {RuntimeSpec} -* Returns: {string[]|ReferencedExport[]} - -#### `getErrors()` - -* Returns: {Error[]} - -#### `getLogger(name)` - -* `name` {string|object} -* Returns: {WebpackLogger} - -#### `getModule(module)` - -* `module` {Module} -* Returns: {Module} - -Fetches a module from a compilation by its identifier - -#### `getPath(filename[, data])` - -* `filename` {TemplatePath} -* `data` {PathData} -* Returns: {string} - -#### `getPathWithInfo(filename[, data])` - -* `filename` {TemplatePath} -* `data` {PathData} -* Returns: {InterpolatedPathAndAssetInfo} - -#### `getRenderManifest(options)` - -* `options` {RenderManifestOptions} -* Returns: {RenderManifestEntry[]} - -#### `getStats()` - -* Returns: {Stats} - -#### `getWarnings()` - -* Returns: {Error[]} - -#### `handleModuleCreation(__namedParameters, callback)` - -* `__namedParameters` {HandleModuleCreationOptions} -* `callback` {object} -* Returns: {void} - -#### `patchChunksAfterReasonRemoval(module, chunk)` - -* `module` {Module} -* `chunk` {Chunk} -* Returns: {void} - -#### `processModuleDependencies(module, callback)` - -* `module` {Module} -* `callback` {object} -* Returns: {void} - -#### `processModuleDependenciesNonRecursive(module)` - -* `module` {Module} -* Returns: {void} - -#### `processRuntimeRequirements([__namedParameters])` - -* `__namedParameters` {object} -* Returns: {void} - -#### `rebuildModule(module, callback)` - -* `module` {Module} -* `callback` {object} -* Returns: {void} - -#### `removeChunkFromDependencies(block, chunk)` - -* `block` {DependenciesBlock} -* `chunk` {Chunk} -* Returns: {void} - -#### `removeReasonsOfDependencyBlock(module, block)` - -* `module` {Module} -* `block` {DependenciesBlockLike} -* Returns: {void} - -#### `renameAsset(file, newFile)` - -* `file` {string} -* `newFile` {string} -* Returns: {void} - -#### `reportDependencyErrorsAndWarnings(module, blocks)` - -* `module` {Module} -* `blocks` {DependenciesBlock[]} -* Returns: {boolean} - -#### `seal(callback)` - -* `callback` {object} -* Returns: {void} - -#### `sortItemsWithChunkIds()` - -* Returns: {void} - -#### `summarizeDependencies()` - -* Returns: {void} - -#### `unseal()` - -* Returns: {void} - -#### `updateAsset(file, newSourceOrFunction[, assetInfoUpdateOrFunction])` - -* `file` {string} -* `newSourceOrFunction` {Source|object} -* `assetInfoUpdateOrFunction` {AssetInfo|object} -* Returns: {void} - -*** - -## Class: `Compiler` - -### Constructors - -#### `new Compiler(context[, options])` - -* `context` {string} -* `options` {WebpackOptionsNormalized} -* Returns: {Compiler} - -### Properties - -* `cache` {CacheClass} -* `compilerPath` {string} -* `context` {string} -* `contextTimestamps` {Map} -* `fileTimestamps` {Map} -* `fsStartTime` {number} -* `hooks` {Readonly} -* `idle` {boolean} -* `immutablePaths` {Set} -* `infrastructureLogger` {object} -* `inputFileSystem` {InputFileSystem} -* `intermediateFileSystem` {IntermediateFileSystem} -* `managedPaths` {Set} -* `modifiedFiles` {ReadonlySet} -* `moduleMemCaches` {Map} -* `name` {string} -* `options` {WebpackOptionsNormalized} -* `outputFileSystem` {OutputFileSystem} -* `outputPath` {string} -* `parentCompilation` {Compilation} -* `platform` {Readonly} -* `records` {Records} -* `recordsInputPath` {string} -* `recordsOutputPath` {string} -* `removedFiles` {ReadonlySet} -* `requestShortener` {RequestShortener} -* `resolverFactory` {ResolverFactory} -* `root` {Compiler} -* `running` {boolean} -* `unmanagedPaths` {Set} -* `watchFileSystem` {WatchFileSystem} -* `watching` {Watching} -* `watchMode` {boolean} -* `webpack` {exports} - -### Methods - -#### `close(callback)` - -* `callback` {object} -* Returns: {void} - -#### `compile(callback)` - -* `callback` {CallbackWebpackFunction_2} -* Returns: {void} - -#### `createChildCompiler(compilation, compilerName, compilerIndex[, outputOptions][, plugins])` - -* `compilation` {Compilation} -* `compilerName` {string} -* `compilerIndex` {number} -* `outputOptions` {Partial} -* `plugins` {false|""|0|WebpackPluginInstance|object[]} -* Returns: {Compiler} - -#### `createCompilation(params)` - -* `params` {CompilationParams} -* Returns: {Compilation} - -#### `createContextModuleFactory()` - -* Returns: {ContextModuleFactory} - -#### `createNormalModuleFactory()` - -* Returns: {NormalModuleFactory} - -#### `emitAssets(compilation, callback)` - -* `compilation` {Compilation} -* `callback` {object} -* Returns: {void} - -#### `emitRecords(callback)` - -* `callback` {object} -* Returns: {void} - -#### `getCache(name)` - -* `name` {string} -* Returns: {CacheFacade} - -#### `getInfrastructureLogger(name)` - -* `name` {string|object} -* Returns: {WebpackLogger} - -#### `isChild()` - -* Returns: {boolean} - -#### `newCompilation(params)` - -* `params` {CompilationParams} -* Returns: {Compilation} - -#### `newCompilationParams()` - -* Returns: {object} - -#### `purgeInputFileSystem()` - -* Returns: {void} - -#### `readRecords(callback)` - -* `callback` {object} -* Returns: {void} - -#### `run(callback)` - -* `callback` {CallbackWebpackFunction_2} -* Returns: {void} - -#### `runAsChild(callback)` - -* `callback` {object} -* Returns: {void} - -#### `validate(schema, value[, options][, check])` - -###### T - -`T` *extends* {object|object[]} = {object} -* `schema` {JSONSchema4|ExtendedSchema|JSONSchema6|ExtendedSchema|JSONSchema7|ExtendedSchema|object} -* `value` {T} -* `options` {ValidationErrorConfiguration} -* `check` {object} -* Returns: {void} - -Schema validation function with optional pre-compiled check - -#### `watch(watchOptions, handler)` - -* `watchOptions` {WatchOptions} -* `handler` {CallbackWebpackFunction_2} -* Returns: {Watching} - -*** - -## Class: `ConcatenationScope` - -### Constructors - -#### `new ConcatenationScope(modulesMap, currentModule, usedNames)` - -* `modulesMap` {ModuleInfo[]|Map} -* `currentModule` {ConcatenatedModuleInfo} -* `usedNames` {Set} -* Returns: {ConcatenationScope} - -### Properties - -* `usedNames` {Set} -* `DEFAULT_EXPORT` {string} -* `NAMESPACE_OBJECT_EXPORT` {string} - -### Methods - -#### `createModuleReference(module, __namedParameters)` - -* `module` {Module} -* `__namedParameters` {Partial} -* Returns: {string} - -#### `getRawExport(exportName)` - -* `exportName` {string} -* Returns: {string} - -#### `isModuleInScope(module)` - -* `module` {Module} -* Returns: {boolean} - -#### `registerExport(exportName, symbol)` - -* `exportName` {string} -* `symbol` {string} -* Returns: {void} - -#### `registerNamespaceExport(symbol)` - -* `symbol` {string} -* Returns: {void} - -#### `registerRawExport(exportName, expression)` - -* `exportName` {string} -* `expression` {string} -* Returns: {void} - -#### `setRawExportMap(exportName, expression)` - -* `exportName` {string} -* `expression` {string} -* Returns: {void} - -#### Static method: `isModuleReference(name)` - -* `name` {string} -* Returns: {boolean} - -#### Static method: `matchModuleReference(name)` - -* `name` {string} -* Returns: {ModuleReferenceOptions|object} - -*** - -## Class: `ContextExclusionPlugin` - -### Constructors - -#### `new ContextExclusionPlugin(negativeMatcher)` - -* `negativeMatcher` {RegExp} -* Returns: {ContextExclusionPlugin} - -### Properties - -* `negativeMatcher` {RegExp} - -### Methods - -#### `apply(compiler)` - -* `compiler` {Compiler} -* Returns: {void} - -Apply the plugin - -*** - -## Class: `ContextReplacementPlugin` - -### Constructors - -#### `new ContextReplacementPlugin(resourceRegExp[, newContentResource][, newContentRecursive][, newContentRegExp])` - -* `resourceRegExp` {RegExp} -* `newContentResource` {string|boolean|RegExp|object} -* `newContentRecursive` {boolean|RegExp|NewContentCreateContextMap} -* `newContentRegExp` {RegExp} -* Returns: {ContextReplacementPlugin} - -### Properties - -* `newContentCallback` {object} -* `newContentCreateContextMap` {object} -* `newContentRecursive` {boolean} -* `newContentRegExp` {RegExp} -* `newContentResource` {string} -* `resourceRegExp` {RegExp} - -### Methods - -#### `apply(compiler)` - -* `compiler` {Compiler} -* Returns: {void} - -Apply the plugin - -*** - -## Class: `DefinePlugin` - -### Constructors - -#### `new DefinePlugin(definitions)` - -* `definitions` {Definitions} -* Returns: {DefinePlugin} - -Create a new define plugin - -### Properties - -* `definitions` {Definitions} - -### Methods - -#### `apply(compiler)` - -* `compiler` {Compiler} -* Returns: {void} - -Apply the plugin - -#### Static method: `getCompilationHooks(compilation)` - -* `compilation` {Compilation} -* Returns: {DefinePluginHooks} - -#### Static method: `runtimeValue(fn[, options])` - -* `fn` {object} -* `options` {true|string[]|RuntimeValueOptions} -* Returns: {RuntimeValue} - -*** - -## Class: `DelegatedPlugin` - -### Constructors - -#### `new DelegatedPlugin(options)` - -* `options` {Options} -* Returns: {DelegatedPlugin} - -### Properties - -* `options` {Options} - -### Methods - -#### `apply(compiler)` - -* `compiler` {Compiler} -* Returns: {void} - -Apply the plugin - -*** - -## Class: `Dependency` - -### Extended by - -- {ModuleDependency} -- {NullDependency} - -### Constructors - -#### `new Dependency()` - -* Returns: {Dependency} - -### Properties - -* `category` {string} -* `disconnect` {any} -* `loc` {DependencyLocation} -* `module` {any} -* `optional` {boolean} -* `type` {string} -* `weak` {boolean} -* `EXPORTS_OBJECT_REFERENCED` {string[][]} -* `NO_EXPORTS_REFERENCED` {string[][]} -* `TRANSITIVE` {TRANSITIVE} - -### Methods - -#### `couldAffectReferencingModule()` - -* Returns: {boolean|TRANSITIVE} - -#### `createIgnoredModule(context)` - -* `context` {string} -* Returns: {Module} - -#### `deserialize(__namedParameters)` - -* `__namedParameters` {ObjectDeserializerContext} -* Returns: {void} - -#### `getCondition(moduleGraph)` - -* `moduleGraph` {ModuleGraph} -* Returns: {false|object} - -#### `getContext()` - -* Returns: {string} - -#### `getErrors(moduleGraph)` - -* `moduleGraph` {ModuleGraph} -* Returns: {WebpackError[]} - -Returns errors - -#### `getExports(moduleGraph)` - -* `moduleGraph` {ModuleGraph} -* Returns: {ExportsSpec} - -Returns the exported names - -#### `getModuleEvaluationSideEffectsState(moduleGraph)` - -* `moduleGraph` {ModuleGraph} -* Returns: {ConnectionState} - -#### `getNumberOfIdOccurrences()` - -* Returns: {number} - -implement this method to allow the occurrence order plugin to count correctly - -#### `getReference(moduleGraph)` - -> Stability: 0 - Deprecated - -* `moduleGraph` {ModuleGraph} -* Returns: {never} - -Returns the referenced module and export - -#### `getReferencedExports(moduleGraph, runtime)` - -* `moduleGraph` {ModuleGraph} -* `runtime` {RuntimeSpec} -* Returns: {string[]|ReferencedExport[]} - -Returns list of exports referenced by this dependency - -#### `getResourceIdentifier()` - -* Returns: {string} - -#### `getWarnings(moduleGraph)` - -* `moduleGraph` {ModuleGraph} -* Returns: {WebpackError[]} - -Returns warnings - -#### `serialize(__namedParameters)` - -* `__namedParameters` {ObjectSerializerContext} -* Returns: {void} - -#### `setLoc(startLine, startColumn, endLine, endColumn)` - -* `startLine` {number} -* `startColumn` {number} -* `endLine` {number} -* `endColumn` {number} -* Returns: {void} - -#### `updateHash(hash, context)` - -* `hash` {Hash} -* `context` {UpdateHashContextDependency} -* Returns: {void} - -Update the hash - -#### Static method: `isLowPriorityDependency(dependency)` - -* `dependency` {Dependency} -* Returns: {boolean} - -*** - -## Class: `DllPlugin` - -### Constructors - -#### `new DllPlugin(options)` - -* `options` {DllPluginOptions} -* Returns: {DllPlugin} - -### Properties - -* `options` {DllPluginOptions} - -### Methods - -#### `apply(compiler)` - -* `compiler` {Compiler} -* Returns: {void} - -Apply the plugin - -*** - -## Class: `DllReferencePlugin` - -### Constructors - -#### `new DllReferencePlugin(options)` - -* `options` {DllReferencePluginOptions} -* Returns: {DllReferencePlugin} - -### Properties - -* `options` {DllReferencePluginOptions} - -### Methods - -#### `apply(compiler)` - -* `compiler` {Compiler} -* Returns: {void} - -Apply the plugin - -*** - -## Class: `DotenvPlugin` - -### Constructors - -#### `new DotenvPlugin([options])` - -* `options` {DotenvPluginOptions} -* Returns: {DotenvPlugin} - -### Properties - -* `options` {DotenvPluginOptions} - -### Methods - -#### `apply(compiler)` - -* `compiler` {Compiler} -* Returns: {void} - -*** - -## Class: `DynamicEntryPlugin` - -### Constructors - -#### `new DynamicEntryPlugin(context, entry)` - -* `context` {string} -* `entry` {object} -* Returns: {DynamicEntryPlugin} - -### Properties - -* `context` {string} -* `entry` {object} - -### Methods - -#### `apply(compiler)` - -* `compiler` {Compiler} -* Returns: {void} - -Apply the plugin - -*** - -## Class: `EntryOptionPlugin` - -### Constructors - -#### `new EntryOptionPlugin()` - -* Returns: {EntryOptionPlugin} - -### Methods - -#### `apply(compiler)` - -* `compiler` {Compiler} -* Returns: {void} - -#### Static method: `applyEntryOption(compiler, context, entry)` - -* `compiler` {Compiler} -* `context` {string} -* `entry` {EntryNormalized} -* Returns: {void} - -#### Static method: `entryDescriptionToOptions(compiler, name, desc)` - -* `compiler` {Compiler} -* `name` {string} -* `desc` {EntryDescriptionNormalized} -* Returns: {EntryOptions} - -*** - -## Class: `EntryPlugin` - -### Constructors - -#### `new EntryPlugin(context, entry[, options])` - -* `context` {string} -* `entry` {string} -* `options` {string|EntryOptions} -* Returns: {EntryPlugin} - -An entry plugin which will handle creation of the EntryDependency - -### Properties - -* `context` {string} -* `entry` {string} -* `options` {string|EntryOptions} - -### Methods - -#### `apply(compiler)` - -* `compiler` {Compiler} -* Returns: {void} - -Apply the plugin - -#### Static method: `createDependency(entry, options)` - -* `entry` {string} -* `options` {string|EntryOptions} -* Returns: {EntryDependency} - -*** - -## Class: `Entrypoint` - -### Extends - -- {ChunkGroup} - -### Constructors - -#### `new Entrypoint()` - -* Returns: {Entrypoint} - -### Properties - -* `asyncEntrypointsIterable` {SortableSet} -* `blocksIterable` {Iterable} -* `childrenIterable` {SortableSet} -* `chunks` {Chunk[]} -* `debugId` {string} get a uniqueId for ChunkGroup, made up of its member Chunk debugId's -* `getModuleIndex` {object} -* `getModuleIndex2` {object} -* `groupDebugId` {number} -* `id` {string} get a unique id for ChunkGroup, made up of its member Chunk id's -* `index` {number} -* `name` {string} returns the name of current ChunkGroup -sets a new name for current ChunkGroup -* `options` {ChunkGroupOptions} -* `origins` {OriginRecord[]} -* `parentsIterable` {SortableSet} - -### Methods - -#### `addAsyncEntrypoint(entrypoint)` - -* `entrypoint` {Entrypoint} -* Returns: {boolean} - -#### `addBlock(block)` - -* `block` {AsyncDependenciesBlock} -* Returns: {boolean} - -#### `addChild(group)` - -* `group` {ChunkGroup} -* Returns: {boolean} - -#### `addDependOn(entrypoint)` - -* `entrypoint` {Entrypoint} -* Returns: {void} - -#### `addOptions(options)` - -* `options` {ChunkGroupOptions} -* Returns: {void} - -when a new chunk is added to a chunkGroup, addingOptions will occur. - -#### `addOrigin(module, loc, request)` - -* `module` {Module} -* `loc` {DependencyLocation} -* `request` {string} -* Returns: {void} - -#### `addParent(parentChunk)` - -* `parentChunk` {ChunkGroup} -* Returns: {boolean} - -#### `checkConstraints()` - -* Returns: {void} - -#### `compareTo(chunkGraph, otherGroup)` - -* `chunkGraph` {ChunkGraph} -* `otherGroup` {ChunkGroup} -* Returns: {-1|0|1} - -Sorting predicate which allows current ChunkGroup to be compared against another. -Sorting values are based off of number of chunks in ChunkGroup. - -#### `dependOn(entrypoint)` - -* `entrypoint` {Entrypoint} -* Returns: {boolean} - -#### `getBlocks()` - -* Returns: {AsyncDependenciesBlock[]} - -#### `getChildren()` - -* Returns: {ChunkGroup[]} - -#### `getChildrenByOrders(moduleGraph, chunkGraph)` - -* `moduleGraph` {ModuleGraph} -* `chunkGraph` {ChunkGraph} -* Returns: {Record} - -#### `getEntrypointChunk()` - -* Returns: {Chunk} - -Returns the chunk which contains the entrypoint modules -(or at least the execution of them) - -#### `getFiles()` - -* Returns: {string[]} - -#### `getModulePostOrderIndex(module)` - -* `module` {Module} -* Returns: {number} - -Gets the bottom-up index of a module in this ChunkGroup - -#### `getModulePreOrderIndex(module)` - -* `module` {Module} -* Returns: {number} - -Gets the top-down index of a module in this ChunkGroup - -#### `getNumberOfBlocks()` - -* Returns: {number} - -#### `getNumberOfChildren()` - -* Returns: {number} - -#### `getNumberOfParents()` - -* Returns: {number} - -#### `getParents()` - -* Returns: {ChunkGroup[]} - -#### `getRuntimeChunk()` - -* Returns: {Chunk} - -Fetches the chunk reference containing the webpack bootstrap code - -#### `hasBlock(block)` - -* `block` {AsyncDependenciesBlock} -* Returns: {boolean} - -#### `hasParent(parent)` - -* `parent` {ChunkGroup} -* Returns: {boolean} - -#### `insertChunk(chunk, before)` - -* `chunk` {Chunk} -* `before` {Chunk} -* Returns: {boolean} - -inserts a chunk before another existing chunk in group - -#### `isInitial()` - -* Returns: {boolean} - -#### `pushChunk(chunk)` - -* `chunk` {Chunk} -* Returns: {boolean} - -add a chunk into ChunkGroup. Is pushed on or prepended - -#### `remove()` - -* Returns: {void} - -#### `removeChild(group)` - -* `group` {ChunkGroup} -* Returns: {boolean} - -#### `removeChunk(chunk)` - -* `chunk` {Chunk} -* Returns: {boolean} - -#### `removeParent(chunkGroup)` - -* `chunkGroup` {ChunkGroup} -* Returns: {boolean} - -#### `replaceChunk(oldChunk, newChunk)` - -* `oldChunk` {Chunk} -* `newChunk` {Chunk} -* Returns: {boolean} - -#### `setEntrypointChunk(chunk)` - -* `chunk` {Chunk} -* Returns: {void} - -Sets the chunk with the entrypoint modules for an entrypoint. - -#### `setModulePostOrderIndex(module, index)` - -* `module` {Module} -* `index` {number} -* Returns: {void} - -Sets the bottom-up index of a module in this ChunkGroup - -#### `setModulePreOrderIndex(module, index)` - -* `module` {Module} -* `index` {number} -* Returns: {void} - -Sets the top-down index of a module in this ChunkGroup - -#### `setRuntimeChunk(chunk)` - -* `chunk` {Chunk} -* Returns: {void} - -Sets the runtimeChunk for an entrypoint. - -#### `sortItems()` - -* Returns: {void} - -#### `unshiftChunk(chunk)` - -* `chunk` {Chunk} -* Returns: {boolean} - -Performs an unshift of a specific chunk - -*** - -## Class: `EnvironmentPlugin` - -### Constructors - -#### `new EnvironmentPlugin(keys)` - -* `keys` {string|string[]|Record[]} -* Returns: {EnvironmentPlugin} - -### Properties - -* `defaultValues` {Record} -* `keys` {string[]} - -### Methods - -#### `apply(compiler)` - -* `compiler` {Compiler} -* Returns: {void} - -Apply the plugin - -*** - -## Class: `EvalDevToolModulePlugin` - -### Constructors - -#### `new EvalDevToolModulePlugin([options])` - -* `options` {EvalDevToolModulePluginOptions} -* Returns: {EvalDevToolModulePlugin} - -### Properties - -* `moduleFilenameTemplate` {DevtoolModuleFilenameTemplate} -* `namespace` {string} -* `sourceUrlComment` {string} - -### Methods - -#### `apply(compiler)` - -* `compiler` {Compiler} -* Returns: {void} - -Apply the plugin - -*** - -## Class: `EvalSourceMapDevToolPlugin` - -### Constructors - -#### `new EvalSourceMapDevToolPlugin([inputOptions])` - -* `inputOptions` {string|SourceMapDevToolPluginOptions} -* Returns: {EvalSourceMapDevToolPlugin} - -### Properties - -* `moduleFilenameTemplate` {DevtoolModuleFilenameTemplate} -* `namespace` {string} -* `options` {SourceMapDevToolPluginOptions} -* `sourceMapComment` {string} - -### Methods - -#### `apply(compiler)` - -* `compiler` {Compiler} -* Returns: {void} - -Apply the plugin - -*** - -## Class: `ExternalModule` - -### Extends - -- {Module} - -### Constructors - -#### `new ExternalModule(request, type, userRequest[, dependencyMeta])` - -* `request` {ExternalModuleRequest} -* `type` {ExternalsType} -* `userRequest` {string} -* `dependencyMeta` {ImportDependencyMeta|CssImportDependencyMeta|AssetDependencyMeta} -* Returns: {ExternalModule} - -### Properties - -* `blocks` {AsyncDependenciesBlock[]} -* `buildInfo` {BuildInfo} -* `buildMeta` {BuildMeta} -* `chunksIterable` {Iterable} -* `codeGenerationDependencies` {Dependency[]} -* `context` {string} -* `debugId` {number} -* `dependencies` {Dependency[]} -* `dependencyMeta` {ImportDependencyMeta|CssImportDependencyMeta|AssetDependencyMeta} -* `depth` {number} -* `errors` {any} -* `exportsArgument` {string} -* `externalType` {ExternalsType} -* `factoryMeta` {FactoryMeta} -* `hasEqualsChunks` {any} -* `hash` {string} -* `hot` {boolean} -* `id` {string|number} -* `index` {number} -* `index2` {number} -* `issuer` {Module} -* `isUsed` {any} -* `layer` {string} -* `moduleArgument` {string} -* `needId` {boolean} -* `optimizationBailout` {string|object[]} -* `optional` {boolean} -* `parent` {DependenciesBlock} -* `presentationalDependencies` {Dependency[]} -* `profile` {ModuleProfile} -* `renderedHash` {string} -* `request` {ExternalModuleRequest} -* `resolveOptions` {ResolveOptions} -* `type` {string} -* `used` {any} -* `usedExports` {boolean|SortableSet} -* `userRequest` {string} -* `useSimpleSourceMap` {boolean} -* `useSourceMap` {boolean} -* `warnings` {any} -* `getExternalModuleNodeCommonjsInitFragment` {object} -* `ModuleExternalInitFragment` {ModuleExternalInitFragment} - -### Methods - -#### `addBlock(block)` - -* `block` {AsyncDependenciesBlock} -* Returns: {void} - -Adds a DependencyBlock to DependencyBlock relationship. -This is used for when a Module has a AsyncDependencyBlock tie (for code-splitting) - -#### `addCacheDependencies(fileDependencies, contextDependencies, missingDependencies, buildDependencies)` - -* `fileDependencies` {LazySet} -* `contextDependencies` {LazySet} -* `missingDependencies` {LazySet} -* `buildDependencies` {LazySet} -* Returns: {void} - -#### `addChunk(chunk)` - -* `chunk` {Chunk} -* Returns: {boolean} - -#### `addCodeGenerationDependency(codeGenerationDependency)` - -* `codeGenerationDependency` {Dependency} -* Returns: {void} - -#### `addDependency(dependency)` - -* `dependency` {Dependency} -* Returns: {void} - -#### `addError(error)` - -* `error` {WebpackError} -* Returns: {void} - -#### `addPresentationalDependency(presentationalDependency)` - -* `presentationalDependency` {Dependency} -* Returns: {void} - -#### `addWarning(warning)` - -* `warning` {WebpackError} -* Returns: {void} - -#### `build(options, compilation, resolver, fs, callback)` - -* `options` {WebpackOptionsNormalizedWithDefaults} -* `compilation` {Compilation} -* `resolver` {ResolverWithOptions} -* `fs` {InputFileSystem} -* `callback` {object} -* Returns: {void} - -#### `chunkCondition(chunk, compilation)` - -* `chunk` {Chunk} -* `compilation` {Compilation} -* Returns: {boolean} - -#### `cleanupForCache()` - -* Returns: {void} - -Assuming this module is in the cache. Remove internal references to allow freeing some memory. - -#### `clearDependenciesAndBlocks()` - -* Returns: {void} - -Removes all dependencies and blocks - -#### `clearWarningsAndErrors()` - -* Returns: {void} - -removes all warnings and errors - -#### `codeGeneration(context)` - -* `context` {CodeGenerationContext} -* Returns: {CodeGenerationResult} - -#### `deserialize(__namedParameters)` - -* `__namedParameters` {ObjectDeserializerContext} -* Returns: {void} - -#### `getChunks()` - -* Returns: {Chunk[]} - -#### `getConcatenationBailoutReason(context)` - -* `context` {ConcatenationBailoutReasonContext} -* Returns: {string} - -#### `getErrors()` - -* Returns: {Iterable} - -#### `getExportsType(moduleGraph[, strict])` - -* `moduleGraph` {ModuleGraph} -* `strict` {boolean} -* Returns: {ExportsType} - -#### `getNumberOfChunks()` - -* Returns: {number} - -#### `getNumberOfErrors()` - -* Returns: {number} - -#### `getNumberOfWarnings()` - -* Returns: {number} - -#### `getRootBlock()` - -* Returns: {DependenciesBlock} - -#### `getSideEffectsConnectionState(moduleGraph)` - -* `moduleGraph` {ModuleGraph} -* Returns: {ConnectionState} - -#### `getSourceBasicTypes()` - -* Returns: {ReadonlySet} - -Basic source types are high-level categories like javascript, css, webassembly, etc. -We only have built-in knowledge about the javascript basic type here; other basic types may be -added or changed over time by generators and do not need to be handled or detected here. -Some modules, e.g. RemoteModule, may return non-basic source types like "remote" and "share-init" -from getSourceTypes(), but their generated output is still JavaScript, i.e. their basic type is JS. - -#### `getSourceTypes()` - -* Returns: {ReadonlySet} - -#### `getUnsafeCacheData()` - -* Returns: {UnsafeCacheData} - -Module should be unsafe cached. Get data that's needed for that. -This data will be passed to restoreFromUnsafeCache later. - -#### `getWarnings()` - -* Returns: {Iterable} - -#### `hasChunkCondition()` - -* Returns: {boolean} - -#### `hasReasonForChunk(chunk, moduleGraph, chunkGraph)` - -* `chunk` {Chunk} -* `moduleGraph` {ModuleGraph} -* `chunkGraph` {ChunkGraph} -* Returns: {boolean} - -#### `hasReasons(moduleGraph, runtime)` - -* `moduleGraph` {ModuleGraph} -* `runtime` {RuntimeSpec} -* Returns: {boolean} - -#### `identifier()` - -* Returns: {string} - -#### `invalidateBuild()` - -* Returns: {void} - -#### `isAccessibleInChunk(chunkGraph, chunk[, ignoreChunk])` - -* `chunkGraph` {ChunkGraph} -* `chunk` {Chunk} -* `ignoreChunk` {Chunk} -* Returns: {boolean} - -#### `isAccessibleInChunkGroup(chunkGraph, chunkGroup[, ignoreChunk])` - -* `chunkGraph` {ChunkGraph} -* `chunkGroup` {ChunkGroup} -* `ignoreChunk` {Chunk} -* Returns: {boolean} - -#### `isEntryModule()` - -* Returns: {boolean} - -#### `isInChunk(chunk)` - -* `chunk` {Chunk} -* Returns: {boolean} - -#### `isOptional(moduleGraph)` - -* `moduleGraph` {ModuleGraph} -* Returns: {boolean} - -#### `isProvided(exportName)` - -* `exportName` {string} -* Returns: {boolean} - -#### `libIdent(options)` - -* `options` {LibIdentOptions} -* Returns: {string} - -#### `nameForCondition()` - -* Returns: {string} - -#### `needBuild(context, callback)` - -* `context` {NeedBuildContext} -* `callback` {object} -* Returns: {void} - -#### `needRebuild(fileTimestamps, contextTimestamps)` - -> Stability: 0 - Deprecated - -* `fileTimestamps` {Map} -* `contextTimestamps` {Map} -* Returns: {boolean} - -Use needBuild instead - -#### `originalSource()` - -* Returns: {Source} - -#### `readableIdentifier(requestShortener)` - -* `requestShortener` {RequestShortener} -* Returns: {string} - -#### `removeChunk(chunk)` - -* `chunk` {Chunk} -* Returns: {void} - -#### `removeDependency(dependency)` - -* `dependency` {Dependency} -* Returns: {void} - -#### `restoreFromUnsafeCache(unsafeCacheData, normalModuleFactory)` - -* `unsafeCacheData` {UnsafeCacheData} -* `normalModuleFactory` {NormalModuleFactory} -* Returns: {void} - -restore unsafe cache data - -#### `serialize(__namedParameters)` - -* `__namedParameters` {ObjectSerializerContext} -* Returns: {void} - -#### `size([type])` - -* `type` {string} -* Returns: {number} - -#### `source(dependencyTemplates, runtimeTemplate[, type])` - -> Stability: 0 - Deprecated - -* `dependencyTemplates` {DependencyTemplates} -* `runtimeTemplate` {RuntimeTemplate} -* `type` {string} -* Returns: {Source} - -Use codeGeneration() instead - -#### `updateCacheModule(module)` - -* `module` {Module} -* Returns: {void} - -Assuming this module is in the cache. Update the (cached) module with -the fresh module from the factory. Usually updates internal references -and properties. - -#### `updateHash(hash, context)` - -* `hash` {Hash} -* `context` {UpdateHashContextDependency} -* Returns: {void} - -#### Static method: `getCompilationHooks(compilation)` - -* `compilation` {Compilation} -* Returns: {ExternalModuleHooks} - -#### Static method: `getSourceBasicTypes(module)` - -> Stability: 0 - Deprecated - -* `module` {Module} -* Returns: {ReadonlySet} - -In webpack 6, call getSourceBasicTypes() directly on the module instance instead of using this static method. - -*** - -## Class: `ExternalsPlugin` - -### Constructors - -#### `new ExternalsPlugin(type, externals)` - -* `type` {"asset"|"module"|"css-import"|"css-url"|"global"|"import"|"commonjs"|"jsonp"|"promise"|"this"|"var"|"assign"|"window"|"self"|"commonjs2"|"commonjs-module"|"commonjs-static"|"amd"|"amd-require"|"umd"|"umd2"|"system"|"module-import"|"script"|"node-commonjs"|object} -* `externals` {Externals} -* Returns: {ExternalsPlugin} - -### Properties - -* `externals` {Externals} -* `type` {"asset"|"module"|"css-import"|"css-url"|"global"|"import"|"commonjs"|"jsonp"|"promise"|"this"|"var"|"assign"|"window"|"self"|"commonjs2"|"commonjs-module"|"commonjs-static"|"amd"|"amd-require"|"umd"|"umd2"|"system"|"module-import"|"script"|"node-commonjs"|object} - -### Methods - -#### `apply(compiler)` - -* `compiler` {Compiler} -* Returns: {void} - -Apply the plugin - -*** - -## Class: `Generator` - -### Constructors - -#### `new Generator()` - -* Returns: {Generator} - -### Methods - -#### `generate(module, __namedParameters)` - -* `module` {NormalModule} -* `__namedParameters` {GenerateContext} -* Returns: {Source} - -#### `getConcatenationBailoutReason(module, context)` - -* `module` {NormalModule} -* `context` {ConcatenationBailoutReasonContext} -* Returns: {string} - -#### `getSize(module[, type])` - -* `module` {NormalModule} -* `type` {string} -* Returns: {number} - -#### `getTypes(module)` - -* `module` {NormalModule} -* Returns: {ReadonlySet} - -#### `updateHash(hash, __namedParameters)` - -* `hash` {Hash} -* `__namedParameters` {UpdateHashContextGenerator} -* Returns: {void} - -#### Static method: `byType(map)` - -* `map` {object} -* Returns: {ByTypeGenerator} - -*** - -## Class: `HotModuleReplacementPlugin` - -### Constructors - -#### `new HotModuleReplacementPlugin()` - -* Returns: {HotModuleReplacementPlugin} - -### Methods - -#### `apply(compiler)` - -* `compiler` {Compiler} -* Returns: {void} - -Apply the plugin - -#### Static method: `getParserHooks(parser)` - -* `parser` {JavascriptParser} -* Returns: {HMRJavascriptParserHooks} - -*** - -## Class: `HotUpdateChunk` - -### Extends - -- {Chunk} - -### Constructors - -#### `new HotUpdateChunk()` - -* Returns: {HotUpdateChunk} - -### Properties - -* `auxiliaryFiles` {Set} -* `chunkReason` {string} -* `contentHash` {Record} -* `cssFilenameTemplate` {string|object} -* `debugId` {number} -* `entryModule` {Module} -* `extraAsync` {boolean} -* `filenameTemplate` {string|object} -* `files` {Set} -* `groupsIterable` {SortableSet} -* `hash` {string} -* `id` {string|number} -* `idNameHints` {SortableSet} -* `ids` {ChunkId[]} -* `modulesIterable` {Iterable} -* `name` {string} -* `preventIntegration` {boolean} -* `rendered` {boolean} -* `renderedHash` {string} -* `runtime` {RuntimeSpec} - -### Methods - -#### `addGroup(chunkGroup)` - -* `chunkGroup` {ChunkGroup} -* Returns: {void} - -#### `addModule(module)` - -* `module` {Module} -* Returns: {boolean} - -#### `canBeInitial()` - -* Returns: {boolean} - -#### `canBeIntegrated(otherChunk)` - -* `otherChunk` {Chunk} -* Returns: {boolean} - -#### `compareTo(otherChunk)` - -* `otherChunk` {Chunk} -* Returns: {-1|0|1} - -#### `containsModule(module)` - -* `module` {Module} -* Returns: {boolean} - -#### `disconnectFromGroups()` - -* Returns: {void} - -#### `getAllAsyncChunks()` - -* Returns: {Set} - -#### `getAllInitialChunks()` - -* Returns: {Set} - -#### `getAllReferencedAsyncEntrypoints()` - -* Returns: {Set} - -#### `getAllReferencedChunks()` - -* Returns: {Set} - -#### `getChildIdsByOrders(chunkGraph[, filterFn])` - -* `chunkGraph` {ChunkGraph} -* `filterFn` {object} -* Returns: {Record} - -#### `getChildIdsByOrdersMap(chunkGraph[, includeDirectChildren][, filterFn])` - -* `chunkGraph` {ChunkGraph} -* `includeDirectChildren` {boolean} -* `filterFn` {object} -* Returns: {ChunkChildIdsByOrdersMapByData} - -#### `getChildrenOfTypeInOrder(chunkGraph, type)` - -* `chunkGraph` {ChunkGraph} -* `type` {string} -* Returns: {ChunkChildOfTypeInOrder[]} - -#### `getChunkMaps(realHash)` - -> Stability: 0 - Deprecated - -* `realHash` {boolean} -* Returns: {ChunkMaps} - -#### `getChunkModuleMaps(filterFn)` - -* `filterFn` {object} -* Returns: {ChunkModuleMaps} - -#### `getEntryOptions()` - -* Returns: {EntryOptions} - -#### `getModules()` - -* Returns: {Module[]} - -#### `getNumberOfGroups()` - -* Returns: {number} - -#### `getNumberOfModules()` - -* Returns: {number} - -#### `hasAsyncChunks()` - -* Returns: {boolean} - -#### `hasChildByOrder(chunkGraph, type[, includeDirectChildren][, filterFn])` - -* `chunkGraph` {ChunkGraph} -* `type` {string} -* `includeDirectChildren` {boolean} -* `filterFn` {object} -* Returns: {boolean} - -#### `hasEntryModule()` - -* Returns: {boolean} - -#### `hasModuleInGraph(filterFn[, filterChunkFn])` - -* `filterFn` {object} -* `filterChunkFn` {object} -* Returns: {boolean} - -#### `hasRuntime()` - -* Returns: {boolean} - -#### `integrate(otherChunk)` - -* `otherChunk` {Chunk} -* Returns: {boolean} - -#### `integratedSize(otherChunk, options)` - -* `otherChunk` {Chunk} -* `options` {ChunkSizeOptions} -* Returns: {number} - -#### `isEmpty()` - -* Returns: {boolean} - -#### `isInGroup(chunkGroup)` - -* `chunkGroup` {ChunkGroup} -* Returns: {boolean} - -#### `isOnlyInitial()` - -* Returns: {boolean} - -#### `modulesSize()` - -* Returns: {number} - -#### `moveModule(module, otherChunk)` - -* `module` {Module} -* `otherChunk` {Chunk} -* Returns: {void} - -#### `remove()` - -* Returns: {void} - -#### `removeGroup(chunkGroup)` - -* `chunkGroup` {ChunkGroup} -* Returns: {void} - -#### `removeModule(module)` - -* `module` {Module} -* Returns: {void} - -#### `size([options])` - -* `options` {ChunkSizeOptions} -* Returns: {number} - -#### `split(newChunk)` - -* `newChunk` {Chunk} -* Returns: {void} - -#### `updateHash(hash, chunkGraph)` - -* `hash` {Hash} -* `chunkGraph` {ChunkGraph} -* Returns: {void} - -*** - -## Class: `IgnorePlugin` - -### Constructors - -#### `new IgnorePlugin(options)` - -* `options` {IgnorePluginOptions} -* Returns: {IgnorePlugin} - -### Properties - -* `options` {IgnorePluginOptions} - -### Methods - -#### `apply(compiler)` - -* `compiler` {Compiler} -* Returns: {void} - -Apply the plugin - -#### `checkIgnore(resolveData)` - -* `resolveData` {BeforeContextResolveData|ResolveData} -* Returns: {false} - -Note that if "contextRegExp" is given, both the "resourceRegExp" and "contextRegExp" have to match. - -*** - -## Class: `InitFragment` - -### Type Parameters - -#### GenerateContext - -`GenerateContext` - -### Constructors - -#### `new InitFragment(content, stage, position[, key][, endContent])` - -###### GenerateContext - -`GenerateContext` -* `content` {string|Source} -* `stage` {number} -* `position` {number} -* `key` {string} -* `endContent` {string|Source} -* Returns: {InitFragment} - -### Properties - -* `content` {string|Source} -* `endContent` {string|Source} -* `key` {string} -* `position` {number} -* `stage` {number} -* `STAGE_ASYNC_BOUNDARY` {number} -* `STAGE_ASYNC_DEPENDENCIES` {number} -* `STAGE_ASYNC_HARMONY_IMPORTS` {number} -* `STAGE_CONSTANTS` {number} -* `STAGE_HARMONY_EXPORTS` {number} -* `STAGE_HARMONY_IMPORTS` {number} -* `STAGE_PROVIDES` {number} - -### Methods - -#### `deserialize(context)` - -* `context` {ObjectDeserializerContext} -* Returns: {void} - -#### `getContent(context)` - -* `context` {GenerateContext} -* Returns: {string|Source} - -#### `getEndContent(context)` - -* `context` {GenerateContext} -* Returns: {string|Source} - -#### `serialize(context)` - -* `context` {ObjectSerializerContext} -* Returns: {void} - -#### Static method: `addToSource(source, initFragments, context)` - -###### Context - -`Context` -* `source` {Source} -* `initFragments` {MaybeMergeableInitFragment[]} -* `context` {Context} -* Returns: {Source} - -*** - -## Class: `JavascriptModulesPlugin` - -### Constructors - -#### `new JavascriptModulesPlugin([options])` - -* `options` {object} -* Returns: {JavascriptModulesPlugin} - -### Properties - -* `options` {object} -* `chunkHasJs` {object} - -### Methods - -#### `apply(compiler)` - -* `compiler` {Compiler} -* Returns: {void} - -Apply the plugin - -#### `renderBootstrap(renderContext, hooks)` - -* `renderContext` {RenderBootstrapContext} -* `hooks` {CompilationHooksJavascriptModulesPlugin} -* Returns: {Bootstrap} - -#### `renderChunk(renderContext, hooks)` - -* `renderContext` {RenderContextJavascriptModulesPlugin} -* `hooks` {CompilationHooksJavascriptModulesPlugin} -* Returns: {Source} - -#### `renderMain(renderContext, hooks, compilation)` - -* `renderContext` {MainRenderContext} -* `hooks` {CompilationHooksJavascriptModulesPlugin} -* `compilation` {Compilation} -* Returns: {Source} - -#### `renderModule(module, renderContext, hooks)` - -* `module` {Module} -* `renderContext` {ModuleRenderContext} -* `hooks` {CompilationHooksJavascriptModulesPlugin} -* Returns: {Source} - -#### `renderRequire(renderContext, hooks)` - -* `renderContext` {RenderBootstrapContext} -* `hooks` {CompilationHooksJavascriptModulesPlugin} -* Returns: {string} - -#### `updateHashWithBootstrap(hash, renderContext, hooks)` - -* `hash` {Hash} -* `renderContext` {RenderBootstrapContext} -* `hooks` {CompilationHooksJavascriptModulesPlugin} -* Returns: {void} - -#### Static method: `getChunkFilenameTemplate(chunk, outputOptions)` - -* `chunk` {Chunk} -* `outputOptions` {OutputNormalizedWithDefaults} -* Returns: {TemplatePath} - -#### Static method: `getCompilationHooks(compilation)` - -* `compilation` {Compilation} -* Returns: {CompilationHooksJavascriptModulesPlugin} - -*** - -## Class: `LibManifestPlugin` - -### Constructors - -#### `new LibManifestPlugin(options)` - -* `options` {LibManifestPluginOptions} -* Returns: {LibManifestPlugin} - -### Properties - -* `options` {LibManifestPluginOptions} - -### Methods - -#### `apply(compiler)` - -* `compiler` {Compiler} -* Returns: {void} - -Apply the plugin - -*** - -## Class: `LibraryTemplatePlugin` - -### Constructors - -#### `new LibraryTemplatePlugin(name, target, umdNamedDefine, auxiliaryComment, exportProperty)` - -* `name` {LibraryName} -* `target` {string} -* `umdNamedDefine` {boolean} -* `auxiliaryComment` {AuxiliaryComment} -* `exportProperty` {LibraryExport} -* Returns: {LibraryTemplatePlugin} - -### Properties - -* `library` {object} - -### Methods - -#### `apply(compiler)` - -* `compiler` {Compiler} -* Returns: {void} - -Apply the plugin - -*** - -## Class: `LoaderOptionsPlugin` - -### Constructors - -#### `new LoaderOptionsPlugin([options])` - -* `options` {LoaderOptionsPluginOptions|MatchObject} -* Returns: {LoaderOptionsPlugin} - -### Properties - -* `options` {LoaderOptionsPluginOptions|MatchObject} - -### Methods - -#### `apply(compiler)` - -* `compiler` {Compiler} -* Returns: {void} - -Apply the plugin - -*** - -## Class: `LoaderTargetPlugin` - -### Constructors - -#### `new LoaderTargetPlugin(target)` - -* `target` {string} -* Returns: {LoaderTargetPlugin} - -### Properties - -* `target` {string} - -### Methods - -#### `apply(compiler)` - -* `compiler` {Compiler} -* Returns: {void} - -Apply the plugin - -*** - -## Class: `ManifestPlugin` - -### Constructors - -#### `new ManifestPlugin([options])` - -* `options` {ManifestPluginOptions} -* Returns: {ManifestPlugin} - -### Properties - -* `options` {ManifestPluginOptions} - -### Methods - -#### `apply(compiler)` - -* `compiler` {Compiler} -* Returns: {void} - -Apply the plugin - -*** - -## Class: `Module` - -### Extends - -- {DependenciesBlock} - -### Extended by - -- {ExternalModule} -- {NormalModule} -- {RuntimeModule} - -### Constructors - -#### `new Module(type[, context][, layer])` - -* `type` {string} -* `context` {string} -* `layer` {string} -* Returns: {Module} - -### Properties - -* `blocks` {AsyncDependenciesBlock[]} -* `buildInfo` {BuildInfo} -* `buildMeta` {BuildMeta} -* `chunksIterable` {Iterable} -* `codeGenerationDependencies` {Dependency[]} -* `context` {string} -* `debugId` {number} -* `dependencies` {Dependency[]} -* `depth` {number} -* `errors` {any} -* `exportsArgument` {string} -* `factoryMeta` {FactoryMeta} -* `hasEqualsChunks` {any} -* `hash` {string} -* `hot` {boolean} -* `id` {string|number} -* `index` {number} -* `index2` {number} -* `issuer` {Module} -* `isUsed` {any} -* `layer` {string} -* `moduleArgument` {string} -* `needId` {boolean} -* `optimizationBailout` {string|object[]} -* `optional` {boolean} -* `parent` {DependenciesBlock} -* `presentationalDependencies` {Dependency[]} -* `profile` {ModuleProfile} -* `renderedHash` {string} -* `resolveOptions` {ResolveOptions} -* `type` {string} -* `used` {any} -* `usedExports` {boolean|SortableSet} -* `useSimpleSourceMap` {boolean} -* `useSourceMap` {boolean} -* `warnings` {any} - -### Methods - -#### `addBlock(block)` - -* `block` {AsyncDependenciesBlock} -* Returns: {void} - -Adds a DependencyBlock to DependencyBlock relationship. -This is used for when a Module has a AsyncDependencyBlock tie (for code-splitting) - -#### `addCacheDependencies(fileDependencies, contextDependencies, missingDependencies, buildDependencies)` - -* `fileDependencies` {LazySet} -* `contextDependencies` {LazySet} -* `missingDependencies` {LazySet} -* `buildDependencies` {LazySet} -* Returns: {void} - -#### `addChunk(chunk)` - -* `chunk` {Chunk} -* Returns: {boolean} - -#### `addCodeGenerationDependency(codeGenerationDependency)` - -* `codeGenerationDependency` {Dependency} -* Returns: {void} - -#### `addDependency(dependency)` - -* `dependency` {Dependency} -* Returns: {void} - -#### `addError(error)` - -* `error` {WebpackError} -* Returns: {void} - -#### `addPresentationalDependency(presentationalDependency)` - -* `presentationalDependency` {Dependency} -* Returns: {void} - -#### `addWarning(warning)` - -* `warning` {WebpackError} -* Returns: {void} - -#### `build(options, compilation, resolver, fs, callback)` - -* `options` {WebpackOptionsNormalizedWithDefaults} -* `compilation` {Compilation} -* `resolver` {ResolverWithOptions} -* `fs` {InputFileSystem} -* `callback` {object} -* Returns: {void} - -#### `chunkCondition(chunk, compilation)` - -* `chunk` {Chunk} -* `compilation` {Compilation} -* Returns: {boolean} - -#### `cleanupForCache()` - -* Returns: {void} - -Assuming this module is in the cache. Remove internal references to allow freeing some memory. - -#### `clearDependenciesAndBlocks()` - -* Returns: {void} - -Removes all dependencies and blocks - -#### `clearWarningsAndErrors()` - -* Returns: {void} - -removes all warnings and errors - -#### `codeGeneration(context)` - -* `context` {CodeGenerationContext} -* Returns: {CodeGenerationResult} - -#### `deserialize(__namedParameters)` - -* `__namedParameters` {ObjectDeserializerContext} -* Returns: {void} - -#### `getChunks()` - -* Returns: {Chunk[]} - -#### `getConcatenationBailoutReason(context)` - -* `context` {ConcatenationBailoutReasonContext} -* Returns: {string} - -#### `getErrors()` - -* Returns: {Iterable} - -#### `getExportsType(moduleGraph[, strict])` - -* `moduleGraph` {ModuleGraph} -* `strict` {boolean} -* Returns: {ExportsType} - -#### `getNumberOfChunks()` - -* Returns: {number} - -#### `getNumberOfErrors()` - -* Returns: {number} - -#### `getNumberOfWarnings()` - -* Returns: {number} - -#### `getRootBlock()` - -* Returns: {DependenciesBlock} - -#### `getSideEffectsConnectionState(moduleGraph)` - -* `moduleGraph` {ModuleGraph} -* Returns: {ConnectionState} - -#### `getSourceBasicTypes()` - -* Returns: {ReadonlySet} - -Basic source types are high-level categories like javascript, css, webassembly, etc. -We only have built-in knowledge about the javascript basic type here; other basic types may be -added or changed over time by generators and do not need to be handled or detected here. -Some modules, e.g. RemoteModule, may return non-basic source types like "remote" and "share-init" -from getSourceTypes(), but their generated output is still JavaScript, i.e. their basic type is JS. - -#### `getSourceTypes()` - -* Returns: {ReadonlySet} - -#### `getUnsafeCacheData()` - -* Returns: {UnsafeCacheData} - -Module should be unsafe cached. Get data that's needed for that. -This data will be passed to restoreFromUnsafeCache later. - -#### `getWarnings()` - -* Returns: {Iterable} - -#### `hasChunkCondition()` - -* Returns: {boolean} - -#### `hasReasonForChunk(chunk, moduleGraph, chunkGraph)` - -* `chunk` {Chunk} -* `moduleGraph` {ModuleGraph} -* `chunkGraph` {ChunkGraph} -* Returns: {boolean} - -#### `hasReasons(moduleGraph, runtime)` - -* `moduleGraph` {ModuleGraph} -* `runtime` {RuntimeSpec} -* Returns: {boolean} - -#### `identifier()` - -* Returns: {string} - -#### `invalidateBuild()` - -* Returns: {void} - -#### `isAccessibleInChunk(chunkGraph, chunk[, ignoreChunk])` - -* `chunkGraph` {ChunkGraph} -* `chunk` {Chunk} -* `ignoreChunk` {Chunk} -* Returns: {boolean} - -#### `isAccessibleInChunkGroup(chunkGraph, chunkGroup[, ignoreChunk])` - -* `chunkGraph` {ChunkGraph} -* `chunkGroup` {ChunkGroup} -* `ignoreChunk` {Chunk} -* Returns: {boolean} - -#### `isEntryModule()` - -* Returns: {boolean} - -#### `isInChunk(chunk)` - -* `chunk` {Chunk} -* Returns: {boolean} - -#### `isOptional(moduleGraph)` - -* `moduleGraph` {ModuleGraph} -* Returns: {boolean} - -#### `isProvided(exportName)` - -* `exportName` {string} -* Returns: {boolean} - -#### `libIdent(options)` - -* `options` {LibIdentOptions} -* Returns: {string} - -#### `nameForCondition()` - -* Returns: {string} - -#### `needBuild(context, callback)` - -* `context` {NeedBuildContext} -* `callback` {object} -* Returns: {void} - -#### `needRebuild(fileTimestamps, contextTimestamps)` - -> Stability: 0 - Deprecated - -* `fileTimestamps` {Map} -* `contextTimestamps` {Map} -* Returns: {boolean} - -Use needBuild instead - -#### `originalSource()` - -* Returns: {Source} - -#### `readableIdentifier(requestShortener)` - -* `requestShortener` {RequestShortener} -* Returns: {string} - -#### `removeChunk(chunk)` - -* `chunk` {Chunk} -* Returns: {void} - -#### `removeDependency(dependency)` - -* `dependency` {Dependency} -* Returns: {void} - -#### `serialize(__namedParameters)` - -* `__namedParameters` {ObjectSerializerContext} -* Returns: {void} - -#### `size([type])` - -* `type` {string} -* Returns: {number} - -#### `source(dependencyTemplates, runtimeTemplate[, type])` - -> Stability: 0 - Deprecated - -* `dependencyTemplates` {DependencyTemplates} -* `runtimeTemplate` {RuntimeTemplate} -* `type` {string} -* Returns: {Source} - -Use codeGeneration() instead - -#### `updateCacheModule(module)` - -* `module` {Module} -* Returns: {void} - -Assuming this module is in the cache. Update the (cached) module with -the fresh module from the factory. Usually updates internal references -and properties. - -#### `updateHash(hash, context)` - -* `hash` {Hash} -* `context` {UpdateHashContextDependency} -* Returns: {void} - -#### Static method: `getSourceBasicTypes(module)` - -> Stability: 0 - Deprecated - -* `module` {Module} -* Returns: {ReadonlySet} - -In webpack 6, call getSourceBasicTypes() directly on the module instance instead of using this static method. - -*** - -## Class: `ModuleFactory` - -### Constructors - -#### `new ModuleFactory()` - -* Returns: {ModuleFactory} - -### Methods - -#### `create(data, callback)` - -* `data` {ModuleFactoryCreateData} -* `callback` {object} -* Returns: {void} - -*** - -## Class: `ModuleGraph` - -### Constructors - -#### `new ModuleGraph()` - -* Returns: {ModuleGraph} - -### Properties - -* `ModuleGraphConnection` {ModuleGraphConnection} - -### Methods - -#### `addExplanation(dependency, explanation)` - -* `dependency` {Dependency} -* `explanation` {string} -* Returns: {void} - -#### `addExtraReason(module, explanation)` - -* `module` {Module} -* `explanation` {string} -* Returns: {void} - -#### `cached(fn, args)` - -###### T - -`T` *extends* {any[]} - -###### R - -`R` -* `fn` {object} -* `args` {T} -* Returns: {R} - -#### `cloneModuleAttributes(sourceModule, targetModule)` - -* `sourceModule` {Module} -* `targetModule` {Module} -* Returns: {void} - -#### `copyOutgoingModuleConnections(oldModule, newModule, filterConnection)` - -* `oldModule` {Module} -* `newModule` {Module} -* `filterConnection` {object} -* Returns: {void} - -#### `dependencyCacheProvide(dependency, args)` - -###### D - -`D` *extends* {Dependency} - -###### ARGS - -`ARGS` *extends* {any[]} - -###### R - -`R` -* `dependency` {D} -* `args` {Tuple} -* Returns: {R} - -#### `finishUpdateParent()` - -* Returns: {void} - -#### `freeze([cacheStage])` - -* `cacheStage` {string} -* Returns: {void} - -#### `getConnection(dependency)` - -* `dependency` {Dependency} -* Returns: {ModuleGraphConnection} - -#### `getDepth(module)` - -* `module` {Module} -* Returns: {number} - -#### `getExportInfo(module, exportName)` - -* `module` {Module} -* `exportName` {string} -* Returns: {ExportInfo} - -#### `getExportsInfo(module)` - -* `module` {Module} -* Returns: {ExportsInfo} - -#### `getIncomingConnections(module)` - -* `module` {Module} -* Returns: {Iterable} - -#### `getIncomingConnectionsByOriginModule(module)` - -* `module` {Module} -* Returns: {ReadonlyMap} - -#### `getIssuer(module)` - -* `module` {Module} -* Returns: {Module} - -#### `getMeta(thing)` - -* `thing` {object} -* Returns: {Meta} - -#### `getMetaIfExisting(thing)` - -* `thing` {object} -* Returns: {Meta} - -#### `getModule(dependency)` - -* `dependency` {Dependency} -* Returns: {Module} - -#### `getOptimizationBailout(module)` - -* `module` {Module} -* Returns: {string|object[]} - -#### `getOrigin(dependency)` - -* `dependency` {Dependency} -* Returns: {Module} - -#### `getOutgoingConnections(module)` - -* `module` {Module} -* Returns: {Iterable} - -#### `getOutgoingConnectionsByModule(module)` - -* `module` {Module} -* Returns: {ReadonlyMap} - -#### `getParentBlock(dependency)` - -* `dependency` {Dependency} -* Returns: {DependenciesBlock} - -#### `getParentBlockIndex(dependency)` - -* `dependency` {Dependency} -* Returns: {number} - -#### `getParentModule(dependency)` - -* `dependency` {Dependency} -* Returns: {Module} - -#### `getPostOrderIndex(module)` - -* `module` {Module} -* Returns: {number} - -#### `getPreOrderIndex(module)` - -* `module` {Module} -* Returns: {number} - -#### `getProfile(module)` - -* `module` {Module} -* Returns: {ModuleProfile} - -#### `getProvidedExports(module)` - -* `module` {Module} -* Returns: {true|string[]} - -#### `getReadOnlyExportInfo(module, exportName)` - -* `module` {Module} -* `exportName` {string} -* Returns: {ExportInfo} - -#### `getResolvedModule(dependency)` - -* `dependency` {Dependency} -* Returns: {Module} - -#### `getResolvedOrigin(dependency)` - -* `dependency` {Dependency} -* Returns: {Module} - -#### `getUsedExports(module, runtime)` - -* `module` {Module} -* `runtime` {RuntimeSpec} -* Returns: {boolean|SortableSet} - -#### `isAsync(module)` - -* `module` {Module} -* Returns: {boolean} - -#### `isDeferred(module)` - -* `module` {Module} -* Returns: {boolean} - -#### `isExportProvided(module, exportName)` - -* `module` {Module} -* `exportName` {string|string[]} -* Returns: {boolean} - -#### `moveModuleConnections(oldModule, newModule, filterConnection)` - -* `oldModule` {Module} -* `newModule` {Module} -* `filterConnection` {object} -* Returns: {void} - -#### `removeAllModuleAttributes()` - -* Returns: {void} - -#### `removeConnection(dependency)` - -* `dependency` {Dependency} -* Returns: {void} - -#### `removeModuleAttributes(module)` - -* `module` {Module} -* Returns: {void} - -#### `setAsync(module)` - -* `module` {Module} -* Returns: {void} - -#### `setDepth(module, depth)` - -* `module` {Module} -* `depth` {number} -* Returns: {void} - -#### `setDepthIfLower(module, depth)` - -* `module` {Module} -* `depth` {number} -* Returns: {boolean} - -#### `setIssuer(module, issuer)` - -* `module` {Module} -* `issuer` {Module} -* Returns: {void} - -#### `setIssuerIfUnset(module, issuer)` - -* `module` {Module} -* `issuer` {Module} -* Returns: {void} - -#### `setModuleMemCaches(moduleMemCaches)` - -* `moduleMemCaches` {Map>} -* Returns: {void} - -#### `setParentDependenciesBlockIndex(dependency, index)` - -* `dependency` {Dependency} -* `index` {number} -* Returns: {void} - -#### `setParents(dependency, block, module[, indexInBlock])` - -* `dependency` {Dependency} -* `block` {DependenciesBlock} -* `module` {Module} -* `indexInBlock` {number} -* Returns: {void} - -#### `setPostOrderIndex(module, index)` - -* `module` {Module} -* `index` {number} -* Returns: {void} - -#### `setPostOrderIndexIfUnset(module, index)` - -* `module` {Module} -* `index` {number} -* Returns: {boolean} - -#### `setPreOrderIndex(module, index)` - -* `module` {Module} -* `index` {number} -* Returns: {void} - -#### `setPreOrderIndexIfUnset(module, index)` - -* `module` {Module} -* `index` {number} -* Returns: {boolean} - -#### `setProfile(module[, profile])` - -* `module` {Module} -* `profile` {ModuleProfile} -* Returns: {void} - -#### `setResolvedModule(originModule, dependency, module)` - -* `originModule` {Module} -* `dependency` {Dependency} -* `module` {Module} -* Returns: {void} - -#### `unfreeze()` - -* Returns: {void} - -#### `updateModule(dependency, module)` - -* `dependency` {Dependency} -* `module` {Module} -* Returns: {void} - -#### `updateParent(dependency[, connection][, parentModule])` - -* `dependency` {Dependency} -* `connection` {ModuleGraphConnection} -* `parentModule` {Module} -* Returns: {void} - -#### Static method: `clearModuleGraphForModule(module)` - -> Stability: 0 - Deprecated - -* `module` {Module} -* Returns: {void} - -#### Static method: `getModuleGraphForModule(module, deprecateMessage, deprecationCode)` - -> Stability: 0 - Deprecated - -* `module` {Module} -* `deprecateMessage` {string} -* `deprecationCode` {string} -* Returns: {ModuleGraph} - -#### Static method: `setModuleGraphForModule(module, moduleGraph)` - -> Stability: 0 - Deprecated - -* `module` {Module} -* `moduleGraph` {ModuleGraph} -* Returns: {void} - -*** - -## Class: `ModuleGraphConnection` - -### Constructors - -#### `new ModuleGraphConnection(originModule, dependency, module[, explanation][, weak][, condition])` - -* `originModule` {Module} -* `dependency` {Dependency} -* `module` {Module} -* `explanation` {string} -* `weak` {boolean} -* `condition` {false|object} -* Returns: {ModuleGraphConnection} - -### Properties - -* `condition` {false|object} -* `conditional` {boolean} -* `dependency` {Dependency} -* `explanation` {string} -* `explanations` {Set} -* `module` {Module} -* `originModule` {Module} -* `resolvedModule` {Module} -* `resolvedOriginModule` {Module} -* `weak` {boolean} -* `addConnectionStates` {object} -* `CIRCULAR_CONNECTION` {CIRCULAR_CONNECTION} -* `TRANSITIVE_ONLY` {TRANSITIVE_ONLY} - -### Methods - -#### `addCondition(condition)` - -* `condition` {object} -* Returns: {void} - -#### `addExplanation(explanation)` - -* `explanation` {string} -* Returns: {void} - -#### `clone()` - -* Returns: {ModuleGraphConnection} - -#### `getActiveState(runtime)` - -* `runtime` {RuntimeSpec} -* Returns: {ConnectionState} - -#### `isActive(runtime)` - -* `runtime` {RuntimeSpec} -* Returns: {boolean} - -#### `isTargetActive(runtime)` - -* `runtime` {RuntimeSpec} -* Returns: {boolean} - -#### `setActive(value)` - -* `value` {boolean} -* Returns: {void} - -*** - -## Class: `MultiCompiler` - -### Constructors - -#### `new MultiCompiler(compilers, options)` - -* `compilers` {Compiler[]|Record} -* `options` {MultiCompilerOptions} -* Returns: {MultiCompiler} - -### Properties - -* `compilers` {Compiler[]} -* `dependencies` {WeakMap} -* `hooks` {Readonly} -* `inputFileSystem` {InputFileSystem} -* `intermediateFileSystem` {IntermediateFileSystem} -* `options` {WebpackOptionsNormalized[]|MultiCompilerOptions} -* `outputFileSystem` {OutputFileSystem} -* `outputPath` {string} -* `running` {boolean} -* `watchFileSystem` {WatchFileSystem} - -### Methods - -#### `close(callback)` - -* `callback` {object} -* Returns: {void} - -#### `getInfrastructureLogger(name)` - -* `name` {string|object} -* Returns: {WebpackLogger} - -#### `purgeInputFileSystem()` - -* Returns: {void} - -#### `run(callback)` - -* `callback` {CallbackWebpackFunction_2} -* Returns: {void} - -#### `runWithDependencies(compilers, fn, callback)` - -> Stability: 0 - Deprecated - -* `compilers` {Compiler[]} -* `fn` {object} -* `callback` {CallbackWebpackFunction_2} -* Returns: {void} - -This method should have been private - -#### `setDependencies(compiler, dependencies)` - -* `compiler` {Compiler} -* `dependencies` {string[]} -* Returns: {void} - -#### `validateDependencies(callback)` - -* `callback` {CallbackWebpackFunction_2} -* Returns: {boolean} - -#### `watch(watchOptions, handler)` - -* `watchOptions` {WatchOptions|WatchOptions[]} -* `handler` {CallbackWebpackFunction_2} -* Returns: {MultiWatching} - -*** - -## Class: `MultiStats` - -### Constructors - -#### `new MultiStats()` - -* Returns: {MultiStats} - -### Properties - -* `hash` {string} -* `stats` {Stats[]} - -### Methods - -#### `hasErrors()` - -* Returns: {boolean} - -#### `hasWarnings()` - -* Returns: {boolean} - -#### `toJson([options])` - -* `options` {boolean|"verbose"|"none"|"summary"|"errors-only"|"errors-warnings"|"minimal"|"normal"|"detailed"|StatsOptions} -* Returns: {StatsCompilation} - -#### `toString([options])` - -* `options` {boolean|"verbose"|"none"|"summary"|"errors-only"|"errors-warnings"|"minimal"|"normal"|"detailed"|StatsOptions} -* Returns: {string} - -*** - -## Class: `NoEmitOnErrorsPlugin` - -### Constructors - -#### `new NoEmitOnErrorsPlugin()` - -* Returns: {NoEmitOnErrorsPlugin} - -### Methods - -#### `apply(compiler)` - -* `compiler` {Compiler} -* Returns: {void} - -Apply the plugin - -*** - -## Class: `NormalModule` - -### Extends - -- {Module} - -### Constructors - -#### `new NormalModule(__namedParameters)` - -* `__namedParameters` {NormalModuleCreateData} -* Returns: {NormalModule} - -### Properties - -* `binary` {boolean} -* `blocks` {AsyncDependenciesBlock[]} -* `buildInfo` {BuildInfo} -* `buildMeta` {BuildMeta} -* `chunksIterable` {Iterable} -* `codeGenerationDependencies` {Dependency[]} -* `context` {string} -* `debugId` {number} -* `dependencies` {Dependency[]} -* `depth` {number} -* `error` {WebpackError} -* `errors` {any} -* `exportsArgument` {string} -* `extractSourceMap` {boolean} -* `factoryMeta` {FactoryMeta} -* `generator` {Generator} -* `generatorOptions` {GeneratorOptions} -* `hasEqualsChunks` {any} -* `hash` {string} -* `hot` {boolean} -* `id` {string|number} -* `index` {number} -* `index2` {number} -* `issuer` {Module} -* `isUsed` {any} -* `layer` {string} -* `loaders` {LoaderItem[]} -* `matchResource` {string} -* `moduleArgument` {string} -* `needId` {boolean} -* `optimizationBailout` {string|object[]} -* `optional` {boolean} -* `parent` {DependenciesBlock} -* `parser` {ParserClass} -* `parserOptions` {ParserOptions} -* `presentationalDependencies` {Dependency[]} -* `profile` {ModuleProfile} -* `rawRequest` {string} -* `renderedHash` {string} -* `request` {string} -* `resolveOptions` {ResolveOptions} -* `resource` {string} -* `resourceResolveData` {ResourceSchemeData|Partial} -* `type` {string} -* `used` {any} -* `usedExports` {boolean|SortableSet} -* `userRequest` {string} -* `useSimpleSourceMap` {boolean} -* `useSourceMap` {boolean} -* `warnings` {any} - -### Methods - -#### `addBlock(block)` - -* `block` {AsyncDependenciesBlock} -* Returns: {void} - -Adds a DependencyBlock to DependencyBlock relationship. -This is used for when a Module has a AsyncDependencyBlock tie (for code-splitting) - -#### `addCacheDependencies(fileDependencies, contextDependencies, missingDependencies, buildDependencies)` - -* `fileDependencies` {LazySet} -* `contextDependencies` {LazySet} -* `missingDependencies` {LazySet} -* `buildDependencies` {LazySet} -* Returns: {void} - -#### `addChunk(chunk)` - -* `chunk` {Chunk} -* Returns: {boolean} - -#### `addCodeGenerationDependency(codeGenerationDependency)` - -* `codeGenerationDependency` {Dependency} -* Returns: {void} - -#### `addDependency(dependency)` - -* `dependency` {Dependency} -* Returns: {void} - -#### `addError(error)` - -* `error` {WebpackError} -* Returns: {void} - -#### `addPresentationalDependency(presentationalDependency)` - -* `presentationalDependency` {Dependency} -* Returns: {void} - -#### `addWarning(warning)` - -* `warning` {WebpackError} -* Returns: {void} - -#### `applyNoParseRule(rule, content)` - -* `rule` {string|RegExp|object} -* `content` {string} -* Returns: {boolean} - -#### `build(options, compilation, resolver, fs, callback)` - -* `options` {WebpackOptionsNormalizedWithDefaults} -* `compilation` {Compilation} -* `resolver` {ResolverWithOptions} -* `fs` {InputFileSystem} -* `callback` {object} -* Returns: {void} - -#### `chunkCondition(chunk, compilation)` - -* `chunk` {Chunk} -* `compilation` {Compilation} -* Returns: {boolean} - -#### `cleanupForCache()` - -* Returns: {void} - -Assuming this module is in the cache. Remove internal references to allow freeing some memory. - -#### `clearDependenciesAndBlocks()` - -* Returns: {void} - -Removes all dependencies and blocks - -#### `clearWarningsAndErrors()` - -* Returns: {void} - -removes all warnings and errors - -#### `codeGeneration(context)` - -* `context` {CodeGenerationContext} -* Returns: {CodeGenerationResult} - -#### `createSource(context, content[, sourceMap][, associatedObjectForCache])` - -* `context` {string} -* `content` {string|Buffer} -* `sourceMap` {string|RawSourceMap} -* `associatedObjectForCache` {object} -* Returns: {Source} - -#### `createSourceForAsset(context, name, content[, sourceMap][, associatedObjectForCache])` - -* `context` {string} -* `name` {string} -* `content` {string|Buffer} -* `sourceMap` {string|RawSourceMap} -* `associatedObjectForCache` {object} -* Returns: {Source} - -#### `deserialize(__namedParameters)` - -* `__namedParameters` {ObjectDeserializerContext} -* Returns: {void} - -#### `getChunks()` - -* Returns: {Chunk[]} - -#### `getConcatenationBailoutReason(context)` - -* `context` {ConcatenationBailoutReasonContext} -* Returns: {string} - -#### `getCurrentLoader(loaderContext[, index])` - -* `loaderContext` {AnyLoaderContext} -* `index` {number} -* Returns: {LoaderItem} - -#### `getErrors()` - -* Returns: {Iterable} - -#### `getExportsType(moduleGraph[, strict])` - -* `moduleGraph` {ModuleGraph} -* `strict` {boolean} -* Returns: {ExportsType} - -#### `getNumberOfChunks()` - -* Returns: {number} - -#### `getNumberOfErrors()` - -* Returns: {number} - -#### `getNumberOfWarnings()` - -* Returns: {number} - -#### `getResource()` - -* Returns: {string} - -#### `getRootBlock()` - -* Returns: {DependenciesBlock} - -#### `getSideEffectsConnectionState(moduleGraph)` - -* `moduleGraph` {ModuleGraph} -* Returns: {ConnectionState} - -#### `getSourceBasicTypes()` - -* Returns: {ReadonlySet} - -Basic source types are high-level categories like javascript, css, webassembly, etc. -We only have built-in knowledge about the javascript basic type here; other basic types may be -added or changed over time by generators and do not need to be handled or detected here. -Some modules, e.g. RemoteModule, may return non-basic source types like "remote" and "share-init" -from getSourceTypes(), but their generated output is still JavaScript, i.e. their basic type is JS. - -#### `getSourceTypes()` - -* Returns: {ReadonlySet} - -#### `getUnsafeCacheData()` - -* Returns: {UnsafeCacheData} - -Module should be unsafe cached. Get data that's needed for that. -This data will be passed to restoreFromUnsafeCache later. - -#### `getWarnings()` - -* Returns: {Iterable} - -#### `hasChunkCondition()` - -* Returns: {boolean} - -#### `hasReasonForChunk(chunk, moduleGraph, chunkGraph)` - -* `chunk` {Chunk} -* `moduleGraph` {ModuleGraph} -* `chunkGraph` {ChunkGraph} -* Returns: {boolean} - -#### `hasReasons(moduleGraph, runtime)` - -* `moduleGraph` {ModuleGraph} -* `runtime` {RuntimeSpec} -* Returns: {boolean} - -#### `identifier()` - -* Returns: {string} - -#### `invalidateBuild()` - -* Returns: {void} - -#### `isAccessibleInChunk(chunkGraph, chunk[, ignoreChunk])` - -* `chunkGraph` {ChunkGraph} -* `chunk` {Chunk} -* `ignoreChunk` {Chunk} -* Returns: {boolean} - -#### `isAccessibleInChunkGroup(chunkGraph, chunkGroup[, ignoreChunk])` - -* `chunkGraph` {ChunkGraph} -* `chunkGroup` {ChunkGroup} -* `ignoreChunk` {Chunk} -* Returns: {boolean} - -#### `isEntryModule()` - -* Returns: {boolean} - -#### `isInChunk(chunk)` - -* `chunk` {Chunk} -* Returns: {boolean} - -#### `isOptional(moduleGraph)` - -* `moduleGraph` {ModuleGraph} -* Returns: {boolean} - -#### `isProvided(exportName)` - -* `exportName` {string} -* Returns: {boolean} - -#### `libIdent(options)` - -* `options` {LibIdentOptions} -* Returns: {string} - -#### `markModuleAsErrored(error)` - -* `error` {WebpackError} -* Returns: {void} - -#### `nameForCondition()` - -* Returns: {string} - -#### `needBuild(context, callback)` - -* `context` {NeedBuildContext} -* `callback` {object} -* Returns: {void} - -#### `needRebuild(fileTimestamps, contextTimestamps)` - -> Stability: 0 - Deprecated - -* `fileTimestamps` {Map} -* `contextTimestamps` {Map} -* Returns: {boolean} - -Use needBuild instead - -#### `originalSource()` - -* Returns: {Source} - -#### `readableIdentifier(requestShortener)` - -* `requestShortener` {RequestShortener} -* Returns: {string} - -#### `removeChunk(chunk)` - -* `chunk` {Chunk} -* Returns: {void} - -#### `removeDependency(dependency)` - -* `dependency` {Dependency} -* Returns: {void} - -#### `restoreFromUnsafeCache(unsafeCacheData, normalModuleFactory)` - -* `unsafeCacheData` {UnsafeCacheData} -* `normalModuleFactory` {NormalModuleFactory} -* Returns: {void} - -restore unsafe cache data - -#### `serialize(__namedParameters)` - -* `__namedParameters` {ObjectSerializerContext} -* Returns: {void} - -#### `shouldPreventParsing(noParseRule, request)` - -* `noParseRule` {string|RegExp|object|string|RegExp|object[]} -* `request` {string} -* Returns: {boolean} - -#### `size([type])` - -* `type` {string} -* Returns: {number} - -#### `source(dependencyTemplates, runtimeTemplate[, type])` - -> Stability: 0 - Deprecated - -* `dependencyTemplates` {DependencyTemplates} -* `runtimeTemplate` {RuntimeTemplate} -* `type` {string} -* Returns: {Source} - -Use codeGeneration() instead - -#### `updateCacheModule(module)` - -* `module` {Module} -* Returns: {void} - -Assuming this module is in the cache. Update the (cached) module with -the fresh module from the factory. Usually updates internal references -and properties. - -#### `updateHash(hash, context)` - -* `hash` {Hash} -* `context` {UpdateHashContextDependency} -* Returns: {void} - -#### Static method: `deserialize(context)` - -* `context` {ObjectDeserializerContext} -* Returns: {NormalModule} - -#### Static method: `getCompilationHooks(compilation)` - -* `compilation` {Compilation} -* Returns: {NormalModuleCompilationHooks} - -#### Static method: `getSourceBasicTypes(module)` - -> Stability: 0 - Deprecated - -* `module` {Module} -* Returns: {ReadonlySet} - -In webpack 6, call getSourceBasicTypes() directly on the module instance instead of using this static method. - -*** - -## Class: `NormalModuleReplacementPlugin` - -### Constructors - -#### `new NormalModuleReplacementPlugin(resourceRegExp, newResource)` - -* `resourceRegExp` {RegExp} -* `newResource` {string|object} -* Returns: {NormalModuleReplacementPlugin} - -Create an instance of the plugin - -### Properties - -* `newResource` {string|object} -* `resourceRegExp` {RegExp} - -### Methods - -#### `apply(compiler)` - -* `compiler` {Compiler} -* Returns: {void} - -Apply the plugin - -*** - -## Class: `Parser` - -### Extended by - -- {JavascriptParser} - -### Constructors - -#### `new Parser()` - -* Returns: {ParserClass} - -### Methods - -#### `parse(source, state)` - -* `source` {string|Buffer|PreparsedAst} -* `state` {ParserState} -* Returns: {ParserState} - -*** - -## Class: `PlatformPlugin` - -### Constructors - -#### `new PlatformPlugin(platform)` - -* `platform` {Partial} -* Returns: {PlatformPlugin} - -### Properties - -* `platform` {Partial} - -### Methods - -#### `apply(compiler)` - -* `compiler` {Compiler} -* Returns: {void} - -Apply the plugin - -*** - -## Class: `PrefetchPlugin` - -### Constructors - -#### `new PrefetchPlugin(context[, request])` - -* `context` {string} -* `request` {string} -* Returns: {PrefetchPlugin} - -### Properties - -* `context` {string} -* `request` {string} - -### Methods - -#### `apply(compiler)` - -* `compiler` {Compiler} -* Returns: {void} - -Apply the plugin - -*** - -## Class: `ProgressPlugin` - -### Constructors - -#### `new ProgressPlugin([options])` - -* `options` {ProgressPluginArgument} -* Returns: {ProgressPlugin} - -### Properties - -* `dependenciesCount` {number} -* `handler` {object} -* `modulesCount` {number} -* `options` {ProgressPluginOptions} -* `percentBy` {"entries"|"modules"|"dependencies"} -* `profile` {boolean} -* `showActiveModules` {boolean} -* `showDependencies` {boolean} -* `showEntries` {boolean} -* `showModules` {boolean} -* `createDefaultHandler` {object} -* `defaultOptions` {Required>} - -### Methods - -#### `apply(compiler)` - -* `compiler` {Compiler|MultiCompiler} -* Returns: {void} - -#### Static method: `getReporter(compiler)` - -* `compiler` {Compiler} -* Returns: {object} - -*** - -## Class: `ProvidePlugin` - -### Constructors - -#### `new ProvidePlugin(definitions)` - -* `definitions` {Record} -* Returns: {ProvidePlugin} - -### Properties - -* `definitions` {Record} - -### Methods - -#### `apply(compiler)` - -* `compiler` {Compiler} -* Returns: {void} - -Apply the plugin - -*** - -## Class: `Resolver` - -### Constructors - -#### `new Resolver()` - -* Returns: {Resolver} - -### Properties - -* `fileSystem` {FileSystem} -* `hooks` {KnownHooks} -* `options` {ResolveOptionsResolverFactoryObject1} - -### Methods - -#### `doResolve(hook, request, message, resolveContext, callback)` - -* `hook` {AsyncSeriesBailHook, ResolveRequest>} -* `request` {ResolveRequest} -* `message` {string} -* `resolveContext` {ResolveContext} -* `callback` {object} -* Returns: {void} - -#### `ensureHook(name)` - -* `name` {string|AsyncSeriesBailHook, ResolveRequest, UnsetAdditionalOptions>} -* Returns: {AsyncSeriesBailHook, ResolveRequest>} - -#### `getHook(name)` - -* `name` {string|AsyncSeriesBailHook, ResolveRequest, UnsetAdditionalOptions>} -* Returns: {AsyncSeriesBailHook, ResolveRequest>} - -#### `isDirectory(path)` - -* `path` {string} -* Returns: {boolean} - -#### `isModule(path)` - -* `path` {string} -* Returns: {boolean} - -#### `isPrivate(path)` - -* `path` {string} -* Returns: {boolean} - -#### `join(path, request)` - -* `path` {string} -* `request` {string} -* Returns: {string} - -#### `normalize(path)` - -* `path` {string} -* Returns: {string} - -#### `parse(identifier)` - -* `identifier` {string} -* Returns: {ParsedIdentifier} - -#### `resolve(context, path, request, resolveContext, callback)` - -* `context` {ContextTypes} -* `path` {string} -* `request` {string} -* `resolveContext` {ResolveContext} -* `callback` {object} -* Returns: {void} - -#### `resolveSync(context, path, request)` - -* `context` {ContextTypes} -* `path` {string} -* `request` {string} -* Returns: {string|false} - -*** - -## Class: `RuntimeModule` - -### Extends - -- {Module} - -### Extended by - -- {GetChunkFilenameRuntimeModule} -- {JsonpChunkLoadingRuntimeModule} -- {CssLoadingRuntimeModule} -- {ModuleChunkLoadingRuntimeModule} - -### Constructors - -#### `new RuntimeModule(name[, stage])` - -* `name` {string} -* `stage` {number} -* Returns: {RuntimeModule} - -### Properties - -* `blocks` {AsyncDependenciesBlock[]} -* `buildInfo` {BuildInfo} -* `buildMeta` {BuildMeta} -* `chunk` {Chunk} -* `chunkGraph` {ChunkGraph} -* `chunksIterable` {Iterable} -* `codeGenerationDependencies` {Dependency[]} -* `compilation` {Compilation} -* `context` {string} -* `debugId` {number} -* `dependencies` {Dependency[]} -* `dependentHash` {boolean} -* `depth` {number} -* `errors` {any} -* `exportsArgument` {string} -* `factoryMeta` {FactoryMeta} -* `fullHash` {boolean} -* `hasEqualsChunks` {any} -* `hash` {string} -* `hot` {boolean} -* `id` {string|number} -* `index` {number} -* `index2` {number} -* `issuer` {Module} -* `isUsed` {any} -* `layer` {string} -* `moduleArgument` {string} -* `name` {string} -* `needId` {boolean} -* `optimizationBailout` {string|object[]} -* `optional` {boolean} -* `parent` {DependenciesBlock} -* `presentationalDependencies` {Dependency[]} -* `profile` {ModuleProfile} -* `renderedHash` {string} -* `resolveOptions` {ResolveOptions} -* `stage` {number} -* `type` {string} -* `used` {any} -* `usedExports` {boolean|SortableSet} -* `useSimpleSourceMap` {boolean} -* `useSourceMap` {boolean} -* `warnings` {any} -* `STAGE_ATTACH` {number} Runtime modules which attach to handlers of other runtime modules -* `STAGE_BASIC` {number} Runtime modules with simple dependencies on other runtime modules -* `STAGE_NORMAL` {number} Runtime modules without any dependencies to other runtime modules -* `STAGE_TRIGGER` {number} Runtime modules which trigger actions on bootstrap - -### Methods - -#### `addBlock(block)` - -* `block` {AsyncDependenciesBlock} -* Returns: {void} - -Adds a DependencyBlock to DependencyBlock relationship. -This is used for when a Module has a AsyncDependencyBlock tie (for code-splitting) - -#### `addCacheDependencies(fileDependencies, contextDependencies, missingDependencies, buildDependencies)` - -* `fileDependencies` {LazySet} -* `contextDependencies` {LazySet} -* `missingDependencies` {LazySet} -* `buildDependencies` {LazySet} -* Returns: {void} - -#### `addChunk(chunk)` - -* `chunk` {Chunk} -* Returns: {boolean} - -#### `addCodeGenerationDependency(codeGenerationDependency)` - -* `codeGenerationDependency` {Dependency} -* Returns: {void} - -#### `addDependency(dependency)` - -* `dependency` {Dependency} -* Returns: {void} - -#### `addError(error)` - -* `error` {WebpackError} -* Returns: {void} - -#### `addPresentationalDependency(presentationalDependency)` - -* `presentationalDependency` {Dependency} -* Returns: {void} - -#### `addWarning(warning)` - -* `warning` {WebpackError} -* Returns: {void} - -#### `attach(compilation, chunk[, chunkGraph])` - -* `compilation` {Compilation} -* `chunk` {Chunk} -* `chunkGraph` {ChunkGraph} -* Returns: {void} - -#### `build(options, compilation, resolver, fs, callback)` - -* `options` {WebpackOptionsNormalizedWithDefaults} -* `compilation` {Compilation} -* `resolver` {ResolverWithOptions} -* `fs` {InputFileSystem} -* `callback` {object} -* Returns: {void} - -#### `chunkCondition(chunk, compilation)` - -* `chunk` {Chunk} -* `compilation` {Compilation} -* Returns: {boolean} - -#### `cleanupForCache()` - -* Returns: {void} - -Assuming this module is in the cache. Remove internal references to allow freeing some memory. - -#### `clearDependenciesAndBlocks()` - -* Returns: {void} - -Removes all dependencies and blocks - -#### `clearWarningsAndErrors()` - -* Returns: {void} - -removes all warnings and errors - -#### `codeGeneration(context)` - -* `context` {CodeGenerationContext} -* Returns: {CodeGenerationResult} - -#### `deserialize(__namedParameters)` - -* `__namedParameters` {ObjectDeserializerContext} -* Returns: {void} - -#### `generate()` - -* Returns: {string} - -#### `getChunks()` - -* Returns: {Chunk[]} - -#### `getConcatenationBailoutReason(context)` - -* `context` {ConcatenationBailoutReasonContext} -* Returns: {string} - -#### `getErrors()` - -* Returns: {Iterable} - -#### `getExportsType(moduleGraph[, strict])` - -* `moduleGraph` {ModuleGraph} -* `strict` {boolean} -* Returns: {ExportsType} - -#### `getGeneratedCode()` - -* Returns: {string} - -#### `getNumberOfChunks()` - -* Returns: {number} - -#### `getNumberOfErrors()` - -* Returns: {number} - -#### `getNumberOfWarnings()` - -* Returns: {number} - -#### `getRootBlock()` - -* Returns: {DependenciesBlock} - -#### `getSideEffectsConnectionState(moduleGraph)` - -* `moduleGraph` {ModuleGraph} -* Returns: {ConnectionState} - -#### `getSourceBasicTypes()` - -* Returns: {ReadonlySet} - -Basic source types are high-level categories like javascript, css, webassembly, etc. -We only have built-in knowledge about the javascript basic type here; other basic types may be -added or changed over time by generators and do not need to be handled or detected here. -Some modules, e.g. RemoteModule, may return non-basic source types like "remote" and "share-init" -from getSourceTypes(), but their generated output is still JavaScript, i.e. their basic type is JS. - -#### `getSourceTypes()` - -* Returns: {ReadonlySet} - -#### `getUnsafeCacheData()` - -* Returns: {UnsafeCacheData} - -Module should be unsafe cached. Get data that's needed for that. -This data will be passed to restoreFromUnsafeCache later. - -#### `getWarnings()` - -* Returns: {Iterable} - -#### `hasChunkCondition()` - -* Returns: {boolean} - -#### `hasReasonForChunk(chunk, moduleGraph, chunkGraph)` - -* `chunk` {Chunk} -* `moduleGraph` {ModuleGraph} -* `chunkGraph` {ChunkGraph} -* Returns: {boolean} - -#### `hasReasons(moduleGraph, runtime)` - -* `moduleGraph` {ModuleGraph} -* `runtime` {RuntimeSpec} -* Returns: {boolean} - -#### `identifier()` - -* Returns: {string} - -#### `invalidateBuild()` - -* Returns: {void} - -#### `isAccessibleInChunk(chunkGraph, chunk[, ignoreChunk])` - -* `chunkGraph` {ChunkGraph} -* `chunk` {Chunk} -* `ignoreChunk` {Chunk} -* Returns: {boolean} - -#### `isAccessibleInChunkGroup(chunkGraph, chunkGroup[, ignoreChunk])` - -* `chunkGraph` {ChunkGraph} -* `chunkGroup` {ChunkGroup} -* `ignoreChunk` {Chunk} -* Returns: {boolean} - -#### `isEntryModule()` - -* Returns: {boolean} - -#### `isInChunk(chunk)` - -* `chunk` {Chunk} -* Returns: {boolean} - -#### `isOptional(moduleGraph)` - -* `moduleGraph` {ModuleGraph} -* Returns: {boolean} - -#### `isProvided(exportName)` - -* `exportName` {string} -* Returns: {boolean} - -#### `libIdent(options)` - -* `options` {LibIdentOptions} -* Returns: {string} - -#### `nameForCondition()` - -* Returns: {string} - -#### `needBuild(context, callback)` - -* `context` {NeedBuildContext} -* `callback` {object} -* Returns: {void} - -#### `needRebuild(fileTimestamps, contextTimestamps)` - -> Stability: 0 - Deprecated - -* `fileTimestamps` {Map} -* `contextTimestamps` {Map} -* Returns: {boolean} - -Use needBuild instead - -#### `originalSource()` - -* Returns: {Source} - -#### `readableIdentifier(requestShortener)` - -* `requestShortener` {RequestShortener} -* Returns: {string} - -#### `removeChunk(chunk)` - -* `chunk` {Chunk} -* Returns: {void} - -#### `removeDependency(dependency)` - -* `dependency` {Dependency} -* Returns: {void} - -#### `serialize(__namedParameters)` - -* `__namedParameters` {ObjectSerializerContext} -* Returns: {void} - -#### `shouldIsolate()` - -* Returns: {boolean} - -#### `size([type])` - -* `type` {string} -* Returns: {number} - -#### `source(dependencyTemplates, runtimeTemplate[, type])` - -> Stability: 0 - Deprecated - -* `dependencyTemplates` {DependencyTemplates} -* `runtimeTemplate` {RuntimeTemplate} -* `type` {string} -* Returns: {Source} - -Use codeGeneration() instead - -#### `updateCacheModule(module)` - -* `module` {Module} -* Returns: {void} - -Assuming this module is in the cache. Update the (cached) module with -the fresh module from the factory. Usually updates internal references -and properties. - -#### `updateHash(hash, context)` - -* `hash` {Hash} -* `context` {UpdateHashContextDependency} -* Returns: {void} - -#### Static method: `getSourceBasicTypes(module)` - -> Stability: 0 - Deprecated - -* `module` {Module} -* Returns: {ReadonlySet} - -In webpack 6, call getSourceBasicTypes() directly on the module instance instead of using this static method. - -*** - -## Class: `SourceMapDevToolPlugin` - -### Constructors - -#### `new SourceMapDevToolPlugin([options])` - -* `options` {SourceMapDevToolPluginOptions} -* Returns: {SourceMapDevToolPlugin} - -### Properties - -* `fallbackModuleFilenameTemplate` {DevtoolFallbackModuleFilenameTemplate} -* `moduleFilenameTemplate` {DevtoolModuleFilenameTemplate} -* `namespace` {string} -* `options` {SourceMapDevToolPluginOptions} -* `sourceMapFilename` {string|false} -* `sourceMappingURLComment` {string|false|object} - -### Methods - -#### `apply(compiler)` - -* `compiler` {Compiler} -* Returns: {void} - -Apply the plugin - -*** - -## Class: `Stats` - -### Constructors - -#### `new Stats(compilation)` - -* `compilation` {Compilation} -* Returns: {Stats} - -### Properties - -* `compilation` {Compilation} -* `endTime` {number} -* `hash` {string} -* `startTime` {number} - -### Methods - -#### `hasErrors()` - -* Returns: {boolean} - -#### `hasWarnings()` - -* Returns: {boolean} - -#### `toJson([options])` - -* `options` {boolean|"verbose"|"none"|"summary"|"errors-only"|"errors-warnings"|"minimal"|"normal"|"detailed"|StatsOptions} -* Returns: {StatsCompilation} - -#### `toString([options])` - -* `options` {boolean|"verbose"|"none"|"summary"|"errors-only"|"errors-warnings"|"minimal"|"normal"|"detailed"|StatsOptions} -* Returns: {string} - -*** - -## Class: `Template` - -### Constructors - -#### `new Template()` - -* Returns: {Template} - -### Properties - -* `NUMBER_OF_IDENTIFIER_CONTINUATION_CHARS` {number} -* `NUMBER_OF_IDENTIFIER_START_CHARS` {number} - -### Methods - -#### Static method: `asString(str)` - -* `str` {string|string[]} -* Returns: {string} - -#### Static method: `getFunctionContent(fn)` - -* `fn` {Stringable} -* Returns: {string} - -#### Static method: `getModulesArrayBounds(modules)` - -* `modules` {WithId[]} -* Returns: {false|Tuple} - -#### Static method: `indent(s)` - -* `s` {string|string[]} -* Returns: {string} - -#### Static method: `numberToIdentifier(n)` - -* `n` {number} -* Returns: {string} - -#### Static method: `numberToIdentifierContinuation(n)` - -* `n` {number} -* Returns: {string} - -#### Static method: `prefix(s, prefix)` - -* `s` {string|string[]} -* `prefix` {string} -* Returns: {string} - -#### Static method: `renderChunkModules(renderContext, modules, renderModule[, prefix])` - -* `renderContext` {ChunkRenderContextJavascriptModulesPlugin} -* `modules` {Module[]} -* `renderModule` {object} -* `prefix` {string} -* Returns: {Source} - -#### Static method: `renderChunkRuntimeModules(runtimeModules, renderContext)` - -* `runtimeModules` {RuntimeModule[]} -* `renderContext` {RenderContextJavascriptModulesPlugin} -* Returns: {Source} - -#### Static method: `renderRuntimeModules(runtimeModules, renderContext)` - -* `runtimeModules` {RuntimeModule[]} -* `renderContext` {RenderContextJavascriptModulesPlugin|object} -* Returns: {Source} - -#### Static method: `toComment(str)` - -* `str` {string} -* Returns: {string} - -#### Static method: `toIdentifier(str)` - -* `str` {string} -* Returns: {string} - -#### Static method: `toNormalComment(str)` - -* `str` {string} -* Returns: {string} - -#### Static method: `toPath(str)` - -* `str` {string} -* Returns: {string} - -*** - -## Class: `WatchIgnorePlugin` - -### Constructors - -#### `new WatchIgnorePlugin(options)` - -* `options` {WatchIgnorePluginOptions} -* Returns: {WatchIgnorePlugin} - -### Properties - -* `options` {WatchIgnorePluginOptions} - -### Methods - -#### `apply(compiler)` - -* `compiler` {Compiler} -* Returns: {void} - -Apply the plugin - -*** - -## Class: `Watching` - -### Constructors - -#### `new Watching()` - -* Returns: {Watching} - -### Properties - -* `blocked` {boolean} -* `callbacks` {object[]} -* `closed` {boolean} -* `compiler` {Compiler} -* `handler` {CallbackWebpackFunction_2} -* `invalid` {boolean} -* `lastWatcherStartTime` {number} -* `pausedWatcher` {Watcher} -* `running` {boolean} -* `startTime` {number} -* `suspended` {boolean} -* `watcher` {Watcher} -* `watchOptions` {WatchOptions} - -### Methods - -#### `close(callback)` - -* `callback` {object} -* Returns: {void} - -#### `invalidate([callback])` - -* `callback` {object} -* Returns: {void} - -#### `resume()` - -* Returns: {void} - -#### `suspend()` - -* Returns: {void} - -#### `watch(files, dirs, missing)` - -* `files` {Iterable} -* `dirs` {Iterable} -* `missing` {Iterable} -* Returns: {void} - -*** - -## Class: `WebpackError` - -### Extends - -- {Error} - -### Indexable - -> \[`index`: {number}\]: {object} - -### Constructors - -#### `new WebpackError([message][, options])` - -* `message` {string} -* `options` {object} -* Returns: {WebpackError} - -Creates an instance of WebpackError. - -### Properties - -* `chunk` {Chunk} -* `details` {string} -* `file` {string} -* `hideStack` {boolean} -* `loc` {SyntheticDependencyLocation|RealDependencyLocation} -* `message` {string} -* `module` {Module} -* `name` {string} -* `stack` {string} -* `stackTraceLimit` {number} The `Error.stackTraceLimit` property specifies the number of stack frames -collected by a stack trace (whether generated by `new Error().stack` or -`Error.captureStackTrace(obj)`). -The default value is `10` but may be set to any valid JavaScript number. Changes -will affect any stack trace captured _after_ the value has been changed. -If set to a non-number value, or set to a negative number, stack traces will -not capture any frames. - -### Methods - -#### `deserialize(__namedParameters)` - -* `__namedParameters` {ObjectDeserializerContext} -* Returns: {void} - -#### `serialize(__namedParameters)` - -* `__namedParameters` {ObjectSerializerContext} -* Returns: {void} - -#### Static method: `captureStackTrace(targetObject[, constructorOpt])` - -* `targetObject` {object} -* `constructorOpt` {Function} -* Returns: {void} - -Creates a `.stack` property on `targetObject`, which when accessed returns -a string representing the location in the code at which -`Error.captureStackTrace()` was called. -```js -const myObject = {}; -Error.captureStackTrace(myObject); -myObject.stack; // Similar to `new Error().stack` -``` -The first line of the trace will be prefixed with -`${myObject.name}: ${myObject.message}`. -The optional `constructorOpt` argument accepts a function. If given, all frames -above `constructorOpt`, including `constructorOpt`, will be omitted from the -generated stack trace. -The `constructorOpt` argument is useful for hiding implementation -details of error generation from the user. For instance: -```js -function a() { - b(); -} -function b() { - c(); -} -function c() { - // Create an error without stack trace to avoid calculating the stack trace twice. - const { stackTraceLimit } = Error; - Error.stackTraceLimit = 0; - const error = new Error(); - Error.stackTraceLimit = stackTraceLimit; - // Capture the stack trace above function b - Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace - throw error; -} -a(); -``` - -#### Static method: `prepareStackTrace(err, stackTraces)` - -* `err` {Error} -* `stackTraces` {CallSite[]} -* Returns: {any} - -*** - -## Class: `WebpackOptionsApply` - -### Extends - -- {OptionsApply} - -### Constructors - -#### `new WebpackOptionsApply()` - -* Returns: {WebpackOptionsApply} - -### Methods - -#### `process(options, compiler[, interception])` - -* `options` {WebpackOptionsNormalizedWithDefaults} -* `compiler` {Compiler} -* `interception` {WebpackOptionsInterception} -* Returns: {WebpackOptionsNormalizedWithDefaults} - -*** - -## Class: `WebpackOptionsDefaulter` - -### Constructors - -#### `new WebpackOptionsDefaulter()` - -* Returns: {WebpackOptionsDefaulter} - -### Methods - -#### `process(options)` - -* `options` {Configuration} -* Returns: {WebpackOptionsNormalized} - -*** - -## Class: `WebpackOptionsValidationError` - -### Extends - -- {Error} - -### Constructors - -#### `new WebpackOptionsValidationError(errors, schema[, configuration])` - -* `errors` {SchemaUtilErrorObject[]} array of error objects -* `schema` {Schema} schema -* `configuration` {ValidationErrorConfiguration} configuration -* Returns: {ValidationError} - -### Properties - -* `baseDataPath` {string} -* `errors` {SchemaUtilErrorObject[]} -* `headerName` {string} -* `message` {string} -* `name` {string} -* `postFormatter` {PostFormatter} -* `schema` {Schema} -* `stack` {string} -* `stackTraceLimit` {number} The `Error.stackTraceLimit` property specifies the number of stack frames -collected by a stack trace (whether generated by `new Error().stack` or -`Error.captureStackTrace(obj)`). - -The default value is `10` but may be set to any valid JavaScript number. Changes -will affect any stack trace captured _after_ the value has been changed. - -If set to a non-number value, or set to a negative number, stack traces will -not capture any frames. - -### Methods - -#### `formatSchema(schema[, logic][, prevSchemas])` - -* `schema` {Schema} schema -* `logic` {boolean} logic -* `prevSchemas` {object[]} prev schemas -* Returns: {string} formatted schema - -#### `formatValidationError(error)` - -* `error` {SchemaUtilErrorObject} error object -* Returns: {string} formatted error object - -#### `formatValidationErrors(errors)` - -* `errors` {SchemaUtilErrorObject[]} errors -* Returns: {string} formatted errors - -#### `getSchemaPart(path)` - -* `path` {string} path -* Returns: {Schema} schema - -#### `getSchemaPartDescription([schemaPart])` - -* `schemaPart` {Schema} schema part -* Returns: {string} schema part description - -#### `getSchemaPartText([schemaPart][, additionalPath][, needDot][, logic])` - -* `schemaPart` {Schema} schema part -* `additionalPath` {boolean|string[]} additional path -* `needDot` {boolean} true when need dot -* `logic` {boolean} logic -* Returns: {string} schema part text - -#### Static method: `captureStackTrace(targetObject[, constructorOpt])` - -* `targetObject` {object} -* `constructorOpt` {Function} -* Returns: {void} - -Creates a `.stack` property on `targetObject`, which when accessed returns -a string representing the location in the code at which -`Error.captureStackTrace()` was called. - -```js -const myObject = {}; -Error.captureStackTrace(myObject); -myObject.stack; // Similar to `new Error().stack` -``` - -The first line of the trace will be prefixed with -`${myObject.name}: ${myObject.message}`. - -The optional `constructorOpt` argument accepts a function. If given, all frames -above `constructorOpt`, including `constructorOpt`, will be omitted from the -generated stack trace. - -The `constructorOpt` argument is useful for hiding implementation -details of error generation from the user. For instance: - -```js -function a() { - b(); -} - -function b() { - c(); -} - -function c() { - // Create an error without stack trace to avoid calculating the stack trace twice. - const { stackTraceLimit } = Error; - Error.stackTraceLimit = 0; - const error = new Error(); - Error.stackTraceLimit = stackTraceLimit; - - // Capture the stack trace above function b - Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace - throw error; -} - -a(); -``` - -#### Static method: `prepareStackTrace(err, stackTraces)` - -* `err` {Error} -* `stackTraces` {CallSite[]} -* Returns: {any} - -*** - -## Interface: `Argument` - -### Properties - -* `configs` {ArgumentConfig[]} -* `description` {string} -* `multiple` {boolean} -* `simpleType` {SimpleType} - -*** - -## Interface: `Asset` - -### Properties - -* `info` {AssetInfo} info about the asset -* `name` {string} the filename of the asset -* `source` {Source} source of the asset - -*** - -## Interface: `AssetEmittedInfo` - -### Properties - -* `compilation` {Compilation} -* `content` {Buffer} -* `outputPath` {string} -* `source` {Source} -* `targetPath` {string} - -*** - -## Interface: `Colors` - -### Properties - -* `bgBlack` {object} -* `bgBlackBright` {object} -* `bgBlue` {object} -* `bgBlueBright` {object} -* `bgCyan` {object} -* `bgCyanBright` {object} -* `bgGreen` {object} -* `bgGreenBright` {object} -* `bgMagenta` {object} -* `bgMagentaBright` {object} -* `bgRed` {object} -* `bgRedBright` {object} -* `bgWhite` {object} -* `bgWhiteBright` {object} -* `bgYellow` {object} -* `bgYellowBright` {object} -* `black` {object} -* `blackBright` {object} -* `blue` {object} -* `blueBright` {object} -* `bold` {object} -* `cyan` {object} -* `cyanBright` {object} -* `dim` {object} -* `gray` {object} -* `green` {object} -* `greenBright` {object} -* `hidden` {object} -* `inverse` {object} -* `italic` {object} -* `magenta` {object} -* `magentaBright` {object} -* `red` {object} -* `redBright` {object} -* `reset` {object} -* `strikethrough` {object} -* `underline` {object} -* `white` {object} -* `whiteBright` {object} -* `yellow` {object} -* `yellowBright` {object} - -*** - -## Interface: `ColorsOptions` - -### Properties - -* `useColor` {boolean} force use colors - -*** - -## Interface: `Configuration` - -Options object as provided by the user. - -### Properties - -* `amd` {false|object} Set the value of `require.amd` and `define.amd`. Or disable AMD support. -* `bail` {boolean} Report the first error as a hard error instead of tolerating it. -* `cache` {boolean|FileCacheOptions|MemoryCacheOptions} Cache generated modules and chunks to improve performance for multiple incremental builds. -* `context` {string} The base directory (absolute path!) for resolving the `entry` option. If `output.pathinfo` is set, the included pathinfo is shortened to this directory. -* `dependencies` {string[]} References to other configurations to depend on. -* `devtool` {string|false|object[]} A developer tool to enhance debugging (false | eval | [inline-|hidden-|eval-][nosources-][cheap-[module-]]source-map). -* `dotenv` {boolean|DotenvPluginOptions} Enable and configure the Dotenv plugin to load environment variables from .env files. -* `entry` {string|string[]|EntryObject|object} The entry point(s) of the compilation. -* `experiments` {Experiments} Enables/Disables experiments (experimental features with relax SemVer compatibility). -* `extends` {string|string[]} Extend configuration from another configuration (only works when using webpack-cli). -* `externals` {string|RegExp|ExternalItemObjectKnown|ExternalItemObjectUnknown|object|object|ExternalItem[]} Specify dependencies that shouldn't be resolved by webpack, but should become dependencies of the resulting bundle. The kind of the dependency depends on `output.libraryTarget`. -* `externalsPresets` {ExternalsPresets} Enable presets of externals for specific targets. -* `externalsType` {"asset"|"module"|"css-import"|"css-url"|"global"|"import"|"commonjs"|"jsonp"|"promise"|"this"|"var"|"assign"|"window"|"self"|"commonjs2"|"commonjs-module"|"commonjs-static"|"amd"|"amd-require"|"umd"|"umd2"|"system"|"module-import"|"script"|"node-commonjs"} Specifies the default type of externals ('amd*', 'umd*', 'system' and 'jsonp' depend on output.libraryTarget set to the same value). -* `ignoreWarnings` {RegExp|object|object[]} Ignore specific warnings. -* `infrastructureLogging` {InfrastructureLogging} Options for infrastructure level logging. -* `loader` {Loader} Custom values available in the loader context. -* `mode` {"development"|"none"|"production"} Enable production optimizations or development hints. -* `module` {ModuleOptions} Options affecting the normal modules (`NormalModuleFactory`). -* `name` {string} Name of the configuration. Used when loading multiple configurations. -* `node` {false|NodeOptions} Include polyfills or mocks for various node stuff. -* `optimization` {Optimization} Enables/Disables integrated optimizations. -* `output` {Output} Options affecting the output of the compilation. `output` options tell webpack how to write the compiled files to disk. -* `parallelism` {number} The number of parallel processed modules in the compilation. -* `performance` {false|PerformanceOptions} Configuration for web performance recommendations. -* `plugins` {false|""|0|WebpackPluginInstance|object[]} Add additional plugins to the compiler. -* `profile` {boolean} Capture timing information for each module. -* `recordsInputPath` {string|false} Store compiler state to a json file. -* `recordsOutputPath` {string|false} Load compiler state from a json file. -* `recordsPath` {string|false} Store/Load compiler state from/to a json file. This will result in persistent ids of modules and chunks. An absolute path is expected. `recordsPath` is used for `recordsInputPath` and `recordsOutputPath` if they left undefined. -* `resolve` {ResolveOptions} Options for the resolver. -* `resolveLoader` {ResolveOptions} Options for the resolver when resolving loaders. -* `snapshot` {SnapshotOptionsWebpackOptions} Options affecting how file system snapshots are created and validated. -* `stats` {boolean|"verbose"|"none"|"summary"|"errors-only"|"errors-warnings"|"minimal"|"normal"|"detailed"|StatsOptions} Stats options object or preset name. -* `target` {string|false|string[]} Environment to build for. An array of environments to build for all of them when possible. -* `validate` {boolean} Enable validation of webpack configuration. Defaults to true in development mode. In production mode, defaults to true unless futureDefaults is enabled, then defaults to false. -* `watch` {boolean} Enter watch mode, which rebuilds on file change. -* `watchOptions` {WatchOptions} Options for the watcher. - -*** - -## Interface: `EntryObject` - -Multiple entry bundles are created. The key is the entry name. The value can be a string, an array or an entry description object. - -### Indexable - -> \[`index`: {string}\]: {string|string[]|EntryDescription} - -*** - -## Interface: `ExternalItemFunctionData` - -### Properties - -* `context` {string} the directory in which the request is placed -* `contextInfo` {ModuleFactoryCreateDataContextInfo} contextual information -* `dependencyType` {string} the category of the referencing dependency -* `getResolve` {object} get a resolve function with the current resolver options -* `request` {string} the request as written by the user in the require/import expression/statement - -*** - -## Interface: `ExternalItemObjectKnown` - -If an dependency matches exactly a property of the object, the property value is used as dependency. - -### Properties - -* `byLayer` {object|object} Specify externals depending on the layer. - -*** - -## Interface: `ExternalItemObjectUnknown` - -If an dependency matches exactly a property of the object, the property value is used as dependency. - -### Indexable - -> \[`index`: {string}\]: {ExternalItemValue} - -*** - -## Interface: `FileCacheOptions` - -Options object for persistent file-based caching. - -### Properties - -* `allowCollectingMemory` {boolean} Allows to collect unused memory allocated during deserialization. This requires copying data into smaller buffers and has a performance cost. -* `buildDependencies` {object} Dependencies the build depends on (in multiple categories, default categories: 'defaultWebpack'). -* `cacheDirectory` {string} Base directory for the cache (defaults to node_modules/.cache/webpack). -* `cacheLocation` {string} Locations for the cache (defaults to cacheDirectory / name). -* `compression` {false|"gzip"|"brotli"} Compression type used for the cache files. -* `hashAlgorithm` {string} Algorithm used for generation the hash (see node.js crypto package). -* `idleTimeout` {number} Time in ms after which idle period the cache storing should happen. -* `idleTimeoutAfterLargeChanges` {number} Time in ms after which idle period the cache storing should happen when larger changes has been detected (cumulative build time > 2 x avg cache store time). -* `idleTimeoutForInitialStore` {number} Time in ms after which idle period the initial cache storing should happen. -* `immutablePaths` {string|RegExp[]} List of paths that are managed by a package manager and contain a version or hash in its path so all files are immutable. -* `managedPaths` {string|RegExp[]} List of paths that are managed by a package manager and can be trusted to not be modified otherwise. -* `maxAge` {number} Time for which unused cache entries stay in the filesystem cache at minimum (in milliseconds). -* `maxMemoryGenerations` {number} Number of generations unused cache entries stay in memory cache at minimum (0 = no memory cache used, 1 = may be removed after unused for a single compilation, ..., Infinity: kept forever). Cache entries will be deserialized from disk when removed from memory cache. -* `memoryCacheUnaffected` {boolean} Additionally cache computation of modules that are unchanged and reference only unchanged modules in memory. -* `name` {string} Name for the cache. Different names will lead to different coexisting caches. -* `profile` {boolean} Track and log detailed timing information for individual cache items. -* `readonly` {boolean} Enable/disable readonly mode. -* `store` {"pack"} When to store data to the filesystem. (pack: Store data when compiler is idle in a single file). -* `type` {"filesystem"} Filesystem caching. -* `version` {string} Version of the cache data. Different versions won't allow to reuse the cache and override existing content. Update the version when config changed in a way which doesn't allow to reuse cache. This will invalidate the cache. - -*** - -## Interface: `GeneratorOptionsByModuleTypeKnown` - -Specify options for each generator. - -### Properties - -* `asset` {AssetGeneratorOptions} Generator options for asset modules. -* `asset/bytes` {EmptyGeneratorOptions} No generator options are supported for this module type. -* `asset/inline` {AssetInlineGeneratorOptions} Generator options for asset/inline modules. -* `asset/resource` {AssetResourceGeneratorOptions} Generator options for asset/resource modules. -* `asset/source` {EmptyGeneratorOptions} No generator options are supported for this module type. -* `css` {CssGeneratorOptions} Generator options for css modules. -* `css/auto` {CssModuleGeneratorOptions} Generator options for css/module modules. -* `css/global` {CssModuleGeneratorOptions} Generator options for css/module modules. -* `css/module` {CssModuleGeneratorOptions} Generator options for css/module modules. -* `javascript` {EmptyGeneratorOptions} No generator options are supported for this module type. -* `javascript/auto` {EmptyGeneratorOptions} No generator options are supported for this module type. -* `javascript/dynamic` {EmptyGeneratorOptions} No generator options are supported for this module type. -* `javascript/esm` {EmptyGeneratorOptions} No generator options are supported for this module type. -* `json` {JsonGeneratorOptions} Generator options for json modules. - -*** - -## Interface: `InputFileSystem` - -### Properties - -* `dirname` {object} -* `join` {object} -* `lstat` {LStatFs} -* `lstatSync` {LStatSync} -* `purge` {object} -* `readdir` {ReaddirFs} -* `readdirSync` {ReaddirSync} -* `readFile` {ReadFileFs} -* `readFileSync` {ReadFileSync} -* `readJson` {object} -* `readJsonSync` {object} -* `readlink` {ReadlinkFs} -* `readlinkSync` {ReadlinkSync} -* `realpath` {RealPathFs} -* `realpathSync` {RealPathSync} -* `relative` {object} -* `stat` {StatFs} -* `statSync` {StatSync} - -*** - -## Interface: `LibraryOptions` - -Options for library. - -### Properties - -* `amdContainer` {string} Add a container for define/require functions in the AMD module. -* `auxiliaryComment` {string|LibraryCustomUmdCommentObject} Add a comment in the UMD wrapper. -* `export` {string|string[]} Specify which export should be exposed as library. -* `name` {string|string[]|LibraryCustomUmdObject} The name of the library (some types allow unnamed libraries too). -* `type` {string} Type of library (types included by default are 'var', 'module', 'assign', 'assign-properties', 'this', 'window', 'self', 'global', 'commonjs', 'commonjs2', 'commonjs-module', 'commonjs-static', 'amd', 'amd-require', 'umd', 'umd2', 'jsonp', 'system', but others might be added by plugins). -* `umdNamedDefine` {boolean} If `output.libraryTarget` is set to umd and `output.library` is set, setting this to true will name the AMD module. - -*** - -## Interface: `LoaderDefinitionFunction(this, content[, sourceMap][, additionalData])` - -### Type Parameters - -#### OptionsType - -`OptionsType` = {object} - -#### ContextAdditions - -`ContextAdditions` = {object} - -* `this` {NormalModuleLoaderContext|LoaderRunnerLoaderContext|LoaderPluginLoaderContext|HotModuleReplacementPluginLoaderContext|ContextAdditions} -* `content` {string} -* `sourceMap` {string|RawSourceMap} -* `additionalData` {AdditionalData} -* Returns: {string|void|Buffer|Promise>} - -*** - -## Interface: `LoaderModule` - -### Type Parameters - -#### OptionsType - -`OptionsType` = {object} - -#### ContextAdditions - -`ContextAdditions` = {object} - -### Properties - -* `default` {RawLoaderDefinitionFunction|LoaderDefinitionFunction} -* `pitch` {PitchLoaderDefinitionFunction} -* `raw` {false} - -*** - -## Interface: `MemoryCacheOptions` - -Options object for in-memory caching. - -### Properties - -* `cacheUnaffected` {boolean} Additionally cache computation of modules that are unchanged and reference only unchanged modules. -* `maxGenerations` {number} Number of generations unused cache entries stay in memory cache at minimum (1 = may be removed after unused for a single compilation, ..., Infinity: kept forever). -* `type` {"memory"} In memory caching. - -*** - -## Interface: `ModuleOptions` - -Options affecting the normal modules (`NormalModuleFactory`). - -### Properties - -* `defaultRules` {false|""|0|"..."|RuleSetRule[]} An array of rules applied by default for modules. -* `exprContextCritical` {boolean} Enable warnings for full dynamic dependencies. -* `exprContextRecursive` {boolean} Enable recursive directory lookup for full dynamic dependencies. Deprecated: This option has moved to 'module.parser.javascript.exprContextRecursive'. -* `exprContextRegExp` {boolean|RegExp} Sets the default regular expression for full dynamic dependencies. Deprecated: This option has moved to 'module.parser.javascript.exprContextRegExp'. -* `exprContextRequest` {string} Set the default request for full dynamic dependencies. Deprecated: This option has moved to 'module.parser.javascript.exprContextRequest'. -* `generator` {GeneratorOptionsByModuleType} Specify options for each generator. -* `noParse` {string|RegExp|object|string|RegExp|object[]} Don't parse files matching. It's matched against the full resolved request. -* `parser` {ParserOptionsByModuleType} Specify options for each parser. -* `rules` {false|""|0|"..."|RuleSetRule[]} An array of rules applied for modules. -* `strictExportPresence` {boolean} Emit errors instead of warnings when imported names don't exist in imported module. Deprecated: This option has moved to 'module.parser.javascript.strictExportPresence'. -* `strictThisContextOnImports` {boolean} Handle the this context correctly according to the spec for namespace objects. Deprecated: This option has moved to 'module.parser.javascript.strictThisContextOnImports'. -* `unknownContextCritical` {boolean} Enable warnings when using the require function in a not statically analyse-able way. Deprecated: This option has moved to 'module.parser.javascript.unknownContextCritical'. -* `unknownContextRecursive` {boolean} Enable recursive directory lookup when using the require function in a not statically analyse-able way. Deprecated: This option has moved to 'module.parser.javascript.unknownContextRecursive'. -* `unknownContextRegExp` {boolean|RegExp} Sets the regular expression when using the require function in a not statically analyse-able way. Deprecated: This option has moved to 'module.parser.javascript.unknownContextRegExp'. -* `unknownContextRequest` {string} Sets the request when using the require function in a not statically analyse-able way. Deprecated: This option has moved to 'module.parser.javascript.unknownContextRequest'. -* `unsafeCache` {boolean|object} Cache the resolving of module requests. -* `wrappedContextCritical` {boolean} Enable warnings for partial dynamic dependencies. Deprecated: This option has moved to 'module.parser.javascript.wrappedContextCritical'. -* `wrappedContextRecursive` {boolean} Enable recursive directory lookup for partial dynamic dependencies. Deprecated: This option has moved to 'module.parser.javascript.wrappedContextRecursive'. -* `wrappedContextRegExp` {RegExp} Set the inner regular expression for partial dynamic dependencies. Deprecated: This option has moved to 'module.parser.javascript.wrappedContextRegExp'. - -*** - -## Interface: `MultiCompilerOptions` - -### Properties - -* `parallelism` {number} how many Compilers are allows to run at the same time in parallel - -*** - -## Interface: `ObjectDeserializerContext` - -### Properties - -* `read` {object} -* `setCircularReference` {object} - -*** - -## Interface: `ObjectSerializerContext` - -### Properties - -* `rollback` {object} -* `setCircularReference` {object} -* `snapshot` {object} -* `write` {object} -* `writeLazy` {object} -* `writeSeparate` {object} - -*** - -## Interface: `OutputFileSystem` - -### Properties - -* `createReadStream` {object} -* `dirname` {object} -* `join` {object} -* `lstat` {LStatFs} -* `mkdir` {Mkdir} -* `readdir` {ReaddirFs} -* `readFile` {ReadFileFs} -* `relative` {object} -* `rmdir` {object} -* `stat` {StatFs} -* `unlink` {object} -* `writeFile` {WriteFile} - -*** - -## Interface: `ParserOptionsByModuleTypeKnown` - -Specify options for each parser. - -### Properties - -* `asset` {AssetParserOptions} Parser options for asset modules. -* `asset/bytes` {EmptyParserOptions} No parser options are supported for this module type. -* `asset/inline` {EmptyParserOptions} No parser options are supported for this module type. -* `asset/resource` {EmptyParserOptions} No parser options are supported for this module type. -* `asset/source` {EmptyParserOptions} No parser options are supported for this module type. -* `css` {CssParserOptions} Parser options for css modules. -* `css/auto` {CssModuleParserOptions} Parser options for css/module modules. -* `css/global` {CssModuleParserOptions} Parser options for css/module modules. -* `css/module` {CssModuleParserOptions} Parser options for css/module modules. -* `javascript` {JavascriptParserOptions} Parser options for javascript modules. -* `javascript/auto` {JavascriptParserOptions} Parser options for javascript modules. -* `javascript/dynamic` {JavascriptParserOptions} Parser options for javascript modules. -* `javascript/esm` {JavascriptParserOptions} Parser options for javascript modules. -* `json` {JsonParserOptions} Parser options for JSON modules. - -*** - -## Interface: `PathData` - -### Properties - -* `basename` {string} -* `chunk` {Chunk|ChunkPathData} -* `chunkGraph` {ChunkGraph} -* `contentHash` {string} -* `contentHashType` {string} -* `contentHashWithLength` {object} -* `filename` {string} -* `hash` {string} -* `hashWithLength` {object} -* `module` {Module|ModulePathData} -* `noChunkHash` {boolean} -* `prepareId` {object} -* `query` {string} -* `runtime` {RuntimeSpec} -* `url` {string} - -*** - -## Interface: `PitchLoaderDefinitionFunction(this, remainingRequest, previousRequest, data)` - -### Type Parameters - -#### OptionsType - -`OptionsType` = {object} - -#### ContextAdditions - -`ContextAdditions` = {object} - -* `this` {NormalModuleLoaderContext|LoaderRunnerLoaderContext|LoaderPluginLoaderContext|HotModuleReplacementPluginLoaderContext|ContextAdditions} -* `remainingRequest` {string} -* `previousRequest` {string} -* `data` {object} -* Returns: {string|void|Buffer|Promise>} - -*** - -## Interface: `Problem` - -### Properties - -* `argument` {string} -* `expected` {string} -* `index` {number} -* `path` {string} -* `type` {ProblemType} -* `value` {string|number|boolean|RegExp} - -*** - -## Interface: `RawLoaderDefinitionFunction(this, content[, sourceMap][, additionalData])` - -### Type Parameters - -#### OptionsType - -`OptionsType` = {object} - -#### ContextAdditions - -`ContextAdditions` = {object} - -* `this` {NormalModuleLoaderContext|LoaderRunnerLoaderContext|LoaderPluginLoaderContext|HotModuleReplacementPluginLoaderContext|ContextAdditions} -* `content` {Buffer} -* `sourceMap` {string|RawSourceMap} -* `additionalData` {AdditionalData} -* Returns: {string|void|Buffer|Promise>} - -*** - -## Interface: `RenderManifestOptions` - -### Properties - -* `chunk` {Chunk} the chunk used to render -* `chunkGraph` {ChunkGraph} -* `codeGenerationResults` {CodeGenerationResults} -* `dependencyTemplates` {DependencyTemplates} -* `fullHash` {string} -* `hash` {string} -* `moduleGraph` {ModuleGraph} -* `moduleTemplates` {object} -* `outputOptions` {OutputNormalizedWithDefaults} -* `runtimeTemplate` {RuntimeTemplate} - -*** - -## Interface: `ResolveData` - -### Properties - -* `attributes` {ImportAttributes} -* `cacheable` {boolean} allow to use the unsafe cache -* `context` {string} -* `contextDependencies` {LazySet} -* `contextInfo` {ModuleFactoryCreateDataContextInfo} -* `createData` {Partial} -* `dependencies` {ModuleDependency[]} -* `dependencyType` {string} -* `fileDependencies` {LazySet} -* `ignoredModule` {Module} -* `missingDependencies` {LazySet} -* `request` {string} -* `resolveOptions` {ResolveOptions} - -*** - -## Interface: `ResolveOptions` - -Options object for resolving requests. - -### Properties - -* `alias` {object[]|object} Redirect module requests. -* `aliasFields` {string|string[][]} Fields in the description file (usually package.json) which are used to redirect requests inside the module. -* `byDependency` {object} Extra resolve options per dependency category. Typical categories are "commonjs", "amd", "esm". -* `cache` {boolean} Enable caching of successfully resolved requests (cache entries are revalidated). -* `cachePredicate` {object} Predicate function to decide which requests should be cached. -* `cacheWithContext` {boolean} Include the context information in the cache identifier when caching. -* `conditionNames` {string[]} Condition names for exports field entry point. -* `descriptionFiles` {string[]} Filenames used to find a description file (like a package.json). -* `enforceExtension` {boolean} Enforce the resolver to use one of the extensions from the extensions option (User must specify requests without extension). -* `exportsFields` {string[]} Field names from the description file (usually package.json) which are used to provide entry points of a package. -* `extensionAlias` {object} An object which maps extension to extension aliases. -* `extensions` {string[]} Extensions added to the request when trying to find the file. -* `fallback` {object[]|object} Redirect module requests when normal resolving fails. -* `fileSystem` {InputFileSystem} Filesystem for the resolver. -* `fullySpecified` {boolean} Treats the request specified by the user as fully specified, meaning no extensions are added and the mainFiles in directories are not resolved (This doesn't affect requests from mainFields, aliasFields or aliases). -* `importsFields` {string[]} Field names from the description file (usually package.json) which are used to provide internal request of a package (requests starting with # are considered as internal). -* `mainFields` {string|string[][]} Field names from the description file (package.json) which are used to find the default entry point. -* `mainFiles` {string[]} Filenames used to find the default entry point if there is no description file or main field. -* `modules` {string[]} Folder names or directory paths where to find modules. -* `plugins` {false|""|0|"..."|object|object[]} Plugins for the resolver. -* `preferAbsolute` {boolean} Prefer to resolve server-relative URLs (starting with '/') as absolute paths before falling back to resolve in 'resolve.roots'. -* `preferRelative` {boolean} Prefer to resolve module requests as relative request and fallback to resolving as module. -* `resolver` {Resolver} Custom resolver. -* `restrictions` {string|RegExp[]} A list of resolve restrictions. Resolve results must fulfill all of these restrictions to resolve successfully. Other resolve paths are taken when restrictions are not met. -* `roots` {string[]} A list of directories in which requests that are server-relative URLs (starting with '/') are resolved. -* `symlinks` {boolean} Enable resolving symlinks to the original location. -* `tsconfig` {string|boolean|object} TypeScript config for paths mapping. Can be `false` (disabled), `true` (use default `tsconfig.json`), a string path to `tsconfig.json`, or an object with `configFile` and `references` options. -* `unsafeCache` {boolean|object} Enable caching of successfully resolved requests (cache entries are not revalidated). -* `useSyncFileSystemCalls` {boolean} Use synchronous filesystem calls for the resolver. - -*** - -## Interface: `RuleSetRule` - -A rule description with conditions and effects for modules. - -### Properties - -* `assert` {object} Match on import assertions of the dependency. -* `compiler` {string|RegExp|RuleSetLogicalConditions|object|RuleSetCondition[]} Match the child compiler name. -* `dependency` {string|RegExp|RuleSetLogicalConditions|RuleSetCondition[]|object} Match dependency type. -* `descriptionData` {object} Match values of properties in the description file (usually package.json). -* `enforce` {"pre"|"post"} Enforce this rule as pre or post step. -* `exclude` {string|RegExp|RuleSetLogicalConditionsAbsolute|object|RuleSetConditionAbsolute[]} Shortcut for resource.exclude. -* `extractSourceMap` {boolean} Enable/Disable extracting source map. -* `generator` {object} The options for the module generator. -* `include` {string|RegExp|RuleSetLogicalConditionsAbsolute|RuleSetConditionAbsolute[]|object} Shortcut for resource.include. -* `issuer` {string|RegExp|RuleSetLogicalConditionsAbsolute|RuleSetConditionAbsolute[]|object} Match the issuer of the module (The module pointing to this module). -* `issuerLayer` {string|RegExp|RuleSetLogicalConditions|RuleSetCondition[]|object} Match layer of the issuer of this module (The module pointing to this module). -* `layer` {string} Specifies the layer in which the module should be placed in. -* `loader` {string} Shortcut for use.loader. -* `mimetype` {string|RegExp|RuleSetLogicalConditions|RuleSetCondition[]|object} Match module mimetype when load from Data URI. -* `oneOf` {false|""|0|RuleSetRule[]} Only execute the first matching rule in this array. -* `options` {string|object} Shortcut for use.options. -* `parser` {object} Options for parsing. -* `realResource` {string|RegExp|RuleSetLogicalConditionsAbsolute|RuleSetConditionAbsolute[]|object} Match the real resource path of the module. -* `resolve` {ResolveOptions} Options for the resolver. -* `resource` {string|RegExp|RuleSetLogicalConditionsAbsolute|RuleSetConditionAbsolute[]|object} Match the resource path of the module. -* `resourceFragment` {string|RegExp|RuleSetLogicalConditions|RuleSetCondition[]|object} Match the resource fragment of the module. -* `resourceQuery` {string|RegExp|RuleSetLogicalConditions|RuleSetCondition[]|object} Match the resource query of the module. -* `rules` {false|""|0|RuleSetRule[]} Match and execute these rules when this rule is matched. -* `scheme` {string|RegExp|RuleSetLogicalConditions|RuleSetCondition[]|object} Match module scheme. -* `sideEffects` {boolean} Flags a module as with or without side effects. -* `test` {string|RegExp|RuleSetLogicalConditionsAbsolute|RuleSetConditionAbsolute[]|object} Shortcut for resource.test. -* `type` {string} Module type to use for the module. -* `use` {string|RuleSetUseFunction|string|false|0|RuleSetUseFunction|object[]|object} Modifiers applied to the module when rule is matched. -* `with` {object} Match on import attributes of the dependency. - -*** - -## Interface: `StatsOptions` - -Stats options object. - -### Properties - -* `all` {boolean} Fallback value for stats options when an option is not defined (has precedence over local webpack defaults). -* `assets` {boolean} Add assets information. -* `assetsSort` {string|false} Sort the assets by that field. -* `assetsSpace` {number} Space to display assets (groups will be collapsed to fit this space). -* `builtAt` {boolean} Add built at time information. -* `cached` {boolean} Add information about cached (not built) modules (deprecated: use 'cachedModules' instead). -* `cachedAssets` {boolean} Show cached assets (setting this to `false` only shows emitted files). -* `cachedModules` {boolean} Add information about cached (not built) modules. -* `children` {boolean|"verbose"|"none"|"summary"|"errors-only"|"errors-warnings"|"minimal"|"normal"|"detailed"|StatsOptions|StatsValue[]} Add children information. -* `chunkGroupAuxiliary` {boolean} Display auxiliary assets in chunk groups. -* `chunkGroupChildren` {boolean} Display children of chunk groups. -* `chunkGroupMaxAssets` {number} Limit of assets displayed in chunk groups. -* `chunkGroups` {boolean} Display all chunk groups with the corresponding bundles. -* `chunkModules` {boolean} Add built modules information to chunk information. -* `chunkModulesSpace` {number} Space to display chunk modules (groups will be collapsed to fit this space, value is in number of modules/group). -* `chunkOrigins` {boolean} Add the origins of chunks and chunk merging info. -* `chunkRelations` {boolean} Add information about parent, children and sibling chunks to chunk information. -* `chunks` {boolean} Add chunk information. -* `chunksSort` {string|false} Sort the chunks by that field. -* `colors` {boolean|object} Enables/Disables colorful output. -* `context` {string} Context directory for request shortening. -* `dependentModules` {boolean} Show chunk modules that are dependencies of other modules of the chunk. -* `depth` {boolean} Add module depth in module graph. -* `entrypoints` {boolean|"auto"} Display the entry points with the corresponding bundles. -* `env` {boolean} Add --env information. -* `errorCause` {boolean|"auto"} Add cause to errors. -* `errorDetails` {boolean|"auto"} Add details to errors (like resolving log). -* `errorErrors` {boolean|"auto"} Add nested errors to errors (like in AggregateError). -* `errors` {boolean} Add errors. -* `errorsCount` {boolean} Add errors count. -* `errorsSpace` {number} Space to display errors (value is in number of lines). -* `errorStack` {boolean} Add internal stack trace to errors. -* `exclude` {string|boolean|RegExp|ModuleFilterItemTypes[]|object} Please use excludeModules instead. -* `excludeAssets` {string|RegExp|AssetFilterItemTypes[]|object} Suppress assets that match the specified filters. Filters can be Strings, RegExps or Functions. -* `excludeModules` {string|boolean|RegExp|ModuleFilterItemTypes[]|object} Suppress modules that match the specified filters. Filters can be Strings, RegExps, Booleans or Functions. -* `groupAssetsByChunk` {boolean} Group assets by how their are related to chunks. -* `groupAssetsByEmitStatus` {boolean} Group assets by their status (emitted, compared for emit or cached). -* `groupAssetsByExtension` {boolean} Group assets by their extension. -* `groupAssetsByInfo` {boolean} Group assets by their asset info (immutable, development, hotModuleReplacement, etc). -* `groupAssetsByPath` {boolean} Group assets by their path. -* `groupModulesByAttributes` {boolean} Group modules by their attributes (errors, warnings, assets, optional, orphan, or dependent). -* `groupModulesByCacheStatus` {boolean} Group modules by their status (cached or built and cacheable). -* `groupModulesByExtension` {boolean} Group modules by their extension. -* `groupModulesByLayer` {boolean} Group modules by their layer. -* `groupModulesByPath` {boolean} Group modules by their path. -* `groupModulesByType` {boolean} Group modules by their type. -* `groupReasonsByOrigin` {boolean} Group reasons by their origin module. -* `hash` {boolean} Add the hash of the compilation. -* `ids` {boolean} Add ids. -* `logging` {boolean|"error"|"warn"|"info"|"log"|"verbose"|"none"} Add logging output. -* `loggingDebug` {string|boolean|RegExp|FilterItemTypes[]|object} Include debug logging of specified loggers (i. e. for plugins or loaders). Filters can be Strings, RegExps or Functions. -* `loggingTrace` {boolean} Add stack traces to logging output. -* `moduleAssets` {boolean} Add information about assets inside modules. -* `modules` {boolean} Add built modules information. -* `modulesSort` {string|false} Sort the modules by that field. -* `modulesSpace` {number} Space to display modules (groups will be collapsed to fit this space, value is in number of modules/groups). -* `moduleTrace` {boolean} Add dependencies and origin of warnings/errors. -* `nestedModules` {boolean} Add information about modules nested in other modules (like with module concatenation). -* `nestedModulesSpace` {number} Space to display modules nested within other modules (groups will be collapsed to fit this space, value is in number of modules/group). -* `optimizationBailout` {boolean} Show reasons why optimization bailed out for modules. -* `orphanModules` {boolean} Add information about orphan modules. -* `outputPath` {boolean} Add output path information. -* `performance` {boolean} Add performance hint flags. -* `preset` {string|boolean} Preset for the default values. -* `providedExports` {boolean} Show exports provided by modules. -* `publicPath` {boolean} Add public path information. -* `reasons` {boolean} Add information about the reasons why modules are included. -* `reasonsSpace` {number} Space to display reasons (groups will be collapsed to fit this space). -* `relatedAssets` {boolean} Add information about assets that are related to other assets (like SourceMaps for assets). -* `runtime` {boolean} Add information about runtime modules (deprecated: use 'runtimeModules' instead). -* `runtimeModules` {boolean} Add information about runtime modules. -* `source` {boolean} Add the source code of modules. -* `timings` {boolean} Add timing information. -* `usedExports` {boolean} Show exports used by modules. -* `version` {boolean} Add webpack version information. -* `warnings` {boolean} Add warnings. -* `warningsCount` {boolean} Add warnings count. -* `warningsFilter` {string|RegExp|WarningFilterItemTypes[]|object} Suppress listing warnings that match the specified filters (they will still be counted). Filters can be Strings, RegExps or Functions. -* `warningsSpace` {number} Space to display warnings (value is in number of lines). - -*** - -## Interface: `WebpackOptionsNormalized` - -Normalized webpack options object. - -### Properties - -* `amd` {false|object} Set the value of `require.amd` and `define.amd`. Or disable AMD support. -* `bail` {boolean} Report the first error as a hard error instead of tolerating it. -* `cache` {CacheOptionsNormalized} Cache generated modules and chunks to improve performance for multiple incremental builds. -* `context` {string} The base directory (absolute path!) for resolving the `entry` option. If `output.pathinfo` is set, the included pathinfo is shortened to this directory. -* `dependencies` {string[]} References to other configurations to depend on. -* `devServer` {false|object} Options for the webpack-dev-server. -* `devtool` {string|false|object[]} A developer tool to enhance debugging (false | eval | [inline-|hidden-|eval-][nosources-][cheap-[module-]]source-map). -* `dotenv` {boolean|DotenvPluginOptions} Enable and configure the Dotenv plugin to load environment variables from .env files. -* `entry` {EntryNormalized} The entry point(s) of the compilation. -* `experiments` {ExperimentsNormalized} Enables/Disables experiments (experimental features with relax SemVer compatibility). -* `externals` {Externals} Specify dependencies that shouldn't be resolved by webpack, but should become dependencies of the resulting bundle. The kind of the dependency depends on `output.libraryTarget`. -* `externalsPresets` {ExternalsPresets} Enable presets of externals for specific targets. -* `externalsType` {"asset"|"module"|"css-import"|"css-url"|"global"|"import"|"commonjs"|"jsonp"|"promise"|"this"|"var"|"assign"|"window"|"self"|"commonjs2"|"commonjs-module"|"commonjs-static"|"amd"|"amd-require"|"umd"|"umd2"|"system"|"module-import"|"script"|"node-commonjs"} Specifies the default type of externals ('amd*', 'umd*', 'system' and 'jsonp' depend on output.libraryTarget set to the same value). -* `ignoreWarnings` {object[]} Ignore specific warnings. -* `infrastructureLogging` {InfrastructureLogging} Options for infrastructure level logging. -* `loader` {Loader} Custom values available in the loader context. -* `mode` {"development"|"none"|"production"} Enable production optimizations or development hints. -* `module` {ModuleOptionsNormalized} Options affecting the normal modules (`NormalModuleFactory`). -* `name` {string} Name of the configuration. Used when loading multiple configurations. -* `node` {Node} Include polyfills or mocks for various node stuff. -* `optimization` {OptimizationNormalized} Enables/Disables integrated optimizations. -* `output` {OutputNormalized} Normalized options affecting the output of the compilation. `output` options tell webpack how to write the compiled files to disk. -* `parallelism` {number} The number of parallel processed modules in the compilation. -* `performance` {false|PerformanceOptions} Configuration for web performance recommendations. -* `plugins` {WebpackPluginInstance|object[]} Add additional plugins to the compiler. -* `profile` {boolean} Capture timing information for each module. -* `recordsInputPath` {string|false} Store compiler state to a json file. -* `recordsOutputPath` {string|false} Load compiler state from a json file. -* `resolve` {ResolveOptions} Options for the resolver. -* `resolveLoader` {ResolveOptions} Options for the resolver when resolving loaders. -* `snapshot` {SnapshotOptionsWebpackOptions} Options affecting how file system snapshots are created and validated. -* `stats` {StatsValue} Stats options object or preset name. -* `target` {string|false|string[]} Environment to build for. An array of environments to build for all of them when possible. -* `validate` {boolean} Enable validation of webpack configuration. Defaults to true in development mode. In production mode, defaults to true unless futureDefaults is enabled, then defaults to false. -* `watch` {boolean} Enter watch mode, which rebuilds on file change. -* `watchOptions` {WatchOptions} Options for the watcher. - -*** - -## Interface: `WebpackPluginInstance` - -Plugin instance. - -### Indexable - -> \[`index`: {string}\]: {any} - -### Properties - -* `apply` {object} The run point of the plugin, required method. - -*** - -## Type: `AssetInfo` - -> **AssetInfo** = {KnownAssetInfo|Record} - -*** - -## Type: `Entry` - -> **Entry** = {string|object|EntryObject|string[]} - -*** - -## Type: `EntryNormalized` - -> **EntryNormalized** = {object|EntryStaticNormalized} - -*** - -## Type: `EntryOptions` - -> **EntryOptions** = {object|Omit} - -### Type Declaration - -* `name` {string} - -*** - -## Type: `ExternalItem` - -> **ExternalItem** = {string|RegExp|ExternalItemObjectKnown|ExternalItemObjectUnknown|object|object} - -*** - -## Type: `ExternalItemFunction` - -> **ExternalItemFunction** = {object|object} - -*** - -## Type: `ExternalItemFunctionCallback` - -> **ExternalItemFunctionCallback** = {object} - -* `data` {ExternalItemFunctionData} -* `callback` {object} -* Returns: {void} - -*** - -## Type: `ExternalItemFunctionDataGetResolve` - -> **ExternalItemFunctionDataGetResolve** = {object} - -* `options` {ResolveOptions} -* Returns: {object|object} - -*** - -## Type: `ExternalItemFunctionDataGetResolveCallbackResult` - -> **ExternalItemFunctionDataGetResolveCallbackResult** = {object} - -* `context` {string} -* `request` {string} -* `callback` {object} -* Returns: {void} - -*** - -## Type: `ExternalItemFunctionDataGetResolveResult` - -> **ExternalItemFunctionDataGetResolveResult** = {object} - -* `context` {string} -* `request` {string} -* Returns: {Promise} - -*** - -## Type: `ExternalItemFunctionPromise` - -> **ExternalItemFunctionPromise** = {object} - -* `data` {ExternalItemFunctionData} -* Returns: {Promise} - -*** - -## Type: `ExternalItemValue` - -> **ExternalItemValue** = {string|boolean|string[]|object} - -*** - -## Type: `Externals` - -> **Externals** = {string|RegExp|ExternalItemObjectKnown|ExternalItemObjectUnknown|object|object|ExternalItem[]} - -*** - -## Type: `LoaderContext` - -> **LoaderContext**\<`OptionsType`\> = {NormalModuleLoaderContext|LoaderRunnerLoaderContext|LoaderPluginLoaderContext|HotModuleReplacementPluginLoaderContext} - -### Type Parameters - -#### OptionsType - -`OptionsType` - -*** - -## Type: `LoaderDefinition` - -> **LoaderDefinition**\<`OptionsType`, `ContextAdditions`\> = {LoaderDefinitionFunction|object} - -### Type Declaration - -* `pitch` {PitchLoaderDefinitionFunction} -* `raw` {false} - -### Type Parameters - -#### OptionsType - -`OptionsType` = {object} - -#### ContextAdditions - -`ContextAdditions` = {object} - -*** - -## Type: `MultiConfiguration` - -> **MultiConfiguration** = {ReadonlyArray|MultiCompilerOptions} - -*** - -## Type: `ParserState` - -> **ParserState** = {ParserStateBase|Record} - -*** - -## Type: `RawLoaderDefinition` - -> **RawLoaderDefinition**\<`OptionsType`, `ContextAdditions`\> = {RawLoaderDefinitionFunction|object} - -### Type Declaration - -* `pitch` {PitchLoaderDefinitionFunction} -* `raw` {true} - -### Type Parameters - -#### OptionsType - -`OptionsType` = {object} - -#### ContextAdditions - -`ContextAdditions` = {object} - -*** - -## Type: `RenderManifestEntry` - -> **RenderManifestEntry** = {RenderManifestEntryTemplated|RenderManifestEntryStatic} - -*** - -## Type: `ResolvePluginInstance` - -> **ResolvePluginInstance** = {object|object} - -### Union Members - -#### Type Literal - -{object} - -#### Index Signature - -\[`index`: {string}\]: {any} - -* `apply` {object} The run point of the plugin, required method. - -*** - -#### Function - -{object} - -*** - -## Type: `RuleSetCondition` - -> **RuleSetCondition** = {string|RegExp|object|RuleSetLogicalConditions|RuleSetCondition[]} - -*** - -## Type: `RuleSetConditionAbsolute` - -> **RuleSetConditionAbsolute** = {string|RegExp|object|RuleSetLogicalConditionsAbsolute|RuleSetConditionAbsolute[]} - -*** - -## Type: `RuleSetUse` - -> **RuleSetUse** = {string|undefined|null|string|false|0|RuleSetUseFunction|object[]|RuleSetUseFunction|object} - -### Union Members - -{string} - -*** - -{undefined|null|string|false|0|RuleSetUseFunction|object[]} - -*** - -{RuleSetUseFunction} - -*** - -#### Type Literal - -{object} - -* `ident` {string} Unique loader options identifier. -* `loader` {string} Loader name. -* `options` {string|object} Loader options. - -*** - -## Type: `RuleSetUseFunction` - -> **RuleSetUseFunction** = {object} - -* `data` {EffectData} -* Returns: {string|RuleSetUseFunction|object|undefined|null|string|false|0|RuleSetUseFunction|object[]} - -*** - -## Type: `RuleSetUseItem` - -> **RuleSetUseItem** = {string|RuleSetUseFunction|object} - -### Union Members - -{string} - -*** - -{RuleSetUseFunction} - -*** - -#### Type Literal - -{object} - -* `ident` {string} Unique loader options identifier. -* `loader` {string} Loader name. -* `options` {string|object} Loader options. - -*** - -## Type: `StatsAsset` - -> **StatsAsset** = {KnownStatsAsset|Record} - -*** - -## Type: `StatsChunk` - -> **StatsChunk** = {KnownStatsChunk|Record} - -*** - -## Type: `StatsChunkGroup` - -> **StatsChunkGroup** = {KnownStatsChunkGroup|Record} - -*** - -## Type: `StatsChunkOrigin` - -> **StatsChunkOrigin** = {KnownStatsChunkOrigin|Record} - -*** - -## Type: `StatsCompilation` - -> **StatsCompilation** = {KnownStatsCompilation|Record} - -*** - -## Type: `StatsError` - -> **StatsError** = {KnownStatsError|Record} - -*** - -## Type: `StatsLogging` - -> **StatsLogging** = {KnownStatsLogging|Record} - -*** - -## Type: `StatsLoggingEntry` - -> **StatsLoggingEntry** = {KnownStatsLoggingEntry|Record} - -*** - -## Type: `StatsModule` - -> **StatsModule** = {KnownStatsModule|Record} - -*** - -## Type: `StatsModuleIssuer` - -> **StatsModuleIssuer** = {KnownStatsModuleIssuer|Record} - -*** - -## Type: `StatsModuleReason` - -> **StatsModuleReason** = {KnownStatsModuleReason|Record} - -*** - -## Type: `StatsModuleTraceDependency` - -> **StatsModuleTraceDependency** = {KnownStatsModuleTraceDependency|Record} - -*** - -## Type: `StatsModuleTraceItem` - -> **StatsModuleTraceItem** = {KnownStatsModuleTraceItem|Record} - -*** - -## Type: `StatsProfile` - -> **StatsProfile** = {KnownStatsProfile|Record} - -*** - -## Type: `TemplatePath` - -> **TemplatePath** = {string|object} - -*** - -## Type: `WebpackPluginFunction` - -> **WebpackPluginFunction** = {object} - -* `this` {Compiler} -* `compiler` {Compiler} -* Returns: {void} - -*** - -## `UsageState` - -> `const` **UsageState**: {Readonly} - -*** - -## `validate` - -> `const` **validate**: {object} - -* `configuration` {Configuration|MultiConfiguration} -* Returns: {void} - -*** - -## `validateSchema` - -> `const` **validateSchema**: {object} - -* `schema` {Parameters} -* `options` {Parameters} -* `validationConfiguration` {ValidationErrorConfiguration} -* Returns: {void} - -*** - -## `version` - -> `const` **version**: {string} - -*** - -## `webpack` - -> `const` **webpack**: {_functionWebpack} - -*** - -## `export=(options, callback)` - -### Call Signature - -* `options` {Configuration} -* `callback` {CallbackWebpackFunction_2} -* Returns: {Compiler} - -### Call Signature - -* `options` {Configuration} -* Returns: {Compiler} - -### Call Signature - -* `options` {MultiConfiguration} -* `callback` {CallbackWebpackFunction_2} -* Returns: {MultiCompiler} - -### Call Signature - -* `options` {MultiConfiguration} -* Returns: {MultiCompiler} diff --git a/pages/v5.x/ids/ChunkModuleIdRangePlugin.md b/pages/v5.x/ids/ChunkModuleIdRangePlugin.md new file mode 100644 index 0000000..64bfd28 --- /dev/null +++ b/pages/v5.x/ids/ChunkModuleIdRangePlugin.md @@ -0,0 +1,33 @@ +# ChunkModuleIdRangePlugin + + + +## Class: `ChunkModuleIdRangePlugin` + +### Constructors + +#### `new ChunkModuleIdRangePlugin(options)` + +##### Parameters + +* `options` {ChunkModuleIdRangePluginOptions} + +* Returns: {ChunkModuleIdRangePlugin} + +### Properties + +#### `options` + +* Type: {ChunkModuleIdRangePluginOptions} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} + +Apply the plugin diff --git a/pages/v5.x/ids/DeterministicChunkIdsPlugin.md b/pages/v5.x/ids/DeterministicChunkIdsPlugin.md new file mode 100644 index 0000000..c594c96 --- /dev/null +++ b/pages/v5.x/ids/DeterministicChunkIdsPlugin.md @@ -0,0 +1,33 @@ +# DeterministicChunkIdsPlugin + + + +## Class: `DeterministicChunkIdsPlugin` + +### Constructors + +#### `new DeterministicChunkIdsPlugin([options])` + +##### Parameters + +* `options` {DeterministicChunkIdsPluginOptions} + +* Returns: {DeterministicChunkIdsPlugin} + +### Properties + +#### `options` + +* Type: {DeterministicChunkIdsPluginOptions} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} + +Apply the plugin diff --git a/pages/v5.x/ids/DeterministicModuleIdsPlugin.md b/pages/v5.x/ids/DeterministicModuleIdsPlugin.md new file mode 100644 index 0000000..0b8b153 --- /dev/null +++ b/pages/v5.x/ids/DeterministicModuleIdsPlugin.md @@ -0,0 +1,33 @@ +# DeterministicModuleIdsPlugin + + + +## Class: `DeterministicModuleIdsPlugin` + +### Constructors + +#### `new DeterministicModuleIdsPlugin([options])` + +##### Parameters + +* `options` {DeterministicModuleIdsPluginOptions} + +* Returns: {DeterministicModuleIdsPlugin} + +### Properties + +#### `options` + +* Type: {DeterministicModuleIdsPluginOptions} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} + +Apply the plugin diff --git a/pages/v5.x/ids/HashedModuleIdsPlugin.md b/pages/v5.x/ids/HashedModuleIdsPlugin.md new file mode 100644 index 0000000..8d240cf --- /dev/null +++ b/pages/v5.x/ids/HashedModuleIdsPlugin.md @@ -0,0 +1,33 @@ +# HashedModuleIdsPlugin + + + +## Class: `HashedModuleIdsPlugin` + +### Constructors + +#### `new HashedModuleIdsPlugin([options])` + +##### Parameters + +* `options` {HashedModuleIdsPluginOptions} + +* Returns: {HashedModuleIdsPlugin} + +### Properties + +#### `options` + +* Type: {HashedModuleIdsPluginOptions} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} + +Apply the plugin diff --git a/pages/v5.x/ids/NamedChunkIdsPlugin.md b/pages/v5.x/ids/NamedChunkIdsPlugin.md new file mode 100644 index 0000000..c0b2a9d --- /dev/null +++ b/pages/v5.x/ids/NamedChunkIdsPlugin.md @@ -0,0 +1,33 @@ +# NamedChunkIdsPlugin + + + +## Class: `NamedChunkIdsPlugin` + +### Constructors + +#### `new NamedChunkIdsPlugin([options])` + +##### Parameters + +* `options` {NamedChunkIdsPluginOptions} + +* Returns: {NamedChunkIdsPlugin} + +### Properties + +#### `options` + +* Type: {NamedChunkIdsPluginOptions} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} + +Apply the plugin diff --git a/pages/v5.x/ids/NamedModuleIdsPlugin.md b/pages/v5.x/ids/NamedModuleIdsPlugin.md new file mode 100644 index 0000000..91a28b5 --- /dev/null +++ b/pages/v5.x/ids/NamedModuleIdsPlugin.md @@ -0,0 +1,33 @@ +# NamedModuleIdsPlugin + + + +## Class: `NamedModuleIdsPlugin` + +### Constructors + +#### `new NamedModuleIdsPlugin([options])` + +##### Parameters + +* `options` {NamedModuleIdsPluginOptions} + +* Returns: {NamedModuleIdsPlugin} + +### Properties + +#### `options` + +* Type: {NamedModuleIdsPluginOptions} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} + +Apply the plugin diff --git a/pages/v5.x/ids/NaturalModuleIdsPlugin.md b/pages/v5.x/ids/NaturalModuleIdsPlugin.md new file mode 100644 index 0000000..33dbc53 --- /dev/null +++ b/pages/v5.x/ids/NaturalModuleIdsPlugin.md @@ -0,0 +1,23 @@ +# NaturalModuleIdsPlugin + + + +## Class: `NaturalModuleIdsPlugin` + +### Constructors + +#### `new NaturalModuleIdsPlugin()` + +* Returns: {NaturalModuleIdsPlugin} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} + +Apply the plugin diff --git a/pages/v5.x/ids/OccurrenceChunkIdsPlugin.md b/pages/v5.x/ids/OccurrenceChunkIdsPlugin.md new file mode 100644 index 0000000..c217e46 --- /dev/null +++ b/pages/v5.x/ids/OccurrenceChunkIdsPlugin.md @@ -0,0 +1,33 @@ +# OccurrenceChunkIdsPlugin + + + +## Class: `OccurrenceChunkIdsPlugin` + +### Constructors + +#### `new OccurrenceChunkIdsPlugin([options])` + +##### Parameters + +* `options` {OccurrenceChunkIdsPluginOptions} + +* Returns: {OccurrenceChunkIdsPlugin} + +### Properties + +#### `options` + +* Type: {OccurrenceChunkIdsPluginOptions} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} + +Apply the plugin diff --git a/pages/v5.x/ids/OccurrenceModuleIdsPlugin.md b/pages/v5.x/ids/OccurrenceModuleIdsPlugin.md new file mode 100644 index 0000000..4b3c3b1 --- /dev/null +++ b/pages/v5.x/ids/OccurrenceModuleIdsPlugin.md @@ -0,0 +1,33 @@ +# OccurrenceModuleIdsPlugin + + + +## Class: `OccurrenceModuleIdsPlugin` + +### Constructors + +#### `new OccurrenceModuleIdsPlugin([options])` + +##### Parameters + +* `options` {OccurrenceModuleIdsPluginOptions} + +* Returns: {OccurrenceModuleIdsPlugin} + +### Properties + +#### `options` + +* Type: {OccurrenceModuleIdsPluginOptions} + +### Methods + +#### `apply(compiler)` + +##### Parameters + +* `compiler` {Compiler} + +* Returns: {void} + +Apply the plugin diff --git a/pages/v5.x/ids/index.md b/pages/v5.x/ids/index.md new file mode 100644 index 0000000..4998766 --- /dev/null +++ b/pages/v5.x/ids/index.md @@ -0,0 +1,17 @@ +# ids + + + +## `ids` + +* Type: {object} + +* `ChunkModuleIdRangePlugin` {ChunkModuleIdRangePlugin} +* `DeterministicChunkIdsPlugin` {DeterministicChunkIdsPlugin} +* `DeterministicModuleIdsPlugin` {DeterministicModuleIdsPlugin} +* `HashedModuleIdsPlugin` {HashedModuleIdsPlugin} +* `NamedChunkIdsPlugin` {NamedChunkIdsPlugin} +* `NamedModuleIdsPlugin` {NamedModuleIdsPlugin} +* `NaturalModuleIdsPlugin` {NaturalModuleIdsPlugin} +* `OccurrenceChunkIdsPlugin` {OccurrenceChunkIdsPlugin} +* `OccurrenceModuleIdsPlugin` {OccurrenceModuleIdsPlugin} diff --git a/pages/v5.x/index.md b/pages/v5.x/index.md index e4abe0c..fdf47ee 100644 --- a/pages/v5.x/index.md +++ b/pages/v5.x/index.md @@ -1,661 +1,228 @@ -
- - - -
-
- -[![npm][npm]][npm-url] - -[![node][node]][node-url] -[![builds1][builds1]][builds1-url] -[![dependency-review][dependency-review]][dependency-review-url] -[![coverage][cover]][cover-url] -[![pkg.pr.new](https://pkg.pr.new/badge/webpack/webpack)](https://pkg.pr.new/~/webpack/webpack) -[![PR's welcome][prs]][prs-url] -[![compatibility-score](https://api.dependabot.com/badges/compatibility_score?dependency-name=webpack&package-manager=npm_and_yarn&previous-version=5.72.1&new-version=5.73.0)](https://docs.github.com/en/code-security/dependabot/dependabot-security-updates/about-dependabot-security-updates#about-compatibility-scores) -[![downloads](https://img.shields.io/npm/dm/webpack.svg)](https://npmcharts.com/compare/webpack?minimal=true) -[![install-size](https://packagephobia.com/badge?p=webpack)](https://packagephobia.com/result?p=webpack) -[![backers](https://opencollective.com/webpack/backers/badge.svg)](https://opencollective.com/webpack#backer) -[![sponsors](https://opencollective.com/webpack/sponsors/badge.svg)](https://opencollective.com/webpack#sponsors) -[![contributors](https://img.shields.io/github/contributors/webpack/webpack.svg)](https://github.com/webpack/webpack/graphs/contributors) -[![discussions](https://img.shields.io/github/discussions/webpack/webpack)](https://github.com/webpack/webpack/discussions) -[![discord](https://img.shields.io/discord/1180618526436888586?label=discord&logo=discord&logoColor=white&style=flat)](https://discord.gg/5sxFZPdx2k) -[![LFX Health Score](https://insights.linuxfoundation.org/api/badge/health-score?project=webpack)](https://insights.linuxfoundation.org/project/webpack) - -

webpack

-

- Webpack is a module bundler. Its main purpose is to bundle JavaScript files for usage in a browser, yet it is also capable of transforming, bundling, or packaging just about any resource or asset. -

-
- -## Table of Contents - -- [Install](#install) -- [Introduction](#introduction) -- [Concepts](#concepts) -- [Contributing](#contributing) -- [Support](#support) -- [Current project members](#current-project-members) - - [TSC (Technical Steering Committee)](#tsc-technical-steering-committee) - - [Core Collaborators](#core-collaborators) -- [Sponsoring](#sponsoring) - - [Premium Partners](#premium-partners) - - [Gold Sponsors](#gold-sponsors) - - [Silver Sponsors](#silver-sponsors) - - [Bronze Sponsors](#bronze-sponsors) - - [Backers](#backers) -- [Special Thanks](#special-thanks-to) - -## Install - -Install with npm: - -```bash -npm install --save-dev webpack -``` - -Install with yarn: - -```bash -yarn add webpack --dev -``` - -## Introduction - -Webpack is a bundler for modules. The main purpose is to bundle JavaScript -files for usage in a browser, yet it is also capable of transforming, bundling, -or packaging just about any resource or asset. - -**TL;DR** - -- Bundles [ES Modules](https://www.2ality.com/2014/09/es6-modules-final.html), [CommonJS](https://wiki.commonjs.org/), and [AMD](https://github.com/amdjs/amdjs-api/wiki/AMD) modules (even combined). -- Can create a single bundle or multiple chunks that are asynchronously loaded at runtime (to reduce initial loading time). -- Dependencies are resolved during compilation, reducing the runtime size. -- Loaders can preprocess files while compiling, e.g. TypeScript to JavaScript, Handlebars strings to compiled functions, images to Base64, etc. -- Highly modular plugin system to do whatever else your application requires. - -#### Learn about webpack through videos! - -- [Understanding Webpack - Video 1](https://www.youtube.com/watch?v=xj93pvQIsRo) -- [Understanding Webpack - Video 2](https://www.youtube.com/watch?v=4tQiJaFzuJ8) - -### Get Started - -Check out webpack's quick [**Get Started**](https://webpack.js.org/guides/getting-started) guide and the [other guides](https://webpack.js.org/guides/). - -### Browser Compatibility - -Webpack supports all browsers that are [ES5-compliant](https://kangax.github.io/compat-table/es5/) (IE8 and below are not supported). -Webpack also needs `Promise` for `import()` and `require.ensure()`. If you want to support older browsers, you will need to [load a polyfill](https://webpack.js.org/guides/shimming/) before using these expressions. - -## Concepts - -### [Plugins](https://webpack.js.org/plugins/) - -Webpack has a [rich plugin -interface](https://webpack.js.org/plugins/). Most of the features -within webpack itself use this plugin interface. This makes webpack very -**flexible**. - -| Name | Status | Install Size | Description | -| :---------------------------------------: | :----------------: | :-----------------: | :-------------------------------------------------------------------------------------- | -| [mini-css-extract-plugin][mini-css] | ![mini-css-npm] | ![mini-css-size] | Extracts CSS into separate files. It creates a CSS file per JS file which contains CSS. | -| [compression-webpack-plugin][compression] | ![compression-npm] | ![compression-size] | Prepares compressed versions of assets to serve them with Content-Encoding | -| [html-bundler-webpack-plugin][bundler] | ![bundler-npm] | ![bundler-size] | Renders a template (EJS, Handlebars, Pug) with referenced source asset files into HTML. | -| [html-webpack-plugin][html-plugin] | ![html-plugin-npm] | ![html-plugin-size] | Simplifies creation of HTML files (`index.html`) to serve your bundles | -| [pug-plugin][pug-plugin] | ![pug-plugin-npm] | ![pug-plugin-size] | Renders Pug files to HTML, extracts JS and CSS from sources specified directly in Pug. | - -[common-npm]: https://img.shields.io/npm/v/webpack.svg -[mini-css]: https://github.com/webpack-contrib/mini-css-extract-plugin -[mini-css-npm]: https://img.shields.io/npm/v/mini-css-extract-plugin.svg -[mini-css-size]: https://packagephobia.com/badge?p=mini-css-extract-plugin -[component]: https://github.com/webpack-contrib/component-webpack-plugin -[component-npm]: https://img.shields.io/npm/v/component-webpack-plugin.svg -[component-size]: https://packagephobia.com/badge?p=component-webpack-plugin -[compression]: https://github.com/webpack-contrib/compression-webpack-plugin -[compression-npm]: https://img.shields.io/npm/v/compression-webpack-plugin.svg -[compression-size]: https://packagephobia.com/badge?p=compression-webpack-plugin -[bundler]: https://github.com/webdiscus/html-bundler-webpack-plugin -[bundler-npm]: https://img.shields.io/npm/v/html-bundler-webpack-plugin.svg -[bundler-size]: https://packagephobia.com/badge?p=html-bundler-webpack-plugin -[html-plugin]: https://github.com/jantimon/html-webpack-plugin -[html-plugin-npm]: https://img.shields.io/npm/v/html-webpack-plugin.svg -[html-plugin-size]: https://packagephobia.com/badge?p=html-webpack-plugin -[pug-plugin]: https://github.com/webdiscus/pug-plugin -[pug-plugin-npm]: https://img.shields.io/npm/v/pug-plugin.svg -[pug-plugin-size]: https://packagephobia.com/badge?p=pug-plugin - -### [Loaders](https://webpack.js.org/loaders/) - -Webpack enables the use of loaders to preprocess files. This allows you to bundle -**any static resource** way beyond JavaScript. You can easily [write your own -loaders](https://webpack.js.org/api/loaders/) using Node.js. - -Loaders are activated by using `loadername!` prefixes in `require()` statements, -or are automatically applied via regex from your webpack configuration. - -#### JSON - -| Name | Status | Install Size | Description | -| :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :---------: | :----------: | :------------------------------: | -| | ![cson-npm] | ![cson-size] | Loads and transpiles a CSON file | - -[cson-npm]: https://img.shields.io/npm/v/cson-loader.svg -[cson-size]: https://packagephobia.com/badge?p=cson-loader - -#### Transpiling - -| Name | Status | Install Size | Description | -| :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------: | :------------: | :------------------------------------------------------------------------------------------------ | -| | ![babel-npm] | ![babel-size] | Loads ES2015+ code and transpiles to ES5 using Babel | -| | ![type-npm] | ![type-size] | Loads TypeScript like JavaScript | -| | ![coffee-npm] | ![coffee-size] | Loads CoffeeScript like JavaScript | - -[babel-npm]: https://img.shields.io/npm/v/babel-loader.svg -[babel-size]: https://packagephobia.com/badge?p=babel-loader -[coffee-npm]: https://img.shields.io/npm/v/coffee-loader.svg -[coffee-size]: https://packagephobia.com/badge?p=coffee-loader -[type-npm]: https://img.shields.io/npm/v/ts-loader.svg -[type-size]: https://packagephobia.com/badge?p=ts-loader - -#### Templating - -| Name | Status | Install Size | Description | -| :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-------------: | :--------------: | :-------------------------------------------------------------------------------------- | -| | ![html-npm] | ![html-size] | Exports HTML as string, requires references to static resources | -| | ![pug-npm] | ![pug-size] | Loads Pug templates and returns a function | -| | ![pug3-npm] | ![pug3-size] | Compiles Pug to a function or HTML string, useful for use with Vue, React, Angular | -| | ![md-npm] | ![md-size] | Compiles Markdown to HTML | -| | ![posthtml-npm] | ![posthtml-size] | Loads and transforms a HTML file using [PostHTML](https://github.com/posthtml/posthtml) | -| | ![hbs-npm] | ![hbs-size] | Compiles Handlebars to HTML | - -[html-npm]: https://img.shields.io/npm/v/html-loader.svg -[html-size]: https://packagephobia.com/badge?p=html-loader -[pug-npm]: https://img.shields.io/npm/v/pug-loader.svg -[pug-size]: https://packagephobia.com/badge?p=pug-loader -[pug3-npm]: https://img.shields.io/npm/v/@webdiscus/pug-loader.svg -[pug3-size]: https://packagephobia.com/badge?p=@webdiscus/pug-loader -[jade-npm]: https://img.shields.io/npm/v/jade-loader.svg -[jade-size]: https://packagephobia.com/badge?p=jade-loader -[md-npm]: https://img.shields.io/npm/v/markdown-loader.svg -[md-size]: https://packagephobia.com/badge?p=markdown-loader -[posthtml-npm]: https://img.shields.io/npm/v/posthtml-loader.svg -[posthtml-size]: https://packagephobia.com/badge?p=posthtml-loader -[hbs-npm]: https://img.shields.io/npm/v/handlebars-loader.svg -[hbs-size]: https://packagephobia.com/badge?p=handlebars-loader - -#### Styling - -| Name | Status | Install Size | Description | -| :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :------------: | :-------------: | :----------------------------------------------------------------------- | -| `