On this page

  • {DependenciesBlock}
new AsyncDependenciesBlock(groupOptions, loc?, request?): AsyncDependenciesBlock
Attributes
groupOptions:<string>
loc:
{SyntheticDependencyLocation|RealDependencyLocation}
request:<string>
Attributes
chunkName:<string>
circular:<boolean>
dependencies:<Dependency[]>
groupOptions:
{GroupOptionsAsyncDependenciesBlock}
loc:
{SyntheticDependencyLocation|RealDependencyLocation}
module:<any>
parent:
{DependenciesBlock}
request:<string>
addBlock(block): void
Attributes
Returns:
{void}

Adds a DependencyBlock to DependencyBlock relationship. This is used for when a Module has a AsyncDependencyBlock tie (for code-splitting)

addDependency(dependency): void
Attributes
dependency:<Dependency>
Returns:
{void}
clearDependenciesAndBlocks(): void
Returns:
{void}

Removes all dependencies and blocks

deserialize(__namedParameters): void
Attributes
__namedParameters:<ObjectDeserializerContext>
Returns:
{void}
getRootBlock(): DependenciesBlock
Returns:
{DependenciesBlock}
removeDependency(dependency): void
Attributes
dependency:<Dependency>
Returns:
{void}
serialize(__namedParameters): void
Attributes
__namedParameters:<ObjectSerializerContext>
Returns:
{void}
updateHash(hash, context): void
  • hash {Hash}
  • context {UpdateHashContextDependency}
  • Returns: {void}

new AutomaticPrefetchPlugin(): AutomaticPrefetchPlugin
apply(compiler): void
Attributes
compiler:<Compiler>
Returns:
{void}

Apply the plugin


new BannerPlugin(options): void
  • banner {object}
  • options {BannerPluginOptions}
apply(compiler): void
Attributes
compiler:<Compiler>
Returns:
{void}

Apply the plugin


new Cache(): CacheClass
Returns:
{CacheClass}
beginIdle(): void
Returns:
{void}
endIdle(callback): void
  • callback {CallbackCacheCache}
  • Returns: {void}
get(identifier, etag, callback): void
Attributes
identifier:<string>
etag:
{Etag}
callback:
{CallbackCacheCache }
Returns:
{void}
shutdown(callback): void
  • callback {CallbackCacheCache}
  • Returns: {void}
store(identifier, etag, data, callback): void
Attributes
identifier:<string>
etag:
{Etag}
data:
{T}
callback:
{CallbackCacheCache }
Returns:
{void}
storeBuildDependencies(dependencies, callback): void
  • dependencies {Iterable}
  • callback {CallbackCacheCache}
  • Returns: {void}

After this method has succeeded the cache can only be restored when build dependencies are


Attributes
new Chunk(name?, backCompat?): Chunk
Attributes
backCompat:<boolean>
Returns:<Chunk>
addGroup(chunkGroup): void
Attributes
chunkGroup:<ChunkGroup>
Returns:
{void}
addModule(module): boolean
Attributes
module:<Module>
Returns:<boolean>
canBeInitial(): boolean
Returns:<boolean>
canBeIntegrated(otherChunk): boolean
Attributes
otherChunk:<Chunk>
Returns:<boolean>
compareTo(otherChunk): -1 | 0 | 1
Attributes
otherChunk:<Chunk>
Returns:
{-1|0|1}
containsModule(module): boolean
Attributes
module:<Module>
Returns:<boolean>
disconnectFromGroups(): void
Returns:
{void}
getAllAsyncChunks(): Set<Chunk>
Returns:
{Set }
getAllInitialChunks(): Set<Chunk>
Returns:
{Set }
getAllReferencedAsyncEntrypoints(): Set<Entrypoint>
Returns:
{Set }
getAllReferencedChunks(): Set<Chunk>
Returns:
{Set }
getChildIdsByOrders(chunkGraph, filterFn?): Record<string, ChunkId[]>
Attributes
chunkGraph:<ChunkGraph>
filterFn:
{object}
Returns:
{Record<string, ChunkId[]>}
getChildIdsByOrdersMap(chunkGraph, includeDirectChildren?, filterFn?): ChunkChildIdsByOrdersMapByData
Attributes
chunkGraph:<ChunkGraph>
includeDirectChildren:<boolean>
filterFn:
{object}
Returns:
{ChunkChildIdsByOrdersMapByData}
getChildrenOfTypeInOrder(chunkGraph, type): ChunkChildOfTypeInOrder[]
Attributes
chunkGraph:<ChunkGraph>
Returns:
{ChunkChildOfTypeInOrder[]}
getChunkMaps(realHash): ChunkMaps
Stability: 0Deprecated
Attributes
realHash:<boolean>
Returns:
{ChunkMaps}
getChunkModuleMaps(filterFn): void
  • filterFn {object}
  • Returns: {ChunkModuleMaps}
