On this page

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

Advanced options for module concatenation.

Attributes
commonjs:boolean
Also concatenate CommonJS modules with statically analyzable exports. Defaults to 'true'.
Attributes
resolveOptions:ResolveOptions
resource:string | false | string[]
resourceFragment:string
resourceQuery:string

Parser options for css/auto and css/module modules.

Attributes
animation:boolean
Enable/disable renaming of @keyframes .
as:"stylesheet" | "block-contents"
Configure how the CSS source is parsed: as a full stylesheet (default) or as a block's contents (e.g. the content of an HTML style attribute).
container:boolean
Enable/disable renaming of @container names.
customIdents:boolean
Enable/disable renaming of custom identifiers.
customMedia:boolean
Enable/disable resolution of @custom-media at-rules (file-local build-time substitution).
customSelectors:boolean
Enable/disable resolution of @custom-selector at-rules (file-local build-time expansion to :is(...) ).
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.
fontPreload:boolean
Auto-emit <link rel="preload" as="font"> for the primary src URL of each @font-face reachable from an HTML entry's initial CSS. Only the first URL per @font-face is preloaded (preloading every format would double-download). Off by default; parser.css.urlHints rules and per-URL magic comments still override the seeded defaults. Set output.crossOriginLoading so the preload matches the font's CORS fetch.
function:boolean
Enable/disable renaming of @function names.
grid:boolean
Enable/disable renaming of grid identifiers.
import:boolean
Enable/disable @import at-rules handling.
namedExports:boolean
Use ES modules named export for css exports.
pure:boolean
Enable strict pure mode: every selector must contain at least one local class or id selector.
url:boolean
Enable/disable url() / image-set() / src() / image() functions handling.
urlHints:UrlHintRule[]
URL-referenced-asset default hint rules for this parser (JavaScript new URL(...) , CSS url(...) , HTML <img src> / <link href> / <script src> ).

Generator options for css/module modules.

Attributes
esModule:boolean
Configure the generated JS modules that use the ES modules syntax.
exportsConvention:"camel-case" | "camel-case-only" | "dashes" | "dashes-only" | "as-is" | ((name: string) => string | string[])
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 | typeof Hash
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 | TemplatePathFn<PathDataModule>
Configure the generated local ident name.

Parser options for css/global modules.

Attributes
animation:boolean
Enable/disable renaming of @keyframes .
as:"stylesheet" | "block-contents"
Configure how the CSS source is parsed: as a full stylesheet (default) or as a block's contents (e.g. the content of an HTML style attribute).
container:boolean
Enable/disable renaming of @container names.
customIdents:boolean
Enable/disable renaming of custom identifiers.
customMedia:boolean
Enable/disable resolution of @custom-media at-rules (file-local build-time substitution).
customSelectors:boolean
Enable/disable resolution of @custom-selector at-rules (file-local build-time expansion to :is(...) ).
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.
fontPreload:boolean
Auto-emit <link rel="preload" as="font"> for the primary src URL of each @font-face reachable from an HTML entry's initial CSS. Only the first URL per @font-face is preloaded (preloading every format would double-download). Off by default; parser.css.urlHints rules and per-URL magic comments still override the seeded defaults. Set output.crossOriginLoading so the preload matches the font's CORS fetch.
function:boolean
Enable/disable renaming of @function names.
grid:boolean
Enable/disable renaming of grid identifiers.
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.
urlHints:UrlHintRule[]
URL-referenced-asset default hint rules for this parser (JavaScript new URL(...) , CSS url(...) , HTML <img src> / <link href> / <script src> ).

Specify options for each generator.

Attributes
asset:AssetGeneratorOptions
Generator options for asset modules.
asset/bytes:EmptyGeneratorOptions
No generator options are supported for this module type.
asset/inline:AssetInlineGeneratorOptions
Generator options for asset/inline modules.
asset/resource:AssetResourceGeneratorOptions
Generator options for asset/resource modules.
asset/source:EmptyGeneratorOptions
No generator options are supported for this module type.
css:CssGeneratorOptions
Generator options for css modules.
css/auto:CssModuleGeneratorOptions
Generator options for css/module modules.
css/global:CssModuleGeneratorOptions
Generator options for css/module modules.
css/module:CssModuleGeneratorOptions
Generator options for css/module modules.
html:HtmlGeneratorOptions
Generator options for html modules.
javascript:EmptyGeneratorOptions
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.
javascript/esm:EmptyGeneratorOptions
No generator options are supported for this module type.
json:JsonGeneratorOptions
Generator options for json modules.

