On this page

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

Returns compiler or MultiCompiler.

Attributes
options:Configuration
callback:CallbackWebpackFunction_2<Stats, void>
Returns:Compiler | null

Returns the compiler object.

Attributes
options:Configuration
Returns:Compiler

Returns the compiler object.

Attributes
options:MultiConfiguration
callback:CallbackWebpackFunction_2<MultiStats, void>
Returns:MultiCompiler | null

Returns the multi compiler object.

Attributes
options:MultiConfiguration
Returns:MultiCompiler

Returns the multi compiler object.

Attributes
signal:AbortSignal
  • [index: {string}] any
Attributes
webpackAST:object
Attributes
assetInfo:AssetInfo
an asset info for asset modules
chunkInitFragments:InitFragment<any>[]
chunk init fragments for javascript modules
filename:string
a filename for asset modules
freeNames:Set<string>
free identifier names in the rendered source for javascript modules
fullContentHash:string
a full content hash for asset modules
share-init:[{ init: string; initStage: number; shareScope: string }]
share-init for modules federation
topLevelDeclarations:Set<string>
top level declarations for javascript modules
url:{ asset-url?: string; javascript?: string }
url for asset modules
Attributes
dispose:(callback: (err?: Error | null) => void) => void
module:(module: Module) => ModuleResult
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
__restrictionsMarker:{ blocked: boolean }
internal: shared marker RestrictionsPlugin flips when it filters out an existing target, letting ExportsFieldPlugin fall back instead of erroring
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:string | false
path
relativePath:string
relative path
tsconfigPathsMap:TsconfigPathsMap | null
tsconfig paths map

Creates a multi compiler.

Attributes
err:Error | null
result:T
Returns:R

Creates a multi compiler.

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
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
the runtime template
sourceTypes:ReadonlySet<string>
source types
Attributes
delete:(key: K) => boolean
get:(key: K) => CodeGenValue<K> | undefined
has:(key: K) => boolean
set:(key: K, value: CodeGenValue<K>) => CodeGenerationResultData
Attributes
context:string
name:string
Attributes
declaration:CompatibilitySettingsDeclaration
name:string
Attributes
loc:DependencyLocation
range:[number, number]
updated:boolean

Checks whether this object is sorted.

Attributes
contextModuleFactory:ContextModuleFactory
normalModuleFactory:NormalModuleFactory
Attributes
absolutePath:string | null
absolute form of name (with slash ending), null when not absolute
alias:Alias
alias target(s)
arrayAlias:boolean
true when alias is an array — precomputed so the hot path skips Array.isArray
firstCharCode:number
first character code of name — used as a cheap screen on the hot path. -1 indicates "matches any first char" (empty wildcard prefix).
name:string
original alias name
nameWithSlash:string
name + "/" — precomputed to avoid per-resolve concat
onlyModule:boolean
normalized onlyModule flag
wildcardPrefix:string | null
substring before the single "*" in name , null when no wildcard
wildcardSuffix:string | null
substring after the single "*" in name , null when no wildcard
Attributes
chunkGraph:ChunkGraph
the chunk graph
concatenateCommonJsModules:boolean
whether eligible CommonJS modules may be concatenated
moduleGraph:ModuleGraph
the module graph
Attributes
context:string
contextDependencies:LazySet<string>
dependencies:ContextDependency[]
fileDependencies:LazySet<string>
missingDependencies:LazySet<string>
request:string
resolveOptions:ResolveOptions
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:Parser
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<ResolveRequest>
resource resolve data
settings:ModuleSettings
type:string
module type. When deserializing, this is set to an empty string "".
userRequest:string
request intended by user (without loaders from config)

Returns location of targetPath relative to rootPath.

Attributes
isBlockDevice:() => boolean
true when is block device, otherwise false
isCharacterDevice:() => boolean
true when is character device, otherwise false
isDirectory:() => boolean
true when is directory, otherwise false
isFIFO:() => boolean
true when is FIFO, otherwise false
isFile:() => boolean
true when is file, otherwise false
isSocket:() => boolean
true when is socket, otherwise false
isSymbolicLink:() => boolean
true when is symbolic link, otherwise false
name:T
name
parentPath:string
path
path:string
path
Attributes
isBlockDevice:() => boolean
true when is block device, otherwise false
isCharacterDevice:() => boolean
true when is character device, otherwise false
isDirectory:() => boolean
true when is directory, otherwise false
isFIFO:() => boolean
true when is FIFO, otherwise false
isFile:() => boolean
true when is file, otherwise false
isSocket:() => boolean
true when is socket, otherwise false
isSymbolicLink:() => boolean
true when is symbolic link, otherwise false
name:T
name
parentPath:string
path
path:string
path

The mappings from request to module info.

Attributes
attributes:Record<string, string>
compiler:string
dependency:string
descriptionData:JsonObjectTypes
issuer:string
issuerLayer:string
mimetype:string
phase:string
realResource:string
resource:string
resourceFragment:string
resourceQuery:string
scheme:string

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) ... ').
generator:boolean
The environment supports generator functions and yield ('function* () yield ... ').
globalThis:boolean
The environment supports 'globalThis'.
hasOwn:boolean
The environment supports 'Object.hasOwn'.
importMetaDirnameAndFilename:boolean
The environment supports import.meta.dirname and import.meta.filename .
let:boolean
The environment supports let for variable declarations.
logicalAssignment:boolean
The environment supports logical assignment operators ('a ||= b', 'a &&= b', 'a ??= b').
methodShorthand:boolean
The environment supports object method shorthand (' module() {} ').
module:boolean
The environment supports EcmaScript Module syntax to import EcmaScript modules (import ... from '...').
modulePreload:boolean
The environment supports <link rel="modulepreload"> to preload EcmaScript modules.
nodeBuiltinModuleGetter:boolean
The environment supports process.getBuiltinModule() to synchronously load Node.js core modules.
nodePrefixForCoreModules:boolean
The environment supports node: prefix for Node.js core modules.
optionalChaining:boolean
The environment supports optional chaining ('obj?.a' or 'obj?.()').
spread:boolean
The environment supports spread and rest in array/object literals and calls (' ...obj ', 'fn(...args)').
symbol:boolean
The environment supports 'Symbol' (and well-known symbols like 'Symbol.toStringTag').
templateLiteral:boolean
The environment supports template literals.

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

  • [index: {string}] any
Attributes
asyncWebAssembly:boolean | "auto"
Support WebAssembly as asynchronous EcmaScript Module. "auto" (the default) enables it unless a loader is registered for WebAssembly files.
backCompat:boolean
Enable backward-compat layer with deprecation warnings for many webpack 4 APIs.
buildHttp:HttpUriOptions | (string | RegExp | ((uri: string) => boolean))[]
Build http(s): urls using a lockfile and resource content cache.
cacheUnaffected:boolean
Enable additional in memory caching of modules that are unchanged and reference only unchanged modules.
css:boolean | "auto"
Enable css support. "auto" (the default) enables the built-in CSS support unless a loader is registered for CSS files.
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.
futureDefaults:boolean
Apply defaults of next major version.
html:boolean | "auto"
Enable HTML entry support. Treats .html files as a first-class module type so they can be used directly as entry points. "auto" (the default) enables it unless a loader is registered for HTML files.
lazyCompilation:boolean | LazyCompilationOptions
Compile entrypoints and import()s only when they are accessed.
outputModule:boolean
Allow output javascript files as module source type.
sourceImport:boolean
Enable experimental tc39 proposal https://github.com/tc39/proposal-source-phase-imports . This allows importing modules at source phase.
syncWebAssembly:boolean
Support WebAssembly as synchronous EcmaScript Module (outdated).
typescript:boolean | "auto"
Enable typescript support. "auto" (the default) enables the built-in TypeScript support when Node.js supports it (>= 22.6) and no loader is registered for TypeScript files.

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