getEntryOptions(): EntryOptions
getModules(): Module[]
Returns:<Module[]>
getNumberOfGroups(): number
Returns:<number>
getNumberOfModules(): number
Returns:<number>
hasAsyncChunks(): boolean
Returns:<boolean>
hasChildByOrder(chunkGraph, type, includeDirectChildren?, filterFn?): boolean
Attributes
chunkGraph:<ChunkGraph>
includeDirectChildren:<boolean>
filterFn:
{object}
Returns:<boolean>
hasEntryModule(): boolean
Returns:<boolean>
hasModuleInGraph(filterFn, filterChunkFn?): void
  • filterFn {object}
  • filterChunkFn {object}
  • Returns: <boolean>
hasRuntime(): boolean
Returns:<boolean>
integrate(otherChunk): boolean
Attributes
otherChunk:<Chunk>
Returns:<boolean>
integratedSize(otherChunk, options): number
Attributes
otherChunk:<Chunk>
options:
{ChunkSizeOptions}
Returns:<number>
isEmpty(): boolean
Returns:<boolean>
isInGroup(chunkGroup): boolean
Attributes
chunkGroup:<ChunkGroup>
Returns:<boolean>
isOnlyInitial(): boolean
Returns:<boolean>
modulesSize(): number
Returns:<number>
moveModule(module, otherChunk): void
Attributes
module:<Module>
otherChunk:<Chunk>
Returns:
{void}
remove(): void
Returns:
{void}
removeGroup(chunkGroup): void
Attributes
chunkGroup:<ChunkGroup>
Returns:
{void}
removeModule(module): void
Attributes
module:<Module>
Returns:
{void}
size(options?): void
  • options {ChunkSizeOptions}
  • Returns: <number>
split(newChunk): void
Attributes
newChunk:<Chunk>
Returns:
{void}
updateHash(hash, chunkGraph): void

