On this page

Source Code: lib/Compilation.js#L598
new Compilation(compiler, params): Compilation
Source Code: lib/Compilation.js#L604
Attributes
compiler:Compiler
Returns:Compilation

Creates an instance of Compilation.

Source Code: lib/Compilation.js#L1320
Type:string[]
Source Code: lib/Compilation.js#L1251
Source Code: lib/Compilation.js#L1322
Source Code: lib/Compilation.js#L1324
Source Code: lib/Compilation.js#L1297
Type:Entrypoint[]
Source Code: lib/Compilation.js#L1207
Type:boolean
Source Code: lib/Compilation.js#L1374
Source Code: lib/Compilation.js#L1264
Source Code: lib/Compilation.js#L1362
Source Code: lib/Compilation.js#L1358
Source Code: lib/Compilation.js#L1336
Source Code: lib/Compilation.js#L1346
Type:Record<string, number>
Source Code: lib/Compilation.js#L1237
Source Code: lib/Compilation.js#L1301
Type:ChunkGroup[]
Source Code: lib/Compilation.js#L1299
Type:Set<Chunk>
Source Code: lib/Compilation.js#L1216
Source Code: lib/Compilation.js#L1360
Source Code: lib/Compilation.js#L1242
Source Code: lib/Compilation.js#L1366
Type:Set<string>
Source Code: lib/Compilation.js#L1380
Stability: 0Deprecated
Type:Object
compilation.compilationDependencies.add(item): LazySet<string>
Attributes
item:string
Returns:LazySet<string>
Source Code: lib/Compilation.js#L1169
Source Code: lib/Compilation.js#L1197
Type:string
Source Code: lib/Compilation.js#L1370
Source Code: lib/Compilation.js#L1282

Modules in value are building during the build of Module in key. Means value blocking key from finishing. Needed to detect build cycles.

Source Code: lib/Compilation.js#L1340
Source Code: lib/Compilation.js#L1342
Source Code: lib/Compilation.js#L1364
Type:Set<string>
Source Code: lib/Compilation.js#L1167
Type:number
Source Code: lib/Compilation.js#L1285
Source Code: lib/Compilation.js#L1295
Source Code: lib/Compilation.js#L1332
Type:Error[]
Source Code: lib/Compilation.js#L1258
Source Code: lib/Compilation.js#L1368
Source Code: lib/Compilation.js#L1176
Type:string
Source Code: lib/Compilation.js#L1287
Type:string
Source Code: lib/Compilation.js#L861
Type:Object
Type:SyncHook<[Dependency, EntryOptions]>
Stability: 0Deprecated
Type:FakeHook<Pick<AsyncSeriesHook<[]>, "name" | "tap" | "tapAsync" | "tapPromise">>
Stability: 0Deprecated
Type:FakeHook<Pick<AsyncSeriesHook<[Set<Chunk>]>, "name" | "tap" | "tapAsync" | "tapPromise">>
Type:SyncHook<[Iterable<Chunk>]>

The afterChunks hook is called directly after the chunks and module graph have been created and before the chunks and modules have been optimized. This hook is useful to inspect, analyze, and/or modify the chunk graph.