Attributes
asyncWebAssembly:boolean | "auto"
Support WebAssembly as asynchronous EcmaScript Module. "auto" (the default) enables it unless a loader is registered for WebAssembly files.
backCompat:boolean
Enable backward-compat layer with deprecation warnings for many webpack 4 APIs.
buildHttp:HttpUriOptions
Build http(s): urls using a lockfile and resource content cache.
cacheUnaffected:boolean
Enable additional in memory caching of modules that are unchanged and reference only unchanged modules.
css:boolean | "auto"
Enable css support. "auto" (the default) enables the built-in CSS support unless a loader is registered for CSS files.
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.
futureDefaults:boolean
Apply defaults of next major version.
html:boolean | "auto"
Enable HTML entry support. Treats .html files as a first-class module type so they can be used directly as entry points. "auto" (the default) enables it unless a loader is registered for HTML files.
lazyCompilation:false | LazyCompilationOptions
Compile entrypoints and import()s only when they are accessed.
outputModule:boolean
Allow output javascript files as module source type.
sourceImport:boolean
Enable experimental tc39 proposal https://github.com/tc39/proposal-source-phase-imports . This allows importing modules at source phase.
syncWebAssembly:boolean
Support WebAssembly as synchronous EcmaScript Module (outdated).
typescript:boolean | "auto"
Enable typescript support. "auto" (the default) enables the built-in TypeScript support when Node.js supports it (>= 22.6) and no loader is registered for TypeScript files.
Attributes
canMangle:boolean
can the export be renamed (defaults to true)
export:string[] | null
when reexported: from which export
exports:(string | ExportSpec)[]
nested exports
from:ModuleGraphConnection
when reexported: from which module
hidden:boolean
export is not visible, because another export blends over it
inlined:InlinedValue
when set: the export binds to a small primitive constant eligible for inlining
isPure:boolean
calling this export has no observable side effects
name:string
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<string>
when exports = true, list of unaffected exports
exports:true | (string | ExportSpec)[] | null
exported names, true for unknown exports or null for no exports
from:ModuleGraphConnection
when reexported: from which module
hideExports:Set<string> | null
list of maybe prior exposed, but now hidden exports
isPure:boolean
calling these exports has no observable side effects
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
import:string | string[]
Request to a module that should be exposed by this container.
name:string
Custom chunk name for the exposed module.

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

Attributes
sideEffectFree:boolean

Creates a deprecation.

Attributes
safeTime:number
timestamp:number

Returns location of targetPath relative to rootPath.

Attributes
close:(args: any[]) => any
open:(args: any[]) => any
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
mapping from dependencies to templates
getData:() => CodeGenerationResultData
get access to the code generation data
moduleGraph:ModuleGraph
the module graph
runtime:RuntimeSpec
the runtime
runtimeRequirements:Set<string>
the requirements for runtime
runtimeTemplate:RuntimeTemplate
the runtime template
type:string
which kind of code should be generated
Attributes
generatedColumn:number
generated column
generatedLine:number
generated line
source:string
source
Attributes
attributes:Record<string, string>
await:boolean
ids:string[]
name:string
phase:ImportPhaseType
source:string
sourceOrder:number
Attributes
digest:(encoding?: string) => string | Buffer<ArrayBufferLike>
get hash digest
update:(data: string | Buffer<ArrayBufferLike>, inputEncoding?: string) => HashLike
make hash update
Attributes
css:boolean
entryName:string
request:string
type:"html" | "preload" | "script" | "prefetch" | "stylesheet" | "script-module" | "modulepreload"
Attributes
addBuildDependency:(dependency: string) => void
register a build dependency (e.g. a template engine config) so changing it invalidates the cache
addContextDependency:(dependency: string) => void
register a directory as a build dependency
addDependency:(dependency: string) => void
register a file (e.g. a template partial) as a build dependency so editing it triggers a rebuild
addMissingDependency:(dependency: string) => void
register a not-yet-existing path as a build dependency so creating it triggers a rebuild
emitError:(error: string | Error) => void
report an error on the module
emitWarning:(warning: string | Error) => void
report a non-fatal warning on the module
module:Module
the html module being transformed
resource:string
absolute path of the module's resource

Enable/disable evaluating import.meta fields. Omitted fields are enabled and unknown fields are preserved. Custom fields are allowed.

Attributes
dirname:boolean
Enable/disable evaluating import.meta.dirname.
env:boolean
Enable/disable evaluating import.meta.env.
filename:boolean
Enable/disable evaluating import.meta.filename.
main:boolean
Enable/disable evaluating import.meta.main.
resolve:boolean
Enable/disable evaluating import.meta.resolve.
url:boolean
Enable/disable evaluating import.meta.url.
webpack:boolean
Enable/disable evaluating import.meta.webpack.
webpackContext:boolean
Enable/disable evaluating import.meta.webpackContext.
webpackHot:boolean
Enable/disable evaluating import.meta.webpackHot.

Enable/disable evaluating import.meta fields. Omitted fields are enabled and unknown fields are preserved. Custom fields are allowed.

Attributes
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.
debug:string | boolean | RegExp | FilterItemTypes[] | ((value: string) => boolean)
Enable debug logging for specific loggers.
level:"error" | "warn" | "info" | "log" | "none" | "verbose"
Log level.
progress:boolean | "auto"
Show build progress. "auto" shows it only for interactive terminals. This option is only used when no custom console is provided.
stream:WritableStream & { columns?: number; isTTY?: boolean; rows?: number }
Stream used for logging output. Defaults to process.stderr. This option is only used when no custom console is provided.

Returns location of targetPath relative to rootPath.

Attributes
close:(df: number, callback: (err: ErrnoException | null) => void) => void
createWriteStream:(pathLike: PathLikeFs, result?: "ascii" | "utf8" | "utf-8" | "utf16le" | "utf-16le" | "ucs2" | "ucs-2" | "base64" | "base64url" | "latin1" | "binary" | "hex" | WriteStreamOptions) => WritableStream
mkdirSync:MkdirSync
open:Open
read:Read<ArrayBufferView<ArrayBufferLike>>
rename:(a: PathLikeFs, b: PathLikeFs, callback: (err: ErrnoException | null) => void) => void

Returns location of targetPath relative to rootPath.

Attributes
atime:Date
atimeMs:T
birthtime:Date
birthtimeMs:T
blksize:T
blocks:T
ctime:Date
ctimeMs:T
dev:T
gid:T
ino:T
isBlockDevice:() => boolean
isCharacterDevice:() => boolean
isDirectory:() => boolean
isFIFO:() => boolean
isFile:() => boolean
isSocket:() => boolean
isSymbolicLink:() => boolean
mode:T
mtime:Date
mtimeMs:T
nlink:T
rdev:T
size:T
uid:T
Attributes
atime:Date
atime
atimeMs:T
atime ms
birthtime:Date
birthtime
birthtimeMs:T
birthtime ms
blksize:T
blksize
blocks:T
blocks
ctime:Date
ctime
ctimeMs:T
ctime ms
dev:T
dev
gid:T
gid
ino:T
ino
isBlockDevice:() => boolean
is block device
isCharacterDevice:() => boolean
is character device
isDirectory:() => boolean
is directory
isFIFO:() => boolean
is FIFO
isFile:() => boolean
is file
isSocket:() => boolean
is socket
isSymbolicLink:() => boolean
is symbolic link
mode:T
mode
mtime:Date
mtime
mtimeMs:T
mtime ms
nlink:T
nlink
rdev:T
rdev
size:T
size
uid:T
uid

Returns location of targetPath relative to rootPath.