new ChunkGraph(moduleGraph, hashFunction?): ChunkGraph
Attributes
moduleGraph:<ModuleGraph>
hashFunction:
{HashFunction}
Returns:<ChunkGraph>
Attributes
moduleGraph:<ModuleGraph>
addChunkRuntimeRequirements(chunk, items): void
Attributes
chunk:<Chunk>
items:
{Set }
Returns:
{void}
addDependentHashModuleToChunk(chunk, module): void
Attributes
Returns:
{void}
addFullHashModuleToChunk(chunk, module): void
Attributes
Returns:
{void}
addModuleRuntimeRequirements(module, runtime, items, transferOwnership?): void
Attributes
module:<Module>
runtime:
{RuntimeSpec}
items:
{Set }
transferOwnership:<boolean>
Returns:
{void}
addTreeRuntimeRequirements(chunk, items): void
Attributes
chunk:<Chunk>
items:
{Iterable }
Returns:
{void}
attachDependentHashModules(chunk, modules): void
Attributes
chunk:<Chunk>
modules:
{Iterable }
Returns:
{void}
attachFullHashModules(chunk, modules): void
Attributes
chunk:<Chunk>
modules:
{Iterable }
Returns:
{void}
attachModules(chunk, modules): void
Attributes
chunk:<Chunk>
modules:
{Iterable }
Returns:
{void}
attachRuntimeModules(chunk, modules): void
Attributes
chunk:<Chunk>
modules:
{Iterable }
Returns:
{void}
canChunksBeIntegrated(chunkA, chunkB): boolean
Attributes
chunkA:<Chunk>
chunkB:<Chunk>
Returns:<boolean>
compareChunks(chunkA, chunkB): -1 | 0 | 1
Attributes
chunkA:<Chunk>
chunkB:<Chunk>
Returns:
{-1|0|1}
connectBlockAndChunkGroup(depBlock, chunkGroup): void
Attributes
Returns:
{void}
connectChunkAndEntryModule(chunk, module, entrypoint): void
Attributes
chunk:<Chunk>
module:<Module>
entrypoint:<Entrypoint>
Returns:
{void}
connectChunkAndModule(chunk, module): void
Attributes
chunk:<Chunk>
module:<Module>
Returns:
{void}
connectChunkAndRuntimeModule(chunk, module): void
Attributes
Returns:
{void}
disconnectChunk(chunk): void
Attributes
chunk:<Chunk>
Returns:
{void}
disconnectChunkAndEntryModule(chunk, module): void
Attributes
chunk:<Chunk>
module:<Module>
Returns:
{void}
disconnectChunkAndModule(chunk, module): void
Attributes
chunk:<Chunk>
module:<Module>
Returns:
{void}
disconnectChunkAndRuntimeModule(chunk, module): void
Attributes
Returns:
{void}
disconnectChunkGroup(chunkGroup): void
Attributes
chunkGroup:<ChunkGroup>
Returns:
{void}
disconnectEntries(chunk): void
Attributes
chunk:<Chunk>
Returns:
{void}
disconnectEntryModule(module): void
Attributes
module:<Module>
Returns:
{void}
getBlockChunkGroup(depBlock): ChunkGroup
Attributes
Returns:<ChunkGroup>
getChunkConditionMap(chunk, filterFn): ChunkConditionMap
Attributes
chunk:<Chunk>
filterFn:
{object}
Returns:
{ChunkConditionMap}
getChunkDependentHashModulesIterable(chunk): Iterable<RuntimeModule, any, any>
Attributes
chunk:<Chunk>
Returns:
{Iterable<RuntimeModule, any, any>}
getChunkEntryDependentChunksIterable(chunk): Iterable<Chunk>
Attributes
chunk:<Chunk>
Returns:
{Iterable }
getChunkEntryModulesIterable(chunk): Iterable<Module>
Attributes
chunk:<Chunk>
Returns:
{Iterable }
getChunkEntryModulesWithChunkGroupIterable(chunk): Iterable<Tuple<Module, Entrypoint>>
Attributes
chunk:<Chunk>
Returns:
{Iterable<Tuple<Module, Entrypoint>>}
getChunkFullHashModulesIterable(chunk): Iterable<RuntimeModule, any, any>
Attributes
chunk:<Chunk>
Returns:
{Iterable<RuntimeModule, any, any>}
getChunkFullHashModulesSet(chunk): ReadonlySet<RuntimeModule>
Attributes
chunk:<Chunk>
Returns:
{ReadonlySet }
getChunkModuleIdMap(chunk, filterFn, includeAllChunks?): ChunkModuleIdMapEs5Alias_2
Attributes
chunk:<Chunk>
filterFn:
{object}
includeAllChunks:<boolean>
Returns:
{ChunkModuleIdMapEs5Alias_2}
getChunkModuleRenderedHashMap(chunk, filterFn, hashLength?, includeAllChunks?): ChunkModuleHashMap
Attributes
chunk:<Chunk>
filterFn:
{object}
hashLength:<number>
includeAllChunks:<boolean>
Returns:
{ChunkModuleHashMap}
getChunkModules(chunk): Module[]
Attributes
chunk:<Chunk>
Returns:<Module[]>
getChunkModulesIterable(chunk): Iterable<Module>
Attributes
chunk:<Chunk>
Returns:
{Iterable }
getChunkModulesIterableBySourceType(chunk, sourceType): Iterable<Module, any, any>
Attributes
chunk:<Chunk>
sourceType:<string>
Returns:
{Iterable<Module, any, any>}
getChunkModuleSourceTypes(chunk, module): ReadonlySet<string>
Attributes
chunk:<Chunk>
module:<Module>
Returns:
{ReadonlySet }
getChunkModulesSize(chunk): number
Attributes
chunk:<Chunk>
Returns:<number>
getChunkModulesSizes(chunk): Record<string, number>
Attributes
chunk:<Chunk>
Returns:
{Record<string, number>}
getChunkRootModules(chunk): Module[]
Attributes
chunk:<Chunk>
Returns:<Module[]>
getChunkRuntimeModulesInOrder(chunk): RuntimeModule[]
Attributes
chunk:<Chunk>
getChunkRuntimeModulesIterable(chunk): Iterable<RuntimeModule>
Attributes
chunk:<Chunk>
Returns:
{Iterable }
getChunkRuntimeRequirements(chunk): ReadonlySet<string>
Attributes
chunk:<Chunk>
Returns:
{ReadonlySet }
getChunkSize(chunk, options?): number
Attributes
chunk:<Chunk>
options:
{ChunkSizeOptions}
Returns:<number>
getIntegratedChunksSize(chunkA, chunkB, options?): number
Attributes
chunkA:<Chunk>
chunkB:<Chunk>
options:
{ChunkSizeOptions}
Returns:<number>
getModuleChunks(module): Chunk[]
Attributes
module:<Module>
Returns:<Chunk[]>
getModuleChunksIterable(module): Iterable<Chunk>
Attributes
module:<Module>
Returns:
{Iterable }
getModuleGraphHash(module, runtime, withConnections?): string
Attributes
module:<Module>
runtime:
{RuntimeSpec}
withConnections:<boolean>
Returns:<string>
getModuleGraphHashBigInt(module, runtime, withConnections?): bigint
Attributes
module:<Module>
runtime:
{RuntimeSpec}
withConnections:<boolean>
Returns:<bigint>
getModuleHash(module, runtime): string
Attributes
module:<Module>
runtime:
{RuntimeSpec}
Returns:<string>
getModuleId(module): string | number
Attributes
module:<Module>
Returns:<string> | <number>
getModuleRuntimeRequirements(module, runtime): ReadonlySet<string>
Attributes
module:<Module>
runtime:
{RuntimeSpec}
Returns:
{ReadonlySet }
getModuleRuntimes(module): RuntimeSpecSet
Attributes
module:<Module>
Returns:
{RuntimeSpecSet}
getModuleSourceTypes(module): ReadonlySet<string>
Attributes
module:<Module>
Returns:
{ReadonlySet }
getNumberOfChunkFullHashModules(chunk): number
Attributes
chunk:<Chunk>
Returns:<number>
getNumberOfChunkModules(chunk): number
Attributes
chunk:<Chunk>
Returns:<number>
getNumberOfEntryModules(chunk): number
Attributes
chunk:<Chunk>
Returns:<number>
getNumberOfModuleChunks(module): number
Attributes
module:<Module>
Returns:<number>
getNumberOfRuntimeModules(chunk): number
Attributes
chunk:<Chunk>
Returns:<number>
getOrderedChunkModules(chunk, comparator): Module[]
Attributes
chunk:<Chunk>
comparator:
{object}
Returns:<Module[]>
getOrderedChunkModulesIterable(chunk, comparator): Iterable<Module>
Attributes
chunk:<Chunk>
comparator:
{object}
Returns:
{Iterable }
getOrderedChunkModulesIterableBySourceType(chunk, sourceType, comparator): Iterable<Module, any, any>
Attributes
chunk:<Chunk>
sourceType:<string>
comparator:
{object}
Returns:
{Iterable<Module, any, any>}
getOrderedModuleChunksIterable(module, sortFn): Iterable<Chunk>
Attributes
module:<Module>
sortFn:
{object}
Returns:
{Iterable }
getRenderedModuleHash(module, runtime): string
Attributes
module:<Module>
runtime:
{RuntimeSpec}
Returns:<string>
getRuntimeChunkDependentChunksIterable(chunk): Iterable<Chunk>
Attributes
chunk:<Chunk>
Returns:
{Iterable }
getRuntimeId(runtime): RuntimeId
Attributes
runtime:<string>
Returns:
{RuntimeId}
getTreeRuntimeRequirements(chunk): ReadonlySet<string>
Attributes
chunk:<Chunk>
Returns:
{ReadonlySet }
hasChunkEntryDependentChunks(chunk): boolean
Attributes
chunk:<Chunk>
Returns:<boolean>
hasModuleHashes(module, runtime): boolean
Attributes
module:<Module>
runtime:
{RuntimeSpec}
Returns:<boolean>
hasModuleInGraph(chunk, filterFn, filterChunkFn?): boolean
Attributes
chunk:<Chunk>
filterFn:
{object}
filterChunkFn:
{object}
Returns:<boolean>
integrateChunks(chunkA, chunkB): void
Attributes
chunkA:<Chunk>
chunkB:<Chunk>
Returns:
{void}
isEntryModule(module): boolean
Attributes
module:<Module>
Returns:<boolean>
isEntryModuleInChunk(module, chunk): boolean
Attributes
module:<Module>
chunk:<Chunk>
Returns:<boolean>
isModuleInChunk(module, chunk): boolean
Attributes
module:<Module>
chunk:<Chunk>
Returns:<boolean>
isModuleInChunkGroup(module, chunkGroup): boolean
Attributes
module:<Module>
chunkGroup:<ChunkGroup>
Returns:<boolean>
replaceModule(oldModule, newModule): void
Attributes
oldModule:<Module>
newModule:<Module>
Returns:
{void}
setChunkModuleSourceTypes(chunk, module, sourceTypes): void
Attributes
chunk:<Chunk>
module:<Module>
sourceTypes:
{ReadonlySet }
Returns:
{void}
setModuleHashes(module, runtime, hash, renderedHash): void
Attributes
module:<Module>
runtime:
{RuntimeSpec}
renderedHash:<string>
Returns:
{void}
setModuleId(module, id): void
Attributes
module:<Module>
id:
{ModuleId}
Returns:
{void}
setRuntimeId(runtime, id): void
Attributes
runtime:<string>
id:
{RuntimeId}
Returns:
{void}
upgradeDependentToFullHashModules(chunk): void
Attributes
chunk:<Chunk>
Returns:
{void}
Stability: 0Deprecated
Attributes
chunk:<Chunk>
Returns:
{void}
Stability: 0Deprecated
Attributes
module:<Module>
Returns:
{void}
Stability: 0Deprecated
Attributes
chunk:<Chunk>
deprecateMessage:<string>
deprecationCode:<string>
Returns:<ChunkGraph>
Stability: 0Deprecated
Attributes
module:<Module>
deprecateMessage:<string>
deprecationCode:<string>
Returns:<ChunkGraph>
Stability: 0Deprecated
Attributes
chunk:<Chunk>
chunkGraph:<ChunkGraph>
Returns:
{void}
Stability: 0Deprecated
Attributes
module:<Module>
chunkGraph:<ChunkGraph>
Returns:
{void}