Specify options for each generator.

Attributes
baseUri:string
target base uri
layer:string
the target layer
publicPath:string
the target public path
Attributes
assetInfo:AssetInfo
dataUrl:boolean
whether the asset is inlined as a data url
filename:string
fullContentHash:string
Attributes
contextDependencies:LazySet<string>
fileDependencies:LazySet<string>
inlineExports:boolean
taken over from the root module
missingDependencies:LazySet<string>
needCreateRequire:boolean
collected from the inner modules
Attributes
snapshot:Snapshot | null
Attributes
charset:string
charset at-rule
cssData:CssData
Attributes
isCssModule:boolean
needIdInConcatenation:boolean
Attributes
javascriptModule:boolean
true when emitting an ESM external ( output.module )
Attributes
baseUrlPrefix:string
../ per <base href> path segment, prepended to the auto-public-path undo path so a relative base doesn't misdirect bundled URLs
htmlEntries:Record<string, HtmlEntryInfo[]>
entries collected from the document, grouped by kind
Attributes
inlineExports:boolean
whether this module was parsed with optimization.inlineExports enabled (gates inlining of its exports)
moduleConcatenationBailout:string
using in CommonJs
needCreateRequire:boolean
using in APIPlugin
pureFunctions:Set<string>
names of locally declared functions known to be free of side effects
Attributes
strictHarmonyModule:boolean
treatAsCommonJs:boolean
Attributes
jsonData:JsonData
Attributes
buildDependencies:LazySet<string>
contextDependencies:LazySet<string>
fileDependencies:LazySet<string>
hash:string
missingDependencies:LazySet<string>
parsed:boolean
resourceIntegrity:string
using in HttpUriPlugin
snapshot:Snapshot | null
valueDependencies:Map<string, ValueCacheVersion>

Returns array of values.

Attributes
assets:string[]
buildTimeExecuted:boolean
built:boolean
cacheable:boolean
cached:boolean
chunks:ChunkId[]
codeGenerated:boolean
dependent:boolean
depth:number | null
errors:number
failed:boolean
filteredModules:number
id:string | number
identifier:string
index:number
index2:number
issuer:string | null
issuerId:string | number | null
issuerName:string | null
issuerPath:StatsModuleIssuer[] | null
layer:string | null
modules:StatsModule[]
moduleType:string
name:string
nameForCondition:string | null
notCacheableReasons:string[]
optimizationBailout:string[]
optional:boolean
orphan:boolean
postOrderIndex:number
preOrderIndex:number
profile:StatsProfile
providedExports:string[] | null
reasons:StatsModuleReason[]
size:number
sizes:Record<string, number>
source:string | Buffer<ArrayBufferLike>
type:string
usedExports:boolean | string[] | null
warnings:number

Returns array of values.

Attributes
id:string | number
identifier:string
name:string
profile:StatsProfile

Returns array of values.

Attributes
active:boolean
explanation:string | null
loc: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
type:string | null
userRequest:string | null

Returns array of values.

Attributes
dependencies:StatsModuleTraceDependency[]
moduleId:string | number
moduleIdentifier:string
moduleName:string
originId:string | number
originIdentifier:string
originName:string
Attributes
jsIncompatibleExports:Record<string, string>
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<string>
fileDependencies:Set<string>
missingDependencies:Set<string>
module:Module
the created module or unset if no module was created
Attributes
absoluteResourcePath:string
the absolute resource path of the module request
allLoaders:string
the all loaders of the module request
hash:string
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
defaultRules:(false | "" | 0 | "..." | RuleSetRule | null | undefined)[]
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'.
generator:GeneratorOptionsByModuleType
Specify options for each generator.
noParse:string | RegExp | ((content: string) => boolean) | (string | RegExp | ((content: string) => boolean))[]
Don't parse files matching. It's matched against the full resolved request.
parser:ParserOptionsByModuleType
Specify options for each parser.
rules:(false | "" | 0 | "..." | RuleSetRule | null | undefined)[]
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 | ((module: Module) => boolean)
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
defaultRules:(false | "" | 0 | "..." | RuleSetRule | null | undefined)[]
An array of rules applied by default for modules.
generator:GeneratorOptionsByModuleType
Specify options for each generator.
noParse:string | RegExp | ((content: string) => boolean) | (string | RegExp | ((content: string) => boolean))[]
Don't parse files matching. It's matched against the full resolved request.
parser:ParserOptionsByModuleType
Specify options for each parser.
rules:(false | "" | 0 | "..." | RuleSetRule | null | undefined)[]
An array of rules applied for modules.
unsafeCache:boolean | ((module: Module) => boolean)
Cache the resolving of module requests.
Attributes
hash:string
hashWithLength:(length: number) => string
id:string | number

