webpack Types

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

Returns compiler or MultiCompiler.

Returns the compiler object.

Returns the compiler object.

Returns the multi compiler object.

Returns the multi compiler object.

• [index: {string}] <any>

• dispose (callback: (err?: <Error> | <null>) => <void>) => <void>
• module (module: <Module>) => <ModuleResult>

Creates a multi compiler.

Creates a multi compiler.

• delete (key: <K>) => <boolean>
• get {(key: K) => CodeGenValue | undefined}
• has (key: <K>) => <boolean>
• set {(key: K, value: CodeGenValue) => CodeGenerationResultData}

Checks whether this object is sorted.

Returns location of targetPath relative to rootPath.

• 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

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

• [index: {string}] {{ buildMeta?: { [index: string]: any }; exports?: true | string[]; id: string | number }}

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

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

• [index: {string}] <any>

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

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

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

• [index: {string}] <string> | <string>[] | <ExposesConfig>

Creates a deprecation.

Returns location of targetPath relative to rootPath.

• close (args: <any>[]) => <any>
• open (args: <any>[]) => <any>

• attributes <Record><<string>, <string>>
• await <boolean>
• ids <string>[]
• name <string>
• phase <ImportPhaseType>
• source <string>
• sourceOrder <number>

• guards {AppendOnlyStackedSet}

• digest {(encoding?: string) => string | Buffer} get hash digest
• update {(data: string | Buffer, inputEncoding?: string) => HashLike} make hash update

Options for infrastructure level logging.

Returns location of targetPath relative to rootPath.

• 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>}
• rename (a: <PathLikeFs>, b: <PathLikeFs>, callback: (err: <ErrnoException> | <null>) => <void>) => <void>

Returns location of targetPath relative to rootPath.

Returns location of targetPath relative to rootPath.

• [index: {string}] <string> | <string>[] | <T>

• [index: {string}] <string> | <number> | <boolean> | <JsonObjectFs> | <JsonValueFs>[] | <null> | <undefined>

• [index: {string}] <string> | <number> | <boolean> | <JsonObjectTypes> | <JsonValueTypes>[] | <null> | <undefined>

• linkPrefetch <SyncWaterfallHook><<[string, Chunk]>, <string>>
• linkPreload <SyncWaterfallHook><<[string, Chunk]>, <string>>

Checks whether this object is sorted.

Returns array of values.

Returns array of values.

Returns array of values.

Returns array of values.

Returns array of values.

Extract fragment index.

• getContent (context: <GenerateContext>) => <string> | <Source> | <undefined>
• getEndContent (context: <GenerateContext>) => <string> | <Source> | <undefined>
• key <string>
• merge {(fragments: MaybeMergeableInitFragment) => MaybeMergeableInitFragment}
• mergeAll {(fragments: MaybeMergeableInitFragment[]) => MaybeMergeableInitFragment[]}
• position <number>
• stage <number>

Returns location of targetPath relative to rootPath.

• encoding <"ascii"> | <"utf8"> | <"utf-8"> | <"utf16le"> | <"utf-16le"> | <"ucs2"> | <"ucs-2"> | <"base64"> | <"base64url"> | <"latin1"> | <"binary"> | <"hex"> | <null>

• encoding <"ascii"> | <"utf8"> | <"utf-8"> | <"utf16le"> | <"utf-16le"> | <"ucs2"> | <"ucs-2"> | <"base64"> | <"base64url"> | <"latin1"> | <"binary"> | <"hex"> | <null> encoding

Enables/Disables integrated optimizations.

Enables/Disables integrated optimizations.

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

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

• assetModuleFilename {string | TemplatePathFn} 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} 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} 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} 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} 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.
• htmlChunkFilename {string | TemplatePathFn} 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} 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} The 'publicPath' specifies the public URL address of the output files when referenced in a browser.
• scriptType <false> | <"module"> | <"text/javascript"> This option enables loading async chunks via a custom script type, such as script type="module".
• sourceMapFilename <string> The filename of the SourceMaps for the JavaScript files. They are inside the 'output.path' directory.
• sourcePrefix <string> Prefixes every line of the source in the bundle with this string.
• strictModuleErrorHandling <boolean> Handles error in module loading correctly at a performance cost. This will handle module error compatible with the EcmaScript Modules spec.
• strictModuleExceptionHandling <boolean> Handles exceptions in module loading correctly at a performance cost (Deprecated). This will handle module error compatible with the Node.js CommonJS way.
• trustedTypes <TrustedTypes> Use a Trusted Types policy to create urls for chunks.
• uniqueName <string> A unique name of the webpack build to avoid multiple webpack runtimes to conflict when using globals.
• wasmLoading <string> | <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).
• webassemblyModuleFilename <string> The filename of WebAssembly modules as relative path inside the 'output.path' directory.
• 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).

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

Returns check if version is greater or equal.

• resolveToUnqualified {(packageName: string, issuer: string, options: { considerBuiltins: boolean }) => string | null} resolve to unqualified

• [index: {string}] <any>