Attributes
new ChunkGroup(): ChunkGroup
Returns:<ChunkGroup>
  • 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}
addAsyncEntrypoint(entrypoint): boolean
Attributes
entrypoint:<Entrypoint>
Returns:<boolean>
addBlock(block): boolean
Attributes
Returns:<boolean>
addChild(group): boolean
Attributes
Returns:<boolean>
addOptions(options): void
  • options {ChunkGroupOptions}
  • Returns: {void}

when a new chunk is added to a chunkGroup, addingOptions will occur.

addOrigin(module, loc, request): void
Attributes
module:<Module>
loc:
{DependencyLocation}
request:<string>
Returns:
{void}
addParent(parentChunk): boolean
Attributes
parentChunk:<ChunkGroup>
Returns:<boolean>
checkConstraints(): void
Returns:
{void}
compareTo(chunkGraph, otherGroup): -1 | 0 | 1
Attributes
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(): AsyncDependenciesBlock[]
getChildren(): ChunkGroup[]
getChildrenByOrders(moduleGraph, chunkGraph): Record<string, ChunkGroup[]>
Attributes
moduleGraph:<ModuleGraph>
chunkGraph:<ChunkGraph>
Returns:
{Record<string, ChunkGroup[]>}
getFiles(): string[]
Returns:<string[]>
getModulePostOrderIndex(module): number
Attributes
module:<Module>
Returns:<number>