Type:SyncHook<[]>
Type:SyncHook<[]>
Type:SyncHook<[]>
Stability: 0Deprecated
Type:SyncHook<[CompilationAssets]>
Stability: 0Deprecated
Type:FakeHook<Pick<AsyncSeriesHook<[Set<Chunk>]>, "name" | "tap" | "tapAsync" | "tapPromise">>
Type:SyncHook<[Iterable<Chunk>]>
Type:SyncHook<[Iterable<Chunk>, Iterable<Module>]>
Type:SyncHook<[Iterable<Chunk>, ChunkGroup[]]>
Type:SyncHook<[Iterable<Module>]>
Type:SyncHook<[Iterable<Module>]>
Type:SyncHook<[Iterable<Module>]>
Type:SyncHook<[Iterable<Chunk>, Iterable<Module>]>
Type:SyncHook<[CompilationAssets]>
Type:SyncHook<[]>
Type:AsyncSeriesHook<[]>
Type:SyncWaterfallHook<[string, PathData, undefined | AssetInfo], string>
Type:SyncHook<[]>
Type:SyncHook<[Iterable<Chunk>]>
Type:SyncHook<[]>
Type:SyncHook<[]>
Type:SyncHook<[]>
Type:SyncHook<[]>
Type:SyncHook<[]>
Type:SyncHook<[Iterable<Module>]>
Type:SyncHook<[]>
Type:SyncHook<[Module]>
Type:SyncHook<[Compiler, string, number]>
Type:SyncHook<[Chunk, string]>
Type:SyncHook<[Chunk, Hash, ChunkHashContext]>
Type:SyncHook<[Iterable<Chunk>]>
Type:SyncHook<[Chunk]>
Type:SyncWaterfallHook<[(string[] | ReferencedExport)[], Dependency, RuntimeSpec], (string[] | ReferencedExport)[]>
Type:SyncHook<[Dependency, EntryOptions, Error]>
Type:SyncHook<[Module, WebpackError]>
Type:AsyncSeriesHook<[Iterable<Module>]>
Type:AsyncSeriesHook<[Module]>
Type:SyncHook<[Hash]>
Type:SyncBailHook<[string, LogEntry], boolean | void>
Type:SyncHook<[Module, string]>
Type:SyncHook<[Iterable<Module>]>
Type:SyncBailHook<[], boolean | void>
Type:SyncBailHook<[], boolean | void>
Type:SyncHook<[]>
Stability: 0Deprecated
Stability: 0Deprecated
Type:FakeHook<Pick<AsyncSeriesHook<[Set<Chunk>]>, "name" | "tap" | "tapAsync" | "tapPromise">>
Type:SyncHook<[Iterable<Chunk>]>
Type:AsyncSeriesBailHook<[Iterable<Chunk>, Iterable<Module>], void>
Type:SyncBailHook<[Iterable<Chunk>, ChunkGroup[]], boolean | void>
Type:SyncHook<[Iterable<Module>]>
Type:SyncBailHook<[Iterable<Module>], boolean | void>
Type:SyncHook<[Iterable<Module>]>
Type:SyncBailHook<[Iterable<Module>], boolean | void>
Type:AsyncSeriesHook<[Iterable<Chunk>, Iterable<Module>]>
Type:AsyncParallelHook<[ExecuteModuleArgument, ExecuteModuleContext]>
Type:AsyncSeriesHook<[CompilationAssets]>
Type:SyncWaterfallHook<[Error[]], Error[]>
Type:SyncWaterfallHook<[Error[]], Error[]>
Type:SyncHook<[Module]>
Type:SyncHook<[Compilation, Records]>
Type:SyncHook<[Iterable<Chunk>, Records]>
Type:SyncHook<[Records]>
Type:SyncHook<[Iterable<Module>, Records]>
Type:SyncHook<[Iterable<Chunk>, Records]>
Type:SyncHook<[Iterable<Module>, Records]>
Type:SyncHook<[RuntimeModule, Chunk]>
Type:HookMap<SyncBailHook<[Chunk, Set<string>, RuntimeRequirementsContext], void>>
Type:HookMap<SyncBailHook<[Module, Set<string>, RuntimeRequirementsContext], void>>
Type:HookMap<SyncBailHook<[Chunk, Set<string>, RuntimeRequirementsContext], void>>
Type:SyncHook<[]>
Type:SyncBailHook<[], boolean | void>
Type:SyncBailHook<[], boolean | void>
Type:HookMap<SyncHook<[Partial<NormalizedStatsOptions>, CreateStatsOptionsContext]>>
Type:SyncHook<[Module]>
Type:SyncHook<[Dependency, EntryOptions, Module]>
Type:SyncHook<[Module]>
Type:SyncHook<[]>
Stability: 0Deprecated
Type:SyncHook<[AnyLoaderContext, NormalModule]>

Gets normal module loader.

