On this page

These types are not exported by webpack, but they are available to TypeScript consumers.

Attributes
mangleImports:<boolean>
mangle imports


  • 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}

  • 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
resolveOptions:<ResolveOptions>
resource:<string> | <string[]>
resourceFragment:<string>
resourceQuery:<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>
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.

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
moduleFilenameTemplate:<string> | <object>
module filename template
namespace:<string>
namespace
sourceUrlComment:<string>
source url comment

Attributes
codeGenerationResult:<CodeGenerationResult>
module:<Module>

  • __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
context:<string>
contextInfo:
{Partial }
currentProfile:<ModuleProfile>
dependencies:<Dependency[]>
factoryResult:<boolean>
return full ModuleFactoryResult instead of only module
originModule:<Module> | <null>

Specify options for each generator.

Attributes
Generator options for asset modules.
No generator options are supported for this module type.
Generator options for asset/inline modules.
Generator options for asset/resource modules.
No generator options are supported for this module type.
Generator options for css modules.
Generator options for css/module modules.
Generator options for css/module modules.
Generator options for css/module modules.
No generator options are supported for this module type.
javascript/auto:<EmptyGeneratorOptions>
No generator options are supported for this module type.
javascript/dynamic:<EmptyGeneratorOptions>
No generator options are supported for this module type.
No generator options are supported for this module type.
Generator options for json modules.

Specify options for each generator.


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

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>
The hashing algorithm to use, defaults to 'md4'. All functions from Node.JS' crypto.createHash are supported.

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

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.

Attributes
assets:<string[]>
buildTimeExecuted:<boolean>
built:<boolean>
cacheable:<boolean>
cached:<boolean>
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
moduleId:<string> | <number>
moduleIdentifier:<string>
moduleName:<string>
originId:<string> | <number>
originIdentifier:<string>
originName:<string>

Attributes

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

Options affecting the normal modules (NormalModuleFactory).

Attributes
An array of rules applied by default for modules.
exprContextCritical:<boolean>
Enable warnings for full dynamic dependencies.
exprContextRecursive:<boolean>
Enable recursive directory lookup for full dynamic dependencies. Deprecated: This option has moved to 'module.parser.javascript.exprContextRecursive'.
exprContextRegExp:<boolean> | <RegExp>
Sets the default regular expression for full dynamic dependencies. Deprecated: This option has moved to 'module.parser.javascript.exprContextRegExp'.
exprContextRequest:<string>
Set the default request for full dynamic dependencies. Deprecated: This option has moved to 'module.parser.javascript.exprContextRequest'.
Specify options for each generator.
Don't parse files matching. It's matched against the full resolved request.
Specify options for each parser.
An array of rules applied for modules.
strictExportPresence:<boolean>
Emit errors instead of warnings when imported names don't exist in imported module. Deprecated: This option has moved to 'module.parser.javascript.strictExportPresence'.
strictThisContextOnImports:<boolean>
Handle the this context correctly according to the spec for namespace objects. Deprecated: This option has moved to 'module.parser.javascript.strictThisContextOnImports'.
unknownContextCritical:<boolean>
Enable warnings when using the require function in a not statically analyse-able way. Deprecated: This option has moved to 'module.parser.javascript.unknownContextCritical'.
unknownContextRecursive:<boolean>
Enable recursive directory lookup when using the require function in a not statically analyse-able way. Deprecated: This option has moved to 'module.parser.javascript.unknownContextRecursive'.
unknownContextRegExp:<boolean> | <RegExp>
Sets the regular expression when using the require function in a not statically analyse-able way. Deprecated: This option has moved to 'module.parser.javascript.unknownContextRegExp'.
unknownContextRequest:<string>
Sets the request when using the require function in a not statically analyse-able way. Deprecated: This option has moved to 'module.parser.javascript.unknownContextRequest'.
unsafeCache:<boolean> | <object>
Cache the resolving of module requests.
wrappedContextCritical:<boolean>
Enable warnings for partial dynamic dependencies. Deprecated: This option has moved to 'module.parser.javascript.wrappedContextCritical'.
wrappedContextRecursive:<boolean>
Enable recursive directory lookup for partial dynamic dependencies. Deprecated: This option has moved to 'module.parser.javascript.wrappedContextRecursive'.
wrappedContextRegExp:<RegExp>
Set the inner regular expression for partial dynamic dependencies. Deprecated: This option has moved to 'module.parser.javascript.wrappedContextRegExp'.

Options affecting the normal modules (NormalModuleFactory).

Attributes
An array of rules applied by default for modules.
Specify options for each generator.
Don't parse files matching. It's matched against the full resolved request.
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>
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>
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.

Attributes
javascript:<ModuleTemplate>

Attributes
module:<Module>
origin:<Module>

Attributes
context:<string>
context


  • 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
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)

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

Specify options for each parser.

Attributes
Parser options for asset modules.
No parser options are supported for this module type.
No parser options are supported for this module type.
asset/resource:<EmptyParserOptions>
No parser options are supported for this module type.
No parser options are supported for this module type.
Parser options for css modules.
Parser options for css/module modules.
Parser options for css/module modules.
Parser options for css/module modules.
Parser options for javascript modules.
Parser options for javascript modules.
javascript/dynamic:<JavascriptParserOptions>
Parser options for javascript modules.
Parser options for javascript modules.
Parser options for JSON modules.

Specify options for each parser.


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

Attributes
chunk:<Chunk>
the chunk
chunkGraph:<ChunkGraph>
the chunk graph
codeGenerationResults:<CodeGenerationResults>
results of code generation
modules
runtimeTemplate:<RuntimeTemplate>
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>
the dependency templates
moduleGraph:<ModuleGraph>
the module graph
runtimeTemplate:<RuntimeTemplate>
the runtime template
strictMode:<boolean>
rendering in strict context

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

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.





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