Renames an inlined module's top-level declaration (and all its references) when its name is already taken in the shared startup scope, recording the chosen name in allUsedNames. Lets inlined modules be emitted without a per-entry/per-chunk IIFE by resolving name collisions instead of isolating each module.

Attributes
chunk:Chunk
the chunk
chunkGraph:ChunkGraph
the chunk graph
chunkInitFragments:InitFragment<ChunkRenderContextJavascriptModulesPlugin>[]
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
data:string
Attributes
extractSourceMap:boolean
Enable/Disable extracting source map.
generator:{ [index: string]: any }
The options for the module generator.
layer:string
Specifies the layer in which the module should be placed in.
parser:{ [index: string]: any }
Options for parsing.
resolve:ResolveOptions
Options for the resolver.
sideEffects:boolean
Flags a module as with or without side effects.
type:string
Module type to use for the module.
Attributes
beforeLoaders:SyncHook<[LoaderItem[], NormalModule, AnyLoaderContext]>
beforeParse:SyncHook<[NormalModule]>
beforeSnapshot:SyncHook<[NormalModule]>
loader:SyncHook<[AnyLoaderContext, NormalModule]>
needBuild:AsyncSeriesBailHook<[NormalModule, NeedBuildContext], boolean>
processResult:SyncWaterfallHook<[[string | Buffer<ArrayBufferLike>, string | RawSourceMap | undefined, PreparsedAst | undefined], NormalModule], [string | Buffer<ArrayBufferLike>, string | RawSourceMap | undefined, PreparsedAst | undefined]>
readResource:HookMap<AsyncSeriesBailHook<[AnyLoaderContext], string | Buffer<ArrayBufferLike> | null, UnsetAdditionalOptions>>
readResourceForScheme:HookMap<FakeHook<AsyncSeriesBailHook<[string, NormalModule], string | Buffer<ArrayBufferLike> | null, UnsetAdditionalOptions>>>
Attributes
context:string
context directory for resolving
extractSourceMap:boolean
enable/disable extracting source map
generator:(Record<"javascript/auto", JavascriptGenerator> & Record<"javascript/dynamic", JavascriptGenerator> & Record<"javascript/esm", JavascriptGenerator> & Record<"json", JsonGenerator> & Record<"asset", AssetGenerator> & Record<"asset/inline", AssetGenerator> & Record<"asset/resource", AssetGenerator> & Record<"asset/source", AssetSourceGenerator> & Record<"asset/bytes", AssetBytesGenerator> & Record<"webassembly/async", Generator> & Record<"webassembly/sync", Generator> & Record<"css", CssGenerator> & Record<"css/auto", CssGenerator> & Record<"css/module", CssGenerator> & Record<"css/global", CssGenerator> & Record<"html", HtmlGenerator> & Record<string, Generator>)[T]
the generator used
generatorOptions:(Record<"javascript/auto", EmptyGeneratorOptions> & Record<"javascript/dynamic", EmptyGeneratorOptions> & Record<"javascript/esm", EmptyGeneratorOptions> & Record<"json", JsonGeneratorOptions> & Record<"asset", AssetGeneratorOptions> & Record<"asset/inline", AssetGeneratorOptions> & Record<"asset/resource", AssetGeneratorOptions> & Record<"asset/source", EmptyGeneratorOptions> & Record<"asset/bytes", EmptyGeneratorOptions> & Record<"webassembly/async", EmptyGeneratorOptions> & Record<"webassembly/sync", EmptyGeneratorOptions> & Record<"css", CssGeneratorOptions> & Record<"css/auto", CssModuleGeneratorOptions> & Record<"css/module", CssModuleGeneratorOptions> & Record<"css/global", CssModuleGeneratorOptions> & Record<"html", HtmlGeneratorOptions> & Record<string, GeneratorOptions>)[T]
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:(Record<"javascript/auto", JavascriptParser> & Record<"javascript/dynamic", JavascriptParser> & Record<"javascript/esm", JavascriptParser> & Record<"json", JsonParser> & Record<"asset", AssetParser> & Record<"asset/inline", AssetParser> & Record<"asset/resource", AssetParser> & Record<"asset/source", AssetSourceParser> & Record<"asset/bytes", AssetBytesParser> & Record<"webassembly/async", AsyncWebAssemblyParser> & Record<"webassembly/sync", WebAssemblyParser> & Record<"css", CssParser> & Record<"css/auto", CssParser> & Record<"css/module", CssParser> & Record<"css/global", CssParser> & Record<"html", HtmlParser> & Record<string, Parser>)[T]
the parser used
parserOptions:(Record<"javascript/auto", JavascriptParserOptions> & Record<"javascript/dynamic", JavascriptParserOptions> & Record<"javascript/esm", JavascriptParserOptions> & Record<"json", JsonParserOptions> & Record<"asset", AssetParserOptions> & Record<"asset/inline", EmptyParserOptions> & Record<"asset/resource", EmptyParserOptions> & Record<"asset/source", EmptyParserOptions> & Record<"asset/bytes", EmptyParserOptions> & Record<"webassembly/async", EmptyParserOptions> & Record<"webassembly/sync", EmptyParserOptions> & Record<"css", CssParserOptions> & Record<"css/auto", CssModuleParserOptions> & Record<"css/module", CssModuleParserOptions> & Record<"css/global", CssModuleParserOptions> & Record<"html", EmptyParserOptions> & Record<string, ParserOptions>)[T]
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<ResolveRequest>
resource resolve data
type:T
module type. When deserializing, this is set to an empty string "".
userRequest:string
request intended by user (without loaders from config)