Source Code: lib/Compilation.js#L1172
Source Code: lib/Compilation.js#L1199
Source Code: lib/Compilation.js#L1338
Source Code: lib/Compilation.js#L1214
Source Code: lib/Compilation.js#L1372
Source Code: lib/Compilation.js#L1235
Source Code: lib/Compilation.js#L1231
Source Code: lib/Compilation.js#L1233
Source Code: lib/Compilation.js#L1307
Type:Set<Module>
Source Code: lib/Compilation.js#L1224
Source Code: lib/Compilation.js#L1163
Type:string
Source Code: lib/Compilation.js#L1303
Source Code: lib/Compilation.js#L1305
Source Code: lib/Compilation.js#L1352
Type:boolean
Source Code: lib/Compilation.js#L1202
Source Code: lib/Compilation.js#L1203
Source Code: lib/Compilation.js#L1212
Source Code: lib/Compilation.js#L1245
Source Code: lib/Compilation.js#L1209
Type:boolean
Source Code: lib/Compilation.js#L1270
Source Code: lib/Compilation.js#L1318
Type:Records | null
Source Code: lib/Compilation.js#L1195
Source Code: lib/Compilation.js#L1170
Source Code: lib/Compilation.js#L1218
Source Code: lib/Compilation.js#L1165
Type:number
Source Code: lib/Compilation.js#L1348
Type:Set<number> | null
Source Code: lib/Compilation.js#L1350
Type:Set<number> | null
Source Code: lib/Compilation.js#L1193
Source Code: lib/Compilation.js#L1334
Type:Error[]
Type:number

Add additional assets to the compilation.

Type:number

Add additional sections to existing assets, like a banner or initialization code.

Type:number

Analyse existing assets.

Type:number

Derive new assets from existing assets. Existing assets should not be treated as complete.

Type:number

Add development tooling to assets, e. g. by extracting a SourceMap.

Type:number

Optimize existing assets in a general way.

Type:number

Optimize the compatibility of existing assets, e. g. add polyfills or vendor-prefixes.

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.

Type:number

Optimize the hashes of the assets, e. g. by generating real hashes of the asset content.

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.

Type:number

Optimize the size of existing assets, e. g. by minimizing or omitting whitespace.

Type:number

Optimize the transfer of existing assets, e. g. by preparing a compressed (gzip) file as separate asset.

Type:number

Basic preprocessing of assets.

Type:number

Creating assets for reporting purposes.

Type:number

Summarize the list of existing assets e. g. creating an assets manifest of Service Workers.

compilation.addAsyncEntrypoint(options, module, loc, request): Entrypoint
Source Code: lib/Compilation.js#L4473
Attributes
options:EntryOptions
module:Module
request:string
Returns:Entrypoint

Adds the provided async entrypoint to this chunk group.

compilation.addChunk(name?): Chunk
Source Code: lib/Compilation.js#L4515
Attributes
name:string | null
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.

compilation.addChunkInGroup(groupOptions, module?, loc?, request?): ChunkGroup
Source Code: lib/Compilation.js#L4422
Attributes

If module is passed, loc and request must also be passed.

compilation.addEntry(context, entry, optionsOrName, callback): void
Source Code: lib/Compilation.js#L2674
Attributes
context:string
optionsOrName:string | EntryOptions
callback:(err?: WebpackError | null, result?: Module | null) => void

Adds the provided string to the compilation.

compilation.addInclude(context, dependency, options, callback): void
Source Code: lib/Compilation.js#L2692
Attributes
context:string
dependency:Dependency
options:EntryOptions
callback:(err?: WebpackError | null, result?: Module | null) => void

Adds the provided string to the compilation.

compilation.addModule(module, callback): void
Source Code: lib/Compilation.js#L1615
Attributes
module:Module
callback:(err?: WebpackError | null, result?: Module | null) => void

Adds the provided module to the compilation.

compilation.addModuleChain(context, dependency, callback): void
Source Code: lib/Compilation.js#L2607
Attributes
context:string
dependency:Dependency
callback:(err?: WebpackError | null, result?: Module | null) => void

Adds the provided string to the compilation.

compilation.addModuleTree(__namedParameters, callback): void
Source Code: lib/Compilation.js#L2620
Attributes
__namedParameters:Object
context:string
context string path
additional context info for the root module
dependency:Dependency
dependency used to create Module chain
callback:(err?: WebpackError | null, result?: Module | null) => void

Adds the provided object to the compilation.

compilation.addRuntimeModule(chunk, module, chunkGraph?): void
Source Code: lib/Compilation.js#L4367
Attributes
chunk:Chunk
chunkGraph:ChunkGraph

Adds runtime module.

compilation.assignDepth(module): void
Source Code: lib/Compilation.js#L4539
Stability: 0Deprecated
Attributes
module:Module

Processes the provided module.

compilation.assignDepths(modules): void
Source Code: lib/Compilation.js#L4576
Attributes
modules:Module[] | Set<Module>

Assigns depth values to the provided modules.