Gets the bottom-up index of a module in this ChunkGroup

getModulePreOrderIndex(module): number
Attributes
module:<Module>
Returns:<number>

Gets the top-down index of a module in this ChunkGroup

getNumberOfBlocks(): number
Returns:<number>
getNumberOfChildren(): number
Returns:<number>
getNumberOfParents(): number
Returns:<number>
getParents(): ChunkGroup[]
hasBlock(block): boolean
Attributes
Returns:<boolean>
hasParent(parent): boolean
Attributes
Returns:<boolean>
insertChunk(chunk, before): boolean
Attributes
chunk:<Chunk>
before:<Chunk>
Returns:<boolean>

inserts a chunk before another existing chunk in group

isInitial(): boolean
Returns:<boolean>
pushChunk(chunk): boolean
Attributes
chunk:<Chunk>
Returns:<boolean>

add a chunk into ChunkGroup. Is pushed on or prepended

remove(): void
Returns:
{void}
removeChild(group): boolean
Attributes
Returns:<boolean>
removeChunk(chunk): boolean
Attributes
chunk:<Chunk>
Returns:<boolean>
removeParent(chunkGroup): boolean
Attributes
chunkGroup:<ChunkGroup>
Returns:<boolean>
replaceChunk(oldChunk, newChunk): boolean
Attributes
oldChunk:<Chunk>
newChunk:<Chunk>
Returns:<boolean>
setModulePostOrderIndex(module, index): void
Attributes
module:<Module>
index:<number>
Returns:
{void}

