new Compilation(compiler, params): CompilationAttributes
compiler:
<Compiler>the compiler which created the compilation
params:
<CompilationParams>the compilation parameters
Returns:
<Compilation>Creates an instance of Compilation.
Attributes
additionalChunkAssets:
<string>[]
addModuleQueue:
<AsyncQueue>assets:
<CompilationAssets>assetsInfo:
<Map><
<string>
,
<AssetInfo>
>asyncEntrypoints:
<Entrypoint>[]
bail:
<boolean>buildQueue:
<AsyncQueue>children:
<Compilation>[]
chunkGraph:
<ChunkGraph>chunkGroups:
<ChunkGroup>[]
chunkTemplate:
<ChunkTemplate>codeGenerationResults:
<CodeGenerationResults>compilationDependencies:
<object>compiler:
<Compiler>compilerPath:
<string>creatingModuleDuringBuild:
<WeakMap>dependencyFactories:
<Map>dependencyTemplates:
<DependencyTemplates>endTime:
<number>entries:
<Map><
<string>
,
<EntryData>
>entrypoints:
<Map><
<string>
,
<Entrypoint>
>errors:
<Error>[]
factorizeQueue:
<AsyncQueue>fileSystemInfo:
<FileSystemInfo>fullHash:
<string>globalEntry:
<EntryData>hash:
<string>hooks:
<Readonly>
<
<object>
>inputFileSystem:
<InputFileSystem>logger:
<WebpackLogger>logging:
<Map><
<string>
,
<LogEntry>
[]>mainTemplate:
<MainTemplate>moduleGraph:
<ModuleGraph>moduleMemCaches:
<Map>moduleMemCaches2:
<Map>moduleTemplates:
<ModuleTemplates>name:
<string>namedChunkGroups:
<Map><
<string>
,
<ChunkGroup>
>needAdditionalPass:
<boolean>outputOptions:
<OutputNormalizedWithDefaults>params:
<CompilationParams>processDependenciesQueue:
<AsyncQueue>profile:
<boolean>rebuildQueue:
<AsyncQueue>requestShortener:
<RequestShortener>resolverFactory:
<ResolverFactory>runtimeTemplate:
<RuntimeTemplate>startTime:
<number>valueCacheVersions:
<Map><
<string>
,
<ValueCacheVersion>
>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.
addAsyncEntrypoint(options, module, loc, request): EntrypointAttributes
options:
<EntryOptions>options for the entrypoint
module:
<Module>the module the references the chunk group
the location from with the chunk group is referenced (inside of module)
request:
<string>the request from which the chunk group is referenced
Returns:
<Entrypoint>the new or existing entrypoint
Adds the provided async entrypoint to this chunk group.
addChunk(name?): ChunkAttributes
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?): ChunkGroupAttributes
groupOptions:
<string>
|
<ChunkGroupOptions>options for the chunk group
module:
<Module>the module the references the chunk group
the location from with the chunk group is referenced (inside of module)
request:
<string>the request from which the chunk group is referenced
Returns:
<ChunkGroup>the new or existing chunk group
If module is passed, loc and request must also be passed.
addEntry(context, entry, optionsOrName, callback): voidAttributes
context:
<string>context path for entry
entry:
<Dependency>entry dependency that should be followed
optionsOrName:
<string>
|
<EntryOptions>options or deprecated name of entry
callback:
<Function>callback function
Returns:
<void>returns
Adds the provided string to the compilation.
addInclude(context, dependency, options, callback): voidAttributes
context:
<string>context path for entry
dependency:
<Dependency>dependency that should be followed
options:
<EntryOptions>options
callback:
<Function>callback function
Returns:
<void>returns
Adds the provided string to the compilation.
addModule(module, callback): voidAttributes
module:
<Module>module to be added that was created
callback:
<Function>returns the module in the compilation,
it could be the passed one (if new), or an already existing in the compilation
Returns:
<void>Adds the provided module to the compilation.
addModuleChain(context, dependency, callback): voidAttributes
context:
<string>context string path
dependency:
<Dependency>dependency used to create Module chain
callback:
<Function>callback for when module chain is complete
Returns:
<void>will throw if dependency instance is not a valid Dependency
Adds the provided string to the compilation.
addModuleTree({ context, dependency, contextInfo }, callback): voidAttributes
context:
<string>context string path
contextInfo:
<Partial>
<
<ModuleFactoryCreateDataContextInfo>
> additional context info for the root moduledependency:
<Dependency>dependency used to create Module chain
callback:
<Function>callback for when module chain is complete
Returns:
<void>will throw if dependency instance is not a valid Dependency
Adds the provided object to the compilation.
addRuntimeModule(chunk, module, chunkGraph?): voidAttributes
chunk:
<Chunk>target chunk
module:
<RuntimeModule>runtime module
chunkGraph:
<ChunkGraph>the chunk graph
Returns:
<void>Adds runtime module.
assignDepth(module): voidAttributes
Processes the provided module.
assignDepths(modules): voidAttributes
Assigns depth values to the provided modules.
assignRuntimeIds(): voidReturns:
<void>buildModule(module, callback): voidAttributes
Schedules a build of the module object
checkConstraints(): voidReturns:
<void>clearAssets(): voidReturns:
<void>codeGeneration(callback): voidAttributes
callback:
<Function>callback
Returns:
<void>Generates code and runtime requirements for this module.
createChildCompiler(name, outputOptions?, plugins?): CompilerAttributes
name:
<string>name of the child compiler
outputOptions:
<Partial>
<
<OutputNormalized>
> // Need to convert config schema to types for thisplugins:
<false>
|
<"">
|
<0>
|
<Function>
|
<WebpackPluginInstance>
|
<null>
|
<undefined>
[] webpack plugins that will be appliedReturns:
<Compiler>creates a child Compiler instance
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): voidAttributes
callback:
<Function>signals when the call finishes
Returns:
<void>Creates a chunk assets.
createHash(): CodeGenerationJobReturns:
<CodeGenerationJob>[]
createModuleAssets(): voidReturns:
<void>createModuleHashes(): voidReturns:
<void>createStatsFactory(options): StatsFactoryAttributes
options:
<NormalizedStatsOptions>options
Returns:
<StatsFactory>the stats factory
Creates a stats factory.
createStatsOptions(optionsOrPreset?, context?): NormalizedStatsOptionsAttributes
optionsOrPreset:
<string>
|
<boolean>
|
<StatsOptions>stats option value
context:
<CreateStatsOptionsContext>context
Returns:
<NormalizedStatsOptions>normalized options
Creates a stats options.
createStatsPrinter(options): StatsPrinterAttributes
options:
<NormalizedStatsOptions>options
Returns:
<StatsPrinter>the stats printer
Creates a stats printer.
deleteAsset(file): voidAttributes
Processes the provided file.
emitAsset(file, source, assetInfo?): voidAttributes
file:
<string>file name
source:
<Source>asset source
assetInfo:
<AssetInfo>extra asset information
Returns:
<void>Processes the provided file.
executeModule(module, options, callback): voidAttributes
module:
<Module>the module
options:
<ExecuteModuleOptions>options
callback:
<Function>callback
Returns:
<void>Processes the provided module.
factorizeModule(options, callback): voidAttributes
Processes the provided |.
Attributes
Processes the provided |.
findModule(identifier): Module | undefinedAttributes
identifier:
<string>identifier (usually path) for module
Returns:
<Module>
|
<undefined>attempt to search for module and return it, else undefined
Attempts to search for a module by its identifier
finish(callback): voidAttributes
callback:
<Function>callback
Returns:
<void>Processes the provided callback.
getAsset(name): ReadonlyAttributes
name:
<string>the name of the asset
Returns:
Returns the asset or undefined when not found.
getAssetPath(filename, data): stringAttributes
filename:
<string>
|
<TemplatePathFn><
<T>
> used to get asset path with hashdata:
{T} context data
Returns:
<string>interpolated path
Returns interpolated path.
getAssetPathWithInfo(filename, data): InterpolatedPathAndAssetInfoAttributes
filename:
<string>
|
<TemplatePathFn><
<T>
> used to get asset path with hashdata:
{T} context data
Returns:
<InterpolatedPathAndAssetInfo>interpolated path and asset info
Gets asset path with info.
getAssets(): ReadonlyReturns:
<Readonly>
<
<Asset>
>[]getCache(name): CacheFacadeAttributes
name:
<string>cache name
Returns:
<CacheFacade>the cache facade instance
Returns the cache facade instance.
getDependencyReferencedExports(dependency, runtime): stringAttributes
dependency:
<Dependency>the dependency
runtime:
<RuntimeSpec>the runtime
Returns:
<string>[] |
<ReferencedExport>
[] referenced exportsGets dependency referenced exports.
getErrors(): ErrorReturns:
<Error>[]
getLogger(name): WebpackLoggerAttributes
name:
<string>
|
<Function>name of the logger, or function called once to get the logger name
Returns:
<WebpackLogger>a logger with that name
Returns a logger with that name.
getModule(module): ModuleAttributes
Fetches a module from a compilation by its identifier
getPath(filename, data?): stringAttributes
filename:
<string>
|
<TemplatePathFn><
<T>
> used to get asset path with hashdata:
{T} context data
Returns:
<string>interpolated path
Returns interpolated path.
getPathWithInfo(filename, data?): InterpolatedPathAndAssetInfoAttributes
filename:
<string>
|
<TemplatePathFn><
<T>
> used to get asset path with hashdata:
{T} context data
Returns:
<InterpolatedPathAndAssetInfo>interpolated path and asset info
Gets path with info.
getRenderManifest(options): RenderManifestEntryAttributes
options:
<RenderManifestOptions>options object
Returns:
<RenderManifestEntry>[] manifest entries
Gets render manifest.
getStats(): StatsReturns:
<Stats>getWarnings(): ErrorReturns:
<Error>[]
handleModuleCreation(handleModuleCreationOptions, callback): voidAttributes
Handle module creation.
patchChunksAfterReasonRemoval(module, chunk): voidAttributes
Patch chunks after reason removal.
processModuleDependencies(module, callback): voidAttributes
Process module dependencies.
processModuleDependenciesNonRecursive(module): voidAttributes
Process module dependencies non recursive.
processRuntimeRequirements({ chunkGraph?, modules?, chunks?, codeGenerationResults?, chunkGraphEntries }?): voidAttributes
chunkGraph:
<ChunkGraph>the chunk graph
chunkGraphEntries:
<Iterable>chunks:
<Iterable>codeGenerationResults:
<CodeGenerationResults>codeGenerationResults
modules:
<Iterable>Returns:
<void>Process runtime requirements.
rebuildModule(module, callback): voidAttributes
module:
<Module>module to be rebuilt
callback:
<Function>callback when module finishes rebuilding
Returns:
<void>Processes the provided module.
removeChunkFromDependencies(block, chunk): voidAttributes
Removes chunk from dependencies.
removeReasonsOfDependencyBlock(module, block): voidAttributes
module:
<Module>module relationship for removal
block:
<DependenciesBlockLike>dependencies block
Returns:
<void>Removes reasons of dependency block.
renameAsset(file, newFile): voidAttributes
Processes the provided file.
reportDependencyErrorsAndWarnings(module, blocks): booleanAttributes
module:
<Module>module to report from
blocks:
<DependenciesBlock>[] blocks to report from
Returns:
<boolean>true, when it has warnings or errors
Report dependency errors and warnings.
M
seal
seal(callback): voidAttributes
callback:
<Function>signals when the call finishes
Returns:
<void>Processes the provided callback.
sortItemsWithChunkIds(): voidReturns:
<void>summarizeDependencies(): voidReturns:
<void>unseal(): voidReturns:
<void>updateAsset(file, newSourceOrFunction, assetInfoUpdateOrFunction?): voidAttributes
file:
<string>file name
newSourceOrFunction:
<Source>
|
<Function>new asset source or function converting old to new
assetInfoUpdateOrFunction:
<AssetInfo>
|
<Function>new asset info or function converting old to new
Returns:
<void>Updates asset using the provided file.
Attributes
[index: {string}]<Source>
Attributes
blocks:
<AsyncDependenciesBlock>[]
dependencies:
<Dependency>[]
Attributes
dependencies:
<Dependency>[] dependencies of the entrypoint that should be evaluated at startup
includeDependencies:
<Dependency>[] dependencies of the entrypoint that should be included but not evaluated
options:
<EntryOptions>options of the entrypoint
Type:
<"module">
|
<"chunk">
|
<"root-of-chunk">
|
<"nested">Attributes
Attributes
Attributes
Attributes
entryOptions:
<EntryOptions>Attributes
Attributes
Processes the provided factorize module option.
Attributes
context:
<string>contextInfo:
<Partial>
<
<ModuleFactoryCreateDataContextInfo>
>currentProfile:
<ModuleProfile>dependencies:
<Dependency>[]
factory:
<ModuleFactory>factoryResult:
<boolean>return full ModuleFactoryResult instead of only module
Attributes
checkCycle:
<boolean>check the cycle dependencies of the created module
connectOrigin:
<boolean>connect the resolved module with the origin module
context:
<string>contextInfo:
<Partial>
<
<ModuleFactoryCreateDataContextInfo>
>dependencies:
<Dependency>[]
factory:
<ModuleFactory>recursive:
<boolean>recurse into dependencies of the created module
Attributes
forToString:
<boolean>Attributes
assetsSort:
<string>
|
<false>assetsSpace:
<number>cachedAssets:
<boolean>cachedModules:
<boolean>chunkGroupAuxiliary:
<boolean>chunkGroupChildren:
<boolean>chunkGroupMaxAssets:
<number>chunkGroups:
<boolean>chunkModulesSort:
<string>
|
<false>chunkModulesSpace:
<number>chunksSort:
<string>
|
<false>context:
<string>dependentModules:
<boolean>entrypoints:
<boolean>
|
<"auto">excludeAssets:
<Function>[]
excludeModules:
<Function>[]
groupAssetsByEmitStatus:
<boolean>groupAssetsByExtension:
<boolean>groupAssetsByPath:
<boolean>groupModulesByAttributes:
<boolean>groupModulesByCacheStatus:
<boolean>groupModulesByExtension:
<boolean>groupModulesByLayer:
<boolean>groupModulesByPath:
<boolean>groupModulesByType:
<boolean>ids:
<boolean>logging:
<false>
|
<"error">
|
<"warn">
|
<"info">
|
<"log">
|
<"none">
|
<"verbose">loggingDebug:
<Function>[]
loggingTrace:
<boolean>modulesSort:
<string>
|
<false>modulesSpace:
<number>nestedModulesSort:
<string>
|
<false>nestedModulesSpace:
<number>orphanModules:
<boolean>requestShortener:
<RequestShortener>runtimeModules:
<boolean>warningsFilter:
<Function>[]
Attributes
Attributes
javascript:
<ModuleTemplate>&
<Omit>
<
<StatsOptions>
,
<"context">
|
<"chunkGroups">
|
<"requestShortener">
|
<"chunksSort">
|
<"modulesSort">
|
<"chunkModulesSort">
|
<"nestedModulesSort">
|
<"assetsSort">
|
<"ids">
|
<"cachedAssets">
|
<"groupAssetsByEmitStatus">
|
<"groupAssetsByPath">
|
<"groupAssetsByExtension">
|
<"assetsSpace">
|
<"excludeAssets">
|
<"excludeModules">
|
<"warningsFilter">
|
<"cachedModules">
|
<"orphanModules">
|
<"dependentModules">
|
<"runtimeModules">
|
<"groupModulesByCacheStatus">
|
<"groupModulesByLayer">
|
<"groupModulesByAttributes">
|
<"groupModulesByPath">
|
<"groupModulesByExtension">
|
<"groupModulesByType">
|
<"entrypoints">
|
<"chunkGroupAuxiliary">
|
<"chunkGroupChildren">
|
<"chunkGroupMaxAssets">
|
<"modulesSpace">
|
<"chunkModulesSpace">
|
<"nestedModulesSpace">
|
<"logging">
|
<"loggingDebug">
|
<"loggingTrace">
|
<"_env">
> &
<Record>
<
<string>
,
<any>
>Attributes
additionalAssets:
<boolean>
|
<Function>Attributes
chunkGraph:
<ChunkGraph>the chunk graph
codeGenerationResults:
<CodeGenerationResults>the code generation results
Attributes
c<Record><<string>,<ExecuteModuleObject>>i<Function>[]