Attributes
atime:Date
atimeMs:number
birthtime:Date
birthtimeMs:number
blksize:number
blocks:number
ctime:Date
ctimeMs:number
dev:number
gid:number
ino:number
isBlockDevice:() => boolean
isCharacterDevice:() => boolean
isDirectory:() => boolean
isFIFO:() => boolean
isFile:() => boolean
isSocket:() => boolean
isSymbolicLink:() => boolean
mode:number
mtime:Date
mtimeMs:number
nlink:number
rdev:number
size:number
uid:number
Attributes
atime:Date
atime
atimeMs:number
atime ms
birthtime:Date
birthtime
birthtimeMs:number
birthtime ms
blksize:number
blksize
blocks:number
blocks
ctime:Date
ctime
ctimeMs:number
ctime ms
dev:number
dev
gid:number
gid
ino:number
ino
isBlockDevice:() => boolean
is block device
isCharacterDevice:() => boolean
is character device
isDirectory:() => boolean
is directory
isFIFO:() => boolean
is FIFO
isFile:() => boolean
is file
isSocket:() => boolean
is socket
isSymbolicLink:() => boolean
is symbolic link
mode:number
mode
mtime:Date
mtime
mtimeMs:number
mtime ms
nlink:number
nlink
rdev:number
rdev
size:number
size
uid:number
uid
Attributes
linkPrefetch:SyncWaterfallHook<[string, Chunk], string>
linkPreload:SyncWaterfallHook<[string, Chunk], string>
Attributes
assets:Record<string, Source>
assets added by loaders or plugins
assetsInfo:Map<string, AssetInfo | undefined>
cacheable:boolean
exportsArgument:string
isCircular:boolean
true when the module is part of a circular dependency chain
moduleArgument:string
notCacheableReasons:string[]
reasons why the module is not cacheable (e.g. paths of loaders that marked it)
strict:boolean
topLevelDeclarations:Set<string>
top level declaration names
usesTopLevelAwaitForOf:boolean
module uses top-level for await…of , which can't be lowered to a generator
Attributes
async:boolean
defaultObject:false | "redirect" | "redirect-warn"
exportsFinalNameByRuntime:Map<string, Record<string, string>>
using in ModuleLibraryPlugin
exportsSourceByRuntime:Map<string, string>
using in ModuleLibraryPlugin
exportsType:"default" | "dynamic" | "namespace" | "flagged"
sideEffectFree:boolean
Attributes
environments:string[]
environments

Checks whether this object is sorted.

Attributes
aggressiveSplits:SplitData[]
chunkHashes:ChunkHashes
chunkModuleHashes:ChunkModuleHashes
chunkModuleIds:ChunkModuleIds
chunkRuntime:ChunkRuntime
chunks:RecordsChunks
fullHashChunkModuleHashes:FullHashChunkModuleHashes
hash:string
hotIndex:number
modules:RecordsModules

Returns array of values.

Attributes
auxiliaryChunkIdHints:string[]
auxiliaryChunkNames:ChunkName[]
auxiliaryChunks:ChunkId[]
cached:boolean
chunkIdHints:string[]
chunkNames:ChunkName[]
chunks:ChunkId[]
comparedForEmit:boolean
emitted:boolean
filteredRelated:number
info:AssetInfo
isOverSizeLimit:boolean
name:string
related:StatsAsset[]
size:number
type:string

Returns array of values.

Attributes
assets:StatsAsset[]
assetsByChunkName:Record<string, string[]>
builtAt:number
children:StatsCompilation[]
chunks:StatsChunk[]
entrypoints:Record<string, StatsChunkGroup>
env:any
errors:StatsError[]
errorsCount:number
filteredAssets:number
filteredErrorDetailsCount:number
filteredModules:number
filteredWarningDetailsCount:number
hash:string
logging:Record<string, StatsLogging>
modules:StatsModule[]
name:string
namedChunkGroups:Record<string, StatsChunkGroup>
needAdditionalPass:boolean
outputPath:string
publicPath:string
time:number
version:string
warnings:StatsError[]
warningsCount:number

Returns array of values.

Attributes
debug:boolean
entries:StatsLoggingEntry[]
filteredEntries:number

Returns array of values.

Attributes
args:any[]
children:StatsLoggingEntry[]
message:string
time:number
trace:string[]
type:string

Returns array of values.

Attributes
additionalIntegration:number
additionalResolving:number
building:number
dependencies:number
factory:number
integration:number
resolving:number
restoring:number
storing:number
total:number
Attributes
path:PathLikeFs
callback:(err: ErrnoException | null, result?: IStatsFs) => void
Returns:void
Attributes
path:PathLikeFs
options:StatOptionsFs & { bigint?: false } | undefined
callback:(err: ErrnoException | null, result?: IStatsFs) => void
Returns:void
Attributes
path:PathLikeFs
options:StatOptionsFs & { bigint: true }
callback:(err: ErrnoException | null, result?: IBigIntStatsFs) => void
Returns:void
Attributes
path:PathLikeFs
options:StatOptionsFs | undefined
callback:(err: ErrnoException | null, result?: IStatsFs | IBigIntStatsFs) => void
Returns:void
Attributes
path:PathLikeFs
Returns:IStatsFs
Attributes
path:PathLikeFs
options:StatSyncOptions & { bigint?: false; throwIfNoEntry?: true }
Returns:IStatsFs
Attributes
path:PathLikeFs
options:StatSyncOptions & { bigint: true; throwIfNoEntry?: true }
Returns:IBigIntStatsFs
Attributes
path:PathLikeFs
options:StatSyncOptions & { bigint?: false; throwIfNoEntry: false }
Returns:IStatsFs | undefined
Attributes
path:PathLikeFs
options:StatSyncOptions & { bigint: true; throwIfNoEntry: false }
Returns:IBigIntStatsFs | undefined
Attributes
path:PathLikeFs
options:StatSyncOptions & { bigint: boolean; throwIfNoEntry?: true }
Returns:IStatsFs | IBigIntStatsFs
Attributes
path:PathLikeFs
options:StatSyncOptions
Returns:IStatsFs | IBigIntStatsFs | undefined
Attributes
path:PathLikeTypes
callback:(err: ErrnoException | null, result?: IStatsTypes) => void
Returns:void
Attributes
path:PathLikeTypes
options:StatOptionsTypes & { bigint?: false } | undefined
callback:(err: ErrnoException | null, result?: IStatsTypes) => void
Returns:void
Attributes
path:PathLikeTypes
options:StatOptionsTypes & { bigint: true }
callback:(err: ErrnoException | null, result?: IBigIntStatsTypes) => void
Returns:void
Attributes
path:PathLikeTypes
options:StatOptionsTypes | undefined
callback:(err: ErrnoException | null, result?: IStatsTypes | IBigIntStatsTypes) => void
Returns:void
Attributes
exclude:string | RegExp | ((str: string) => boolean) | (string | RegExp | ((str: string) => boolean))[]
include:string | RegExp | ((str: string) => boolean) | (string | RegExp | ((str: string) => boolean))[]
test:string | RegExp | ((str: string) => boolean) | (string | RegExp | ((str: string) => boolean))[]

Extract fragment index.

Attributes
getContent:(context: GenerateContext) => string | Source | undefined
getEndContent:(context: GenerateContext) => string | Source | undefined
key:string
merge:(fragments: MaybeMergeableInitFragment<GenerateContext>) => MaybeMergeableInitFragment<GenerateContext>
mergeAll:(fragments: MaybeMergeableInitFragment<GenerateContext>[]) => MaybeMergeableInitFragment<GenerateContext>[]
position:number
stage:number
Attributes
file:PathLikeFs
options:MakeDirectoryOptions & { recursive: true }
callback:(err: ErrnoException | null, result?: string) => void
Returns:void
Attributes
file:PathLikeFs
options:string | number | MakeDirectoryOptions & { recursive?: false } | null | undefined
callback:(err: ErrnoException | null) => void
Returns:void
Attributes
file:PathLikeFs
options:string | number | MakeDirectoryOptions | null | undefined
callback:(err: ErrnoException | null, result?: string) => void
Returns:void
Attributes
file:PathLikeFs
callback:(err: ErrnoException | null) => void
Returns:void
Attributes
path:PathLikeFs
options:MakeDirectoryOptions & { recursive: true }
Returns:string | undefined
Attributes
path:PathLikeFs
options:string | number | MakeDirectoryOptions & { recursive?: false } | null
Returns:void
Attributes
path:PathLikeFs
options:string | number | MakeDirectoryOptions | null
Returns:string | undefined
Attributes
compilation:Compilation
fileSystemInfo:FileSystemInfo
valueCacheVersions:Map<string, ValueCacheVersion>

Returns location of targetPath relative to rootPath.