Specify options for each parser.

Attributes
asset:AssetParserOptions
Parser options for asset modules.
asset/bytes:EmptyParserOptions
No parser options are supported for this module type.
asset/inline:EmptyParserOptions
No parser options are supported for this module type.
asset/resource:EmptyParserOptions
No parser options are supported for this module type.
asset/source:EmptyParserOptions
No parser options are supported for this module type.
css:CssParserOptions
Parser options for css modules.
css/auto:CssAutoOrModuleParserOptions
Parser options for css/auto and css/module modules.
css/global:CssModuleParserOptions
Parser options for css/global modules.
css/module:CssAutoOrModuleParserOptions
Parser options for css/auto and css/module modules.
html:HtmlParserOptions
Parser options for html modules.
javascript:JavascriptParserOptions
Parser options for javascript modules.
javascript/auto:JavascriptParserOptions
Parser options for javascript modules.
javascript/dynamic:JavascriptParserOptions
Parser options for javascript modules.
javascript/esm:JavascriptParserOptions
Parser options for javascript modules.
json:JsonParserOptions
Parser options for JSON modules.

Specify options for each parser.

Attributes
byIdentifier:Record<string, number>
usedIds:number[]

Renames an inlined module's top-level declaration (and all its references) when its name is already taken in the shared startup scope, recording the chosen name in allUsedNames. Lets inlined modules be emitted without a per-entry/per-chunk IIFE by resolving name collisions instead of isolating each module.

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
Type:KnownBuildInfo & Record<string, any> & KnownConcatenatedModuleBuildInfo
Type:KnownBuildInfo & Record<string, any> & KnownContextModuleBuildInfo
Type:ContextOptions & ContextModuleOptionsExtras
Type:KnownBuildInfo & Record<string, any> & KnownNormalModuleBuildInfo & KnownCssModuleBuildInfo
Type:KnownBuildMeta & Record<string, any> & KnownCssModuleBuildMeta
Type:string | ((context: ModuleFilenameTemplateContext) => string)
Type:GeneratorOptionsByModuleTypeKnown & GeneratorOptionsByModuleTypeUnknown
Type:KnownBuildInfo & Record<string, any> & KnownNormalModuleBuildInfo & KnownHtmlModuleBuildInfo
Type:KnownBuildInfo & Record<string, any> & KnownNormalModuleBuildInfo & KnownJavascriptModuleBuildInfo
Type:KnownBuildMeta & Record<string, any> & KnownJavascriptModuleBuildMeta
Type:KnownBuildInfo & Record<string, any> & KnownNormalModuleBuildInfo & KnownJsonModuleBuildInfo
Type:string | RegExp | ((name: string, module: StatsModule, type: "module" | "chunk" | "root-of-chunk" | "nested") => boolean)
Type:string | number
Type:KnownBuildInfo & Record<string, any> & KnownNormalModuleBuildInfo
Type:ParserOptionsByModuleTypeKnown & ParserOptionsByModuleTypeUnknown
Type:PathData & { chunkGraph: ChunkGraph; module: Module | ModulePathData }
Attributes
chunkGraph:ChunkGraph
module:Module | ModulePathData
Type:KnownBuildMeta & Record<string, any> & KnownSyncWasmModuleBuildMeta