Sets the bottom-up index of a module in this ChunkGroup

setModulePreOrderIndex(module, index): void
Attributes
module:<Module>
index:<number>
Returns:
{void}

Sets the top-down index of a module in this ChunkGroup

sortItems(): void
Returns:
{void}
unshiftChunk(chunk): boolean
Attributes
chunk:<Chunk>
Returns:<boolean>

Performs an unshift of a specific chunk


new CleanPlugin(options?): void
  • options {CleanOptions}
apply(compiler): void
Attributes
compiler:<Compiler>
Returns:
{void}

Apply the plugin

Attributes
compilation:<Compilation>
Returns:
{CleanPluginCompilationHooks}

new CodeGenerationResults(): CodeGenerationResults
  • map {Map<Module, RuntimeSpecMap<CodeGenerationResult, CodeGenerationResult>>}
add(module, runtime, result): void
Attributes
module:<Module>
runtime:
{RuntimeSpec}
result:
{CodeGenerationResult}
Returns:
{void}
get(module, runtime): CodeGenerationResult
Attributes
module:<Module>
runtime:
{RuntimeSpec}
Returns:
{CodeGenerationResult}
getData(module, runtime, key): any
Attributes
module:<Module>
runtime:
{RuntimeSpec}
Returns:<any>
getHash(module, runtime): string
Attributes
module:<Module>
runtime:
{RuntimeSpec}
Returns:<string>
getRuntimeRequirements(module, runtime): ReadonlySet<string>
Attributes
module:<Module>
runtime:
{RuntimeSpec}
Returns:
{ReadonlySet }
getSource(module, runtime, sourceType): Source
Attributes
module:<Module>
runtime:
{RuntimeSpec}
sourceType:<string>
Returns:
{Source}
has(module, runtime): boolean
Attributes
module:<Module>
runtime:
{RuntimeSpec}
Returns:<boolean>

new Compilation(compiler, params): Compilation
Attributes
compiler:<Compiler>
params:
{CompilationParams}

Creates an instance of Compilation.