Attributes
encoding:"ascii" | "utf8" | "utf-8" | "utf16le" | "utf-16le" | "ucs2" | "ucs-2" | "base64" | "base64url" | "latin1" | "binary" | "hex" | null
Attributes
encoding:"ascii" | "utf8" | "utf-8" | "utf16le" | "utf-16le" | "ucs2" | "ucs-2" | "base64" | "base64url" | "latin1" | "binary" | "hex" | null
encoding
Attributes
safeTime:number
Attributes
file:PathLikeFs
flags:string | number | undefined
mode:string | number | null | undefined
callback:(err: ErrnoException | null, result?: number) => void
Returns:void
Attributes
file:PathLikeFs
flags:string | number | undefined
callback:(err: ErrnoException | null, result?: number) => void
Returns:void
Attributes
file:PathLikeFs
callback:(err: ErrnoException | null, result?: number) => void
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 | ConcatenateModulesOptions
Concatenate modules when possible to generate less modules, more efficient code and enable more optimizations by the minimizer. An options object implies 'true'.
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.
inlineExports:boolean
Inline ESM exports that bind to small primitive constants (≤6-byte null/undefined/boolean/number/string). Inlining makes the import dependency inactive so DCE can drop the export and possibly the module.
innerGraph:boolean
Creates a module-internal dependency graph for top level symbols, exports and imports, to improve unused exports detection.
mangleExports:boolean | "size" | "deterministic"
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:(false | "" | 0 | "..." | WebpackPluginInstance | ((this: Compiler, compiler: Compiler) => void) | null | undefined)[]
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 | false
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 | "single" | "multiple" | { name?: string | ((entrypoint: { name: string }) => string) }
Create an additional chunk which contains only the webpack runtime and chunk hash maps.
sideEffects:boolean | "flag"
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 | "global"
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 | ConcatenateModulesOptions
Concatenate modules when possible to generate less modules, more efficient code and enable more optimizations by the minimizer. An options object implies 'true'.
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.
inlineExports:boolean
Inline ESM exports that bind to small primitive constants (≤6-byte null/undefined/boolean/number/string). Inlining makes the import dependency inactive so DCE can drop the export and possibly the module.
innerGraph:boolean
Creates a module-internal dependency graph for top level symbols, exports and imports, to improve unused exports detection.
mangleExports:boolean | "size" | "deterministic"
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:("..." | WebpackPluginInstance | ((this: Compiler, compiler: Compiler) => void))[]
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 | false
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:false | { name?: (entrypoint: { name: string }) => string }
Create an additional chunk which contains only the webpack runtime and chunk hash maps.
sideEffects:boolean | "flag"
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 | "global"
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).
Attributes
loc:DependencyLocation
module:Module | null
request:string

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 | TemplatePathFn<PathDataModule>
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 | LibraryCustomUmdCommentObject
Add a comment in the UMD wrapper.
charset:boolean
Add charset attribute for script tag.
chunkFilename:string | TemplatePathFn<PathDataChunk>
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 | false
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 | false
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 | CleanOptions
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 | "use-credentials" | "anonymous"
This option enables cross-origin loading of chunks.
cssChunkFilename:string | TemplatePathFn<PathDataChunk>
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 | TemplatePathFn<PathDataChunk>
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 | ((context: ModuleFilenameTemplateContext) => string)
Similar to output.devtoolModuleFilenameTemplate , but used in the case of duplicate module identifiers.
devtoolModuleFilenameTemplate:string | ((context: ModuleFilenameTemplateContext) => string)
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 | TemplatePathFn<PathDataChunk>
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 | typeof Hash
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.
html:boolean | OutputHtmlOptions
Generate an HTML file for each non-HTML entrypoint with its JS and CSS output chunks injected. Can be overridden per entry via the entry descriptor html option.
htmlChunkFilename:string | TemplatePathFn<PathDataChunk>
Specifies the filename template of non-initial output html 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.
htmlFilename:string | TemplatePathFn<PathDataChunk>
Specifies the filename template of output html 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.
ignoreBrowserWarnings:boolean
Ignore warnings in the browser.
iife:boolean
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).
library:string | string[] | LibraryCustomUmdObject | LibraryOptions
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.
path:string
The output directory as absolute path (required).
pathinfo:boolean | "verbose"
Include comments with information about the modules.
publicPath:string | TemplatePathFn<PathData>
The 'publicPath' specifies the public URL address of the output files when referenced in a browser.
resourceHints:boolean | "preload" | "prefetch" | "none" | ResourceHintsOptions | HtmlResourceHintWebpackOptions[] | ((context: { compilation: Compilation; defaultHints: (HtmlResourceHintHtmlEntryDependency & { hostChunks: string[] })[]; entryName: string; entrypoint: Entrypoint; hostType: "html" | "js" }) => HtmlResourceHintHtmlEntryDependency[])
Resource-hint ( <link rel="prefetch"> / <link rel="preload"> / <link rel="modulepreload"> / <link rel="preconnect"> ) emission for extracted HTML entries and URL-referenced assets. Accepts the initial-graph shorthand (boolean / "prefetch" / "preload" / "none" / HtmlResourceHint[] / function — equivalent to { initial: <value> } ) or the full object form { initial, urlHints, preconnect, modulePreloadPolyfill, manifest } . initial defaults on for ESM output ( output.module ), where native import() would otherwise waterfall; classic output stays opt-in.
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.
strictModuleResolution:boolean
Emit a runtime check that throws a 'MODULE_NOT_FOUND' error when a required module id is missing from the bundle.
trustedTypes:string | true | 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 | false
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).
wasmStreamingFallback:boolean
Fall back to non-streaming WebAssembly instantiation when streaming compilation fails because the server does not serve .wasm files with the application/wasm MIME type.
webassemblyModuleFilename:string
The filename of WebAssembly modules as relative path inside the 'output.path' directory.
workerChunkFilename:string | TemplatePathFn<PathDataChunk>
Specifies the filename template of non-initial output worker's 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.
workerChunkLoading:string | false
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 | false
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 | TemplatePathFn<PathDataModule>
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 | TemplatePathFn<PathDataChunk>
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 | false
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 | false
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 | CleanOptions
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 | "use-credentials" | "anonymous"
This option enables cross-origin loading of chunks.
cssChunkFilename:string | TemplatePathFn<PathDataChunk>
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 | TemplatePathFn<PathDataChunk>
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 | ((context: ModuleFilenameTemplateContext) => string)
Similar to output.devtoolModuleFilenameTemplate , but used in the case of duplicate module identifiers.
devtoolModuleFilenameTemplate:string | ((context: ModuleFilenameTemplateContext) => string)
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 | TemplatePathFn<PathDataChunk>
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 | typeof Hash
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.
html:boolean | OutputHtmlOptions
Generate an HTML file for each non-HTML entrypoint with its JS and CSS output chunks injected. Can be overridden per entry via the entry descriptor html option.
htmlChunkFilename:string | TemplatePathFn<PathDataChunk>
Specifies the filename template of non-initial output html 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.
htmlFilename:string | TemplatePathFn<PathDataChunk>
Specifies the filename template of output html 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.
ignoreBrowserWarnings:boolean
Ignore warnings in the browser.
iife:boolean
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).
library:LibraryOptions
Options for library.
module:boolean
Output javascript files as module source type.
path:string
The output directory as absolute path (required).
pathinfo:boolean | "verbose"
Include comments with information about the modules.
publicPath:string | TemplatePathFn<PathData>
The 'publicPath' specifies the public URL address of the output files when referenced in a browser.
resourceHints:ResourceHintsOptions
Full resource-hint configuration.
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.
strictModuleResolution:boolean
Emit a runtime check that throws a 'MODULE_NOT_FOUND' error when a required module id is missing from the bundle.
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 | false
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).
wasmStreamingFallback:boolean
Fall back to non-streaming WebAssembly instantiation when streaming compilation fails because the server does not serve .wasm files with the application/wasm MIME type.
webassemblyModuleFilename:string
The filename of WebAssembly modules as relative path inside the 'output.path' directory.
workerChunkFilename:string | TemplatePathFn<PathDataChunk>
Specifies the filename template of non-initial output worker's 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.
workerChunkLoading:string | false
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 | false
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).
Attributes
directory:boolean
is directory
file:boolean
is file
fragment:string
fragment
internal:boolean
is internal
module:boolean
is module
query:string
query
request:string
request
Attributes
ast:Program
comments:CommentJavascriptParser[]
Attributes
compilation:Compilation
current:NormalModule
module:NormalModule
options:WebpackOptionsNormalizedWithDefaults
source:string | Buffer<ArrayBufferLike>

Returns check if version is greater or equal.