compilation.assignRuntimeIds(): void
Source Code: lib/Compilation.js#L4713
compilation.buildModule(module, callback): void
Source Code: lib/Compilation.js#L1690
Attributes
module:Module
callback:(err?: WebpackError | null, result?: Module | null) => void

Schedules a build of the module object

compilation.checkConstraints(): void
Source Code: lib/Compilation.js#L6260
compilation.clearAssets(): void
Source Code: lib/Compilation.js#L5544
compilation.codeGeneration(callback): void
Source Code: lib/Compilation.js#L3944
Attributes
callback:(err?: WebpackError | null) => void

Generates code and runtime requirements for this module.

compilation.createChildCompiler(name, outputOptions?, plugins?): Compiler
Source Code: lib/Compilation.js#L5838
Attributes
name:string
outputOptions:Partial<OutputNormalized>
plugins:(false | "" | 0 | ((this: Compiler, compiler: Compiler) => void) | WebpackPluginInstance | null | undefined)[]
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

compilation.createChunkAssets(callback): void
Source Code: lib/Compilation.js#L5592
Attributes
callback:(err?: WebpackError | null) => void

Creates a chunk assets.

compilation.createHash(): CodeGenerationJob[]
Source Code: lib/Compilation.js#L4867
compilation.createModuleAssets(): void
Source Code: lib/Compilation.js#L5553
compilation.createModuleHashes(): void
Source Code: lib/Compilation.js#L4760
compilation.createStatsFactory(options): StatsFactory
Source Code: lib/Compilation.js#L1454
Attributes

Creates a stats factory.

compilation.createStatsOptions(optionsOrPreset?, context?): NormalizedStatsOptions
Source Code: lib/Compilation.js#L1421
Attributes

Creates a stats options.

compilation.createStatsPrinter(options): StatsPrinter
Source Code: lib/Compilation.js#L1465
Attributes

Creates a stats printer.

compilation.deleteAsset(file): void
Source Code: lib/Compilation.js#L5458
Attributes
file:string

Processes the provided file.

compilation.emitAsset(file, source, assetInfo?): void
Source Code: lib/Compilation.js#L5176
Attributes
file:string
source:Source
assetInfo:AssetInfo

Processes the provided file.

compilation.executeModule(module, options, callback): void
Source Code: lib/Compilation.js#L5856
Attributes
module:Module
callback:(err?: WebpackError | null, result?: ExecuteModuleResult | null) => void

Processes the provided module.

compilation.factorizeModule(options, callback): void
Source Code: lib/Compilation.js#L2301
Attributes
options:FactorizeModuleOptions & { factoryResult?: false }
callback:(err?: WebpackError | null, result?: Module | null) => void

Processes the provided module callback.

compilation.factorizeModule(options, callback): void
Source Code: lib/Compilation.js#L2301
Attributes
options:FactorizeModuleOptions & { factoryResult: true }
callback:(err?: WebpackError | null, result?: ModuleFactoryResult | null) => void

Processes the provided module factory result callback.

compilation.findModule(identifier): Module | undefined
Source Code: lib/Compilation.js#L1680
Attributes
identifier:string
Returns:Module | undefined

Attempts to search for a module by its identifier

compilation.finish(callback): void
Source Code: lib/Compilation.js#L3200
Attributes
callback:(err?: WebpackError | null) => void

Processes the provided callback.

compilation.getAsset(name): Readonly<Asset> | undefined
Source Code: lib/Compilation.js#L5535
Attributes
name:string
Returns:Readonly<Asset> | undefined

Returns the asset or undefined when not found.

compilation.getAssetPath(filename, data): string
Source Code: lib/Compilation.js#L5795
Attributes
filename:string | TemplatePathFn<T>
Returns:string

Returns interpolated path.

compilation.getAssetPathWithInfo(filename, data): InterpolatedPathAndAssetInfo
Source Code: lib/Compilation.js#L5810
Attributes

Gets asset path with info.

compilation.getAssets(): Readonly<Asset>[]
Source Code: lib/Compilation.js#L5515
Returns:Readonly<Asset>[]
compilation.getCache(name): CacheFacade
Source Code: lib/Compilation.js#L1476
Attributes
name:string
Returns:CacheFacade

Returns the cache facade instance.