Attributes
additionalChunkAssets:<string[]>
addModuleQueue:
{AsyncQueue<Module, string, Module>}
assets:
{CompilationAssets}
assetsInfo:
{Map<string, AssetInfo>}
asyncEntrypoints:<Entrypoint[]>
buildDependencies:
{LazySet }
buildQueue:
{AsyncQueue<Module, Module, Module>}
buildTimeExecutedModules:
{WeakSet }
builtModules:
{WeakSet }
childrenCounters:
{Record<string, number>}
chunkGraph:<ChunkGraph>
chunkGroups:<ChunkGroup[]>
chunks:
{Set }
chunkTemplate:
{ChunkTemplate}
codeGeneratedModules:
{WeakSet }
codeGenerationResults:<CodeGenerationResults>
comparedForEmitAssets:
{Set }
compilationDependencies:
{object}
compiler:<Compiler>
compilerPath:<string>
contextDependencies:
{LazySet }
creatingModuleDuringBuild:
{WeakMap<Module, Set >} 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<DependencyConstructor, ModuleFactory>}
dependencyTemplates:
{DependencyTemplates}
emittedAssets:
{Set }
endTime:<number>
entries:
{Map<string, EntryData>}
entrypoints:
{Map<string, Entrypoint>}
errors:<Error[]>
factorizeQueue:
{AsyncQueue<FactorizeModuleOptions, string, Module|ModuleFactoryResult>}
fileDependencies:
{LazySet }
fileSystemInfo:
{FileSystemInfo}
fullHash:<string>
globalEntry:
{EntryData}
hooks:
{Readonly }
inputFileSystem:<InputFileSystem>
logger:
{WebpackLogger}
logging:
{Map<string, LogEntry[]>}
mainTemplate:
{MainTemplate}
missingDependencies:
{LazySet }
moduleGraph:<ModuleGraph>
moduleMemCaches:
{Map<Module, WeakTupleMap<any[], any>>}
moduleMemCaches2:
{Map<Module, WeakTupleMap<any[], any>>}
modules:
{Set }
moduleTemplates:
{ModuleTemplates}
namedChunkGroups:
{Map<string, ChunkGroup>}
namedChunks:
{Map<string, Chunk>}
needAdditionalPass:<boolean>
options:
{WebpackOptionsNormalizedWithDefaults}
outputOptions:
{OutputNormalizedWithDefaults}
params:
{CompilationParams}
processDependenciesQueue:
{AsyncQueue<Module, Module, Module>}
profile:<boolean>
rebuildQueue:
{AsyncQueue<Module, Module, Module>}
records:
{Records}
requestShortener:
{RequestShortener}
resolverFactory:
{ResolverFactory}
runtimeTemplate:
{RuntimeTemplate}
startTime:<number>
usedChunkIds:
{Set }
usedModuleIds:
{Set }
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): Entrypoint
Attributes
module:<Module>
loc:
{DependencyLocation}
request:<string>
Returns:<Entrypoint>
addChunk(name?): Chunk
Attributes
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?): ChunkGroup
Attributes
groupOptions:<string>
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): void
Attributes
context:<string>
optionsOrName:<string> | <EntryOptions>
callback:
{object}
Returns:
{void}
addInclude(context, dependency, options, callback): void
Attributes
context:<string>
dependency:<Dependency>
callback:
{object}
Returns:
{void}
addModule(module, callback): void
Attributes
module:<Module>
callback:
{object}
Returns:
{void}
addModuleChain(context, dependency, callback): void
Attributes
context:<string>
dependency:<Dependency>
callback:
{object}
Returns:
{void}
addModuleTree(__namedParameters, callback): void
  • __namedParameters {object}
  • callback {object}
  • Returns: {void}
addRuntimeModule(chunk, module, chunkGraph?): void
Attributes
chunk:<Chunk>
chunkGraph:<ChunkGraph>
Returns:
{void}
assignDepth(module): void
Stability: 0Deprecated
Attributes
module:<Module>
Returns:
{void}
assignDepths(modules): void
  • modules {Set}
  • Returns: {void}
assignRuntimeIds(): void
Returns:
{void}
buildModule(module, callback): void
Attributes
module:<Module>
callback:
{object}
Returns:
{void}

Schedules a build of the module object

checkConstraints(): void
Returns:
{void}
clearAssets(): void
Returns:
{void}
codeGeneration(callback): void
  • callback {object}
  • Returns: {void}
createChildCompiler(name, outputOptions?, plugins?): Compiler
Attributes
outputOptions:
{Partial }
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): void
  • callback {object}
  • Returns: {void}
createHash(): CodeGenerationJob[]
Returns:
{CodeGenerationJob[]}
createModuleAssets(): void
Returns:
{void}
createModuleHashes(): void
Returns:
{void}
createStatsFactory(options): void
  • options {NormalizedStatsOptions}
  • Returns: {StatsFactory}
