On this page

Attributes
callback:
{CallbackWebpackFunction_2<Stats, void>}
Returns:<Compiler> | <null>
Attributes
Returns:<Compiler>
Attributes
callback:
{CallbackWebpackFunction_2<MultiStats, void>}
Attributes

Attributes

Attributes
pluginName:<string>
name of the plugin
used library type

  • [index: {string}] <any>
Attributes
webpackAST:<object>

Attributes
minSizeReduce:<number>
minimal size reduction to trigger merging

Attributes
chunkOverhead:<number>
Extra cost for each chunk (Default: 9.8kiB).
entryChunkMultiplicator:<number>
Extra cost multiplicator for entry chunks (Default: 10).
maxSize:<number>
Byte, max size of per file (Default: 50kiB).
minSize:<number>
Byte, split point. (Default: 30kiB).


  • [index: {string}] {AliasOptionNewRequest}

Attributes
assetInfo:<AssetInfo>
an asset info for asset modules
chunkInitFragments:
{InitFragment []} chunk init fragments for javascript modules
filename:<string>
a filename for asset modules
fullContentHash:<string>
a full content hash for asset modules
share-init:
{Tuple } share-init for modules federation
topLevelDeclarations:
{Set } top level declarations for javascript modules
url for css and javascript modules

Attributes
description:<string>
multiple:<boolean>
negatedDescription:<string>
type:
{"string"|"number"|"boolean"|"path"|"enum"|"RegExp"|"reset"}
values:
{EnumValue[]}

  • sourceType {"css-url"}

Options object for data url generation.

  • encoding {false|"base64"} Asset encoding (defaults to base64).
  • mimetype <string> Asset mimetype (getting from file extension by default).

Generator options for asset/inline modules.

Attributes
binary:<boolean>
Whether or not this asset module should be considered binary. This can be set to 'false' to treat this asset module as text.
dataUrl:<object>
The options for data url generator.

Options object for DataUrl condition.

Attributes
maxSize:<number>
Maximum size of asset that should be inline as modules. Default: 8kb.

Parser options for asset modules.

Attributes
dataUrlCondition:<object>
The condition for inlining the asset as DataUrl.

Generator options for asset/resource modules.

Attributes
binary:<boolean>
Whether or not this asset module should be considered binary. This can be set to 'false' to treat this asset module as text.
Emit an output asset from this asset module. This can be set to 'false' to omit emitting e. g. for SSR.
filename:<string> | <object>
Specifies the filename template of output files on disk. You must  not specify an absolute path here, but the path may contain folders separated by '/'! The specified path is joined with the value of the 'output.path' option to determine the location on disk.
outputPath:<string> | <object>
Emit the asset in the specified folder relative to 'output.path'. This should only be needed when custom 'publicPath' is specified to match the folder structure there.
publicPath:<string> | <object>
The 'publicPath' specifies the public URL address of the output files when referenced in a browser.

Attributes
mangleImports:<boolean>
mangle imports

Attributes
dispose:<object>
module:<object>

Attributes
Specifies the banner.
entryOnly:<boolean>
If true, the banner will only be added to the entry chunks.
Exclude all modules matching any of these conditions.
footer:<boolean>
If true, banner will be placed at the end of the output.
Include all modules matching any of these conditions.
If true, banner will not be wrapped in a comment.
stage:<number>
Specifies the stage when add a banner.
Include all modules that pass test assertion.

Attributes
__innerRequest:<string>
inner request for internal usage
__innerRequest_relativePath:<string>
inner relative path for internal usage
__innerRequest_request:<string>
inner request for internal usage
context:
{ContextTypes} content
descriptionFileData:
{JsonObjectTypes} description file data
descriptionFilePath:<string>
description file path
descriptionFileRoot:<string>
description file root
fullySpecified:<boolean>
true when full specified, otherwise false
ignoreSymlinks:<boolean>
true when need to ignore symlinks, otherwise false
path
relativePath:<string>
relative path
tsconfigPathsMap:<null>
tsconfig paths map

Attributes
afterStartup:<string[]>
allowInlineStartup:<boolean>
beforeStartup:<string[]>
header:<string[]>
startup:<string[]>

Attributes
file
mappings:
{Buffer } mappings
name
sourceRoot:<string>
source root
sources:<string[]>
sources
sourcesContent:
{""|Buffer []} sources content
version:<number>
version

Attributes
bufferedMap:<null>
map:<null>

  • buffer {Buffer} buffer
  • hash {string|Buffer[]} hash
  • maps {Map<string, BufferEntry>} maps
  • size <number> size
  • source <boolean> source

Attributes
chunkGraph:<ChunkGraph>
moduleGraph:<ModuleGraph>

Attributes
automaticNameDelimiter:<string>
chunksFilter:<object>
enforce:<boolean>
enforceSizeThreshold:
{SplitChunksSizes}
filename:<string> | <object>
getName:<object>
idHint:<string>
maxAsyncRequests:<number>
maxAsyncSize:
{SplitChunksSizes}
maxInitialRequests:<number>
maxInitialSize:
{SplitChunksSizes}
minChunks:<number>
minRemainingSize:
{SplitChunksSizes}
minSize:
{SplitChunksSizes}
minSizeReduction:
{SplitChunksSizes}
priority:<number>
reuseExistingChunk:<boolean>
usedExports:<boolean>


Attributes
conditional:
{false|CalculatedStringResult[]}
range:
{Tuple<number, number>}
value:<string>

Attributes
Returns:
{void}

Attributes
result:
{T}
Returns:
{void}

Attributes
result:<null>
Returns:
{void}

Attributes
result:
{T}
Returns:
{void}

Attributes
result:
{T}
Returns:
{void}

Attributes
result:
{T}
Returns:
{R}


  • [index: {string}] {ChunkId[]}

  • [index: {string}] {ChunkChildIdsByOrdersMap}



Attributes
chunkGroup:<ChunkGroup>

Attributes
chunkGraph:<ChunkGraph>
the chunk graph
codeGenerationResults:<CodeGenerationResults>
results of code generation
moduleGraph:<ModuleGraph>
the module graph
runtimeTemplate:
[ <RuntimeTemplate> ]( /RuntimeTemplate.html) the runtime template


  • contentHash {Record<ChunkId, Record<string, string>>}
  • hash {Record<ChunkId, string>}
  • name {Record<ChunkId, string>}



  • [index: {number}] {IdToHashMap}

  • [index: {string}] {IdToHashMap}


  • [index: {number}] {ChunkId[]}

  • [index: {string}] {ChunkId[]}


  • [index: {number}] {ModuleId[]}

  • [index: {string}] {ModuleId[]}


Attributes
end id
the chunk name
order:
{"index"|"preOrderIndex"|"index2"|"postOrderIndex"} order
start:<number>
start id

  • [index: {number}] {ModuleId[]}

  • [index: {string}] {ModuleId[]}


  • hash {chunkModuleHashMap}
  • id {ChunkModuleIdMapEs5Alias_1}


Attributes
chunk:<Chunk>
the chunk
chunkGraph:<ChunkGraph>
the chunk graph
codeGenerationResults:<CodeGenerationResults>
results of code generation
moduleFactoryCache:
{WeakMap<Source, ModuleFactoryCacheEntry>} moduleFactoryCache
moduleSourceContent:<Source>
content
runtimeTemplate:
[ <RuntimeTemplate> ]( /RuntimeTemplate.html) the runtime template
undoPath:<string>
undo path to css file

Attributes
chunk:<Chunk>
the chunk
chunkGraph:<ChunkGraph>
the chunk graph
chunkInitFragments:
{InitFragment []} init fragments for the chunk
codeGenerationResults:<CodeGenerationResults>
results of code generation
dependencyTemplates:
[ <DependencyTemplates> ]( /DependencyTemplates.html) the dependency templates
moduleGraph:<ModuleGraph>
the module graph
runtimeTemplate:
[ <RuntimeTemplate> ]( /RuntimeTemplate.html) the runtime template
strictMode:<boolean>
rendering in strict context


Attributes
chunkOverhead:<number>
constant overhead for a chunk
entryChunkMultiplicator:<number>
multiplicator for initial chunks

Advanced options for cleaning assets.

Attributes
Log the assets that should be removed instead of deleting them.
Keep these assets.

  • keep {SyncBailHook<Tuple, boolean|void>} when returning true the file/directory will be kept during cleaning, returning false will clean it and ignore the following plugins and config

Attributes
chunkGraph:<ChunkGraph>
the chunk graph
codeGenerationResults:<CodeGenerationResults>
code generation results of other modules (need to have a codeGenerationDependency to use that)
compilation:<Compilation>
the compilation
concatenationScope:<ConcatenationScope>
when in concatenated module, information about other concatenated modules
dependencyTemplates:
[ <DependencyTemplates> ]( /DependencyTemplates.html) the dependency templates
moduleGraph:<ModuleGraph>
the module graph
runtime:
{RuntimeSpec} the runtimes code should be generated for
runtimes:
{RuntimeSpec[]} all runtimes code should be generated for
runtimeTemplate:
[ <RuntimeTemplate> ]( /RuntimeTemplate.html) the runtime template
sourceTypes:
{ReadonlySet } source types

Attributes
module:<Module>
runtime:
{RuntimeSpec}
runtimes:
{RuntimeSpec[]}

  • data {CodeGenerationResultData} the resulting data for all source types
  • hash <string> a hash of the code generation result (will be automatically calculated from sources and runtimeRequirements if not provided)
  • runtimeRequirements {ReadonlySet|null} the runtime requirements
  • sources {Map<string, Source>} the resulting sources for all source types

Attributes

Attributes
range:
{Tuple<number, number>}
value:<string>

Attributes
context:<string>

  • a {T}
  • b {T}
  • Returns: {-1|0|1}

  • declaration {CompatibilitySettingsDeclaration}
  • name <string>

  • loc {DependencyLocation}
  • range {Tuple<number, number>}
  • updated <boolean>


  • renderModuleContent {SyncWaterfallHook<Tuple<Source, Module, WebAssemblyRenderContext>, Source>}

  • chunkHash {SyncHook<Tuple<Chunk, Hash, ChunkHashContext>>}
  • renderModulePackage {SyncWaterfallHook<Tuple<Source, Module, ChunkRenderContextCssModulesPlugin>, Source>}

  • chunkHash {SyncHook<Tuple<Chunk, Hash, ChunkHashContext>>}
  • embedInRuntimeBailout {SyncBailHook<Tuple<Module, RenderContextJavascriptModulesPlugin>, string|void>}
  • inlineInRuntimeBailout {SyncBailHook<Tuple<Module, Partial>, string|void>}
  • render {SyncWaterfallHook<Tuple<Source, RenderContextJavascriptModulesPlugin>, Source>}
  • renderChunk {SyncWaterfallHook<Tuple<Source, RenderContextJavascriptModulesPlugin>, Source>}
  • renderContent {SyncWaterfallHook<Tuple<Source, RenderContextJavascriptModulesPlugin>, Source>}
  • renderMain {SyncWaterfallHook<Tuple<Source, RenderContextJavascriptModulesPlugin>, Source>}
  • renderModuleContainer {SyncWaterfallHook<Tuple<Source, Module, ModuleRenderContext>, Source>}
  • renderModuleContent {SyncWaterfallHook<Tuple<Source, Module, ModuleRenderContext>, Source>}
  • renderModulePackage {SyncWaterfallHook<Tuple<Source, Module, ModuleRenderContext>, Source>}
  • renderRequire {SyncWaterfallHook<Tuple<string, RenderBootstrapContext>, string>}
  • renderStartup {SyncWaterfallHook<Tuple<Source, Module, StartupRenderContext>, Source>}
  • strictRuntimeBailout {SyncBailHook<Tuple, string|void>}
  • useSourceMap {SyncBailHook<Tuple<Chunk, RenderContextJavascriptModulesPlugin>, boolean|void>}

  • addContainerEntryDependency {SyncHook}
  • addFederationRuntimeDependency {SyncHook}

  • updateHash {SyncBailHook<Tuple<Buffer[], string>, string|void>}

  • contextModuleFactory [<ContextModuleFactory>](/ContextModuleFactory.html)
  • normalModuleFactory [<NormalModuleFactory>](/NormalModuleFactory.html)

  • ast {Program}
  • chunkInitFragments {InitFragment[]}
  • concatenationScope <ConcatenationScope>
  • exportMap {Map<string, string>}
  • globalScope {Scope<Variable, Reference>}
  • index <number>
  • internalNames {Map<string, string>}
  • internalSource <Source>
  • interopDefaultAccessName <string> runtime namespace object that detects "__esModule"
  • interopDefaultAccessUsed <boolean> runtime namespace object that detects "__esModule"
  • interopNamespaceObject2Name <string> "default-only" namespace
  • interopNamespaceObject2Used <boolean> "default-only" namespace
  • interopNamespaceObjectName <string> "default-with-named" namespace
  • interopNamespaceObjectUsed <boolean> "default-with-named" namespace
  • module <Module>
  • moduleScope {Scope<Variable, Reference>}
  • namespaceExportSymbol <string>
  • namespaceObjectName <string>
  • rawExportMap {Map<string, string>}
  • runtimeRequirements {ReadonlySet}
  • source <ReplaceSource>
  • type {"concatenated"}

Attributes
chunkGraph:<ChunkGraph>
the chunk graph
moduleGraph:<ModuleGraph>
the module graph

new Constructor(...params): any
Attributes
params:<any[]>
Returns:<any>

Advanced configuration for modules that should be consumed from share scope.

Attributes
eager:<boolean>
Include the fallback module directly instead behind an async request. This allows to use fallback module in initial load too. All possible shared modules need to be eager too.
import:<string>
Fallback module if no shared module is found in share scope. Defaults to the property name.
packageName:<string>
Package name to determine required version from description file. This is only needed when package name can't be automatically determined from request.
requiredVersion:<string>
Version requirement from module in share scope.
shareKey:<string>
Module is looked up under this key from the share scope.
shareScope:<string>
Share scope name.
singleton:<boolean>
Allow only a single version of the shared module in share scope (disabled by default).
strictVersion:<boolean>
Do not accept shared module if version is not valid (defaults to yes, if local fallback module is available and shared module is not a singleton, otherwise no, has no effect if there is no required version specified).

Options for consuming shared modules.

  • consumes {Consumes} Modules that should be consumed from share scope. When provided, property names are used to match requested modules in this compilation.
  • shareScope <string> Share scope name used for all consumed modules (defaults to 'default').