compilation.getDependencyReferencedExports(dependency, runtime): (string[] | ReferencedExport)[]
Source Code: lib/Compilation.js#L4612
Attributes
dependency:Dependency
runtime:RuntimeSpec
Returns:(string[] | ReferencedExport)[]

Gets dependency referenced exports.

compilation.getErrors(): Error[]
Source Code: lib/Compilation.js#L5825
Returns:Error[]
compilation.getLogger(name): WebpackLogger
Source Code: lib/Compilation.js#L1485
Attributes
name:string | (() => string)

Returns a logger with that name.

compilation.getModule(module): Module
Source Code: lib/Compilation.js#L1670
Attributes
module:Module
Returns:Module

Fetches a module from a compilation by its identifier

compilation.getPath(filename, data?): string
Source Code: lib/Compilation.js#L5761
Attributes
filename:string | TemplatePathFn<T>
Returns:string

Returns interpolated path.

compilation.getPathWithInfo(filename, data?): InterpolatedPathAndAssetInfo
Source Code: lib/Compilation.js#L5778
Attributes

Gets path with info.

compilation.getRenderManifest(options): RenderManifestEntry[]
Source Code: lib/Compilation.js#L5583
Attributes

Gets render manifest.

compilation.getStats(): Stats
Source Code: lib/Compilation.js#L1411
Returns:Stats
compilation.getWarnings(): Error[]
Source Code: lib/Compilation.js#L5821
Returns:Error[]
compilation.handleModuleCreation(__namedParameters, callback): void
Source Code: lib/Compilation.js#L2328
Attributes
__namedParameters:HandleModuleCreationOptions
callback:(err?: WebpackError | null, result?: Module | null) => void

Handle module creation.

compilation.patchChunksAfterReasonRemoval(module, chunk): void
Source Code: lib/Compilation.js#L4661
Attributes
module:Module
chunk:Chunk

Patch chunks after reason removal.

compilation.processModuleDependencies(module, callback): void
Source Code: lib/Compilation.js#L1775
Attributes
module:Module
callback:(err?: WebpackError | null, result?: Module | null) => void

Process module dependencies.

compilation.processModuleDependenciesNonRecursive(module): void
Source Code: lib/Compilation.js#L1784
Attributes
module:Module

Process module dependencies non recursive.

compilation.processRuntimeRequirements(__namedParameters?): void
Source Code: lib/Compilation.js#L4226
Attributes
__namedParameters:Object
chunkGraph:ChunkGraph
the chunk graph
chunkGraphEntries:Iterable<Chunk, any, any>
chunkGraphEntries
chunks:Iterable<Chunk, any, any>
chunks
codeGenerationResults:CodeGenerationResults
codeGenerationResults
modules:Iterable<Module, any, any>
modules

Process runtime requirements.

compilation.rebuildModule(module, callback): void
Source Code: lib/Compilation.js#L2789
Attributes
module:Module
callback:(err?: WebpackError | null, result?: Module | null) => void

Processes the provided module.

compilation.removeChunkFromDependencies(block, chunk): void
Source Code: lib/Compilation.js#L4680
Attributes

Removes chunk from dependencies.

compilation.removeReasonsOfDependencyBlock(module, block): void
Source Code: lib/Compilation.js#L4630
Attributes

Removes reasons of dependency block.

compilation.renameAsset(file, newFile): void
Source Code: lib/Compilation.js#L5315
Attributes
file:string
newFile:string

Processes the provided file.

compilation.reportDependencyErrorsAndWarnings(module, blocks): boolean
Source Code: lib/Compilation.js#L3898
Attributes
module:Module
Returns:boolean

Report dependency errors and warnings.

compilation.seal(callback): void
Source Code: lib/Compilation.js#L3502
Attributes
callback:(err?: WebpackError | null) => void

Processes the provided callback.

compilation.sortItemsWithChunkIds(): void
Source Code: lib/Compilation.js#L4732
compilation.summarizeDependencies(): void
Source Code: lib/Compilation.js#L4742
compilation.unseal(): void
Source Code: lib/Compilation.js#L3480
compilation.updateAsset(file, newSourceOrFunction, assetInfoUpdateOrFunction?): void
Source Code: lib/Compilation.js#L5282
Attributes
file:string
newSourceOrFunction:Source | ((source: Source) => Source)
assetInfoUpdateOrFunction:AssetInfo | ((assetInfo?: AssetInfo) => AssetInfo | undefined)

Updates asset using the provided file.