createStatsOptions(optionsOrPreset?, context?): NormalizedStatsOptions
Attributes
optionsOrPreset:<string> | <boolean> | <StatsOptions>
context:
{CreateStatsOptionsContext}
Returns:
{NormalizedStatsOptions}
createStatsPrinter(options): void
  • options {NormalizedStatsOptions}
  • Returns: {StatsPrinter}
deleteAsset(file): void
Attributes
Returns:
{void}
emitAsset(file, source, assetInfo?): void
Attributes
source:
{Source}
assetInfo:<AssetInfo>
Returns:
{void}
executeModule(module, options, callback): void
Attributes
module:<Module>
options:
{ExecuteModuleOptions}
callback:
{object}
Returns:
{void}
factorizeModule(options, callback): void
  • options {FactorizeModuleOptions|object}
  • callback {object}
  • Returns: {void}
  • options {FactorizeModuleOptions|object}
  • callback {object}
  • Returns: {void}
findModule(identifier): Module
Attributes
identifier:<string>
Returns:<Module>

Attempts to search for a module by its identifier

finish(callback): void
  • callback {object}
  • Returns: {void}
getAsset(name): Readonly<Asset>
Attributes
Returns:
{Readonly }
getAssetPath(filename, data): string
Attributes
Returns:<string>
getAssetPathWithInfo(filename, data): InterpolatedPathAndAssetInfo
Attributes
Returns:
{InterpolatedPathAndAssetInfo}
getAssets(): Readonly<Asset>[]
Returns:
{Readonly []}
getCache(name): CacheFacade
Attributes
Returns:
{CacheFacade}
getDependencyReferencedExports(dependency, runtime): string[]
Attributes
dependency:<Dependency>
runtime:
{RuntimeSpec}
Returns:<string[]>
getErrors(): Error[]
Returns:<Error[]>
getLogger(name): WebpackLogger
Attributes
Returns:
{WebpackLogger}
getModule(module): Module
Attributes
module:<Module>
Returns:<Module>

Fetches a module from a compilation by its identifier

getPath(filename, data?): string
Attributes
Returns:<string>
getPathWithInfo(filename, data?): InterpolatedPathAndAssetInfo
Attributes
Returns:
{InterpolatedPathAndAssetInfo}
getRenderManifest(options): RenderManifestEntry[]
Attributes
getStats(): Stats
Returns:<Stats>
getWarnings(): Error[]
Returns:<Error[]>
handleModuleCreation(__namedParameters, callback): void
  • __namedParameters {HandleModuleCreationOptions}
  • callback {object}
  • Returns: {void}
patchChunksAfterReasonRemoval(module, chunk): void
Attributes
module:<Module>
chunk:<Chunk>
Returns:
{void}
processModuleDependencies(module, callback): void
Attributes
module:<Module>
callback:
{object}
Returns:
{void}
processModuleDependenciesNonRecursive(module): void
Attributes
module:<Module>
Returns:
{void}
processRuntimeRequirements(__namedParameters?): void
  • __namedParameters {object}
  • Returns: {void}
rebuildModule(module, callback): void
Attributes
module:<Module>
callback:
{object}
Returns:
{void}
removeChunkFromDependencies(block, chunk): void
  • block {DependenciesBlock}
  • chunk <Chunk>
  • Returns: {void}
removeReasonsOfDependencyBlock(module, block): void
Attributes
module:<Module>
block:
{DependenciesBlockLike}
Returns:
{void}
renameAsset(file, newFile): void
Attributes
newFile:<string>
Returns:
{void}
reportDependencyErrorsAndWarnings(module, blocks): boolean
Attributes
module:<Module>
blocks:
{DependenciesBlock[]}
Returns:<boolean>
seal(callback): void
  • callback {object}
  • Returns: {void}
sortItemsWithChunkIds(): void
Returns:
{void}
summarizeDependencies(): void
Returns:
{void}
unseal(): void
Returns:
{void}
updateAsset(file, newSourceOrFunction, assetInfoUpdateOrFunction?): void
Attributes
newSourceOrFunction:
{Source|object}
assetInfoUpdateOrFunction:<AssetInfo>
Returns:
{void}

new Compiler(context, options?): Compiler
Attributes
Returns:<Compiler>