Modules that should be consumed from share scope. Property names are used to match requested modules in this compilation. Relative requests are resolved, module requests are matched unresolved, absolute paths will match resolved requests. A trailing slash will match all requests with this prefix. In this case shareKey must also have a trailing slash.


  • exposes {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 <string> The filename for this container relative path inside the output.path directory.
  • library <LibraryOptions> Options for library.
  • name <string> The name for this container.
  • runtime <string> 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 <string> The name of the share scope which is shared with the host (defaults to 'default').

  • remotes {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 {ExternalsType} The external type of the remote containers.
  • shareScope <string> The name of the share scope shared with all remotes (defaults to 'default').

Attributes
context:<string>
request:<string>

  • resolved {ResolvedContextFileSystemInfoEntry}
  • safeTime <number>
  • symlinks {Set}
  • timestampHash <string>

Attributes
resolved:<string>
symlinks:
{Set }

Attributes
resolveOptions:<ResolveOptions>
resource:<string> | <string[]>
resourceFragment:<string>
resourceQuery:<string>

Attributes
addon:<string>
attributes:
{Record<string, string>}
category:<string>
chunkName:<string> | <null>
exclude:<RegExp> | <null>
groupOptions:
{RawChunkGroupOptions}
include:<RegExp> | <null>
mode:
{ContextMode}
namespaceObject:<boolean>
phase:
{0|2|1}
recursive:<boolean>
referencedExports:<null>
exports referenced from modules (won't be mangled)
regExp:<RegExp> | <null>
typePrefix:<string>

Attributes
context:<string>
contextDependencies:
{LazySet }
dependencies:
[ <ContextDependency[]> ]( /ContextDependency.html)
fileDependencies:
{LazySet }
missingDependencies:
{LazySet }
request:<string>
resolveOptions:<ResolveOptions>

Attributes
resolved:
{ResolvedContextTimestampAndHash}
safeTime:<number>
symlinks:
{Set }
timestampHash:<string>

Attributes
esModule:<boolean>
whether export __esModule
exports:
{Map<string, string>} the css exports

Generator options for css modules.

Attributes
esModule:<boolean>
Configure the generated JS modules that use the ES modules syntax.
exportsOnly:<boolean>
Avoid generating and loading a stylesheet and only embed exports from css into output javascript files.

Attributes
layer:<string>
media:<string>
supports:<string>

  • createStylesheet {SyncWaterfallHook<Tuple<string, Chunk>, string>}
  • linkPrefetch {SyncWaterfallHook<Tuple<string, Chunk>, string>}
  • linkPreload {SyncWaterfallHook<Tuple<string, Chunk>, string>}

Generator options for css/module modules.

Attributes
esModule:<boolean>
Configure the generated JS modules that use the ES modules syntax.
exportsConvention:<object>
Specifies the convention of exported names.
exportsOnly:<boolean>
Avoid generating and loading a stylesheet and only embed exports from css into output javascript files.
exportType:
{"link"|"text"|"css-style-sheet"|"style"} Configure how CSS content is exported as default.
localIdentHashDigest:<string>
Digest types used for the hash.
localIdentHashDigestLength:<number>
Number of chars which are used for the hash.
localIdentHashFunction:<string>
| [ <Hash> ]( /Hash.html) Algorithm used for generation the hash (see node.js crypto package).
localIdentHashSalt:<string>
Any string which is added to the hash to salt it.
localIdentName:<string> | <object>
Configure the generated local ident name.

Parser options for css/module modules.

Attributes
animation:<boolean>
Enable/disable renaming of  @keyframes .
container:<boolean>
Enable/disable renaming of  @container names.
customIdents:<boolean>
Enable/disable renaming of custom identifiers.
dashedIdents:<boolean>
Enable/disable renaming of dashed identifiers, e. g. custom properties.
exportType:
{"link"|"text"|"css-style-sheet"|"style"} Configure how CSS content is exported as default.
function:<boolean>
Enable/disable renaming of  @function names.
Enable/disable renaming of grid identifiers.
import:<boolean>
Enable/disable  @import at-rules handling.
namedExports:<boolean>
Use ES modules named export for css exports.
Enable/disable  url() / image-set() / src() / image() functions handling.

Parser options for css modules.

  • exportType {"link"|"text"|"css-style-sheet"|"style"} Configure how CSS content is exported as default.
  • import <boolean> Enable/disable @import at-rules handling.
  • namedExports <boolean> Use ES modules named export for css exports.
  • url <boolean> Enable/disable url()/image-set()/src()/image() functions handling.

  • definitions {SyncWaterfallHook<Tuple<Record<string, CodeValue>>, Record<string, CodeValue>>}

  • [index: {string}] {CodeValue}

Attributes

new DependencyConstructor(...args): Dependency
Attributes
args:<any[]>
Returns:<Dependency>

Attributes
the main source order
the sub source order

Attributes
chunkGraph:<ChunkGraph>
the chunk graph
chunkInitFragments:
{InitFragment []} chunkInitFragments
codeGenerationResults:<CodeGenerationResults>
the code generation results
concatenationScope:<ConcatenationScope>
when in a concatenated module, information about other concatenated modules
dependencyTemplates:
[ <DependencyTemplates> ]( /DependencyTemplates.html) the dependency templates
initFragments:
{InitFragment []} mutable array of init fragments for the current module
module:<Module>
current module
moduleGraph:<ModuleGraph>
the module graph
runtime:
{RuntimeSpec} current runtimes, for which code is generated
runtimeRequirements:
{Set } the requirements for runtime
runtimeTemplate:
[ <RuntimeTemplate> ]( /RuntimeTemplate.html) the runtime template

Helper function for joining two ranges into a single range. This is useful when working with AST nodes, as it allows you to combine the ranges of child nodes to create the range of the parent node.

Attributes
loc:
{SourceLocation}
pattern:
{Set }
range:
{Tuple<number, number>}
shorthand:<string> | <boolean>

Attributes
context:<string>
context for ids
maxLength:<number>
maximum length of ids

Attributes
context:<string>
context relative to which module identifiers are computed
failOnConflict:<boolean>
throw an error when id conflicts occur (instead of rehashing)
fixedLength:<boolean>
do not increase the maxLength to find an optimal id space size
maxLength:<number>
maximum id length in digits (used as starting point)
hash salt for ids
selector function for modules

Attributes
isBlockDevice:<object>
true when is block device, otherwise false
isCharacterDevice:<object>
true when is character device, otherwise false
isDirectory:<object>
true when is directory, otherwise false
isFIFO:<object>
true when is FIFO, otherwise false
isFile:<object>
true when is file, otherwise false
isSocket:<object>
true when is socket, otherwise false
isSymbolicLink:<object>
true when is symbolic link, otherwise false
name:
{T} name
parentPath:<string>
path
path

  • {IteratorObject}
Returns:
{void}

Attributes
context:<string>
Context of requests in the manifest file (defaults to the webpack context).
entryOnly:<boolean>
If true, only entry points will be exposed (default: true).
format:<boolean>
If true, manifest json file (output) will be formatted.
Name of the exposed dll function (external name, use value of 'output.library').
Absolute path to the manifest json file (output).
Type of the dll bundle (external type, use value of 'output.libraryTarget').

The mappings from request to module info.


An object containing content, name and type.

  • content {DllReferencePluginOptionsContent} The mappings from request to module info.
  • name <string> The name where the dll is exposed (external name).
  • type {"global"|"commonjs"|"jsonp"|"this"|"var"|"assign"|"window"|"commonjs2"|"commonjs-module"|"amd"|"amd-require"|"umd"|"umd2"|"system"} The type how the dll is exposed (external type).

Options for Dotenv plugin.

Attributes
The directory from which .env files are loaded. Can be an absolute path, false will disable the .env file loading.
Only expose environment variables that start with these prefixes. Defaults to 'WEBPACK_'.
template:<string[]>
Template patterns for .env file names. Use [mode] as placeholder for the webpack mode. Defaults to ['.env', '.env.local', '.env.[mode]', '.env.[mode].local'].

Attributes
value:<any>



No generator options are supported for this module type.


No parser options are supported for this module type.


Attributes
additionalApply:<object>
function that runs when applying the current plugin.

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 of the entrypoint

An object with entry point description.

Attributes
asyncChunks:<boolean>
Enable/disable creating async chunks that are loaded on demand.
baseUri:<string>
Base uri for this entry.
chunkLoading:<string>
The method of loading chunks (methods included by default are 'jsonp' (web), 'import' (ESM), 'importScripts' (WebWorker), 'require' (sync node.js), 'async-node' (async node.js), but others might be added by plugins).
dependOn:<string> | <string[]>
The entrypoints that the current entrypoint depend on. They must be loaded when this entrypoint is loaded.
filename:<string> | <object>
Specifies the filename of the output file on disk. You must  not specify an absolute path here, but the path may contain folders separated by '/'! The specified path is joined with the value of the 'output.path' option to determine the location on disk.
import:
{EntryItem} Module(s) that are loaded upon startup.
Specifies the layer in which modules of this entrypoint are placed.
Options for library.
publicPath:<string> | <object>
The 'publicPath' specifies the public URL address of the output files when referenced in a browser.
runtime:<string>
The name of the runtime chunk. If set a runtime chunk with this name is created or an existing entrypoint is used as runtime.
wasmLoading:<string>
The method of loading WebAssembly Modules (methods included by default are 'fetch' (web/WebWorker), 'async-node' (node.js), but others might be added by plugins).

An object with entry point description.

Attributes
asyncChunks:<boolean>
Enable/disable creating async chunks that are loaded on demand.
baseUri:<string>
Base uri for this entry.
chunkLoading:<string>
The method of loading chunks (methods included by default are 'jsonp' (web), 'import' (ESM), 'importScripts' (WebWorker), 'require' (sync node.js), 'async-node' (async node.js), but others might be added by plugins).
dependOn:<string[]>
The entrypoints that the current entrypoint depend on. They must be loaded when this entrypoint is loaded.
filename:<string> | <object>
Specifies the filename of output files on disk. You must  not specify an absolute path here, but the path may contain folders separated by '/'! The specified path is joined with the value of the 'output.path' option to determine the location on disk.
import:<string[]>
Module(s) that are loaded upon startup. The last one is exported.
Specifies the layer in which modules of this entrypoint are placed.
Options for library.
publicPath:<string> | <object>
The 'publicPath' specifies the public URL address of the output files when referenced in a browser.
runtime:<string>
The name of the runtime chunk. If set a runtime chunk with this name is created or an existing entrypoint is used as runtime.
wasmLoading:<string>
The method of loading WebAssembly Modules (methods included by default are 'fetch' (web/WebWorker), 'async-node' (node.js), but others might be added by plugins).

Multiple entry bundles are created. The key is the entry name. The value is an entry description object.

  • [index: {string}] {EntryDescriptionNormalized}

Attributes
accuracy:<number>
safeTime:<number>
timestamp:<number>

  • [index: {string}] {EnumValue}

The abilities of the environment where the webpack generated code should run.

Attributes
arrowFunction:<boolean>
The environment supports arrow functions ('() => { ... }').
asyncFunction:<boolean>
The environment supports async function and await ('async function () { await ... }').
bigIntLiteral:<boolean>
The environment supports BigInt as literal (123n).
const:<boolean>
The environment supports const and let for variable declarations.
destructuring:<boolean>
The environment supports destructuring ('{ a, b } = obj').
document:<boolean>
The environment supports 'document'.
dynamicImport:<boolean>
The environment supports an async import() function to import EcmaScript modules.
dynamicImportInWorker:<boolean>
The environment supports an async import() is available when creating a worker.
forOf:<boolean>
The environment supports 'for of' iteration ('for (const x of array) { ... }').
globalThis:<boolean>
The environment supports 'globalThis'.
importMetaDirnameAndFilename:<boolean>
The environment supports  import.meta.dirname and import.meta.filename .
methodShorthand:<boolean>
The environment supports object method shorthand ('{ module() {} }').
module:<boolean>
The environment supports EcmaScript Module syntax to import EcmaScript modules (import ... from '...').
nodePrefixForCoreModules:<boolean>
The environment supports  node: prefix for Node.js core modules.
optionalChaining:<boolean>
The environment supports optional chaining ('obj?.a' or 'obj?.()').
templateLiteral:<boolean>
The environment supports template literals.

Attributes
toString:<object>

Attributes
moduleFilenameTemplate:<string> | <object>
module filename template
namespace:<string>
namespace
sourceUrlComment:<string>
source url comment

  • codeGenerationResult {CodeGenerationResult}
  • module <Module>
  • moduleObject {ExecuteModuleObject}

  • __webpack_require__ {WebpackRequire}
  • assets {Map<string, object>}
  • chunk <Chunk>
  • chunkGraph <ChunkGraph>

Attributes
error:<Error>
error
exports:<any>
exports
module id
loaded:<boolean>
is loaded

Attributes
entryOptions:<EntryOptions>

  • assets {Map<string, object>}
  • buildDependencies {LazySet}
  • cacheable <boolean>
  • contextDependencies {LazySet}
  • exports <any>
  • fileDependencies {LazySet}
  • missingDependencies {LazySet}

Attributes
module id
module:
{ExecuteModuleObject} module
require:
{WebpackRequire} require function



Enables/Disables experiments (experimental features with relax SemVer compatibility).

Attributes
asyncWebAssembly:<boolean>
Support WebAssembly as asynchronous EcmaScript Module.
backCompat:<boolean>
Enable backward-compat layer with deprecation warnings for many webpack 4 APIs.
cacheUnaffected:<boolean>
Enable additional in memory caching of modules that are unchanged and reference only unchanged modules.
futureDefaults:<boolean>
Apply defaults of next major version.
outputModule:<boolean>
Allow output javascript files as module source type.
syncWebAssembly:<boolean>
Support WebAssembly as synchronous EcmaScript Module (outdated).

Enables/Disables experiments (experimental features with relax SemVer compatibility).

  • [index: {string}] <any>
Attributes
Build http(s): urls using a lockfile and resource content cache.
Enable css support.
deferImport:<boolean>
Enable experimental tc39 proposal  https://github.com/tc39/proposal-defer-import-eval . This allows to defer execution of a module until it's first use.
lazyCompilation:<boolean>
Compile entrypoints and import()s only when they are accessed.

Enables/Disables experiments (experimental features with relax SemVer compatibility).

  • buildHttp {HttpUriOptions} Build http(s): urls using a lockfile and resource content cache.
  • css <boolean> Enable css support.
  • deferImport <boolean> Enable experimental tc39 proposal https://github.com/tc39/proposal-defer-import-eval. This allows to defer execution of a module until it's first use.
  • lazyCompilation {false|LazyCompilationOptions} Compile entrypoints and import()s only when they are accessed.

Attributes
canMangle:<boolean>
can the export be renamed (defaults to true)
when reexported: from which export
exports:<string>
nested exports
when reexported: from which module
hidden:<boolean>
export is not visible, because another export blends over it
the name of the export
priority:<number>
when reexported: with which priority
terminalBinding:<boolean>
is the export a terminal binding that should be checked for export star conflicts

Attributes
canMangle:<boolean>
can the export be renamed (defaults to true)
dependencies:<Module[]>
module on which the result depends on
excludeExports:
{Set } when exports = true, list of unaffected exports
exports:<string> | <null>
exported names, true for unknown exports or null for no exports
when reexported: from which module
hideExports:
{Set |null} list of maybe prior exposed, but now hidden exports
priority:<number>
when reexported: with which priority
terminalBinding:<boolean>
are the exports terminal bindings that should be checked for export star conflicts

Advanced configuration for modules that should be exposed by this container.

Attributes
Request to a module that should be exposed by this container.
Custom chunk name for the exposed module.

Modules that should be exposed by this container. Property names are used as public paths.


Attributes
getMemberRanges:<object>
getMembers:<object>
getMembersOptionals:<object>
rootInfo:<string>
| [ <VariableInfo> ]( /VariableInfo.html)
type:
{"expression"}

Attributes
extension:<string>


  • chunkCondition {SyncBailHook<Tuple<Chunk, Compilation>, boolean>}

Attributes
deferred:<boolean>
the module is deferred at least once
deferredName:<string>
deferred module.exports / harmony namespace object
deferredNamespaceObjectName:<string>
deferred namespace object that being used in a not-analyzable way so it must be materialized
deferredNamespaceObjectUsed:<boolean>
deferred namespace object that being used in a not-analyzable way so it must be materialized
index:<number>
interopDefaultAccessName:<string>
runtime namespace object that detects "__esModule"
interopDefaultAccessUsed:<boolean>
runtime namespace object that detects "__esModule"
interopNamespaceObject2Name:<string>
"default-only" namespace
interopNamespaceObject2Used:<boolean>
"default-only" namespace
interopNamespaceObjectName:<string>
"default-with-named" namespace
interopNamespaceObjectUsed:<boolean>
"default-with-named" namespace
module:<Module>
module.exports / harmony namespace object
nonDeferAccess:<boolean>
runtimeCondition:
{string|boolean|SortableSet }
type:
{"external"}

Enable presets of externals for specific targets.

Attributes
electron:<boolean>
Treat common electron built-in modules in main and preload context like 'electron', 'ipc' or 'shell' as external and load them via require() when used.
electronMain:<boolean>
Treat electron built-in modules in the main context like 'app', 'ipc-main' or 'shell' as external and load them via require() when used.
electronPreload:<boolean>
Treat electron built-in modules in the preload context like 'web-frame', 'ipc-renderer' or 'shell' as external and load them via require() when used.
electronRenderer:<boolean>
Treat electron built-in modules in the renderer context like 'web-frame', 'ipc-renderer' or 'shell' as external and load them via require() when used.
Treat node.js built-in modules like fs, path or vm as external and load them via require() when used.
Treat NW.js legacy nw.gui module as external and load it via require() when used.
Treat references to 'http(s)://...' and 'std:...' as external and load them via import when used (Note that this changes execution order as externals are executed before any other code in the chunk).
webAsync:<boolean>
Treat references to 'http(s)://...' and 'std:...' as external and load them via async import() when used (Note that this external type is an async module, which has various effects on the execution).

Attributes
context:<string>
contextInfo:
{Partial }
currentProfile:
[ <ModuleProfile> ]( /ModuleProfile.html)
dependencies:<Dependency[]>
factoryResult:<boolean>
return full ModuleFactoryResult instead of only module
originModule:<Module> | <null>

Attributes
sideEffectFree:<boolean>


Attributes
automaticNameDelimiter:<string>
chunksFilter:<object>
maxAsyncSize:
{SplitChunksSizes}
maxInitialSize:
{SplitChunksSizes}
minSize:
{SplitChunksSizes}

Attributes
mangleImports:<boolean>
mangle imports

  • lstat {LStatTypes} lstat method
  • readdir {ReaddirTypes} readdir method
  • readFile {ReadFileTypes} read file method
  • readJson <object> read json method
  • readlink {ReadlinkTypes} read link method
  • realpath {RealPathTypes} realpath method
  • stat {StatTypes} stat method

Attributes
safeTime:<number>
timestamp:<number>


Attributes
close:<object>


Attributes
chunkGraph:<ChunkGraph>
the chunk graph
codeGenerationResults:<CodeGenerationResults>
code generation results of other modules (need to have a codeGenerationDependency to use that)
concatenationScope:<ConcatenationScope>
when in concatenated module, information about other concatenated modules
dependencyTemplates:
[ <DependencyTemplates> ]( /DependencyTemplates.html) mapping from dependencies to templates
getData:<object>
get access to the code generation data
moduleGraph:<ModuleGraph>
the module graph
runtime:
{RuntimeSpec} the runtime
runtimeRequirements:
{Set } the requirements for runtime
runtimeTemplate:
[ <RuntimeTemplate> ]( /RuntimeTemplate.html) the runtime template
which kind of code should be generated

Attributes
generatedColumn:<number>
generated column
generatedLine:<number>
generated line
source:<string>
source

  • [index: {string}] <any>

Specify options for each generator.


  • result {T}
  • callback <object>
  • Returns: {void}

Attributes
createGroup:<object>
getKeys:<object>
getOptions:<object>

Attributes
force:<boolean>
groupChildren:<boolean>
targetGroupCount:<number>

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 }
dependencies:<Dependency[]>
originModule:<Module> | <null>
recursive:<boolean>
recurse into dependencies of the created module


  • guards {AppendOnlyStackedSet}

Attributes
updateHash:<object>

Attributes
context:<string>
The context directory for creating names.
hashDigest:
{"ascii"|"utf8"|"utf-8"|"utf16le"|"utf-16le"|"ucs2"|"ucs-2"|"base64"|"base64url"|"latin1"|"binary"|"hex"} The encoding to use when generating the hash, defaults to 'base64'. All encodings from Node.JS' hash.digest are supported.
hashDigestLength:<number>
The prefix length of the hash digest to use, defaults to 4.
hashFunction:<string>
| [ <Hash> ]( /Hash.html) The hashing algorithm to use, defaults to 'md4'. All functions from Node.JS' crypto.createHash are supported.

Attributes
digest:<object>
get hash digest
update:<object>
make hash update

  • hotAcceptCallback {SyncBailHook<Tuple<ClassExpression|Identifier|SimpleLiteral|RegExpLiteral|BigIntLiteral|ArrayExpression|ArrowFunctionExpression|AssignmentExpression|AwaitExpression|BinaryExpression|SimpleCallExpression|NewExpression|ChainExpression|ConditionalExpression|FunctionExpression|ImportExpression|LogicalExpression|MemberExpression|MetaProperty|ObjectExpression|SequenceExpression|TaggedTemplateExpression|TemplateLiteral|ThisExpression|UnaryExpression|UpdateExpression|YieldExpression|SpreadElement, string[]>, void>}
  • hotAcceptWithoutCallback {SyncBailHook<Tuple<CallExpression, string[]>, void>}

These properties are added by the HotModuleReplacementPlugin

Attributes

Options for building http resources.

Attributes
allowedUris:<string> | <RegExp> | <object[]>
List of allowed URIs (resp. the beginning of them).
cacheLocation:<string>
Location where resource content is stored for lockfile entries. It's also possible to disable storing by passing false.
frozen:<boolean>
When set, anything that would lead to a modification of the lockfile or any resource content, will result in an error.
lockfileLocation:<string>
Location of the lockfile.
proxy:<string>
Proxy configuration, which can be used to specify a proxy server to use for HTTP requests.
upgrade:<boolean>
When set, resources of existing lockfile entries will be fetched and entries will be upgraded when resource content has changed.


  • attributes {Record<string, string>}
  • externalType {"module"|"import"}

Attributes
baseUri:<string>
target base uri
layer:<string>
the target layer
publicPath:<string>
the target public path

  • expression {ImportExpressionJavascriptParser}
  • references {string[][]}

Options for infrastructure level logging.

Attributes
appendOnly:<boolean>
Only appends lines to the output. Avoids updating existing output e. g. for status messages. This option is only used when no custom console is provided.
colors:<boolean>
Enables/Disables colorful output. This option is only used when no custom console is provided.
console:<Console>
Custom console used for logging.
Enable debug logging for specific loggers.
level:
{"error"|"warn"|"info"|"log"|"verbose"|"none"} Log level.
Stream used for logging output. Defaults to process.stderr. This option is only used when no custom console is provided.

  • Session {Session}

Attributes
close:<object>
createWriteStream:<object>
mkdirSync:
{MkdirSync}
open:
{Open}
read:
{Read<ArrayBufferView >}
rename:<object>

Attributes

Attributes
atime:<Date>
atimeMs:<number>
birthtime:<Date>
birthtimeMs:<number>
blksize:<number>
blocks:<number>
ctime:<Date>
ctimeMs:<number>
isBlockDevice:<object>
isCharacterDevice:<object>
isDirectory:<object>
isFIFO:<object>
isFile:<object>
isSocket:<object>
isSymbolicLink:<object>
mtime:<Date>
mtimeMs:<number>
nlink:<number>

Attributes
atime:<Date>
atimeMs:
{T}
birthtime:<Date>
birthtimeMs:
{T}
blksize:
{T}
blocks:
{T}
ctime:<Date>
ctimeMs:
{T}
dev:
{T}
gid:
{T}
ino:
{T}
isBlockDevice:<object>
isCharacterDevice:<object>
isDirectory:<object>
isFIFO:<object>
isFile:<object>
isSocket:<object>
isSymbolicLink:<object>
mode:
{T}
mtime:<Date>
mtimeMs:
{T}
nlink:
{T}
rdev:
{T}
size:
{T}
uid:
{T}


  • {Iterator<T, TReturn, TNext>}.{Disposable}
  • {SetIterator}
Returns:
{void}
Returns:
{IteratorObject<T, TReturn, TNext>}

Parser options for javascript modules.

Attributes
Set the value of  require.amd and define.amd . Or disable AMD support.
browserify:<boolean>
Enable/disable special handling for browserify bundles.
commonjs:<boolean>
Enable/disable parsing of CommonJs syntax.
commonjsMagicComments:<boolean>
Enable/disable parsing of magic comments in CommonJs syntax.
createRequire:<string> | <boolean>
Enable/disable parsing "import { createRequire } from "module"" and evaluating createRequire().
deferImport:<boolean>
Enable experimental tc39 proposal  https://github.com/tc39/proposal-defer-import-eval . This allows to defer execution of a module until it's first use.
dynamicImportFetchPriority:
{false|"auto"|"low"|"high"} Specifies global fetchPriority for dynamic import.
dynamicImportMode:
{"weak"|"eager"|"lazy"|"lazy-once"} Specifies global mode for dynamic import.
dynamicImportPrefetch:<number> | <boolean>
Specifies global prefetch for dynamic import.
dynamicImportPreload:<number> | <boolean>
Specifies global preload for dynamic import.
dynamicUrl:<boolean>
Enable/disable parsing of dynamic URL.
exportsPresence:
{false|"error"|"warn"|"auto"} Specifies the behavior of invalid export names in "import ... from ..." and "export ... from ...".
exprContextCritical:<boolean>
Enable warnings for full dynamic dependencies.
exprContextRecursive:<boolean>
Enable recursive directory lookup for full dynamic dependencies.
exprContextRegExp:<boolean> | <RegExp>
Sets the default regular expression for full dynamic dependencies.
exprContextRequest:<string>
Set the default request for full dynamic dependencies.
harmony:<boolean>
Enable/disable parsing of EcmaScript Modules syntax.
import:<boolean>
Enable/disable parsing of import() syntax.
importExportsPresence:
{false|"error"|"warn"|"auto"} Specifies the behavior of invalid export names in "import ... from ...".
importMeta:<boolean>
Enable/disable evaluating import.meta. Set to 'preserve-unknown' to preserve unknown properties for runtime evaluation.
importMetaContext:<boolean>
Enable/disable evaluating import.meta.webpackContext.
node:
{false|NodeOptions} Include polyfills or mocks for various node stuff.
overrideStrict:
{"strict"|"non-strict"} Override the module to strict or non-strict. This may affect the behavior of the module (some behaviors differ between strict and non-strict), so please configure this option carefully.
parse:<object>
Function to parser source code.
reexportExportsPresence:
{false|"error"|"warn"|"auto"} Specifies the behavior of invalid export names in "export ... from ...". This might be useful to disable during the migration from "export ... from ..." to "export type ... from ..." when reexporting types in TypeScript.
requireContext:<boolean>
Enable/disable parsing of require.context syntax.
requireEnsure:<boolean>
Enable/disable parsing of require.ensure syntax.
requireInclude:<boolean>
Enable/disable parsing of require.include syntax.
requireJs:<boolean>
Enable/disable parsing of require.js special syntax like require.config, requirejs.config, require.version and requirejs.onError.
strictExportPresence:<boolean>
Deprecated in favor of "exportsPresence". Emit errors instead of warnings when imported names don't exist in imported module.
strictThisContextOnImports:<boolean>
Handle the this context correctly according to the spec for namespace objects.
system:<boolean>
Enable/disable parsing of System.js special syntax like System.import, System.get, System.set and System.register.
unknownContextCritical:<boolean>
Enable warnings when using the require function in a not statically analyse-able way.
unknownContextRecursive:<boolean>
Enable recursive directory lookup when using the require function in a not statically analyse-able way.
unknownContextRegExp:<boolean> | <RegExp>
Sets the regular expression when using the require function in a not statically analyse-able way.
unknownContextRequest:<string>
Sets the request when using the require function in a not statically analyse-able way.
Enable/disable parsing of new URL() syntax.
Disable or configure parsing of WebWorker syntax like new Worker() or navigator.serviceWorker.register().
wrappedContextCritical:<boolean>
Enable warnings for partial dynamic dependencies.
wrappedContextRecursive:<boolean>
Enable recursive directory lookup for partial dynamic dependencies.
wrappedContextRegExp:<RegExp>
Set the inner regular expression for partial dynamic dependencies.

Generator options for json modules.

Attributes
JSONParse:<boolean>
Use  JSON.parse when the JSON string is longer than 20 characters.

Attributes
exportsDepth:<number>
The depth of json dependency flagged as  exportInfo .
namedExports:<boolean>
Allow named exports for json of object type
parse:<object>
Function that executes for a module source string and should return json-compatible data.



Parser options for JSON modules.

Attributes
exportsDepth:<number>
The depth of json dependency flagged as  exportInfo .
namedExports:<boolean>
Allow named exports for json of object type.
parse:<object>
Function to parser content and return JSON.

  • linkPrefetch {SyncWaterfallHook<Tuple<string, Chunk>, string>}
  • linkPreload {SyncWaterfallHook<Tuple<string, Chunk>, string>}

Attributes
chunkhash:<string> | <string[]>
the value(s) of the chunk hash used for this asset
contenthash:<string> | <string[]>
the value(s) of the content hash used for this asset
development:<boolean>
true, when asset is only used for development and doesn't count towards user-facing assets
fullhash:<string> | <string[]>
the value(s) of the full hash used for this asset
hotModuleReplacement:<boolean>
true, when asset ships data for updating an existing application (HMR)
immutable:<boolean>
true, if the asset can be long term cached forever (contains a hash)
javascriptModule:<boolean>
true, when asset is javascript and an ESM
manifest:<boolean>
true, when file is a manifest
minimized:<boolean>
whether the asset is minimized
modulehash:<string> | <string[]>
the value(s) of the module hash used for this asset
related:
{Record<string, string|string[]|null>} object of pointers to other assets, keyed by type of relation (only points from parent to child)
size in bytes, only set after asset has been emitted
sourceFilename:<string>
when asset was created from a source file (potentially transformed), the original filename relative to compilation context

Attributes
active:<boolean>
for lazy compilation modules
assetInfo:<AssetInfo>
for assets modules
assets:
{Record<string, Source>} using in NormalModule
assetsInfo:
{Map<string, AssetInfo|undefined>} using in NormalModule
buildDependencies:
{LazySet } using in NormalModule
cacheable:<boolean>
contextDependencies:
{LazySet } using in NormalModule
cssData:
{CssData} for css modules
dataUrl:<boolean>
for assets modules
exportsArgument:<string>
using in AMD
fileDependencies:
{LazySet } using in NormalModule
filename:<string>
for assets modules
fullContentHash:<string>
for assets modules
using in NormalModule
javascriptModule:<boolean>
for external modules
jsonData:
[ <JsonData> ]( /JsonData.html) for json modules
missingDependencies:
{LazySet } using in NormalModule
moduleArgument:<string>
using in AMD
moduleConcatenationBailout:<string>
using in CommonJs
needCreateRequire:<boolean>
using in APIPlugin
parsed:<boolean>
resourceIntegrity:<string>
using in HttpUriPlugin
snapshot:
[ <Snapshot> ]( /Snapshot.html) | <null> using in ContextModule
strict:<boolean>
topLevelDeclarations:
{Set } top level declaration names
valueDependencies:
{Map<string, ValueCacheVersion>} using in NormalModule

Attributes
async:<boolean>
defaultObject:
{false|"redirect"|"redirect-warn"}
exportsFinalNameByRuntime:
{Map<string, Record<string, string>>}
exportsSourceByRuntime:
{Map<string, string>}
exportsType:
{"default"|"dynamic"|"namespace"|"flagged"}
isCSSModule:<boolean>
jsIncompatibleExports:
{Record<string, string>}
sideEffectFree:<boolean>
strictHarmonyModule:<boolean>
treatAsCommonJs:<boolean>

Attributes
environments:<string[]>
environments

Attributes
forToString:<boolean>

  • noResolve {SyncHook<Tuple<ResolveRequest, Error>>} no resolve hook
  • resolve {AsyncSeriesBailHook<Tuple<ResolveRequest, ResolveContext>, ResolveRequest|null>} resolve hook
  • resolveStep {SyncHook<Tuple<AsyncSeriesBailHook<Tuple<ResolveRequest, ResolveContext>, ResolveRequest|null, UnsetAdditionalOptions>, ResolveRequest>>} resolve step hook
  • result {AsyncSeriesHook<Tuple<ResolveRequest, ResolveContext>>} result hook

  • harmonyNamedExports {Set}
  • harmonyStarExports [<HarmonyStarExportsList>](/HarmonyStarExportsList.html)
  • lastHarmonyImportOrder <number>
  • localModules [<LocalModule[]>](/LocalModule.html)

  • deferredImportVarMap {Map<Module, string>}
  • importVarMap {Map<Module, string>}

Attributes
assetsSort:<string>
assetsSpace:<number>
cachedAssets:<boolean>
cachedModules:<boolean>
chunkGroupAuxiliary:<boolean>
chunkGroupChildren:<boolean>
chunkGroupMaxAssets:<number>
chunkGroups:<boolean>
chunkModulesSort:<string>
chunkModulesSpace:<number>
chunksSort:<string>
context:<string>
dependentModules:<boolean>
entrypoints:<boolean>
excludeAssets:<object[]>
excludeModules:<object[]>
groupAssetsByEmitStatus:<boolean>
groupAssetsByExtension:<boolean>
groupAssetsByPath:<boolean>
groupModulesByAttributes:<boolean>
groupModulesByCacheStatus:<boolean>
groupModulesByExtension:<boolean>
groupModulesByLayer:<boolean>
groupModulesByPath:<boolean>
groupModulesByType:<boolean>
logging:
{false|"error"|"warn"|"info"|"log"|"verbose"|"none"}
loggingDebug:<object[]>
loggingTrace:<boolean>
modulesSort:<string>
modulesSpace:<number>
nestedModulesSort:<string>
nestedModulesSpace:<number>
orphanModules:<boolean>
requestShortener:
[ <RequestShortener> ]( /RequestShortener.html)
runtimeModules:<boolean>
warningsFilter:<object[]>

  • aggressiveSplits {SplitData[]}
  • chunkHashes {ChunkHashes}
  • chunkModuleHashes {ChunkModuleHashes}
  • chunkModuleIds {ChunkModuleIds}
  • chunkRuntime {ChunkRuntime}
  • chunks {RecordsChunks}
  • fullHashChunkModuleHashes {FullHashChunkModuleHashes}
  • hash <string>
  • hotIndex <number>
  • modules {RecordsModules}

Attributes
auxiliaryChunkIdHints:<string[]>
auxiliaryChunkNames:
{ChunkName[]}
auxiliaryChunks:
{ChunkId[]}
cached:<boolean>
chunkIdHints:<string[]>
chunkNames:
{ChunkName[]}
chunks:
{ChunkId[]}
comparedForEmit:<boolean>
emitted:<boolean>
filteredRelated:<number>
isOverSizeLimit:<boolean>

Attributes
auxiliaryFiles:<string[]>
children:
{ChunkId[]}
childrenByOrder:
{Record<string, ChunkId[]>}
entry:<boolean>
filteredModules:<number>
idHints:<string[]>
initial:<boolean>
parents:
{ChunkId[]}
reason:<string>
recorded:<boolean>
rendered:<boolean>
runtime:<string[]>
siblings:
{ChunkId[]}
sizes:
{Record<string, number>}

Attributes
assets:<object[]>
assetsSize:<number>
auxiliaryAssets:<object[]>
auxiliaryAssetsSize:<number>
childAssets:
{Record<string, string[]>}
children:
{Record<string, StatsChunkGroup[]>}
chunks:
{ChunkId[]}
filteredAssets:<number>
filteredAuxiliaryAssets:<number>
isOverSizeLimit:<boolean>

Attributes
module:<string>
moduleId:<string> | <number>
moduleIdentifier:<string>
moduleName:<string>
request:<string>

Attributes
assetsByChunkName:
{Record<string, string[]>}
builtAt:<number>
entrypoints:
{Record<string, StatsChunkGroup>}
env:<any>
errorsCount:<number>
filteredAssets:<number>
filteredErrorDetailsCount:<number>
filteredModules:<number>
filteredWarningDetailsCount:<number>
logging:
{Record<string, StatsLogging>}
namedChunkGroups:
{Record<string, StatsChunkGroup>}
needAdditionalPass:<boolean>
outputPath:<string>
publicPath:<string>
version:<string>
warningsCount:<number>


Attributes
cachedGetErrors:<object>
cachedGetWarnings:<object>
compilation:<Compilation>
compilationAuxiliaryFileToChunks:
{Map<string, Chunk[]>}
compilationFileToChunks:
{Map<string, Chunk[]>}
makePathsRelative:<object>
rootModules:
{Set }
runtime:
{RuntimeSpec}

Attributes
debug:<boolean>
filteredEntries:<number>

Attributes

Attributes
assets:<string[]>
buildTimeExecuted:<boolean>
built:<boolean>
cacheable:<boolean>
cached:<boolean>
chunks:
{ChunkId[]}
codeGenerated:<boolean>
dependent:<boolean>
errors:<number>
failed:<boolean>
filteredModules:<number>
identifier:<string>
index:<number>
index2:<number>
issuer:<string> | <null>
issuerId:<string> | <number> | <null>
issuerName:<string> | <null>
moduleType:<string>
nameForCondition:<string> | <null>
optimizationBailout:<string[]>
optional:<boolean>
orphan:<boolean>
postOrderIndex:<number>
preOrderIndex:<number>
providedExports:<string[]> | <null>
sizes:
{Record<string, number>}
source:
{string|Buffer }
usedExports:<boolean> | <string[]> | <null>
warnings:<number>

Attributes

Attributes
active:<boolean>
explanation:<string> | <null>
module:<string> | <null>
moduleId:<string> | <number> | <null>
moduleIdentifier:<string> | <null>
moduleName:<string> | <null>
resolvedModule:<string> | <null>
resolvedModuleId:<string> | <number> | <null>
resolvedModuleIdentifier:<string> | <null>
userRequest:<string> | <null>

Attributes

Attributes
moduleId:<string> | <number>
moduleIdentifier:<string>
moduleName:<string>
originId:<string> | <number>
originIdentifier:<string>
originName:<string>

Attributes
green:<object>
magenta:<object>
yellow:<object>

Attributes
chunkGroupKind:<string>
compilation:<StatsCompilation>
moduleIssuer:<StatsModuleIssuer>
moduleReason:<StatsModuleReason>
moduleTraceDependency:<StatsModuleTraceDependency>
moduleTraceItem:<StatsModuleTraceItem>

Attributes
formatChunkId:<object>
formatDateTime:<object>
formatError:<object>
formatFilename:<object>
formatFlag:<object>
formatLayer:<object>
formatModuleId:<object>
formatSize:<object>
formatTime:<object>

Attributes
additionalIntegration:<number>
additionalResolving:<number>
building:<number>
dependencies:<number>
factory:<number>
integration:<number>
resolving:<number>
restoring:<number>
storing:<number>
total:<number>

  • factoryMeta {FactoryMeta} factory meta
  • generatorOptions {GeneratorOptions}
  • parserOptions {ParserOptions}
  • resolveOptions <ResolveOptions> resolve options

Options for the default backend.

Attributes
client:<string>
A custom client.
Specifies where to listen to from the server.
protocol:
{"http"|"https"} Specifies the protocol the client should use to connect to the server.
server:
{ServerOptions<IncomingMessage, ServerResponse>|ServerOptions<IncomingMessage, ServerResponse>|object} Specifies how to create the server handling the EventSource requests.

Options for compiling entrypoints and import()s only when they are accessed.

Attributes
backend:<object> | <object>
Specifies the backend that should be used for handling client keep alive.
entries:<boolean>
Enable/disable lazy compilation for entries.
imports:<boolean>
Enable/disable lazy compilation for import() modules.
Specify which entrypoints or import()ed modules should be lazily compiled. This is matched with the imported module and not the entrypoint name.

  • [index: {string}] <any>

Attributes
associatedObjectForCache:<object>
object for caching
context:<string>
absolute context path to which lib ident is relative to

Attributes
context:<string>
Context of requests in the manifest file (defaults to the webpack context).
entryOnly:<boolean>
If true, only entry points will be exposed (default: true).
format:<boolean>
If true, manifest json file (output) will be formatted.
Name of the exposed dll function (external name, use value of 'output.library').
Absolute path to the manifest json file (output).
Type of the dll bundle (external type, use value of 'output.libraryTarget').

Attributes
chunkGraph:<ChunkGraph>
compilation:<Compilation>
options:
{T}

Set explicit comments for commonjs, commonjs2, amd, and root.

Attributes
Set comment for  amd section in UMD.
commonjs:<string>
Set comment for  commonjs (exports) section in UMD.
commonjs2:<string>
Set comment for  commonjs2 (module.exports) section in UMD.
Set comment for  root (global variable) section in UMD.

Description object for all UMD variants of the library name.

Attributes
Name of the exposed AMD library in the UMD.
commonjs:<string>
Name of the exposed commonjs export in the UMD.
Name of the property exposed globally by a UMD library.

Attributes
chunkOverhead:<number>
Constant overhead for a chunk.
entryChunkMultiplicator:<number>
Multiplicator for initial chunks.
maxChunks:<number>
Limit the maximum number of chunks using a value greater than or equal to 1.

Custom values available in the loader context.

  • [index: {string}] <any>

Attributes
loader:<string>
options:
{string|Record<string, any>|null}

  • [index: {string}] <any>
Attributes
debug:<boolean>
Whether loaders should be in debug mode or not. debug will be removed as of webpack 3.
minimize:<boolean>
Where loaders can be switched to minimize mode.
options:<object>
A configuration object that can be used to configure older loaders.

These properties are added by the LoaderPlugin

Call Signature
Attributes
request:<string>
options:<undefined>
callback:<object>
Returns:
{void}
Call Signature
Attributes
request:<string>
options:
{ImportModuleOptions}
Returns:
{Promise }
Attributes
request:<string>
callback:<object>
Returns:
{void}

Resolves the given request to a module, applies all configured loaders and calls back with the generated source, the sourceMap and the module instance (usually an instance of NormalModule). Use this function if you need to know the source code of another module to generate the result.


The properties are added by https://github.com/webpack/loader-runner

Attributes
callback:<object>
context:<string>
The directory of the module. Can be used as context for resolving other stuff. eg '/workspaces/ts-loader/examples/vanilla/src'
currentRequest:<string>
data:<any>
environment:
{Environment} Tell what kind of ES-features may be used in the generated runtime-code. Example: { arrowFunction: true }
loaderIndex:<number>
The index in the loaders array of the current loader. In the example: in loader1: 0, in loader2: 1
loaders:<object[]>
An array of all the loaders. It is writeable in the pitch phase. loaders = [{request: string, path: string, query: string, module: function}] In the example: [ { request: "/abc/loader1.js?xyz", path: "/abc/loader1.js", query: "?xyz", module: [Function] }, { request: "/abc/node_modules/loader2/index.js", path: "/abc/node_modules/loader2/index.js", query: "", module: [Function] } ]
previousRequest:<string>
query:<string>
remainingRequest:<string>
request:<string>
resource:<string>
The resource inclusive query and fragment. Example: "/abc/resource.js?query#frag"
resourceFragment:<string>
The resource fragment. Example: "#frag"
resourcePath:<string>
The resource path. In the example: "/abc/resource.js"
resourceQuery:<string>
The resource query string. Example: "?query"
target:<string>
Target of compilation. Example: "web"
Attributes
context:<string>
Returns:
{void}

Add a directory as dependency of the loader result.

Attributes
Returns:
{void}

Adds a file as dependency of the loader result in order to make them watchable. For example, html-loader uses this technique as it finds src and src-set attributes. Then, it sets the url's for those attributes as dependencies of the html file that is parsed.

Attributes
context:<string>
Returns:
{void}
Returns:<object>

Make this loader async.

Attributes
Returns:
{void}

Make this loader result cacheable. By default it's cacheable. A cacheable loader must have a deterministic result, when inputs and dependencies haven't changed. This means the loader shouldn't have other dependencies than specified with this.addDependency. Most loaders are deterministic and cacheable.

Returns:
{void}

Remove all dependencies of the loader result. Even initial dependencies and these of other loaders.

Attributes
Returns:
{void}

alias of addDependency Adds a file as dependency of the loader result in order to make them watchable. For example, html-loader uses this technique as it finds src and src-set attributes. Then, it sets the url's for those attributes as dependencies of the html file that is parsed.

Returns:<string[]>
Returns:<string[]>
Returns:<string[]>

  • createScript {SyncWaterfallHook<Tuple<string, Chunk>, string>}

Attributes
args:<any[]>
type:
{"debug"|"error"|"warn"|"info"|"log"|"trace"|"group"|"groupCollapsed"|"groupEnd"|"profile"|"profileEnd"|"time"|"clear"|"status"}

  • path {PathLikeFs}
  • callback <object>
  • Returns: {void}

  • path {PathLikeFs}
  • options <undefined>
  • Returns: {IStats}
  • path {PathLikeFs}
  • options <object>
  • Returns: {IStats}
  • path {PathLikeFs}
  • options <object>
  • Returns: {IBigIntStats}
  • path {PathLikeFs}
  • options <object>
  • Returns: {IStats|IBigIntStats}
  • path {PathLikeFs}
  • options {StatSyncOptions}
  • Returns: <undefined>

  • path {PathLikeTypes}
  • callback <object>
  • Returns: {void}

Attributes
chunk:<Chunk>
the chunk
chunkGraph:<ChunkGraph>
the chunk graph
codeGenerationResults:<CodeGenerationResults>
results of code generation
dependencyTemplates:
[ <DependencyTemplates> ]( /DependencyTemplates.html) the dependency templates
hash to be used for render call
moduleGraph:<ModuleGraph>
the module graph
runtimeTemplate:
[ <RuntimeTemplate> ]( /RuntimeTemplate.html) the runtime template
strictMode:<boolean>
rendering in strict context

Attributes
recursive:<boolean>

Describes a manifest entrypoint.

Attributes
imports:<string[]>
Contains the names of entrypoints.
parents:<string[]>
Contains the names of parent entrypoints.

Describes a manifest asset that links the emitted path to the producing asset.

Attributes
The path absolute URL (this indicates that the path is absolute from the server's root directory) to file.
The source path relative to the context.

The manifest object.

  • [index: {string}] <any>
  • assets {Record<string, ManifestItem>} Contains the names of assets.
  • entrypoints {Record<string, ManifestEntrypoint>} Contains the names of entrypoints.

Attributes
entrypoints:<boolean>
Enables/disables generation of the entrypoints manifest section.
filename:<string>
Specifies the filename of the output file on disk. By default the plugin will emit  manifest.json inside the 'output.path' directory.
filter:<object>
Allows filtering the files which make up the manifest.
generate:<object>
A function that receives the manifest object, modifies it, and returns the modified manifest.
prefix:<string>
Specifies a path prefix for all keys in the manifest.
serialize:<object>
A function that receives the manifest object and returns the manifest string.

Attributes
columns:<boolean>
need columns?
module:<boolean>
is module

Attributes

Attributes
getContent:<object>
getEndContent:<object>
merge:<object>
mergeAll:<object>
position:<number>
stage:<number>

Attributes
stage:<number>
Specifies the stage for merging duplicate chunks.

Attributes
chunkOverhead:<number>
Constant overhead for a chunk.
entryChunkMultiplicator:<number>
Multiplicator for initial chunks.
minChunkSize:<number>
Minimum number of characters.

  • file {PathLikeFs}
  • callback <object>
  • Returns: {void}


  • inheritance {Tuple<CssLayer, Supports, Media>[]} - The inheritance chain
  • source <CachedSource> - The cached source
  • undoPath <string> - The undo path to the CSS file

Attributes
context:<string>
contextInfo:
{ModuleFactoryCreateDataContextInfo}
dependencies:<Dependency[]>
resolveOptions:<ResolveOptions>

Attributes
compiler:<string>
issuer:<string>
issuerLayer:
{IssuerLayer}

Attributes
cacheable:<boolean>
allow to use the unsafe cache
contextDependencies:
{Set }
fileDependencies:
{Set }
missingDependencies:
{Set }
module:<Module>
the created module or unset if no module was created

Attributes
exposes:<string>
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:<string>
The filename of the container as relative path inside the  output.path directory.
Options for library.
The name of the container.
remotes:<string>
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:
{"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"} The external type of the remote containers.
runtime:<string>
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:<string>
Modules that should be shared in the share scope. When provided, property names are used to match requested modules in this compilation.
shareScope:<string>
Share scope name used for all shared modules (defaults to 'default').

Attributes
absoluteResourcePath:<string>
the absolute resource path of the module request
allLoaders:<string>
the all loaders of the module request
the hash of the module identifier
identifier:<string>
the identifier of the module
loaders:<string>
the loaders of the module request
moduleId:<string>
the module id of the module
namespace:<string>
the module namespace
query:<string>
the query of the module identifier
resource:<string>
the resource of the module request
resourcePath:<string>
the resource path of the module request
shortIdentifier:<string>
the shortened identifier of the module

  • buildInfo {BuildInfo}
  • memCache {WeakTupleMap<any[], any>}
  • references {WeakMap<Dependency, Module>}

Options affecting the normal modules (NormalModuleFactory).

Attributes
An array of rules applied by default for modules.
generator:
{GeneratorOptionsByModuleType} Specify options for each generator.
Don't parse files matching. It's matched against the full resolved request.
parser:
{ParserOptionsByModuleType} Specify options for each parser.
An array of rules applied for modules.
unsafeCache:<boolean> | <object>
Cache the resolving of module requests.

Attributes
hashWithLength:<object>

Attributes
asiSafe:<boolean>
if the position is ASI safe or unknown
true, when this referenced export is called
deferredImport:<boolean>
true, when this referenced export is deferred
directImport:<boolean>
true, when this referenced export is directly imported (not via property access)
the properties/exports of the module

Attributes
chunk:<Chunk>
the chunk
chunkGraph:<ChunkGraph>
the chunk graph
chunkInitFragments:
{InitFragment []} init fragments for the chunk
codeGenerationResults:<CodeGenerationResults>
results of code generation
dependencyTemplates:
[ <DependencyTemplates> ]( /DependencyTemplates.html) the dependency templates
factory:<boolean>
true: renders as factory method, false: pure module content
inlinedInIIFE:<boolean>
the inlined entry module is wrapped in an IIFE, existing only when  factory is set to false
moduleGraph:<ModuleGraph>
the module graph
renderInObject:<boolean>
render module in object container
runtimeTemplate:
[ <RuntimeTemplate> ]( /RuntimeTemplate.html) the runtime template
strictMode:<boolean>
rendering in strict context

Attributes
active:<boolean>
client:<string>

Attributes
extractSourceMap:<boolean>
Enable/Disable extracting source map.
generator:<object>
The options for the module generator.
layer:<string>
Specifies the layer in which the module should be placed in.
parser:<object>
Options for parsing.
Options for the resolver.
sideEffects:<boolean>
Flags a module as with or without side effects.
Module type to use for the module.

  • javascript [<ModuleTemplate>](/ModuleTemplate.html)

Attributes
module:<Module>
origin:<Module>

Attributes
context:<string>
context
delimiter:<string>
delimiter

Attributes
context:<string>
context

Attributes
compilation:<Compilation>
fileSystemInfo:
[ <FileSystemInfo> ]( /FileSystemInfo.html)
valueCacheVersions:
{Map<string, ValueCacheVersion>}


  • infrastructureLogging {InfrastructureLogging} infrastructure logging options

Options object for node compatibility features.

Attributes
__dirname:<boolean>
Include a polyfill for the '__dirname' variable.
__filename:<boolean>
Include a polyfill for the '__filename' variable.
global:<boolean>
Include a polyfill for the 'global' variable.

Attributes
asyncChunkLoading:<boolean>
enable async chunk loading

  • [index: {string}] {VirtualModule}

  • beforeLoaders {SyncHook<Tuple<LoaderItem[], NormalModule, AnyLoaderContext>>}
  • beforeParse {SyncHook<Tuple>}
  • beforeSnapshot {SyncHook<Tuple>}
  • loader {SyncHook<Tuple<AnyLoaderContext, NormalModule>>}
  • needBuild {AsyncSeriesBailHook<Tuple<NormalModule, NeedBuildContext>, boolean>}
  • processResult {SyncWaterfallHook<Tuple<Tuple<string|Buffer, string|RawSourceMap|undefined, PreparsedAst|undefined>, NormalModule>, Tuple<string|Buffer, string|RawSourceMap|undefined, PreparsedAst|undefined>>}
  • readResource {HookMap<AsyncSeriesBailHook<Tuple, string|Buffer|null, UnsetAdditionalOptions>>}
  • readResourceForScheme {HookMap<FakeHook<AsyncSeriesBailHook<Tuple<string, NormalModule>, string|Buffer|null, UnsetAdditionalOptions>>>}

Attributes
context:<string>
context directory for resolving
extractSourceMap:<boolean>
enable/disable extracting source map
generator:<Generator>
the generator used
generatorOptions:
{GeneratorOptions} the options of the generator used
layer:<string>
an optional layer in which the module is
loaders:
{LoaderItem[]} list of loaders
matchResource:<string>
path + query of the matched resource (virtual)
parser:
{ParserClass} the parser used
parserOptions:
{ParserOptions} the options of the parser used
rawRequest:<string>
request without resolving
request:<string>
request string
resolveOptions:<ResolveOptions>
options used for resolving requests from this module
resource:<string>
path + query of the real resource
resourceResolveData:
{ResourceSchemeData|Partial } resource resolve data
module type. When deserializing, this is set to an empty string "".
userRequest:<string>
request intended by user (without loaders from config)

These properties are added by the NormalModule

Attributes
_compilation:<Compilation>
_compiler:<Compiler>
hashDigest:<string>
hashDigestLength:<number>
hashFunction:
{HashFunction}
hashSalt:<string>
mode:
{"development"|"none"|"production"}
rootContext:<string>
sourceMap:<boolean>
utils:<object>
version:<number>
webpack:<boolean>
Attributes
Returns:
{void}
Attributes
error:<Error>
Returns:
{void}
Attributes
content:
{string|Buffer }
sourceMap:<string>
assetInfo:<AssetInfo>
Returns:
{void}
Attributes
warning:<Error>
Returns:
{void}
Attributes
Returns:
[ <WebpackLogger> ]( /WebpackLogger.html)
Call Signature
Returns:
{OptionsType}
Call Signature
  • schema {Schema}
  • Returns: {OptionsType}
  • options {ResolveOptionsWithDependencyType}
  • Returns: <object>
Attributes
context:<string>
request:<string>
callback:<object>
Returns:
{void}

  • [index: {string}] <any>

Attributes
encoding:<null>

Attributes
deserialize:<object>
serialize:<object>

Attributes
currentPos:<number>
currentPosTypeLookup:<number>
cycleStackSize:<number>
length:<number>
objectTypeLookupSize:<number>
referenceableSize:<number>

Attributes
prioritiseInitial:<boolean>
Prioritise initial size over total size.

Attributes
prioritiseInitial:<boolean>
Prioritise initial size over total size.

Attributes
safeTime:<number>

  • file {PathLikeFs}
  • callback <object>
  • Returns: {void}

Enables/Disables integrated optimizations.

Attributes
avoidEntryIife:<boolean>
Avoid wrapping the entry module in an IIFE.
checkWasmTypes:<boolean>
Check for incompatible wasm types when importing/exporting from/to ESM.
chunkIds:
{false|"size"|"natural"|"named"|"deterministic"|"total-size"} Define the algorithm to choose chunk ids (named: readable ids for better debugging, deterministic: numeric hash ids for better long term caching, size: numeric ids focused on minimal initial download size, total-size: numeric ids focused on minimal total download size, false: no algorithm used, as custom one can be provided via plugin).
concatenateModules:<boolean>
Concatenate modules when possible to generate less modules, more efficient code and enable more optimizations by the minimizer.
emitOnErrors:<boolean>
Emit assets even when errors occur. Critical errors are emitted into the generated code and will cause errors at runtime.
flagIncludedChunks:<boolean>
Also flag chunks as loaded which contain a subset of the modules.
innerGraph:<boolean>
Creates a module-internal dependency graph for top level symbols, exports and imports, to improve unused exports detection.
mangleExports:<boolean>
Rename exports when possible to generate shorter code (depends on optimization.usedExports and optimization.providedExports, true/"deterministic": generate short deterministic names optimized for caching, "size": generate the shortest possible names).
mangleWasmImports:<boolean>
Reduce size of WASM by changing imports to shorter strings.
mergeDuplicateChunks:<boolean>
Merge chunks which contain the same modules.
minimize:<boolean>
Enable minimizing the output. Uses optimization.minimizer.
Minimizer(s) to use for minimizing the output.
moduleIds:
{false|"size"|"natural"|"named"|"deterministic"|"hashed"} Define the algorithm to choose module ids (natural: numeric ids in order of usage, named: readable ids for better debugging, hashed: (deprecated) short hashes as ids for better long term caching, deterministic: numeric hash ids for better long term caching, size: numeric ids focused on minimal initial download size, false: no algorithm used, as custom one can be provided via plugin).
nodeEnv:<string>
Set process.env.NODE_ENV to a specific value.
noEmitOnErrors:<boolean>
Avoid emitting assets when errors occur (deprecated: use 'emitOnErrors' instead).
portableRecords:<boolean>
Generate records with relative paths to be able to move the context folder.
providedExports:<boolean>
Figure out which exports are provided by modules to generate more efficient code.
realContentHash:<boolean>
Use real [contenthash] based on final content of the assets.
removeAvailableModules:<boolean>
Removes modules from chunks when these modules are already included in all parents.
removeEmptyChunks:<boolean>
Remove chunks which are empty.
runtimeChunk:<boolean> | <object>
Create an additional chunk which contains only the webpack runtime and chunk hash maps.
sideEffects:<boolean>
Skip over modules which contain no side effects when exports are not used (false: disabled, 'flag': only use manually placed side effects flag, true: also analyse source code for side effects).
splitChunks:
{false|OptimizationSplitChunksOptions} Optimize duplication and caching by splitting chunks by shared modules and cache group.
usedExports:<boolean>
Figure out which exports are used by modules to mangle export names, omit unused exports and generate more efficient code (true: analyse used exports for each runtime, "global": analyse exports globally for all runtimes combined).

Enables/Disables integrated optimizations.

Attributes
avoidEntryIife:<boolean>
Avoid wrapping the entry module in an IIFE.
checkWasmTypes:<boolean>
Check for incompatible wasm types when importing/exporting from/to ESM.
chunkIds:
{false|"size"|"natural"|"named"|"deterministic"|"total-size"} Define the algorithm to choose chunk ids (named: readable ids for better debugging, deterministic: numeric hash ids for better long term caching, size: numeric ids focused on minimal initial download size, total-size: numeric ids focused on minimal total download size, false: no algorithm used, as custom one can be provided via plugin).
concatenateModules:<boolean>
Concatenate modules when possible to generate less modules, more efficient code and enable more optimizations by the minimizer.
emitOnErrors:<boolean>
Emit assets even when errors occur. Critical errors are emitted into the generated code and will cause errors at runtime.
flagIncludedChunks:<boolean>
Also flag chunks as loaded which contain a subset of the modules.
innerGraph:<boolean>
Creates a module-internal dependency graph for top level symbols, exports and imports, to improve unused exports detection.
mangleExports:<boolean>
Rename exports when possible to generate shorter code (depends on optimization.usedExports and optimization.providedExports, true/"deterministic": generate short deterministic names optimized for caching, "size": generate the shortest possible names).
mangleWasmImports:<boolean>
Reduce size of WASM by changing imports to shorter strings.
mergeDuplicateChunks:<boolean>
Merge chunks which contain the same modules.
minimize:<boolean>
Enable minimizing the output. Uses optimization.minimizer.
Minimizer(s) to use for minimizing the output.
moduleIds:
{false|"size"|"natural"|"named"|"deterministic"|"hashed"} Define the algorithm to choose module ids (natural: numeric ids in order of usage, named: readable ids for better debugging, hashed: (deprecated) short hashes as ids for better long term caching, deterministic: numeric hash ids for better long term caching, size: numeric ids focused on minimal initial download size, false: no algorithm used, as custom one can be provided via plugin).
nodeEnv:<string>
Set process.env.NODE_ENV to a specific value.
noEmitOnErrors:<boolean>
Avoid emitting assets when errors occur (deprecated: use 'emitOnErrors' instead).
portableRecords:<boolean>
Generate records with relative paths to be able to move the context folder.
providedExports:<boolean>
Figure out which exports are provided by modules to generate more efficient code.
realContentHash:<boolean>
Use real [contenthash] based on final content of the assets.
removeAvailableModules:<boolean>
Removes modules from chunks when these modules are already included in all parents.
removeEmptyChunks:<boolean>
Remove chunks which are empty.
runtimeChunk:<object>
Create an additional chunk which contains only the webpack runtime and chunk hash maps.
sideEffects:<boolean>
Skip over modules which contain no side effects when exports are not used (false: disabled, 'flag': only use manually placed side effects flag, true: also analyse source code for side effects).
splitChunks:
{false|OptimizationSplitChunksOptions} Optimize duplication and caching by splitting chunks by shared modules and cache group.
usedExports:<boolean>
Figure out which exports are used by modules to mangle export names, omit unused exports and generate more efficient code (true: analyse used exports for each runtime, "global": analyse exports globally for all runtimes combined).

Options object for describing behavior of a cache group selecting modules that should be cached together.

Attributes
automaticNameDelimiter:<string>
Sets the name delimiter for created chunks.
Select chunks for determining cache group content (defaults to "initial", "initial" and "all" requires adding these chunks to the HTML).
enforce:<boolean>
Ignore minimum size, minimum chunks and maximum requests and always create chunks for this cache group.
enforceSizeThreshold:<number> | <object>
Size threshold at which splitting is enforced and other restrictions (minRemainingSize, maxAsyncRequests, maxInitialRequests) are ignored.
filename:<string> | <object>
Sets the template for the filename for created chunks.
idHint:<string>
Sets the hint for chunk id.
Assign modules to a cache group by module layer.
maxAsyncRequests:<number>
Maximum number of requests which are accepted for on-demand loading.
maxAsyncSize:<number> | <object>
Maximal size hint for the on-demand chunks.
maxInitialRequests:<number>
Maximum number of initial chunks which are accepted for an entry point.
maxInitialSize:<number> | <object>
Maximal size hint for the initial chunks.
maxSize:<number> | <object>
Maximal size hint for the created chunks.
minChunks:<number>
Minimum number of times a module has to be duplicated until it's considered for splitting.
minRemainingSize:<number> | <object>
Minimal size for the chunks the stay after moving the modules to a new chunk.
minSize:<number> | <object>
Minimal size for the created chunk.
minSizeReduction:<number> | <object>
Minimum size reduction due to the created chunk.
Give chunks for this cache group a name (chunks with equal name are merged).
priority:<number>
Priority of this cache group.
reuseExistingChunk:<boolean>
Try to reuse existing chunk (with name) when it has matching modules.
Assign modules to a cache group by module name.
Assign modules to a cache group by module type.
usedExports:<boolean>
Compare used exports when checking common modules. Modules will only be put in the same chunk when exports are equal.

Options object for splitting chunks into smaller chunks.

Attributes
automaticNameDelimiter:<string>
Sets the name delimiter for created chunks.
cacheGroups:<object>
Assign modules to a cache group (modules from different cache groups are tried to keep in separate chunks, default categories: 'default', 'defaultVendors').
Select chunks for determining shared modules (defaults to "async", "initial" and "all" requires adding these chunks to the HTML).
defaultSizeTypes:<string[]>
Sets the size types which are used when a number is used for sizes.
enforceSizeThreshold:<number> | <object>
Size threshold at which splitting is enforced and other restrictions (minRemainingSize, maxAsyncRequests, maxInitialRequests) are ignored.
fallbackCacheGroup:<object>
Options for modules not selected by any other cache group.
filename:<string> | <object>
Sets the template for the filename for created chunks.
hidePathInfo:<boolean>
Prevents exposing path info when creating names for parts splitted by maxSize.
maxAsyncRequests:<number>
Maximum number of requests which are accepted for on-demand loading.
maxAsyncSize:<number> | <object>
Maximal size hint for the on-demand chunks.
maxInitialRequests:<number>
Maximum number of initial chunks which are accepted for an entry point.
maxInitialSize:<number> | <object>
Maximal size hint for the initial chunks.
maxSize:<number> | <object>
Maximal size hint for the created chunks.
minChunks:<number>
Minimum number of times a module has to be duplicated until it's considered for splitting.
minRemainingSize:<number> | <object>
Minimal size for the chunks the stay after moving the modules to a new chunk.
minSize:<number> | <object>
Minimal size for the created chunks.
minSizeReduction:<number> | <object>
Minimum size reduction due to the created chunk.
Give chunks created a name (chunks with equal name are merged).
usedExports:<boolean>
Compare used exports when checking common modules. Modules will only be put in the same chunk when exports are equal.

Attributes
associatedObjectForCache:<object>
object for caching
content:
{DllReferencePluginOptionsContent} content
context:<string>
absolute context path to which lib ident is relative to
extensions:<string[]>
extensions
scope:<string>
scope
source:<string>
source
type:
{"object"|"require"} type


Options affecting the output of the compilation. output options tell webpack how to write the compiled files to disk.

Attributes
amdContainer:<string>
Add a container for define/require functions in the AMD module.
assetModuleFilename:<string> | <object>
The filename of asset modules as relative path inside the 'output.path' directory.
asyncChunks:<boolean>
Enable/disable creating async chunks that are loaded on demand.
auxiliaryComment:<string>
Add a comment in the UMD wrapper.
charset:<boolean>
Add charset attribute for script tag.
chunkFilename:<string> | <object>
Specifies the filename template of output files of non-initial chunks on disk. You must  not specify an absolute path here, but the path may contain folders separated by '/'! The specified path is joined with the value of the 'output.path' option to determine the location on disk.
chunkFormat:<string>
The format of chunks (formats included by default are 'array-push' (web/WebWorker), 'commonjs' (node.js), 'module' (ESM), but others might be added by plugins).
chunkLoading:<string>
The method of loading chunks (methods included by default are 'jsonp' (web), 'import' (ESM), 'importScripts' (WebWorker), 'require' (sync node.js), 'async-node' (async node.js), but others might be added by plugins).
chunkLoadingGlobal:<string>
The global variable used by webpack for loading of chunks.
chunkLoadTimeout:<number>
Number of milliseconds before chunk request expires.
clean:<boolean>
Clean the output directory before emit.
compareBeforeEmit:<boolean>
Check if to be emitted file already exists and have the same content before writing to output filesystem.
crossOriginLoading:
{false|"anonymous"|"use-credentials"} This option enables cross-origin loading of chunks.
cssChunkFilename:<string> | <object>
Specifies the filename template of non-initial output css files on disk. You must  not specify an absolute path here, but the path may contain folders separated by '/'! The specified path is joined with the value of the 'output.path' option to determine the location on disk.
cssFilename:<string> | <object>
Specifies the filename template of output css files on disk. You must  not specify an absolute path here, but the path may contain folders separated by '/'! The specified path is joined with the value of the 'output.path' option to determine the location on disk.
devtoolFallbackModuleFilenameTemplate:<string> | <object>
Similar to  output.devtoolModuleFilenameTemplate , but used in the case of duplicate module identifiers.
devtoolModuleFilenameTemplate:<string> | <object>
Filename template string of function for the sources array in a generated SourceMap.
devtoolNamespace:<string>
Module namespace to use when interpolating filename template string for the sources array in a generated SourceMap. Defaults to  output.library if not set. It's useful for avoiding runtime collisions in sourcemaps from multiple webpack projects built as libraries.
enabledChunkLoadingTypes:<string[]>
List of chunk loading types enabled for use by entry points.
enabledLibraryTypes:<string[]>
List of library types enabled for use by entry points.
enabledWasmLoadingTypes:<string[]>
List of wasm loading types enabled for use by entry points.
environment:
{Environment} The abilities of the environment where the webpack generated code should run.
filename:<string> | <object>
Specifies the filename of output files on disk. You must  not specify an absolute path here, but the path may contain folders separated by '/'! The specified path is joined with the value of the 'output.path' option to determine the location on disk.
globalObject:<string>
An expression which is used to address the global object/scope in runtime code.
hashDigest:<string>
Digest types used for the hash.
hashDigestLength:<number>
Number of chars which are used for the hash.
hashFunction:<string>
| [ <Hash> ]( /Hash.html) Algorithm used for generation the hash (see node.js crypto package).
hashSalt:<string>
Any string which is added to the hash to salt it.
hotUpdateChunkFilename:<string>
The filename of the Hot Update Chunks. They are inside the output.path directory.
hotUpdateGlobal:<string>
The global variable used by webpack for loading of hot update chunks.
hotUpdateMainFilename:<string>
The filename of the Hot Update Main File. It is inside the 'output.path' directory.
ignoreBrowserWarnings:<boolean>
Ignore warnings in the browser.
Wrap javascript code into IIFE's to avoid leaking into global scope.
importFunctionName:<string>
The name of the native import() function (can be exchanged for a polyfill).
importMetaName:<string>
The name of the native import.meta object (can be exchanged for a polyfill).
Make the output files a library, exporting the exports of the entry point.
libraryExport:<string> | <string[]>
Specify which export should be exposed as library.
libraryTarget:<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).
module:<boolean>
Output javascript files as module source type.
The output directory as  absolute path (required).
pathinfo:<boolean>
Include comments with information about the modules.
publicPath:<string> | <object>
The 'publicPath' specifies the public URL address of the output files when referenced in a browser.
scriptType:
{false|"module"|"text/javascript"} This option enables loading async chunks via a custom script type, such as script type="module".
sourceMapFilename:<string>
The filename of the SourceMaps for the JavaScript files. They are inside the 'output.path' directory.
sourcePrefix:<string>
Prefixes every line of the source in the bundle with this string.
strictModuleErrorHandling:<boolean>
Handles error in module loading correctly at a performance cost. This will handle module error compatible with the EcmaScript Modules spec.
strictModuleExceptionHandling:<boolean>
Handles exceptions in module loading correctly at a performance cost (Deprecated). This will handle module error compatible with the Node.js CommonJS way.
trustedTypes:<string> | <TrustedTypes>
Use a Trusted Types policy to create urls for chunks. 'output.uniqueName' is used a default policy name. Passing a string sets a custom policy name.
umdNamedDefine:<boolean>
If  output.libraryTarget is set to umd and output.library is set, setting this to true will name the AMD module.
uniqueName:<string>
A unique name of the webpack build to avoid multiple webpack runtimes to conflict when using globals.
wasmLoading:<string>
The method of loading WebAssembly Modules (methods included by default are 'fetch' (web/WebWorker), 'async-node' (node.js), but others might be added by plugins).
webassemblyModuleFilename:<string>
The filename of WebAssembly modules as relative path inside the 'output.path' directory.
workerChunkLoading:<string>
The method of loading chunks (methods included by default are 'jsonp' (web), 'import' (ESM), 'importScripts' (WebWorker), 'require' (sync node.js), 'async-node' (async node.js), but others might be added by plugins).
workerPublicPath:<string>
Worker public path. Much like the public path, this sets the location where the worker script file is intended to be found. If not set, webpack will use the publicPath. Don't set this option unless your worker scripts are located at a different path from your other script files.
workerWasmLoading:<string>
The method of loading WebAssembly Modules (methods included by default are 'fetch' (web/WebWorker), 'async-node' (node.js), but others might be added by plugins).

Normalized options affecting the output of the compilation. output options tell webpack how to write the compiled files to disk.

Attributes
assetModuleFilename:<string> | <object>
The filename of asset modules as relative path inside the 'output.path' directory.
asyncChunks:<boolean>
Enable/disable creating async chunks that are loaded on demand.
charset:<boolean>
Add charset attribute for script tag.
chunkFilename:<string> | <object>
Specifies the filename template of output files of non-initial chunks on disk. You must  not specify an absolute path here, but the path may contain folders separated by '/'! The specified path is joined with the value of the 'output.path' option to determine the location on disk.
chunkFormat:<string>
The format of chunks (formats included by default are 'array-push' (web/WebWorker), 'commonjs' (node.js), 'module' (ESM), but others might be added by plugins).
chunkLoading:<string>
The method of loading chunks (methods included by default are 'jsonp' (web), 'import' (ESM), 'importScripts' (WebWorker), 'require' (sync node.js), 'async-node' (async node.js), but others might be added by plugins).
chunkLoadingGlobal:<string>
The global variable used by webpack for loading of chunks.
chunkLoadTimeout:<number>
Number of milliseconds before chunk request expires.
clean:<boolean>
Clean the output directory before emit.
compareBeforeEmit:<boolean>
Check if to be emitted file already exists and have the same content before writing to output filesystem.
crossOriginLoading:
{false|"anonymous"|"use-credentials"} This option enables cross-origin loading of chunks.
cssChunkFilename:<string> | <object>
Specifies the filename template of non-initial output css files on disk. You must  not specify an absolute path here, but the path may contain folders separated by '/'! The specified path is joined with the value of the 'output.path' option to determine the location on disk.
cssFilename:<string> | <object>
Specifies the filename template of output css files on disk. You must  not specify an absolute path here, but the path may contain folders separated by '/'! The specified path is joined with the value of the 'output.path' option to determine the location on disk.
devtoolFallbackModuleFilenameTemplate:<string> | <object>
Similar to  output.devtoolModuleFilenameTemplate , but used in the case of duplicate module identifiers.
devtoolModuleFilenameTemplate:<string> | <object>
Filename template string of function for the sources array in a generated SourceMap.
devtoolNamespace:<string>
Module namespace to use when interpolating filename template string for the sources array in a generated SourceMap. Defaults to  output.library if not set. It's useful for avoiding runtime collisions in sourcemaps from multiple webpack projects built as libraries.
enabledChunkLoadingTypes:<string[]>
List of chunk loading types enabled for use by entry points.
enabledLibraryTypes:<string[]>
List of library types enabled for use by entry points.
enabledWasmLoadingTypes:<string[]>
List of wasm loading types enabled for use by entry points.
environment:
{Environment} The abilities of the environment where the webpack generated code should run.
filename:<string> | <object>
Specifies the filename of output files on disk. You must  not specify an absolute path here, but the path may contain folders separated by '/'! The specified path is joined with the value of the 'output.path' option to determine the location on disk.
globalObject:<string>
An expression which is used to address the global object/scope in runtime code.
hashDigest:<string>
Digest types used for the hash.
hashDigestLength:<number>
Number of chars which are used for the hash.
hashFunction:<string>
| [ <Hash> ]( /Hash.html) Algorithm used for generation the hash (see node.js crypto package).
hashSalt:<string>
Any string which is added to the hash to salt it.
hotUpdateChunkFilename:<string>
The filename of the Hot Update Chunks. They are inside the output.path directory.
hotUpdateGlobal:<string>
The global variable used by webpack for loading of hot update chunks.
hotUpdateMainFilename:<string>
The filename of the Hot Update Main File. It is inside the 'output.path' directory.
ignoreBrowserWarnings:<boolean>
Ignore warnings in the browser.
Wrap javascript code into IIFE's to avoid leaking into global scope.
importFunctionName:<string>
The name of the native import() function (can be exchanged for a polyfill).
importMetaName:<string>
The name of the native import.meta object (can be exchanged for a polyfill).
Options for library.
module:<boolean>
Output javascript files as module source type.
The output directory as  absolute path (required).
pathinfo:<boolean>
Include comments with information about the modules.
publicPath:<string> | <object>
The 'publicPath' specifies the public URL address of the output files when referenced in a browser.
scriptType:
{false|"module"|"text/javascript"} This option enables loading async chunks via a custom script type, such as script type="module".
sourceMapFilename:<string>
The filename of the SourceMaps for the JavaScript files. They are inside the 'output.path' directory.
sourcePrefix:<string>
Prefixes every line of the source in the bundle with this string.
strictModuleErrorHandling:<boolean>
Handles error in module loading correctly at a performance cost. This will handle module error compatible with the EcmaScript Modules spec.
strictModuleExceptionHandling:<boolean>
Handles exceptions in module loading correctly at a performance cost (Deprecated). This will handle module error compatible with the Node.js CommonJS way.
trustedTypes:<TrustedTypes>
Use a Trusted Types policy to create urls for chunks.
uniqueName:<string>
A unique name of the webpack build to avoid multiple webpack runtimes to conflict when using globals.
wasmLoading:<string>
The method of loading WebAssembly Modules (methods included by default are 'fetch' (web/WebWorker), 'async-node' (node.js), but others might be added by plugins).
webassemblyModuleFilename:<string>
The filename of WebAssembly modules as relative path inside the 'output.path' directory.
workerChunkLoading:<string>
The method of loading chunks (methods included by default are 'jsonp' (web), 'import' (ESM), 'importScripts' (WebWorker), 'require' (sync node.js), 'async-node' (async node.js), but others might be added by plugins).
workerPublicPath:<string>
Worker public path. Much like the public path, this sets the location where the worker script file is intended to be found. If not set, webpack will use the publicPath. Don't set this option unless your worker scripts are located at a different path from your other script files.
workerWasmLoading:<string>
The method of loading WebAssembly Modules (methods included by default are 'fetch' (web/WebWorker), 'async-node' (node.js), but others might be added by plugins).

  • tArg {TArg}
  • Returns: {Comparator}

Attributes
directory:<boolean>
is directory
is file
fragment:<string>
fragment
internal:<boolean>
is internal
module:<boolean>
is module
query:<string>
query
request:<string>
request

Attributes
allowHashBang:<boolean>
allowReturnOutsideFunction:<boolean>
comments:<boolean>
ecmaVersion:
{ecmaVersion}
locations:<boolean>
ranges:<boolean>
semicolons:<boolean>
sourceType:
{"module"|"script"}

  • ast {Program}
  • comments {CommentJavascriptParser[]}
  • semicolons {Set}

  • [index: {string}] <any>

Specify options for each parser.


Attributes
compilation:<Compilation>
options:
{WebpackOptionsNormalizedWithDefaults}
source:
{string|Buffer }

Configuration object for web performance recommendations.

Attributes
assetFilter:<object>
Filter function to select assets that are checked.
hints:
{false|"error"|"warning"} Sets the format of the hints: warnings, errors or nothing at all.
maxAssetSize:<number>
File size limit (in bytes) when exceeded, that webpack will provide performance hints.
maxEntrypointSize:<number>
Total size of an entry point (in bytes).

Attributes
browser:<boolean> | <null>
browser platform, running in a normal web browser
electron:<boolean> | <null>
electron platform, require of some electron built-in modules is available
node platform, require of node built-in modules is available
nwjs platform, require of legacy nw.gui is available
web platform, importing of http(s) and std: is available
webworker:<boolean> | <null>
(Web)Worker platform, running in a web/shared/service worker

Attributes
resolveToUnqualified:<object>
resolve to unqualified

Attributes
column:<number>

  • [index: {string}] <any>

Attributes
content:<string>
element:<string>

Attributes
additionalAssets:<boolean> | <object>

Attributes
outputPath:<string>
Path to the output file e.g.  path.resolve(__dirname, 'profiling/events.json') . Defaults to events.json .

Options object for the ProgressPlugin.

Attributes
activeModules:<boolean>
Show active modules count and one active module in progress message.
dependencies:<boolean>
Show dependencies count in progress message.
dependenciesCount:<number>
Minimum dependencies count to start with. For better progress calculation. Default: 10000.
entries:<boolean>
Show entries count in progress message.
handler:<object>
Function that executes for every progress step.
modules:<boolean>
Show modules count in progress message.
modulesCount:<number>
Minimum modules count to start with. For better progress calculation. Default: 5000.
percentBy:<null>
Collect percent algorithm. By default it calculates by a median from modules, entries and dependencies percent.
profile:<boolean> | <null>
Collect profile data for progress steps. Default: false.

Advanced configuration for modules that should be provided as shared modules to the share scope.

Attributes
eager:<boolean>
Include the provided module directly instead behind an async request. This allows to use this shared module in initial load too. All possible shared modules need to be eager too.
shareKey:<string>
Key in the share scope under which the shared modules should be stored.
shareScope:<string>
Share scope name.
version:<string>
Version of the provided module. Will replace lower matching versions, but not higher.

  • provides {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 <string> Share scope name used for all provided modules (defaults to 'default').

Modules that should be provided as shared modules to the share scope. Property names are used as share keys.


  • fetchPriority {"auto"|"low"|"high"}
  • prefetchOrder <number>
  • preloadOrder <number>

Attributes
debugId:<string>
debug id
file
ignoreList:<number[]>
ignore list
mappings:<string>
mappings
names
sourceRoot:<string>
source root
sources:<string[]>
sources
sourcesContent:<string[]>
sources content
version:<number>
version

Attributes
buffer:
{TBuffer}
offset:<number>
length:<number>
position:<number> | <bigint> | <null>
callback:<object>
Returns:
{void}
Attributes
options:
{ReadAsyncOptions }
callback:<object>
Returns:
{void}
Attributes
callback:<object>
Returns:
{void}


  • path {PathLikeFs}
  • callback <object>
  • Returns: {void}

  • path {PathLikeFs}
  • options <object>
  • Returns: {Buffer[]}
  • path {PathLikeFs}
  • options <object> | <null>
  • Returns: {string[]|Buffer[]}
  • path {PathLikeFs}
  • options <object>
  • Returns: {Dirent[]}
  • path {PathLikeFs}
  • options <object>
  • Returns: {Dirent<Buffer>[]}

  • path {PathLikeTypes}
  • callback <object>
  • Returns: {void}

Attributes
import:<boolean>
use import?

Attributes
import:<boolean>
use import?
mangleImports:<boolean>
mangle imports

  • path {PathOrFileDescriptorFs}
  • options <object>
  • callback <object>
  • Returns: {void}
  • path {PathOrFileDescriptorFs}
  • callback <object>
  • Returns: {void}

  • path {PathOrFileDescriptorFs}
  • options <object> | <null>
  • Returns: {Buffer}
  • path {PathOrFileDescriptorFs}
  • options <object> | <null>
  • Returns: {string|Buffer}

  • path {PathOrFileDescriptorTypes}
  • options <object>
  • callback <object>
  • Returns: {void}
  • path {PathOrFileDescriptorTypes}
  • callback <object>
  • Returns: {void}

  • path {PathLikeFs}
  • options {EncodingOption}
  • callback <object>
  • Returns: {void}
  • path {PathLikeFs}
  • options {BufferEncodingOption}
  • callback <object>
  • Returns: {void}
  • path {PathLikeFs}
  • options {EncodingOption}
  • callback <object>
  • Returns: {void}
  • path {PathLikeFs}
  • callback <object>
  • Returns: {void}

  • path {PathLikeFs}
  • options {EncodingOption}
  • Returns: <string>
  • path {PathLikeFs}
  • options {BufferEncodingOption}
  • Returns: {Buffer}
  • path {PathLikeFs}
  • options {EncodingOption}
  • Returns: {string|Buffer}

  • path {PathLikeTypes}
  • options {EncodingOption}
  • callback <object>
  • Returns: {void}
  • path {PathLikeTypes}
  • options {BufferEncodingOption}
  • callback <object>
  • Returns: {void}
  • path {PathLikeTypes}
  • options {EncodingOption}
  • callback <object>
  • Returns: {void}
  • path {PathLikeTypes}
  • callback <object>
  • Returns: {void}

Attributes
hashDigest:<string>
the hash digest to use
hashFunction:
{HashFunction} the hash function to use

  • end {SourcePosition}
  • index <number>
  • start {SourcePosition}

  • path {PathLikeFs}
  • options {EncodingOption}
  • callback <object>
  • Returns: {void}
  • path {PathLikeFs}
  • options {BufferEncodingOption}
  • callback <object>
  • Returns: {void}
  • path {PathLikeFs}
  • options {EncodingOption}
  • callback <object>
  • Returns: {void}
  • path {PathLikeFs}
  • callback <object>
  • Returns: {void}

  • path {PathLikeFs}
  • options {EncodingOption}
  • Returns: <string>
  • path {PathLikeFs}
  • options {BufferEncodingOption}
  • Returns: {Buffer}
  • path {PathLikeFs}
  • options {EncodingOption}
  • Returns: {string|Buffer}

  • path {PathLikeTypes}
  • options {EncodingOption}
  • callback <object>
  • Returns: {void}
  • path {PathLikeTypes}
  • options {BufferEncodingOption}
  • callback <object>
  • Returns: {void}
  • path {PathLikeTypes}
  • options {EncodingOption}
  • callback <object>
  • Returns: {void}
  • path {PathLikeTypes}
  • callback <object>
  • Returns: {void}

  • byName {Record<string, number>}
  • bySource {Record<string, number>}
  • usedIds <number[]>

  • byIdentifier {Record<string, number>}
  • usedIds <number[]>


Attributes
canMangle:<boolean>
when false, referenced export can not be mangled, defaults to true
name of the referenced export

Advanced configuration for container locations from which modules should be resolved and loaded at runtime.

Attributes
external:<string> | <string[]>
Container locations from which modules should be resolved and loaded at runtime.
shareScope:<string>
The name of the share scope shared with this remote.

Container locations from which modules should be resolved and loaded at runtime. Property names are used as request scopes.


Attributes
chunk:<Chunk>
the chunk
chunkGraph:<ChunkGraph>
the chunk graph
codeGenerationResults:<CodeGenerationResults>
results of code generation
hash to be used for render call
moduleGraph:<ModuleGraph>
the module graph
runtimeTemplate:
[ <RuntimeTemplate> ]( /RuntimeTemplate.html) the runtime template

Attributes
chunk:<Chunk>
the chunk
chunkGraph:<ChunkGraph>
the chunk graph
codeGenerationResults:<CodeGenerationResults>
results of code generation
modules:
[ <CssModule[]> ]( /CssModule.html) modules
runtimeTemplate:
[ <RuntimeTemplate> ]( /RuntimeTemplate.html) the runtime template
undoPath:<string>
undo path to css file
uniqueName:<string>
the unique name

Attributes
chunk:<Chunk>
the chunk
chunkGraph:<ChunkGraph>
the chunk graph
codeGenerationResults:<CodeGenerationResults>
results of code generation
dependencyTemplates:
[ <DependencyTemplates> ]( /DependencyTemplates.html) the dependency templates
moduleGraph:<ModuleGraph>
the module graph
runtimeTemplate:
[ <RuntimeTemplate> ]( /RuntimeTemplate.html) the runtime template
strictMode:<boolean>
rendering in strict context

Attributes
auxiliary:<boolean>
filename:<string>
identifier:<string>
render:<object>

Attributes
auxiliary:<boolean>
filenameTemplate:<TemplatePath>
identifier:<string>
pathOptions:<PathData>
render:<object>


  • directories {Set} list of directories
  • files {Set} list of files
  • missing {Set} list of missing entries
  • resolveDependencies {ResolveDependencies} dependencies of the resolving
  • resolveResults {Map<string, string|false|undefined>} stored resolve results

  • contextDependencies {WriteOnlySet} directories that was found on file system
  • fileDependencies {WriteOnlySet} files that was found on file system
  • log <object> log function
  • missingDependencies {WriteOnlySet} dependencies that was not found on file system
  • stack {Set} set of hooks' calls. For instance, resolve → parsedResolve → describedResolve,
  • yield <object> yield result, if provided plugins can return several results

Attributes
safeTime:<number>
timestampHash:<string>

Attributes
safeTime:<number>
timestampHash:<string>

  • directories {Set} list of directories
  • files {Set} list of files
  • missing {Set} list of missing entries

  • platform {false|PlatformTargetProperties} - platform target properties

  • alias {AliasOption[]} alias
  • aliasFields {Set<string|string[]>} alias fields
  • cachePredicate <object> cache predicate
  • cacheWithContext <boolean> cache with context
  • conditionNames {Set} A list of exports field condition names.
  • descriptionFiles <string[]> description files
  • enforceExtension <boolean> enforce extension
  • exportsFields {Set<string|string[]>} exports fields
  • extensionAlias {ExtensionAliasOption[]} extension alias
  • extensions {Set} extensions
  • fallback {AliasOption[]} fallback
  • fileSystem <FileSystem> fileSystem
  • fullySpecified <boolean> fully specified
  • importsFields {Set<string|string[]>} imports fields
  • mainFields <object[]> main fields
  • mainFiles {Set} main files
  • modules <string> modules
  • plugins <Plugin[]> plugins
  • pnpApi <null> pnp API
  • preferAbsolute <boolean> prefer absolute
  • preferRelative <boolean> prefer relative
  • resolver <Resolver> resolver
  • resolveToContext <boolean> resolve to context
  • restrictions {Set<string|RegExp>} restrictions
  • roots {Set} roots
  • symlinks <boolean> symlinks
  • tsconfig <string> | <boolean> tsconfig file path or config object
  • unsafeCache {false|CacheTypes} unsafe cache

  • alias {AliasOption[]|AliasOptions} A list of module alias configurations or an object which maps key to value
  • aliasFields <string> A list of alias fields in description files
  • cachePredicate <object> A function which decides whether a request should be cached or not. An object is passed with at least path and request properties.
  • cacheWithContext <boolean> Whether or not the unsafeCache should include request context as part of the cache key.
  • conditionNames <string[]> A list of exports field condition names.
  • descriptionFiles <string[]> A list of description files to read from
  • enforceExtension <boolean> Enforce that a extension from extensions must be used
  • exportsFields <string> A list of exports fields in description files
  • extensionAlias {ExtensionAliasOptions} An object which maps extension to extension aliases
  • extensions <string[]> A list of extensions which should be tried for files
  • fallback {AliasOption[]|AliasOptions} A list of module alias configurations or an object which maps key to value, applied only after modules option
  • fileSystem <FileSystem> The file system which should be used
  • fullySpecified <boolean> The request is already fully specified and no extensions or directories are resolved for it
  • importsFields <string> A list of imports fields in description files
  • mainFields <string> | <string[]> | <object[]> A list of main fields in description files
  • mainFiles <string[]> A list of main files in directories
  • modules <string> | <string[]> A list of directories to resolve modules from, can be absolute path or folder name
  • plugins <Plugin[]> A list of additional resolve plugins which should be applied
  • pnpApi <null> A PnP API that should be used - null is "never", undefined is "auto"
  • preferAbsolute <boolean> Prefer to resolve server-relative urls as absolute paths before falling back to resolve in roots
  • preferRelative <boolean> Prefer to resolve module requests as relative requests before falling back to modules
  • resolver <Resolver> A prepared Resolver to which the plugins are attached
  • resolveToContext <boolean> Resolve to a context instead of a file
  • restrictions <string> | <RegExp[]> A list of resolve restrictions
  • roots <string[]> A list of root paths
  • symlinks <boolean> Resolve symlinks to their symlinked location
  • tsconfig <string> | <boolean> TypeScript config file path or config object with configFile and references
  • unsafeCache <boolean> Use this cache object to unsafely cache the successful requests
  • useSyncFileSystemCalls <boolean> Use only the sync constraints of the file system calls

  • direct {WeakMap<ResolveOptionsWithDependencyType, ResolverWithOptions>}
  • stringified {Map<string, ResolverWithOptions>}

Attributes
context:<string>
data:
{ResourceSchemeData|Partial }
fragment:<string>
query:<string>
resource:<string>

Attributes
encodedContent:<string>
encoded content of the resource
encoding:
{false|"base64"} encoding of the resource
mimetype:<string>
mime type of the resource
parameters:<string>
additional parameters for the resource

Attributes
canMangleProvide:<boolean>
exportsInfo:
[ <RestoreProvidedData> ]( /RestoreProvidedData.html)
provided:<boolean> | <null>
terminalBinding:<boolean>

Attributes
execute the rule set
references:
{Map<string, RuleSetLoaderOptions>} map of references in the rule set (may grow over time)

Logic operators used in a condition matcher.

Attributes

Logic operators used in a condition matcher.

Attributes

Attributes
chunkGraph:<ChunkGraph>
the chunk graph
codeGenerationResults:<CodeGenerationResults>
the code generation results

Attributes
buildDependencies:<string[]>
contextDependencies:<string[]>
fileDependencies:<string[]>
missingDependencies:<string[]>
version:<string> | <object>

Helper function for joining two ranges into a single range. This is useful when working with AST nodes, as it allows you to combine the ranges of child nodes to create the range of the parent node.



  • {IteratorObject<T, undefined>}
Returns:
{void}
Returns:
{SetIterator }

Advanced configuration for modules that should be shared in the share scope.

Attributes
eager:<boolean>
Include the provided and fallback module directly instead behind an async request. This allows to use this shared module in initial load too. All possible shared modules need to be eager too.
import:<string>
Provided module that should be provided to share scope. Also acts as fallback module if no shared module is found in share scope or version isn't valid. Defaults to the property name.
packageName:<string>
Package name to determine required version from description file. This is only needed when package name can't be automatically determined from request.
requiredVersion:<string>
Version requirement from module in share scope.
shareKey:<string>
Module is looked up under this key from the share scope.
shareScope:<string>
Share scope name.
singleton:<boolean>
Allow only a single version of the shared module in share scope (disabled by default).
strictVersion:<boolean>
Do not accept shared module if version is not valid (defaults to yes, if local fallback module is available and shared module is not a singleton, otherwise no, has no effect if there is no required version specified).
version:<string>
Version of the provided module. Will replace lower matching versions, but not higher.

Modules that should be shared in the share scope. Property names are used to match requested modules in this compilation. Relative requests are resolved, module requests are matched unresolved, absolute paths will match resolved requests. A trailing slash will match all requests with this prefix. In this case shareKey must also have a trailing slash.


Options for shared modules.

  • shared {Shared} Modules that should be shared in the share scope. When provided, property names are used to match requested modules in this compilation.
  • shareScope <string> Share scope name used for all shared modules (defaults to 'default').

Attributes
should use hash to snapshot
timestamp:<boolean>
should use timestamp to snapshot

Options affecting how file system snapshots are created and validated.

Attributes
buildDependencies:<object>
Options for snapshotting build dependencies to determine if the whole cache need to be invalidated.
contextModule:<object>
Options for snapshotting the context module to determine if it needs to be built again.
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.
module:<object>
Options for snapshotting dependencies of modules to determine if they need to be built again.
resolve:<object>
Options for snapshotting dependencies of request resolving to determine if requests need to be re-resolved.
resolveBuildDependencies:<object>
Options for snapshotting the resolving of build dependencies to determine if the build dependencies need to be re-resolved.
unmanagedPaths:<string> | <RegExp[]>
List of paths that are not managed by a package manager and the contents are subject to change.


Attributes
map:<null>
map
source:
{SourceValue} source

Attributes
buffer:<object>
buffer
map
size
source:<object>
source
sourceAndMap:<object>
source and map
updateHash:<object>
hash updater

Attributes
Appends the given value to the original asset. Usually the #sourceMappingURL comment. [url] is replaced with a URL to the source map file. false disables the appending.
columns:<boolean>
Indicates whether column mappings should be used (defaults to true).
debugIds:<boolean>
Emit debug IDs into source and SourceMap.
Exclude modules that match the given value from source map generation.
fallbackModuleFilenameTemplate:<string> | <object>
Generator string or function to create identifiers of modules for the 'sources' array in the SourceMap used only if 'moduleFilenameTemplate' would result in a conflict.
fileContext:<string>
Path prefix to which the [file] placeholder is relative to.
filename:<string> | <null>
Defines the output filename of the SourceMap (will be inlined if no value is provided).
ignoreList:<string> | <RegExp> | <object>
Decide whether to ignore source files that match the specified value in the SourceMap.
Include source maps for module paths that match the given value.
module:<boolean>
Indicates whether SourceMaps from loaders should be used (defaults to true).
moduleFilenameTemplate:<string> | <object>
Generator string or function to create identifiers of modules for the 'sources' array in the SourceMap.
namespace:<string>
Namespace prefix to allow multiple webpack roots in the devtools.
noSources:<boolean>
Omit the 'sourceContents' array from the SourceMap.
publicPath:<string>
Provide a custom public path for the SourceMapping comment.
sourceRoot:<string>
Provide a custom value for the 'sourceRoot' property in the SourceMap.
Include source maps for modules based on their extension (defaults to .js and .css).

Attributes
column:<number>

Attributes
automaticNameDelimiter:<string>
chunksFilter:<object>
defaultSizeTypes:<string[]>
enforceSizeThreshold:
{SplitChunksSizes}
fallbackCacheGroup:
{FallbackCacheGroup}
filename:<string> | <object>
getCacheGroups:<object>
getName:<object>
hidePathInfo:<boolean>
maxAsyncRequests:<number>
maxAsyncSize:
{SplitChunksSizes}
maxInitialRequests:<number>
maxInitialSize:
{SplitChunksSizes}
minChunks:<number>
minRemainingSize:
{SplitChunksSizes}
minSize:
{SplitChunksSizes}
minSizeReduction:
{SplitChunksSizes}
usedExports:<boolean>


Attributes

Attributes
chunk:<Chunk>
the chunk
chunkGraph:<ChunkGraph>
the chunk graph
codeGenerationResults:<CodeGenerationResults>
results of code generation
dependencyTemplates:
[ <DependencyTemplates> ]( /DependencyTemplates.html) the dependency templates
inlined:<boolean>
inlined
inlinedInIIFE:<boolean>
the inlined entry module is wrapped in an IIFE
moduleGraph:<ModuleGraph>
the module graph
needExportsDeclaration:<boolean>
whether the top-level exports declaration needs to be generated
runtimeTemplate:
[ <RuntimeTemplate> ]( /RuntimeTemplate.html) the runtime template
strictMode:<boolean>
rendering in strict context

  • path {PathLikeFs}
  • callback <object>
  • Returns: {void}

Attributes
bigint:<boolean>

  • extract {HookMap<SyncBailHook<Tuple<any, any, StatsFactoryContext>, void, UnsetAdditionalOptions>>}
  • filter {HookMap<SyncBailHook<Tuple<any, StatsFactoryContext, number, number>, boolean|void, UnsetAdditionalOptions>>}
  • filterResults {HookMap<SyncBailHook<Tuple<any, StatsFactoryContext, number, number>, boolean|void, UnsetAdditionalOptions>>}
  • filterSorted {HookMap<SyncBailHook<Tuple<any, StatsFactoryContext, number, number>, boolean|void, UnsetAdditionalOptions>>}
  • getItemFactory {HookMap<SyncBailHook<Tuple<any, StatsFactoryContext>, void|StatsFactory, UnsetAdditionalOptions>>}
  • getItemName {HookMap<SyncBailHook<Tuple<any, StatsFactoryContext>, string|void, UnsetAdditionalOptions>>}
  • groupResults {HookMap<SyncBailHook<Tuple<GroupConfig<any, any>[], StatsFactoryContext>, void, UnsetAdditionalOptions>>}
  • merge {HookMap<SyncBailHook<Tuple<any[], StatsFactoryContext>, any, UnsetAdditionalOptions>>}
  • result {HookMap<SyncBailHook<Tuple<any, StatsFactoryContext>, any, UnsetAdditionalOptions>>}
  • sort {HookMap<SyncBailHook<Tuple<object[], StatsFactoryContext>, void, UnsetAdditionalOptions>>}
  • sortResults {HookMap<SyncBailHook<Tuple<object[], StatsFactoryContext>, void, UnsetAdditionalOptions>>}

  • getItemName {HookMap<SyncBailHook<Tuple<any, StatsPrinterContext>, string|void, UnsetAdditionalOptions>>}
  • print {HookMap<SyncBailHook<Tuple<any, StatsPrinterContext>, string|void|undefined, UnsetAdditionalOptions>>}
  • printElements {HookMap<SyncBailHook<Tuple<PrintedElement[], StatsPrinterContext>, string|void|undefined, UnsetAdditionalOptions>>}
  • printItems {HookMap<SyncBailHook<Tuple<string[], StatsPrinterContext>, string|undefined, UnsetAdditionalOptions>>}
  • result {HookMap<SyncWaterfallHook<Tuple<string, StatsPrinterContext>, string, UnsetAdditionalOptions>>}
  • sortElements {HookMap<SyncBailHook<Tuple<string[], StatsPrinterContext>, void, UnsetAdditionalOptions>>}
  • sortItems {HookMap<SyncBailHook<Tuple<any[], StatsPrinterContext>, boolean|void, UnsetAdditionalOptions>>}

  • path {PathLikeFs}
  • options <undefined>
  • Returns: {IStats}
  • path {PathLikeFs}
  • options <object>
  • Returns: {IStats}
  • path {PathLikeFs}
  • options <object>
  • Returns: {IBigIntStats}
  • path {PathLikeFs}
  • options <object>
  • Returns: {IStats|IBigIntStats}
  • path {PathLikeFs}
  • options {StatSyncOptions}
  • Returns: <undefined>

Attributes
bigint:<boolean>
throwIfNoEntry:<boolean>

  • path {PathLikeTypes}
  • callback <object>
  • Returns: {void}

Attributes
columns:<boolean>
finalSource:<boolean>
source:<boolean>

Attributes
autoClose:<boolean>
emitClose:<boolean>
encoding:
{"ascii"|"utf8"|"utf-8"|"utf16le"|"utf-16le"|"ucs2"|"ucs-2"|"base64"|"base64url"|"latin1"|"binary"|"hex"}
flags:<string>
start:<number>

Attributes
toString:<object>

Attributes
context:<string>
context for module names
mode:
{"update"|"read"|"create"|"merge"} operation mode (defaults to merge)
path to file
selector for modules

Attributes
index:<number>

  • data {Record<string, any>|TopLevelSymbol|HarmonySettings|ImportSettings|CommonJsImportSettings|CompatibilitySettings|HarmonySpecifierGuards}
  • next {TagInfo}
  • tag <symbol>

Attributes

Attributes
deferred:<boolean>
export:<string[]>
module:<Module>

Attributes
safeTime:<number>
timestamp:<number>

Use a Trusted Types policy to create urls for chunks.

  • onPolicyCreationFailure {"continue"|"stop"} If the call to trustedTypes.createPolicy(...) fails -- e.g., due to the policy name missing from the CSP trusted-types list, or it being a duplicate name, etc. -- controls whether to continue with loading in the hope that require-trusted-types-for 'script' isn't enforced yet, versus fail immediately. Default behavior is 'stop'.
  • policyName <string> The name of the Trusted Types policy created by webpack to serve bundle chunks.

Attributes
baseUrl:<string>
Override baseUrl from tsconfig.json. If provided, this value will be used instead of the baseUrl in the tsconfig file
configFile:<string>
A relative path to the tsconfig file based on cwd, or an absolute path of tsconfig file
references:<string[]>
References to other tsconfig files. 'auto' inherits from TypeScript config, or an array of relative/absolute paths

  • alias {AliasOption[]} tsconfig file data
  • modules <string[]> tsconfig file data

Attributes
allContexts:<object>
all contexts (main + refs) for quick lookup
fileDependencies:
{Set } file dependencies
main:
{TsconfigPathsData} main tsconfig paths data
mainContext:<string>
main tsconfig base URL (absolute path)
referenced tsconfig paths data mapped by baseUrl

Attributes
chunkGraph:<ChunkGraph>
runtime:
{RuntimeSpec}
runtimeTemplate:
[ <RuntimeTemplate> ]( /RuntimeTemplate.html)

Attributes
chunkGraph:<ChunkGraph>
the module
runtime:
{RuntimeSpec}
runtimeTemplate:
[ <RuntimeTemplate> ]( /RuntimeTemplate.html)

Attributes

  • [index: {string}] {Value[]}

A virtual module definition.

Attributes
context:<string>
The context for the virtual module. A string path. Defaults to 'auto', which will try to resolve the context from the module id.
source:<object>
The source function that provides the virtual content.
The module type.
version:<string> | <object>
Optional version function or value for cache invalidation.

  • [index: {string}] {VirtualModuleContent}

Options for building virtual resources.

Attributes
context:<string>
The default context for virtual modules. A string path. Defaults to 'auto', which will try to resolve the context from the module id.
modules:<object>
The virtual modules configuration.
scheme:<string>
The URL scheme to use for virtual resources.

Attributes
close:<object>
closes the watcher and all underlying file watchers
getAggregatedChanges:<object>
get current aggregated changes that have not yet send to callback
getAggregatedRemovals:<object>
get current aggregated removals that have not yet send to callback
getContextTimeInfoEntries:<object>
get info about directories
getFileTimeInfoEntries:<object>
get info about files
getInfo:<object>
get info about timestamps and changes
pause:<object>
closes the watcher, but keeps underlying file watchers alive until the next watch call

  • changes {Set|null} get current aggregated changes that have not yet send to callback
  • contextTimeInfoEntries {Map<string, "ignore"|EntryTypesIndex|OnlySafeTimeEntry|ExistenceOnlyTimeEntryTypesIndex|null>} get info about directories
  • fileTimeInfoEntries {Map<string, "ignore"|EntryTypesIndex|OnlySafeTimeEntry|ExistenceOnlyTimeEntryTypesIndex|null>} get info about files
  • removals {Set|null} get current aggregated removals that have not yet send to callback

Attributes
watch:<object>

Attributes
A list of RegExps or absolute paths to directories or files that should be ignored.

Options for the watcher.

Attributes
aggregateTimeout:<number>
Delay the rebuilt after the first change. Value is a time in ms.
followSymlinks:<boolean>
Resolve symlinks and watch symlink and real file. This is usually not needed as webpack already resolves symlinks ('resolve.symlinks').
Ignore some files from watching (glob pattern or regexp).
Enable polling mode for watching.
stdin:<boolean>
Stop watching when stdin stream has ended.

Attributes
chunk:<Chunk>
the chunk
chunkGraph:<ChunkGraph>
the chunk graph
codeGenerationResults:<CodeGenerationResults>
results of code generation
dependencyTemplates:
[ <DependencyTemplates> ]( /DependencyTemplates.html) the dependency templates
moduleGraph:<ModuleGraph>
the module graph
runtimeTemplate:
[ <RuntimeTemplate> ]( /RuntimeTemplate.html) the runtime template

Attributes

Attributes
Returns:<any>
  • c {Record<string, ExecuteModuleObject>}
  • i <object[]>

Attributes

Attributes
withOptions:<object>
create a resolver with additional/different options

  • file {PathOrFileDescriptorFs}
  • data {string|ArrayBufferView}
  • options {WriteFileOptions}
  • callback <object>
  • Returns: {void}
  • file {PathOrFileDescriptorFs}
  • data {string|ArrayBufferView}
  • callback <object>
  • Returns: {void}

Attributes

Attributes
resolveDependencies:<object>
resource:<string> | <string[]>
resourceFragment:<string>
resourceQuery:<string>



Type:
{NormalModuleLoaderContext |LoaderRunnerLoaderContext |LoaderPluginLoaderContext|HotModuleReplacementPluginLoaderContext}


Type:
{AssetInlineGeneratorOptions|AssetResourceGeneratorOptions}



Type:
{ContextResolveData|ContextOptions}

Type:
{"ascii"|"utf8"|"utf-8"|"utf16le"|"utf-16le"|"ucs2"|"ucs-2"|"base64"|"base64url"|"latin1"|"binary"|"hex"}


Type:
{KnownBuildInfo|Record<string, any>}

Type:
{KnownBuildMeta|Record<string, any>}


Type:
{SimpleCallExpression|NewExpression}


Attributes



Type:
{Omit<Map<string, any>, "get"|"set"|"has"|"delete">|CodeGenMapOverloads}

Type:<any>

Type:
{undefined|null|string|number|bigint|boolean|Function|RegExp|RuntimeValue|object|RecursiveArrayOrRecord<undefined|null|string|number|bigint|boolean|Function|RegExp|RuntimeValue>[]}


Attributes
loc:
{SourceLocation}
start:<number>




Type:
{Item |string|Item []}

Attributes
request:<string>

Type:
{"weak"|"eager"|"lazy"|"lazy-once"|"sync"|"async-weak"}

Type:
{ContextOptions|ContextModuleOptionsExtras}

Type:
{KnownContext|Record<any, any>}

Type:
{Record<string, StatsChunkGroup>|StatsObject<V, F>[]|StatsObject<T, F>}

Attributes

Type:
{KnownCreateStatsOptionsContext|Record<string, any>}

Attributes
close:<object>
write:<object>


Type:
{FunctionDeclaration|VariableDeclaration|ClassDeclaration}

Type:
{SyntheticDependencyLocation|RealDependencyLocation}



<object>

Attributes
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>
An object containing content and name or a string to the absolute path of the JSON manifest to be loaded upon compilation.
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:
{"var"|"assign"|"this"|"window"|"global"|"commonjs"|"commonjs2"|"commonjs-module"|"amd"|"amd-require"|"umd"|"umd2"|"jsonp"|"system"} How the dll is exposed (libraryTarget, defaults to manifest.type).
type:
{"object"|"require"} The way how the export of the dll bundle is used.

<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 {"var"|"assign"|"this"|"window"|"global"|"commonjs"|"commonjs2"|"commonjs-module"|"amd"|"amd-require"|"umd"|"umd2"|"jsonp"|"system"} How the dll is exposed (libraryTarget).
  • type {"object"|"require"} The way how the export of the dll bundle is used.

Type:
{3|5|6|7|8|9|10|11|12|13|14|15|16|17|2015|2016|2017|2018|2019|2020|2021|2022|2023|2024|2025|2026|"latest"}

Type:
{EffectUse|EffectBasic}

Type:
{"use"|"use-pre"|"use-post"}





Attributes
details:<string>

Type:
{"module"|"chunk"|"root-of-chunk"|"nested"}

Type:
{ExperimentsCommon|ExperimentsExtra}

Type:
{ExperimentsCommon|ExperimentsNormalizedExtra}

| [ <VariableInfo> ]( /VariableInfo.html)

Type:
{"unused"|"missing"|"empty-star"|"reexport-dynamic-default"|"reexport-named-default"|"reexport-namespace-object"|"reexport-fake-namespace-object"|"reexport-undefined"|"normal-reexport"|"dynamic-reexport"}

Type:
{0|1|2|3}

Type:
{"namespace"|"default-only"|"default-with-named"|"dynamic"}


Type:
{ImportExpressionImport|UnaryExpression|ArrayExpression|ArrowFunctionExpression|AssignmentExpression|AwaitExpression|BinaryExpression|SimpleCallExpression|NewExpression|ChainExpression|ClassExpression|ConditionalExpression|FunctionExpression|Identifier|SimpleLiteral|RegExpLiteral|BigIntLiteral|LogicalExpression|MemberExpression|MetaProperty|ObjectExpression|SequenceExpression|TaggedTemplateExpression|TemplateLiteral|ThisExpression|UpdateExpression|YieldExpression}


  • electron {NonNullable<undefined|boolean>}
  • electronMain {NonNullable<undefined|boolean>}
  • electronPreload {NonNullable<undefined|boolean>}
  • electronRenderer {NonNullable<undefined|boolean>}
  • node {NonNullable<undefined|boolean>}
  • nwjs {NonNullable<undefined|boolean>}
  • web {NonNullable<undefined|boolean>}

Type:
{"import"|"var"|"module"|"assign"|"this"|"window"|"self"|"global"|"commonjs"|"commonjs2"|"commonjs-module"|"commonjs-static"|"amd"|"amd-require"|"umd"|"umd2"|"jsonp"|"system"|"promise"|"module-import"|"script"|"node-commonjs"|"asset"|"css-import"|"css-url"}

Type:
{T|FakeHookMarker}



Attributes
Attributes
entryOptions:<EntryOptions>
Attributes
circular:<boolean>

| [ <Hash> ]( /Hash.html)

Type:
{IStatsBase |object}
Attributes
atimeNs:<bigint>
birthtimeNs:<bigint>
ctimeNs:<bigint>
mtimeNs:<bigint>

<object>

Attributes
contextRegExp:<RegExp>
A RegExp to test the context (directory) against.
resourceRegExp:<RegExp>
A RegExp to test the request against.

<object>

Attributes
checkResource:<object>
A filter function for resource and context.

Type:
{true|Tuple<string, string>[]}

  • phase {"defer"}

Type:
{0|1|2}


  • appendOnly {NonNullable<undefined|boolean>}
  • colors {NonNullable<undefined|boolean>}
  • debug {NonNullable<undefined|string|boolean|RegExp|FilterItemTypes[]|object>}
  • level {NonNullable<undefined|"none"|"verbose"|"error"|"warn"|"info"|"log">}
  • stream <NodeJS.WritableStream> | <object>


Type:
{T|TOMBSTONE|UNDEFINED_MARKER}



Type:
{ParserStateBase|Record<string, any>|KnownJavascriptParserState}



Type:
{object|Partial }



Type:
{"error"|"warn"|"info"|"log"|"debug"|"clear"|"profile"|"trace"|"group"|"groupCollapsed"|"groupEnd"|"profileEnd"|"time"|"status"}



Type:
{KnownMeta|Record<symbol, string[]>|Record<string, any>}



Type:
{ConcatenatedModuleInfo|ExternalModuleInfo}

Type:
{false|NodeOptions}


Type:
{KnownNormalizedStatsOptions|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>}

  • avoidEntryIife {NonNullable<undefined|boolean>}
  • checkWasmTypes {NonNullable<undefined|boolean>}
  • chunkIds {NonNullable<undefined|false|"natural"|"named"|"deterministic"|"size"|"total-size">}
  • concatenateModules {NonNullable<undefined|boolean>}
  • emitOnErrors {NonNullable<undefined|boolean>}
  • flagIncludedChunks {NonNullable<undefined|boolean>}
  • innerGraph {NonNullable<undefined|boolean>}
  • mangleExports {NonNullable<undefined|boolean|"deterministic"|"size">}
  • mangleWasmImports {NonNullable<undefined|boolean>}
  • mergeDuplicateChunks {NonNullable<undefined|boolean>}
  • minimize {NonNullable<undefined|boolean>}
  • minimizer <object> | <WebpackPluginInstance> | <"..."[]>
  • moduleIds {NonNullable<undefined|false|"natural"|"named"|"deterministic"|"size"|"hashed">}
  • nodeEnv {NonNullable<undefined|string|false>}
  • portableRecords {NonNullable<undefined|boolean>}
  • providedExports {NonNullable<undefined|boolean>}
  • realContentHash {NonNullable<undefined|boolean>}
  • removeAvailableModules {NonNullable<undefined|boolean>}
  • removeEmptyChunks {NonNullable<undefined|boolean>}
  • runtimeChunk {NonNullable<undefined|false|object>}
  • sideEffects {NonNullable<undefined|boolean|"flag">}
  • splitChunks {NonNullable<undefined|false|OptimizationSplitChunksOptions>}
  • usedExports {NonNullable<undefined|boolean|"global">}

  • assetModuleFilename {NonNullable<undefined|string|object>}
  • asyncChunks {NonNullable<undefined|boolean>}
  • charset {NonNullable<undefined|boolean>}
  • chunkFilename {NonNullable<undefined|string|object>}
  • chunkFormat {NonNullable<undefined|string|false>}
  • chunkLoading {NonNullable<undefined|string|false>}
  • chunkLoadingGlobal <string>
  • chunkLoadTimeout <number>
  • compareBeforeEmit {NonNullable<undefined|boolean>}
  • crossOriginLoading {NonNullable<undefined|false|"anonymous"|"use-credentials">}
  • cssChunkFilename {NonNullable<undefined|string|object>}
  • cssFilename {NonNullable<undefined|string|object>}
  • devtoolNamespace <string>
  • environment {RecursiveNonNullable}
  • filename {NonNullable<undefined|string|object>}
  • globalObject <string>
  • hashDigest <string>
  • hashDigestLength <number>
  • hashFunction {NonNullable<undefined|string|Hash>}
  • hotUpdateChunkFilename <string>
  • hotUpdateGlobal <string>
  • hotUpdateMainFilename <string>
  • iife {NonNullable<undefined|boolean>}
  • importFunctionName <string>
  • importMetaName <string>
  • module {NonNullable<undefined|boolean>}
  • path <string>
  • pathinfo {NonNullable<undefined|boolean|"verbose">}
  • publicPath {NonNullable<undefined|string|object>}
  • scriptType {NonNullable<undefined|false|"module"|"text/javascript">}
  • sourceMapFilename <string>
  • strictModuleErrorHandling {NonNullable<undefined|boolean>}
  • strictModuleExceptionHandling {NonNullable<undefined|boolean>}
  • uniqueName <string>
  • wasmLoading {NonNullable<undefined|string|false>}
  • webassemblyModuleFilename <string>
  • workerChunkLoading {NonNullable<undefined|string|false>}
  • workerPublicPath <string>
  • workerWasmLoading {NonNullable<undefined|string|false>}






Type:
{Identifier|MemberExpression|ObjectPattern|ArrayPattern|RestElement|AssignmentPattern}


Type:
{"unknown-argument"|"unexpected-non-array-in-path"|"unexpected-non-object-in-path"|"multiple-values-unexpected"|"invalid-value"}




Attributes

Type:
{KnownRecords|Record<string, KnownRecords[]>|Record<string, any>}

Type:
{object|RecursiveArrayOrRecord []|T}



Attributes
dependencyType:<string>
resolveToContext:<boolean>

Type:
{BaseResolveRequest|Partial }






Type:
{undefined|string|boolean|SortableSet }


Type:
{undefined|string|SortableSet }

Type:
{ServerImportHttp |ServerImportHttps }



Type:
{"string"|"number"|"boolean"}

Attributes
buildDependencies:<object>
immutablePaths:<string> | <RegExp[]>
managedPaths:<string> | <RegExp[]>
module:<object>
resolve:<object>
resolveBuildDependencies:<object>
unmanagedPaths:<string> | <RegExp[]>


Type:
{FunctionDeclaration|VariableDeclaration|ClassDeclaration|ExpressionStatement|BlockStatement|StaticBlock|EmptyStatement|DebuggerStatement|WithStatement|ReturnStatement|LabeledStatement|BreakStatement|ContinueStatement|IfStatement|SwitchStatement|ThrowStatement|TryStatement|WhileStatement|DoWhileStatement|ForStatement|ForInStatement|ForOfStatement}

Type:
{ImportDeclaration|ExportNamedDeclaration|ExportAllDeclaration|ImportExpressionImport|UnaryExpression|ArrayExpression|ArrowFunctionExpression|AssignmentExpression|AwaitExpression|BinaryExpression|SimpleCallExpression|NewExpression|ChainExpression|ClassExpression|ConditionalExpression|FunctionExpression|Identifier|SimpleLiteral|RegExpLiteral|BigIntLiteral|LogicalExpression|MemberExpression|MetaProperty|ObjectExpression|SequenceExpression|TaggedTemplateExpression|TemplateLiteral|ThisExpression|UpdateExpression|YieldExpression|FunctionDeclaration|MaybeNamedFunctionDeclaration|VariableDeclaration|ClassDeclaration|MaybeNamedClassDeclaration|ExpressionStatement|BlockStatement|StaticBlock|EmptyStatement|DebuggerStatement|WithStatement|ReturnStatement|LabeledStatement|BreakStatement|ContinueStatement|IfStatement|SwitchStatement|ThrowStatement|TryStatement|WhileStatement|DoWhileStatement|ForStatement|ForInStatement|ForOfStatement|ExportDefaultDeclaration}

Type:
{KnownStatsFactoryContext|Record<string, any>}


Type:
{KnownStatsPrinterColorFunctions|KnownStatsPrinterFormatters|KnownStatsPrinterContext|Record<string, any>}



Type:
{KnownUnsafeCacheData|Record<string, any>}


Type:
{0|1|2|3|4}



Type:
{string|Set }

Type:
{0|1|2|4}



Attributes
context:<string>
  • infrastructureLogging {InfrastructureLoggingNormalizedWithDefaults}
  • target {NonNullable<undefined|string|false|string[]>}
  • output {OutputNormalizedWithDefaults}
  • optimization {OptimizationNormalizedWithDefaults}
  • devtool {NonNullable<undefined|string|false|object[]>}
  • stats {NonNullable}
  • node {NonNullable}
  • profile {NonNullable<undefined|boolean>}
Attributes
parallelism:<number>
  • snapshot {SnapshotNormalizedWithDefaults}
  • externalsPresets {ExternalsPresetsNormalizedWithDefaults}
  • externalsType {NonNullable<undefined|"import"|"var"|"module"|"assign"|"this"|"window"|"self"|"global"|"commonjs"|"commonjs2"|"commonjs-module"|"commonjs-static"|"amd"|"amd-require"|"umd"|"umd2"|"jsonp"|"system"|"promise"|"module-import"|"script"|"node-commonjs"|"asset"|"css-import"|"css-url">}
  • watch {NonNullable<undefined|boolean>}
  • performance {NonNullable<undefined|false|PerformanceOptions>}
  • recordsInputPath {NonNullable<undefined|string|false>}
  • recordsOutputPath {NonNullable<undefined|string|false>}
  • dotenv {NonNullable<undefined|boolean|DotenvPluginOptions>}


Attributes

Stability: 0Deprecated
Type:
{boolean|SortableSet |null}





Type:
{Readonly }

webpack.validate(configuration): void
Attributes
Returns:
{void}

webpack.validateSchema(schema, options, validationConfiguration?): void
  • schema {Parameters}
  • options {Parameters}
  • validationConfiguration {ValidationErrorConfiguration}
  • Returns: {void}


Type:
{_functionWebpack}

webpack(options, callback): void
Attributes
options
callback:
{CallbackWebpackFunction_2<Stats, void>} callback
Returns:<Compiler> | <null>
Compiler or MultiCompiler
Attributes
options
Returns:<Compiler>
Compiler or MultiCompiler
Attributes
options
callback:
{CallbackWebpackFunction_2<MultiStats, void>} callback
Compiler or MultiCompiler
Attributes
options
Compiler or MultiCompiler