Attributes
browser:boolean | null
browser platform, running in a normal web browser
bun:boolean | null
bun platform, bun and node built-in modules are available
deno:boolean | null
deno platform, node built-in modules (via the node: specifier) and web APIs are available
electron:boolean | null
electron platform, require of some electron built-in modules is available
node:boolean | null
node platform, require of node built-in modules is available
nwjs:boolean | null
nwjs platform, require of legacy nw.gui is available
universal:boolean | null
universal ESM target spanning both web and node (target "universal" or ["web", "node"] )
web:boolean | null
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:(packageName: string, issuer: string, options: { considerBuiltins: boolean }) => string | null
resolve to unqualified
  • [index: {string}] any
Attributes
debugId:string
debug id
file:string
file
ignoreList:number[]
ignore list
mappings:string
mappings
names:string[]
names
sourceRoot:string
source root
sources:string[]
sources
sourcesContent:string[]
sources content
version:number
version
Attributes
fd:number
buffer:TBuffer
offset:number
length:number
position:number | bigint | null
callback:(err: ErrnoException | null, bytesRead: number, buffer: TBuffer) => void
Returns:void
Attributes
fd:number
options:ReadAsyncOptions<TBuffer>
callback:(err: ErrnoException | null, bytesRead: number, buffer: TBuffer) => void
Returns:void
Attributes
fd:number
callback:(err: ErrnoException | null, bytesRead: number, buffer: ArrayBufferView) => void
Returns:void
Attributes
path:PathLikeFs
options:"ascii" | "utf8" | "utf-8" | "utf16le" | "utf-16le" | "ucs2" | "ucs-2" | "base64" | "base64url" | "latin1" | "binary" | "hex" | { encoding: "ascii" | "utf8" | "utf-8" | "utf16le" | "utf-16le" | "ucs2" | "ucs-2" | "base64" | "base64url" | "latin1" | "binary" | "hex" | null; recursive?: boolean; withFileTypes?: false } | null | undefined
callback:(err: ErrnoException | null, files?: string[]) => void
Returns:void
Attributes
path:PathLikeFs
options:"buffer" | { encoding: "buffer"; recursive?: boolean; withFileTypes?: false }
callback:(err: ErrnoException | null, files?: Buffer<ArrayBufferLike>[]) => void
Returns:void
Attributes
path:PathLikeFs
options:"ascii" | "utf8" | "utf-8" | "utf16le" | "utf-16le" | "ucs2" | "ucs-2" | "base64" | "base64url" | "latin1" | "binary" | "hex" | ObjectEncodingOptionsFs & { recursive?: boolean; withFileTypes?: false } | null | undefined
callback:(err: ErrnoException | null, files?: string[] | Buffer<ArrayBufferLike>[]) => void
Returns:void
Attributes
path:PathLikeFs
callback:(err: ErrnoException | null, files?: string[]) => void
Returns:void
Attributes
path:PathLikeFs
options:ObjectEncodingOptionsFs & { recursive?: boolean; withFileTypes: true }
callback:(err: ErrnoException | null, files?: DirentFs<string>[]) => void
Returns:void
Attributes
path:PathLikeFs
encoding:"buffer"
recursive:boolean
withFileTypes:true
callback:(err: ErrnoException | null, files: DirentFs<Buffer<ArrayBufferLike>>[]) => void
Returns:void
Attributes
path:PathLikeFs
options:"ascii" | "utf8" | "utf-8" | "utf16le" | "utf-16le" | "ucs2" | "ucs-2" | "base64" | "base64url" | "latin1" | "binary" | "hex" | { encoding: "ascii" | "utf8" | "utf-8" | "utf16le" | "utf-16le" | "ucs2" | "ucs-2" | "base64" | "base64url" | "latin1" | "binary" | "hex" | null; recursive?: boolean; withFileTypes?: false } | null
Returns:string[]
Attributes
path:PathLikeFs
options:"buffer" | { encoding: "buffer"; recursive?: boolean; withFileTypes?: false }
Returns:Buffer<ArrayBufferLike>[]
Attributes
path:PathLikeFs
options:"ascii" | "utf8" | "utf-8" | "utf16le" | "utf-16le" | "ucs2" | "ucs-2" | "base64" | "base64url" | "latin1" | "binary" | "hex" | ObjectEncodingOptionsFs & { recursive?: boolean; withFileTypes?: false } | null
Returns:string[] | Buffer<ArrayBufferLike>[]
Attributes
path:PathLikeFs
options:ObjectEncodingOptionsFs & { recursive?: boolean; withFileTypes: true }
Returns:DirentFs<string>[]
Attributes
path:PathLikeFs
encoding:"buffer"
recursive:boolean
withFileTypes:true
Returns:DirentFs<Buffer<ArrayBufferLike>>[]
Attributes
path:PathLikeTypes
options:"ascii" | "utf8" | "utf-8" | "utf16le" | "utf-16le" | "ucs2" | "ucs-2" | "base64" | "base64url" | "latin1" | "binary" | "hex" | { encoding: "ascii" | "utf8" | "utf-8" | "utf16le" | "utf-16le" | "ucs2" | "ucs-2" | "base64" | "base64url" | "latin1" | "binary" | "hex" | null; recursive?: boolean; withFileTypes?: false } | null | undefined
callback:(err: ErrnoException | null, files?: string[]) => void
Returns:void
Attributes
path:PathLikeTypes
options:"buffer" | { encoding: "buffer"; recursive?: boolean; withFileTypes?: false }
callback:(err: ErrnoException | null, files?: Buffer<ArrayBufferLike>[]) => void
Returns:void
Attributes
path:PathLikeTypes
options:"ascii" | "utf8" | "utf-8" | "utf16le" | "utf-16le" | "ucs2" | "ucs-2" | "base64" | "base64url" | "latin1" | "binary" | "hex" | ObjectEncodingOptionsTypes & { recursive?: boolean; withFileTypes?: false } | null | undefined
callback:(err: ErrnoException | null, files?: string[] | Buffer<ArrayBufferLike>[]) => void
Returns:void
Attributes
path:PathLikeTypes
callback:(err: ErrnoException | null, files?: string[]) => void
Returns:void
Attributes
path:PathLikeTypes
options:ObjectEncodingOptionsTypes & { recursive?: boolean; withFileTypes: true }
callback:(err: ErrnoException | null, files?: DirentTypes<string>[]) => void
Returns:void
Attributes
path:PathLikeTypes
encoding:"buffer"
recursive:boolean
withFileTypes:true
callback:(err: ErrnoException | null, files: DirentTypes<Buffer<ArrayBufferLike>>[]) => void
Returns:void
Attributes
path:PathOrFileDescriptorFs
options:{ encoding?: null; flag?: string } & Abortable | null | undefined
callback:(err: ErrnoException | null, result?: Buffer<ArrayBufferLike>) => void
Returns:void
Attributes
path:PathOrFileDescriptorFs
options:"ascii" | "utf8" | "utf-8" | "utf16le" | "utf-16le" | "ucs2" | "ucs-2" | "base64" | "base64url" | "latin1" | "binary" | "hex" | { encoding: BufferEncoding; flag?: string } & Abortable
callback:(err: ErrnoException | null, result?: string) => void
Returns:void
Attributes
path:PathOrFileDescriptorFs
options:"ascii" | "utf8" | "utf-8" | "utf16le" | "utf-16le" | "ucs2" | "ucs-2" | "base64" | "base64url" | "latin1" | "binary" | "hex" | ObjectEncodingOptionsFs & { flag?: string } & Abortable | null | undefined
callback:(err: ErrnoException | null, result?: string | Buffer<ArrayBufferLike>) => void
Returns:void
Attributes
path:PathOrFileDescriptorFs
callback:(err: ErrnoException | null, result?: Buffer<ArrayBufferLike>) => void
Returns:void
Attributes
path:PathOrFileDescriptorFs
options:{ encoding?: null; flag?: string } | null
Returns:Buffer
Attributes
path:PathOrFileDescriptorFs
options:"ascii" | "utf8" | "utf-8" | "utf16le" | "utf-16le" | "ucs2" | "ucs-2" | "base64" | "base64url" | "latin1" | "binary" | "hex" | { encoding: BufferEncoding; flag?: string }
Returns:string
Attributes
path:PathOrFileDescriptorFs
options:"ascii" | "utf8" | "utf-8" | "utf16le" | "utf-16le" | "ucs2" | "ucs-2" | "base64" | "base64url" | "latin1" | "binary" | "hex" | ObjectEncodingOptionsFs & { flag?: string } | null
Returns:string | Buffer<ArrayBufferLike>
Attributes
path:PathOrFileDescriptorTypes
options:{ encoding?: null; flag?: string } & Abortable | null | undefined
callback:(err: ErrnoException | null, result?: Buffer<ArrayBufferLike>) => void
Returns:void
Attributes
path:PathOrFileDescriptorTypes
options:"ascii" | "utf8" | "utf-8" | "utf16le" | "utf-16le" | "ucs2" | "ucs-2" | "base64" | "base64url" | "latin1" | "binary" | "hex" | { encoding: BufferEncoding; flag?: string } & Abortable
callback:(err: ErrnoException | null, result?: string) => void
Returns:void
Attributes
path:PathOrFileDescriptorTypes
options:"ascii" | "utf8" | "utf-8" | "utf16le" | "utf-16le" | "ucs2" | "ucs-2" | "base64" | "base64url" | "latin1" | "binary" | "hex" | ObjectEncodingOptionsTypes & { flag?: string } & Abortable | null | undefined
callback:(err: ErrnoException | null, result?: string | Buffer<ArrayBufferLike>) => void
Returns:void
Attributes
path:PathOrFileDescriptorTypes
callback:(err: ErrnoException | null, result?: Buffer<ArrayBufferLike>) => void
Returns:void
Attributes
path:PathLikeFs
options:EncodingOptionFs
callback:(err: ErrnoException | null, result?: string) => void
Returns:void
Attributes
path:PathLikeFs
options:BufferEncodingOption
callback:(err: ErrnoException | null, result?: Buffer<ArrayBufferLike>) => void
Returns:void
Attributes
path:PathLikeFs
options:EncodingOptionFs
callback:(err: ErrnoException | null, result?: string | Buffer<ArrayBufferLike>) => void
Returns:void
Attributes
path:PathLikeFs
callback:(err: ErrnoException | null, result?: string) => void
Returns:void
Attributes
path:PathLikeFs
options:EncodingOptionFs
Returns:string
Attributes
path:PathLikeFs
options:BufferEncodingOption
Returns:Buffer
Attributes
path:PathLikeFs
options:EncodingOptionFs
Returns:string | Buffer<ArrayBufferLike>
Attributes
path:PathLikeTypes
options:EncodingOptionTypes
callback:(err: ErrnoException | null, result?: string) => void
Returns:void
Attributes
path:PathLikeTypes
options:BufferEncodingOption
callback:(err: ErrnoException | null, result?: Buffer<ArrayBufferLike>) => void
Returns:void
Attributes
path:PathLikeTypes
options:EncodingOptionTypes
callback:(err: ErrnoException | null, result?: string | Buffer<ArrayBufferLike>) => void
Returns:void
Attributes
path:PathLikeTypes
callback:(err: ErrnoException | null, result?: string) => void
Returns:void
Attributes
path:PathLikeFs
options:EncodingOptionFs
callback:(err: ErrnoException | null, result?: string) => void
Returns:void
Attributes
path:PathLikeFs
options:BufferEncodingOption
callback:(err: ErrnoException | null, result?: Buffer<ArrayBufferLike>) => void
Returns:void
Attributes
path:PathLikeFs
options:EncodingOptionFs
callback:(err: ErrnoException | null, result?: string | Buffer<ArrayBufferLike>) => void
Returns:void
Attributes
path:PathLikeFs
callback:(err: ErrnoException | null, result?: string) => void
Returns:void
Attributes
path:PathLikeFs
options:EncodingOptionFs
Returns:string
Attributes
path:PathLikeFs
options:BufferEncodingOption
Returns:Buffer
Attributes
path:PathLikeFs
options:EncodingOptionFs
Returns:string | Buffer<ArrayBufferLike>
Attributes
path:PathLikeTypes
options:EncodingOptionTypes
callback:(err: ErrnoException | null, result?: string) => void
Returns:void
Attributes
path:PathLikeTypes
options:BufferEncodingOption
callback:(err: ErrnoException | null, result?: Buffer<ArrayBufferLike>) => void
Returns:void
Attributes
path:PathLikeTypes
options:EncodingOptionTypes
callback:(err: ErrnoException | null, result?: string | Buffer<ArrayBufferLike>) => void
Returns:void
Attributes
path:PathLikeTypes
callback:(err: ErrnoException | null, result?: string) => void
Returns:void
Attributes
canInline:boolean
when false, the referenced export can not be substituted with an inlined literal at this site, defaults to true
canMangle:boolean
when false, referenced export can not be mangled, defaults to true
name:string[]
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.

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
hash:string
hash to be used for render call
moduleGraph:ModuleGraph
the module graph
runtimeTemplate:RuntimeTemplate
the runtime template
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

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
definitions:StackedMap<string, VariableInfo | ScopeInfo>
inShorthand:string | boolean
inTaggedTemplateTag:boolean
inTry:boolean
isAsmJs:boolean
isStrict:boolean
terminated:2 | 1
topLevelScope:boolean | "arrow"

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 | false
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 | false
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 | false
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.

Attributes
map:RawSourceMap | null
map
source:SourceValue
source
Attributes
buffer:() => Buffer
buffer
buffers:() => Buffer<ArrayBufferLike>[]
buffers
clearCache:(options?: ClearCacheOptions, visited?: WeakSet<Source>) => void
clear cache
map:(options?: MapOptions) => RawSourceMap | null
map
size:() => number
size
source:() => SourceValue
source
sourceAndMap:(options?: MapOptions) => SourceAndMap
source and map
updateHash:(hash: HashLike) => void
hash updater
Attributes
column:number
line:number
Attributes
hash:string
id:string | number
modules:string[]
size: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
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
the runtime template
strictMode:boolean
rendering in strict context
Attributes
path:PathLikeFs
callback:(err: ErrnoException | null, result?: IStatsFs) => void
Returns:void
Attributes
path:PathLikeFs
options:StatOptionsFs & { bigint?: false } | undefined
callback:(err: ErrnoException | null, result?: IStatsFs) => void
Returns:void
Attributes
path:PathLikeFs
options:StatOptionsFs & { bigint: true }
callback:(err: ErrnoException | null, result?: IBigIntStatsFs) => void
Returns:void
Attributes
path:PathLikeFs
options:StatOptionsFs | undefined
callback:(err: ErrnoException | null, result?: IStatsFs | IBigIntStatsFs) => void
Returns:void

Returns location of targetPath relative to rootPath.

Attributes
bigint:boolean
Attributes
bigint:boolean
need bigint values
Attributes
path:PathLikeFs
Returns:IStatsFs
Attributes
path:PathLikeFs
options:StatSyncOptions & { bigint?: false; throwIfNoEntry?: true }
Returns:IStatsFs
Attributes
path:PathLikeFs
options:StatSyncOptions & { bigint: true; throwIfNoEntry?: true }
Returns:IBigIntStatsFs
Attributes
path:PathLikeFs
options:StatSyncOptions & { bigint?: false; throwIfNoEntry: false }
Returns:IStatsFs | undefined
Attributes
path:PathLikeFs
options:StatSyncOptions & { bigint: true; throwIfNoEntry: false }
Returns:IBigIntStatsFs | undefined
Attributes
path:PathLikeFs
options:StatSyncOptions & { bigint: boolean; throwIfNoEntry?: true }
Returns:IStatsFs | IBigIntStatsFs
Attributes
path:PathLikeFs
options:StatSyncOptions
Returns:IStatsFs | IBigIntStatsFs | undefined
Attributes
path:PathLikeTypes
callback:(err: ErrnoException | null, result?: IStatsTypes) => void
Returns:void
Attributes
path:PathLikeTypes
options:StatOptionsTypes & { bigint?: false } | undefined
callback:(err: ErrnoException | null, result?: IStatsTypes) => void
Returns:void
Attributes
path:PathLikeTypes
options:StatOptionsTypes & { bigint: true }
callback:(err: ErrnoException | null, result?: IBigIntStatsTypes) => void
Returns:void
Attributes
path:PathLikeTypes
options:StatOptionsTypes | undefined
callback:(err: ErrnoException | null, result?: IStatsTypes | IBigIntStatsTypes) => void
Returns:void
Attributes
data:Record<string, any> | TopLevelSymbol | HarmonySettings | ImportSettings | CommonJsImportSettings | CompatibilitySettings
next:TagInfo
tag:symbol

Use a Trusted Types policy to create urls for chunks.

Attributes
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
alias:CompiledAliasOptions
tsconfig file data
modules:string[]
tsconfig file data
Attributes
allContexts:{ [index: string]: TsconfigPathsData }
all contexts (main + refs) for quick lookup
contextList:string[]
precomputed Object.keys(allContexts) — read-only; used on the _selectPathsDataForContext hot path
fileDependencies:Set<string>
file dependencies
main:TsconfigPathsData
main tsconfig paths data
mainContext:string
main tsconfig base URL (absolute path)
refs:{ [index: string]: TsconfigPathsData }
referenced tsconfig paths data mapped by baseUrl
Attributes
chunkGraph:ChunkGraph
module:NormalModule
the module
runtime:RuntimeSpec
runtimeTemplate:RuntimeTemplate
Extends:URL

One default-hint rule for URL-referenced assets emitted by this parser (JS new URL(...), CSS url(...), HTML <img src> / <link href> / <script src>). test / include / exclude match against the asset's request; omit all three to apply to every asset. Matching rules set the same fields a webpackPrefetch / webpackPreload / webpackAs / webpackType / webpackMedia / webpackFetchPriority magic comment would; explicit magic comments on the same URL still win.

Attributes
as:string
Default as attribute (script / style / font / image / …).
exclude:string | RegExp | RuleSetLogicalConditions | RuleSetCondition[] | ((value: string) => boolean)
A condition matcher.
fetchPriority:false | "auto" | "high" | "low"
Default fetchpriority for prefetch / preload links.
include:string | RegExp | RuleSetLogicalConditions | RuleSetCondition[] | ((value: string) => boolean)
A condition matcher.
media:string
Default media attribute (e.g. "(min-width: 800px)" ).
prefetch:boolean
When true, emit <link rel="prefetch"> for matching assets without an explicit hint comment.
preload:boolean
When true, emit <link rel="preload"> for matching assets without an explicit hint comment.
test:string | RegExp | RuleSetLogicalConditions | RuleSetCondition[] | ((value: string) => boolean)
A condition matcher.
type:string
Default type attribute (MIME).

Returns location of targetPath relative to rootPath.

Attributes
close:() => void
closes the watcher and all underlying file watchers
getAggregatedChanges:() => Set<string> | null
get current aggregated changes that have not yet send to callback
getAggregatedRemovals:() => Set<string> | null
get current aggregated removals that have not yet send to callback
getContextTimeInfoEntries:() => Map<string, "ignore" | EntryTypesIndex | OnlySafeTimeEntry | ExistenceOnlyTimeEntryTypesIndex | null>
get info about directories
getFileTimeInfoEntries:() => Map<string, "ignore" | EntryTypesIndex | OnlySafeTimeEntry | ExistenceOnlyTimeEntryTypesIndex | null>
get info about files
getInfo:() => WatcherInfo
get info about timestamps and changes
pause:() => void
closes the watcher, but keeps underlying file watchers alive until the next watch call

Returns location of targetPath relative to rootPath.

Attributes
changes:Set<string> | 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<string> | null
get current aggregated removals that have not yet send to callback
Attributes
file:PathOrFileDescriptorFs
data:string | ArrayBufferView<ArrayBufferLike>
options:WriteFileOptions
callback:(err: ErrnoException | null) => void
Returns:void
Attributes
file:PathOrFileDescriptorFs
data:string | ArrayBufferView<ArrayBufferLike>
callback:(err: ErrnoException | null) => void
Returns:void
Attributes
add:(item: T) => void
Type:ContextResolveData & ContextOptions & { resolveDependencies: (fs: InputFileSystem, options: ContextModuleOptions, callback: (err: null | Error, dependencies?: ContextElementDependency[]) => void) => void; resource: string | string[]; resourceFragment?: string; resourceQuery?: string }
Attributes
resolveDependencies:(fs: InputFileSystem, options: ContextModuleOptions, callback: (err: null | Error, dependencies?: ContextElementDependency[]) => void) => void
resource:string | string[]
resourceFragment:string
resourceQuery:string
Type:string | false | string[]
Type:ContextResolveData & ContextOptions
Type:"ascii" | "utf8" | "utf-8" | "utf16le" | "utf-16le" | "ucs2" | "ucs-2" | "base64" | "base64url" | "latin1" | "binary" | "hex"
Type:"buffer" | { encoding: "buffer" }
Type:KnownBuildInfo & Record<string, any>
Type:KnownBuildMeta & Record<string, any>
Type:SimpleCallExpression | NewExpression
Type:Omit<Map<string, any>, "get" | "set" | "has" | "delete"> & CodeGenMapOverloads
Type:K extends "filename" | "assetInfo" | "share-init" | "topLevelDeclarations" | "freeNames" | "chunkInitFragments" | "url" | "fullContentHash" ? AllCodeGenerationSchemas[K] : any
Type:undefined | null | string | number | bigint | boolean | Function | RegExp
Type:CommentImport & { end: number; loc?: null | SourceLocation; start: number }
Attributes
end:number
loc:null | SourceLocation
start:number
Attributes
env:Record<string, any>
argv:Record<string, any>
Returns:MaybePromise<Configuration | MultiConfiguration>
Type:boolean | typeof CIRCULAR_CONNECTION | typeof TRANSITIVE_ONLY
Type:Item<T> | (string | Item<T>)[]
Type:"eager" | "weak" | "lazy" | "lazy-once" | "sync" | "async-weak"
Type:KnownContext & Record<any, any>
Type:FSImplementation & { read: (args: any[]) => any }
Attributes
read:(args: any[]) => any
Type:FSImplementation & { close?: (args: any[]) => any; write: (args: any[]) => any }
Attributes
close:(args: any[]) => any
write:(args: any[]) => any
Type:undefined | string
Type:Configuration | MultiConfiguration | ((env: Record<string, any>, argv: Record<string, any>) => MaybePromise<Configuration | MultiConfiguration>) | ((env: Record<string, any>, argv: Record<string, any>) => MaybePromise<Configuration | MultiConfiguration>)[] | Promise<Configuration | MultiConfiguration | ((env: Record<string, any>, argv: Record<string, any>) => MaybePromise<Configuration | MultiConfiguration>) | ((env: Record<string, any>, argv: Record<string, any>) => MaybePromise<Configuration | MultiConfiguration>)[]>
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:undefined | null | "ascii" | "utf8" | "utf-8" | "utf16le" | "utf-16le" | "ucs2" | "ucs-2" | "base64" | "base64url" | "latin1" | "binary" | "hex" | ObjectEncodingOptionsFs
Type:undefined | null | "ascii" | "utf8" | "utf-8" | "utf16le" | "utf-16le" | "ucs2" | "ucs-2" | "base64" | "base64url" | "latin1" | "binary" | "hex" | ObjectEncodingOptionsTypes
Type:Error & { details?: string }
Attributes
details:string
Type:0 | 1 | 2 | 3
Type:"namespace" | "dynamic" | "default-only" | "default-with-named"
Type:T & FakeHookMarker
Type:string | RegExp | ((value: string) => boolean)
Type:string | typeof Hash
Type:T extends readonly [infer H, ...any[]] ? H : T extends readonly [] ? any : T extends (infer E)[] ? E : never
Type:string | { color?: string; crossorigin?: "anonymous" | "use-credentials"; href: string; media?: string; sizes?: string; type?: string }

string

{ color?: string; crossorigin?: "anonymous" | "use-credentials"; href: string; media?: string; sizes?: string; type?: string }

Attributes
color:string
Value for the color attribute (used by rel="mask-icon" ).
crossorigin:"anonymous" | "use-credentials"
Value for the crossorigin attribute.
href:string
Path to the icon file, emitted as a hashed asset.
media:string
Value for the media attribute (e.g. "(prefers-color-scheme: dark)" ).
sizes:string
Value for the sizes attribute (e.g. "180x180" or "any" ).
type:string
Value for the type attribute; inferred from the file extension when omitted.
Type:"prefetch" | "preload" | "modulepreload" | "preconnect" | "dns-prefetch"
Type:IStatsBaseFs<bigint> & { atimeNs: bigint; birthtimeNs: bigint; ctimeNs: bigint; mtimeNs: bigint }
Attributes
atimeNs:bigint
birthtimeNs:bigint
ctimeNs:bigint
mtimeNs:bigint
Type:IStatsBaseTypes<bigint> & { atimeNs: bigint; birthtimeNs: bigint; ctimeNs: bigint; mtimeNs: bigint }
Attributes
atimeNs:bigint
birthtimeNs:bigint
ctimeNs:bigint
mtimeNs:bigint
Type:ImportExpressionImport & { phase?: "defer" | "source" }
Attributes
phase:"defer" | "source"
Type:0 | 1 | 2
Type:InfrastructureLogging & { appendOnly: NonNullable<undefined | boolean>; colors: NonNullable<undefined | boolean>; debug: NonNullable<undefined | string | boolean | RegExp | FilterItemTypes[] | ((value: string) => boolean)>; level: NonNullable<undefined | "none" | "verbose" | "error" | "warn" | "info" | "log">; stream: NodeJS.WritableStream & { columns?: number; isTTY?: boolean; rows?: number } }
Attributes
appendOnly:NonNullable<undefined | boolean>
colors:NonNullable<undefined | boolean>
debug:NonNullable<undefined | string | boolean | RegExp | FilterItemTypes[] | ((value: string) => boolean)>
level:NonNullable<undefined | "none" | "verbose" | "error" | "warn" | "info" | "log">
stream:NodeJS.WritableStream & { columns?: number; isTTY?: boolean; rows?: number }
Type:null | string
Type:null | string | number | boolean | JsonObjectFs | JsonValueFs[]
Type:null | string | number | boolean | JsonObjectTypes | JsonValueTypes[]
Type:() => InputValue | Promise<InputValue> & Partial<{ options: InternalLazyOptions }>
Type:T | Promise<T>
Type:undefined | string
Type:T & {}
Type:OptimizationNormalized & { avoidEntryIife: NonNullable<undefined | boolean>; checkWasmTypes: NonNullable<undefined | boolean>; chunkIds: NonNullable<undefined | false | "natural" | "named" | "deterministic" | "size" | "total-size">; concatenateModules: NonNullable<undefined | boolean | ConcatenateModulesOptions>; emitOnErrors: NonNullable<undefined | boolean>; flagIncludedChunks: NonNullable<undefined | boolean>; inlineExports: 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: (((this: Compiler, compiler: Compiler) => void) | 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 | { name?: (entrypoint: { name: string }) => string }>; sideEffects: NonNullable<undefined | boolean | "flag">; splitChunks: NonNullable<undefined | false | OptimizationSplitChunksOptions>; usedExports: NonNullable<undefined | boolean | "global"> }
Attributes
avoidEntryIife:NonNullable<undefined | boolean>
checkWasmTypes:NonNullable<undefined | boolean>
chunkIds:NonNullable<undefined | false | "natural" | "named" | "deterministic" | "size" | "total-size">
concatenateModules:NonNullable<undefined | boolean | ConcatenateModulesOptions>
emitOnErrors:NonNullable<undefined | boolean>
flagIncludedChunks:NonNullable<undefined | boolean>
inlineExports: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:(((this: Compiler, compiler: Compiler) => void) | 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 | { name?: (entrypoint: { name: string }) => string }>
sideEffects:NonNullable<undefined | boolean | "flag">
splitChunks:NonNullable<undefined | false | OptimizationSplitChunksOptions>
usedExports:NonNullable<undefined | boolean | "global">
Type:OutputNormalized & { assetModuleFilename: NonNullable<undefined | string | TemplatePathFn<PathDataModule>>; asyncChunks: NonNullable<undefined | boolean>; charset: NonNullable<undefined | boolean>; chunkFilename: NonNullable<undefined | string | TemplatePathFn<PathDataChunk>>; 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 | TemplatePathFn<PathDataChunk>>; cssFilename: NonNullable<undefined | string | TemplatePathFn<PathDataChunk>>; devtoolNamespace: string; environment: RecursiveNonNullable<Environment>; filename: NonNullable<undefined | string | TemplatePathFn<PathDataChunk>>; globalObject: string; hashDigest: string; hashDigestLength: number; hashFunction: NonNullable<undefined | string | typeof 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 | TemplatePathFn<PathData>>; scriptType: NonNullable<undefined | false | "module" | "text/javascript">; sourceMapFilename: string; strictModuleErrorHandling: NonNullable<undefined | boolean>; strictModuleExceptionHandling: NonNullable<undefined | boolean>; strictModuleResolution: NonNullable<undefined | boolean>; uniqueName: string; wasmLoading: NonNullable<undefined | string | false>; webassemblyModuleFilename: string; workerChunkFilename: NonNullable<undefined | string | TemplatePathFn<PathDataChunk>>; workerChunkLoading: NonNullable<undefined | string | false>; workerPublicPath: string; workerWasmLoading: NonNullable<undefined | string | false> }
Attributes
assetModuleFilename:NonNullable<undefined | string | TemplatePathFn<PathDataModule>>
asyncChunks:NonNullable<undefined | boolean>
charset:NonNullable<undefined | boolean>
chunkFilename:NonNullable<undefined | string | TemplatePathFn<PathDataChunk>>
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 | TemplatePathFn<PathDataChunk>>
cssFilename:NonNullable<undefined | string | TemplatePathFn<PathDataChunk>>
devtoolNamespace:string
environment:RecursiveNonNullable<Environment>
filename:NonNullable<undefined | string | TemplatePathFn<PathDataChunk>>
globalObject:string
hashDigest:string
hashDigestLength:number
hashFunction:NonNullable<undefined | string | typeof 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 | TemplatePathFn<PathData>>
scriptType:NonNullable<undefined | false | "module" | "text/javascript">
sourceMapFilename:string
strictModuleErrorHandling:NonNullable<undefined | boolean>
strictModuleExceptionHandling:NonNullable<undefined | boolean>
strictModuleResolution:NonNullable<undefined | boolean>
uniqueName:string
wasmLoading:NonNullable<undefined | string | false>
webassemblyModuleFilename:string
workerChunkFilename:NonNullable<undefined | string | TemplatePathFn<PathDataChunk>>
workerChunkLoading:NonNullable<undefined | string | false>
workerPublicPath:string
workerWasmLoading:NonNullable<undefined | string | false>
Type:ParserStateBase & Record<string, any>
Type:string | Buffer | URL
Type:string | URL_url | Buffer
Type:string | number | Buffer | URL
Type:string | number | URL_url | Buffer
Type:undefined | null | false | "" | 0 | { apply: (this: Resolver, resolver: Resolver) => void } | ((this: Resolver, resolver: Resolver) => void)
Type:string | false
Type:KnownRecords & Record<string, KnownRecords[]> & Record<string, any>
Type:string | object
Type:string | RegExp | ((str: string) => boolean)
Type:ServerImportHttp<typeof IncomingMessage> | ServerImportHttps<typeof IncomingMessage>
Type:SnapshotOptionsWebpackOptions & { buildDependencies: { hash?: boolean; timestamp?: boolean }; immutablePaths: (string | RegExp)[]; managedPaths: (string | RegExp)[]; module: { hash?: boolean; timestamp?: boolean }; resolve: { hash?: boolean; timestamp?: boolean }; resolveBuildDependencies: { hash?: boolean; timestamp?: boolean }; unmanagedPaths: (string | RegExp)[] }
Attributes
buildDependencies:{ hash?: boolean; timestamp?: boolean }
immutablePaths:(string | RegExp)[]
managedPaths:(string | RegExp)[]
module:{ hash?: boolean; timestamp?: boolean }
resolve:{ hash?: boolean; timestamp?: boolean }
resolveBuildDependencies:{ hash?: boolean; timestamp?: boolean }
unmanagedPaths:(string | RegExp)[]
Type:string | Buffer
Type:undefined | string
Type:T extends readonly [any, ...(infer R)] ? R : T
Type:0 | 1 | 2 | 3 | 4
Type:string | RegExp | ((warning: StatsError, warningString: string) => boolean)