2018-05-08 12:04:57 +08:00
/ * *
2018-09-18 19:57:44 +08:00
* This file was automatically generated .
* DO NOT MODIFY BY HAND .
* Run ` yarn special-lint-fix ` to update
2018-05-08 12:04:57 +08:00
* /
2018-09-18 19:57:44 +08:00
/ * *
* This interface was referenced by ` WebpackOptions ` ' s JSON - Schema
2018-09-19 16:37:53 +08:00
* via the ` definition ` "Entry" .
2018-09-18 19:57:44 +08:00
* /
2018-09-19 18:59:48 +08:00
export type Entry = EntryDynamic | EntryStatic ;
/ * *
* A Function returning an entry object , an entry string , an entry array or a promise to these things .
*
* This interface was referenced by ` WebpackOptions ` ' s JSON - Schema
* via the ` definition ` "EntryDynamic" .
* /
2019-02-05 17:06:32 +08:00
export type EntryDynamic = ( ) = > EntryStatic | Promise < EntryStatic > ;
2018-09-19 18:59:48 +08:00
/ * *
* This interface was referenced by ` WebpackOptions ` ' s JSON - Schema
* via the ` definition ` "EntryStatic" .
* /
export type EntryStatic = EntryObject | EntryItem ;
2018-09-18 19:57:44 +08:00
/ * *
* This interface was referenced by ` WebpackOptions ` ' s JSON - Schema
2018-09-19 16:37:53 +08:00
* via the ` definition ` "NonEmptyArrayOfUniqueStringValues" .
2018-09-18 19:57:44 +08:00
* /
2018-09-19 16:37:53 +08:00
export type NonEmptyArrayOfUniqueStringValues = string [ ] ;
2018-09-19 18:59:48 +08:00
/ * *
* This interface was referenced by ` WebpackOptions ` ' s JSON - Schema
* via the ` definition ` "EntryItem" .
* /
export type EntryItem = string | NonEmptyArrayOfUniqueStringValues ;
2018-09-18 19:57:44 +08:00
/ * *
* This interface was referenced by ` WebpackOptions ` ' s JSON - Schema
2018-09-19 16:37:53 +08:00
* via the ` definition ` "Externals" .
2018-09-18 19:57:44 +08:00
* /
2018-09-19 18:59:48 +08:00
export type Externals =
| ( (
context : string ,
request : string ,
callback : ( err? : Error , result? : string ) = > void
) = > void )
| ExternalItem
| (
| ( (
context : string ,
request : string ,
callback : ( err? : Error , result? : string ) = > void
) = > void )
| ExternalItem ) [ ] ;
2018-09-18 21:17:44 +08:00
/ * *
* This interface was referenced by ` WebpackOptions ` ' s JSON - Schema
2018-09-19 16:37:53 +08:00
* via the ` definition ` "ExternalItem" .
2018-09-18 21:17:44 +08:00
* /
export type ExternalItem =
2018-05-08 12:04:57 +08:00
| string
| {
/ * *
* The dependency used for the external
* /
[ k : string ] :
| string
| {
[ k : string ] : any ;
}
2018-09-19 16:37:53 +08:00
| ArrayOfStringValues
2018-05-08 12:04:57 +08:00
| boolean ;
}
2018-09-21 14:39:15 +08:00
| RegExp ;
2018-09-18 19:57:44 +08:00
/ * *
* This interface was referenced by ` WebpackOptions ` ' s JSON - Schema
2018-09-19 16:37:53 +08:00
* via the ` definition ` "ArrayOfStringValues" .
2018-09-18 19:57:44 +08:00
* /
2018-09-19 16:37:53 +08:00
export type ArrayOfStringValues = string [ ] ;
2018-09-18 21:17:44 +08:00
/ * *
* One or multiple rule conditions
*
* This interface was referenced by ` WebpackOptions ` ' s JSON - Schema
2018-09-19 16:37:53 +08:00
* via the ` definition ` "RuleSetConditionOrConditions" .
2018-09-18 21:17:44 +08:00
* /
export type RuleSetConditionOrConditions = RuleSetCondition | RuleSetConditions ;
2018-09-18 19:57:44 +08:00
/ * *
* This interface was referenced by ` WebpackOptions ` ' s JSON - Schema
2018-09-19 16:37:53 +08:00
* via the ` definition ` "RuleSetCondition" .
2018-09-18 19:57:44 +08:00
* /
2018-05-08 12:04:57 +08:00
export type RuleSetCondition =
2018-09-21 14:39:15 +08:00
| RegExp
2018-05-08 12:04:57 +08:00
| string
2018-09-21 17:00:44 +08:00
| ( ( value : string ) = > boolean )
2018-09-21 14:39:15 +08:00
| RuleSetConditions
2018-05-08 12:04:57 +08:00
| {
/ * *
* Logical AND
* /
and? : RuleSetConditions ;
/ * *
* Exclude all module s matching any of these conditions
* /
2018-09-18 21:17:44 +08:00
exclude? : RuleSetConditionOrConditions ;
2018-05-08 12:04:57 +08:00
/ * *
* Exclude all module s matching not any of these conditions
* /
2018-09-18 21:17:44 +08:00
include? : RuleSetConditionOrConditions ;
2018-05-08 12:04:57 +08:00
/ * *
* Logical NOT
* /
not? : RuleSetConditions ;
/ * *
* Logical OR
* /
or? : RuleSetConditions ;
/ * *
* Exclude all module s matching any of these conditions
* /
2018-09-18 21:17:44 +08:00
test? : RuleSetConditionOrConditions ;
2018-05-08 12:04:57 +08:00
} ;
2018-09-18 19:57:44 +08:00
/ * *
* This interface was referenced by ` WebpackOptions ` ' s JSON - Schema
2018-09-19 16:37:53 +08:00
* via the ` definition ` "RuleSetConditions" .
2018-09-18 19:57:44 +08:00
* /
2018-09-18 21:17:44 +08:00
export type RuleSetConditions = RuleSetConditionsRecursive ;
2018-09-21 17:00:44 +08:00
/ * *
* One or multiple rule conditions
*
* This interface was referenced by ` WebpackOptions ` ' s JSON - Schema
* via the ` definition ` "RuleSetConditionOrConditionsAbsolute" .
* /
export type RuleSetConditionOrConditionsAbsolute =
| RuleSetConditionAbsolute
| RuleSetConditionsAbsolute ;
/ * *
* This interface was referenced by ` WebpackOptions ` ' s JSON - Schema
* via the ` definition ` "RuleSetConditionAbsolute" .
* /
export type RuleSetConditionAbsolute =
| RegExp
| string
| ( ( value : string ) = > boolean )
| RuleSetConditionsAbsolute
| {
/ * *
* Logical AND
* /
and? : RuleSetConditionsAbsolute ;
/ * *
* Exclude all module s matching any of these conditions
* /
exclude? : RuleSetConditionOrConditionsAbsolute ;
/ * *
* Exclude all module s matching not any of these conditions
* /
include? : RuleSetConditionOrConditionsAbsolute ;
/ * *
* Logical NOT
* /
not? : RuleSetConditionsAbsolute ;
/ * *
* Logical OR
* /
or? : RuleSetConditionsAbsolute ;
/ * *
* Exclude all module s matching any of these conditions
* /
test? : RuleSetConditionOrConditionsAbsolute ;
} ;
/ * *
* This interface was referenced by ` WebpackOptions ` ' s JSON - Schema
* via the ` definition ` "RuleSetConditionsAbsolute" .
* /
export type RuleSetConditionsAbsolute = RuleSetConditionsAbsoluteRecursive ;
2018-09-18 19:57:44 +08:00
/ * *
* This interface was referenced by ` WebpackOptions ` ' s JSON - Schema
2018-09-19 16:37:53 +08:00
* via the ` definition ` "RuleSetLoader" .
2018-09-18 19:57:44 +08:00
* /
2018-05-08 12:04:57 +08:00
export type RuleSetLoader = string ;
2018-09-18 19:57:44 +08:00
/ * *
* This interface was referenced by ` WebpackOptions ` ' s JSON - Schema
2018-09-19 16:37:53 +08:00
* via the ` definition ` "RuleSetUse" .
2018-09-18 19:57:44 +08:00
* /
2019-05-16 17:31:41 +08:00
export type RuleSetUse =
| RuleSetUseItem
| ( ( data : object ) = > RuleSetUseItem [ ] )
| RuleSetUseItem [ ] ;
2018-09-18 19:57:44 +08:00
/ * *
* This interface was referenced by ` WebpackOptions ` ' s JSON - Schema
2018-09-19 16:37:53 +08:00
* via the ` definition ` "RuleSetUseItem" .
2018-09-18 19:57:44 +08:00
* /
2018-05-08 12:04:57 +08:00
export type RuleSetUseItem =
| RuleSetLoader
2019-05-16 17:31:41 +08:00
| ( ( data : object ) = > RuleSetUseItem | RuleSetUseItem [ ] )
2018-05-08 12:04:57 +08:00
| {
2018-09-19 16:17:33 +08:00
/ * *
2019-05-16 17:31:41 +08:00
* Unique loader options identifier
2018-09-19 16:17:33 +08:00
* /
ident? : string ;
2018-05-08 12:04:57 +08:00
/ * *
* Loader name
* /
loader? : RuleSetLoader ;
/ * *
* Loader options
* /
2019-05-16 17:31:41 +08:00
options? : RuleSetLoaderOptions ;
2018-05-08 12:04:57 +08:00
} ;
2018-09-18 19:57:44 +08:00
/ * *
* This interface was referenced by ` WebpackOptions ` ' s JSON - Schema
2019-05-16 17:31:41 +08:00
* via the ` definition ` "RuleSetLoaderOptions" .
2018-09-18 19:57:44 +08:00
* /
2019-05-16 17:31:41 +08:00
export type RuleSetLoaderOptions =
2018-05-08 12:04:57 +08:00
| {
[ k : string ] : any ;
}
| string ;
2018-09-18 19:57:44 +08:00
/ * *
* This interface was referenced by ` WebpackOptions ` ' s JSON - Schema
2018-09-19 16:37:53 +08:00
* via the ` definition ` "ArrayOfStringOrStringArrayValues" .
2018-09-18 19:57:44 +08:00
* /
2018-09-19 16:37:53 +08:00
export type ArrayOfStringOrStringArrayValues = ( string | string [ ] ) [ ] ;
2018-09-18 21:17:44 +08:00
/ * *
* Function acting as plugin
*
* This interface was referenced by ` WebpackOptions ` ' s JSON - Schema
2018-09-19 16:37:53 +08:00
* via the ` definition ` "WebpackPluginFunction" .
2018-09-18 21:17:44 +08:00
* /
2018-09-19 16:37:53 +08:00
export type WebpackPluginFunction = (
2018-11-22 23:15:20 +08:00
this : import ( "../lib/Compiler" ) ,
2018-09-18 21:17:44 +08:00
compiler : import ( "../lib/Compiler" )
) = > void ;
2018-09-18 19:57:44 +08:00
/ * *
* This interface was referenced by ` WebpackOptions ` ' s JSON - Schema
2018-09-19 16:37:53 +08:00
* via the ` definition ` "RuleSetRules" .
2018-09-18 19:57:44 +08:00
* /
2018-05-08 12:04:57 +08:00
export type RuleSetRules = RuleSetRule [ ] ;
2018-12-12 17:46:44 +08:00
/ * *
* This interface was referenced by ` WebpackOptions ` ' s JSON - Schema
* via the ` definition ` "OptimizationSplitChunksGetCacheGroups" .
* /
2019-02-06 22:37:11 +08:00
export type OptimizationSplitChunksGetCacheGroups = (
2018-12-12 17:46:44 +08:00
module : import ( "../lib/Module" )
) = >
| OptimizationSplitChunksCacheGroup
| OptimizationSplitChunksCacheGroup [ ]
2019-02-06 22:37:11 +08:00
| void ;
2018-12-04 23:40:06 +08:00
/ * *
* This interface was referenced by ` WebpackOptions ` ' s JSON - Schema
* via the ` definition ` "OptimizationSplitChunksSizes" .
* /
export type OptimizationSplitChunksSizes =
| number
| {
/ * *
* Size of the part of the chunk with the type of the key
* /
[ k : string ] : number ;
} ;
2018-09-18 19:57:44 +08:00
/ * *
* This interface was referenced by ` WebpackOptions ` ' s JSON - Schema
2018-09-19 16:37:53 +08:00
* via the ` definition ` "FilterTypes" .
2018-09-18 19:57:44 +08:00
* /
2018-05-08 12:04:57 +08:00
export type FilterTypes = FilterItemTypes | FilterItemTypes [ ] ;
2018-09-18 19:57:44 +08:00
/ * *
* This interface was referenced by ` WebpackOptions ` ' s JSON - Schema
2018-09-19 16:37:53 +08:00
* via the ` definition ` "FilterItemTypes" .
2018-09-18 19:57:44 +08:00
* /
2018-09-21 14:39:15 +08:00
export type FilterItemTypes = RegExp | string | Function ;
2018-05-08 12:04:57 +08:00
export interface WebpackOptions {
/ * *
2019-03-11 00:13:53 +08:00
* Set the value of ` require.amd ` and ` define.amd ` . Or disable AMD support .
2018-05-08 12:04:57 +08:00
* /
2019-03-11 00:13:53 +08:00
amd ? :
2019-03-12 00:43:25 +08:00
| false
2019-03-11 00:13:53 +08:00
| {
[ k : string ] : any ;
} ;
2018-05-08 12:04:57 +08:00
/ * *
* Report the first error as a hard error instead of tolerating it .
* /
bail? : boolean ;
/ * *
* Cache generated module s and chunks to improve performance for multiple incremental builds .
* /
2018-10-09 20:30:59 +08:00
cache? : false | true | MemoryCacheOptions | FileCacheOptions ;
2018-05-08 12:04:57 +08:00
/ * *
* The base directory ( absolute path ! ) for resolving the ` entry ` option . If ` output.pathinfo ` is set , the included pathinfo is shortened to this directory .
* /
context? : string ;
/ * *
* References to other configurations to depend on .
* /
dependencies? : string [ ] ;
/ * *
* Options for the webpack - dev - server
* /
devServer ? : {
[ k : string ] : any ;
} ;
/ * *
* A developer tool to enhance debugging .
* /
devtool? : string | false ;
/ * *
* The entry point ( s ) of the compilation .
* /
entry? : Entry ;
/ * *
* Specify dependencies that shouldn ' t be resolved by webpack , but should become dependencies of the resulting bundle . The kind of the dependency depends on ` output.libraryTarget ` .
* /
externals? : Externals ;
/ * *
* Custom values available in the loader context .
* /
loader ? : {
[ k : string ] : any ;
} ;
2018-09-19 16:17:33 +08:00
/ * *
* Enable production optimizations or development hints .
* /
mode ? : "development" | "production" | "none" ;
2018-05-08 12:04:57 +08:00
/ * *
* Options affecting the normal module s ( ` NormalModuleFactory ` ) .
* /
2018-09-19 16:37:53 +08:00
module ? : ModuleOptions ;
2018-05-08 12:04:57 +08:00
/ * *
* Name of the configuration . Used when loading multiple configurations .
* /
name? : string ;
/ * *
* Include polyfills or mocks for various node stuff .
* /
2018-09-19 16:37:53 +08:00
node? : false | NodeOptions ;
2018-05-08 12:04:57 +08:00
/ * *
* Enables / Disables integrated optimizations
* /
2018-09-19 16:37:53 +08:00
optimization? : OptimizationOptions ;
2018-09-19 16:17:33 +08:00
/ * *
* Options affecting the output of the compilation . ` output ` options tell webpack how to write the compiled files to disk .
* /
2018-09-19 16:46:37 +08:00
output? : OutputOptions ;
2018-05-08 12:04:57 +08:00
/ * *
* The number of parallel processed module s in the compilation .
* /
parallelism? : number ;
/ * *
* Configuration for web performance recommendations .
* /
2018-09-19 16:37:53 +08:00
performance? : false | PerformanceOptions ;
2018-05-08 12:04:57 +08:00
/ * *
* Add additional plugins to the compiler .
* /
2018-09-19 16:37:53 +08:00
plugins ? : ( WebpackPluginInstance | WebpackPluginFunction ) [ ] ;
2018-05-08 12:04:57 +08:00
/ * *
* Capture timing information for each module .
* /
profile? : boolean ;
/ * *
* Store compiler state to a json file .
* /
recordsInputPath? : string ;
/ * *
* Load compiler state from a json file .
* /
recordsOutputPath? : string ;
/ * *
* Store / Load compiler state from / to a json file . This will result in persistent ids of module s and chunks . An absolute path is expected . ` recordsPath ` is used for ` recordsInputPath ` and ` recordsOutputPath ` if they left undefined .
* /
recordsPath? : string ;
/ * *
* Options for the resolver
* /
2018-09-19 16:37:53 +08:00
resolve? : ResolveOptions ;
2018-05-08 12:04:57 +08:00
/ * *
* Options for the resolver when resolving loaders
* /
2018-09-19 16:37:53 +08:00
resolveLoader? : ResolveOptions ;
2018-05-08 12:04:57 +08:00
/ * *
* Options for webpack - serve
* /
serve ? : {
[ k : string ] : any ;
} ;
/ * *
* Used by the webpack CLI program to pass stats options .
* /
stats ? :
2018-09-19 16:37:53 +08:00
| StatsOptions
2018-05-08 12:04:57 +08:00
| boolean
2019-03-19 19:24:34 +08:00
| (
| "none"
| "errors-only"
| "minimal"
| "normal"
| "detailed"
| "verbose"
| "errors-warnings" ) ;
2018-05-08 12:04:57 +08:00
/ * *
* Environment to build for
* /
target ? :
| (
| "web"
| "webworker"
| "node"
| "async-node"
| "node-webkit"
| "electron-main"
| "electron-renderer" )
2018-09-19 18:59:48 +08:00
| ( ( compiler : import ( "../lib/Compiler" ) ) = > void ) ;
2018-05-08 12:04:57 +08:00
/ * *
* Enter watch mode , which rebuilds on file change .
* /
watch? : boolean ;
/ * *
* Options for the watcher
* /
2018-12-10 18:34:59 +08:00
watchOptions? : WatchOptions ;
2018-05-08 12:04:57 +08:00
}
2018-10-09 20:30:59 +08:00
/ * *
* This interface was referenced by ` WebpackOptions ` ' s JSON - Schema
* via the ` definition ` "MemoryCacheOptions" .
* /
export interface MemoryCacheOptions {
/ * *
* In memory caching
* /
type : "memory" ;
}
/ * *
* This interface was referenced by ` WebpackOptions ` ' s JSON - Schema
* via the ` definition ` "FileCacheOptions" .
* /
export interface FileCacheOptions {
/ * *
* Base directory for the cache ( defaults to node_modules / . cache / webpack ) .
* /
cacheDirectory? : string ;
2019-01-26 02:21:45 +08:00
/ * *
* Locations for the cache ( defaults to cacheDirectory / name ) .
* /
cacheLocation? : string ;
2018-10-09 20:30:59 +08:00
/ * *
* Algorithm used for generation the hash ( see node . js crypto package )
* /
hashAlgorithm? : string ;
2019-01-19 18:47:53 +08:00
/ * *
2019-01-19 19:07:26 +08:00
* Time in ms after which idle period the cache storing should happen ( only for store : 'pack' or 'idle' )
2019-01-19 18:47:53 +08:00
* /
idleTimeout? : number ;
2019-01-19 19:07:26 +08:00
/ * *
* Time in ms after which idle period the initial cache storing should happen ( only for store : 'pack' or 'idle' )
* /
idleTimeoutForInitialStore? : number ;
2018-10-09 20:30:59 +08:00
/ * *
2018-10-23 13:33:45 +08:00
* Display log info . ( debug : all access and errors with stack trace , verbose : all access , info : all write access , warning : only failed serialization )
2018-10-09 20:30:59 +08:00
* /
2018-10-23 13:33:45 +08:00
loglevel ? : "debug" | "verbose" | "info" | "warning" ;
2018-10-09 20:30:59 +08:00
/ * *
* Name for the cache . Different names will lead to different coexisting caches .
* /
name? : string ;
/ * *
2018-10-23 17:31:20 +08:00
* When to store data to the filesystem . ( pack : Store data when compiler is idle in a single file , idle : Store data when compiler is idle in multiple files ; background : Store data in background while compiling , but doesn ' t block the compilation ; instant : Store data when creating blocking compilation until data is stored ; defaults to idle )
2018-10-09 20:30:59 +08:00
* /
2018-10-23 17:31:20 +08:00
store ? : "pack" | "idle" | "background" | "instant" ;
2018-10-09 20:30:59 +08:00
/ * *
* Filesystem caching
* /
type : "filesystem" ;
/ * *
* Version of the cache data . Different versions won 't allow to reuse the cache and override existing content. Update the version when config changed in a way which doesn' t allow to reuse cache . This will invalidate the cache .
* /
version? : string ;
}
2018-09-19 18:59:48 +08:00
/ * *
* Multiple entry bundles are created . The key is the chunk name . The value can be a string or an array .
*
* This interface was referenced by ` WebpackOptions ` ' s JSON - Schema
* via the ` definition ` "EntryObject" .
* /
export interface EntryObject {
/ * *
* An entry point with name
* /
[ k : string ] : string | NonEmptyArrayOfUniqueStringValues ;
}
2018-09-18 19:57:44 +08:00
/ * *
* This interface was referenced by ` WebpackOptions ` ' s JSON - Schema
2018-09-19 16:37:53 +08:00
* via the ` definition ` "ModuleOptions" .
2018-09-18 19:57:44 +08:00
* /
2018-09-19 16:37:53 +08:00
export interface ModuleOptions {
2018-09-19 16:17:33 +08:00
/ * *
* An array of rules applied by default for module s.
* /
defaultRules? : RuleSetRules ;
2018-05-08 12:04:57 +08:00
/ * *
* Enable warnings for full dynamic dependencies
* /
exprContextCritical? : boolean ;
/ * *
* Enable recursive directory lookup for full dynamic dependencies
* /
exprContextRecursive? : boolean ;
/ * *
* Sets the default regular expression for full dynamic dependencies
* /
2018-09-21 14:39:15 +08:00
exprContextRegExp? : boolean | RegExp ;
2018-05-08 12:04:57 +08:00
/ * *
* Set the default request for full dynamic dependencies
* /
exprContextRequest? : string ;
/ * *
* Don 't parse files matching. It' s matched against the full resolved request .
* /
2018-09-21 14:39:15 +08:00
noParse? : RegExp [ ] | RegExp | Function | string [ ] | string ;
2018-05-08 12:04:57 +08:00
/ * *
* An array of rules applied for module s.
* /
rules? : RuleSetRules ;
/ * *
2018-09-19 16:17:33 +08:00
* Emit errors instead of warnings when imported names don ' t exist in imported module
2018-05-08 12:04:57 +08:00
* /
2018-09-19 16:17:33 +08:00
strictExportPresence? : boolean ;
/ * *
* Handle the this context correctly according to the spec for namespace objects
* /
strictThisContextOnImports? : boolean ;
2018-05-08 12:04:57 +08:00
/ * *
* Enable warnings when using the require function in a not statically analyse - able way
* /
unknownContextCritical? : boolean ;
/ * *
* Enable recursive directory lookup when using the require function in a not statically analyse - able way
* /
unknownContextRecursive? : boolean ;
/ * *
* Sets the regular expression when using the require function in a not statically analyse - able way
* /
2018-09-21 14:39:15 +08:00
unknownContextRegExp? : boolean | RegExp ;
2018-05-08 12:04:57 +08:00
/ * *
* Sets the request when using the require function in a not statically analyse - able way
* /
unknownContextRequest? : string ;
/ * *
* Cache the resolving of module requests
* /
2018-09-19 18:59:48 +08:00
unsafeCache? : boolean | Function ;
2018-05-08 12:04:57 +08:00
/ * *
* Enable warnings for partial dynamic dependencies
* /
wrappedContextCritical? : boolean ;
/ * *
* Enable recursive directory lookup for partial dynamic dependencies
* /
wrappedContextRecursive? : boolean ;
/ * *
* Set the inner regular expression for partial dynamic dependencies
* /
2018-09-21 14:39:15 +08:00
wrappedContextRegExp? : RegExp ;
2018-05-08 12:04:57 +08:00
}
2018-09-18 19:57:44 +08:00
/ * *
* This interface was referenced by ` WebpackOptions ` ' s JSON - Schema
2018-09-19 16:37:53 +08:00
* via the ` definition ` "RuleSetRule" .
2018-09-18 19:57:44 +08:00
* /
2018-05-08 12:04:57 +08:00
export interface RuleSetRule {
2018-09-19 16:17:33 +08:00
/ * *
* Match the child compiler name
* /
2018-09-18 21:17:44 +08:00
compiler? : RuleSetConditionOrConditions ;
2018-05-08 12:04:57 +08:00
/ * *
* Enforce this rule as pre or post step
* /
enforce ? : "pre" | "post" ;
/ * *
* Shortcut for resource . exclude
* /
2018-09-21 17:00:44 +08:00
exclude? : RuleSetConditionOrConditionsAbsolute ;
2018-05-08 12:04:57 +08:00
/ * *
* Shortcut for resource . include
* /
2018-09-21 17:00:44 +08:00
include? : RuleSetConditionOrConditionsAbsolute ;
2018-05-08 12:04:57 +08:00
/ * *
* Match the issuer of the module ( The module pointing to this module )
* /
2018-09-21 17:00:44 +08:00
issuer? : RuleSetConditionOrConditionsAbsolute ;
2018-05-08 12:04:57 +08:00
/ * *
* Shortcut for use . loader
* /
loader? : RuleSetLoader | RuleSetUse ;
/ * *
* Only execute the first matching rule in this array
* /
oneOf? : RuleSetRules ;
/ * *
* Shortcut for use . options
* /
2019-05-16 17:31:41 +08:00
options? : RuleSetLoaderOptions ;
2018-05-08 12:04:57 +08:00
/ * *
* Options for parsing
* /
parser ? : {
[ k : string ] : any ;
} ;
/ * *
2019-05-16 17:31:41 +08:00
* Match the real resource path of the module
2018-05-08 12:04:57 +08:00
* /
2019-05-16 17:31:41 +08:00
realResource? : RuleSetConditionOrConditionsAbsolute ;
2018-05-08 12:04:57 +08:00
/ * *
2018-09-19 16:17:33 +08:00
* Options for the resolver
2018-05-08 12:04:57 +08:00
* /
2018-09-19 16:37:53 +08:00
resolve? : ResolveOptions ;
2018-05-08 12:04:57 +08:00
/ * *
* Match the resource path of the module
* /
2018-09-21 17:00:44 +08:00
resource? : RuleSetConditionOrConditionsAbsolute ;
2018-05-08 12:04:57 +08:00
/ * *
* Match the resource query of the module
* /
2018-09-18 21:17:44 +08:00
resourceQuery? : RuleSetConditionOrConditions ;
2018-05-08 12:04:57 +08:00
/ * *
* Match and execute these rules when this rule is matched
* /
rules? : RuleSetRules ;
2018-09-19 16:17:33 +08:00
/ * *
* Flags a module as with or without side effects
* /
sideEffects? : boolean ;
2018-05-08 12:04:57 +08:00
/ * *
* Shortcut for resource . test
* /
2018-09-21 17:00:44 +08:00
test? : RuleSetConditionOrConditionsAbsolute ;
2018-09-19 16:17:33 +08:00
/ * *
* Module type to use for the module
* /
type ? :
| "javascript/auto"
| "javascript/dynamic"
| "javascript/esm"
| "json"
| "webassembly/experimental" ;
2018-05-08 12:04:57 +08:00
/ * *
* Modifiers applied to the module when rule is matched
* /
use? : RuleSetUse ;
}
2018-09-18 19:57:44 +08:00
/ * *
* This interface was referenced by ` WebpackOptions ` ' s JSON - Schema
2018-09-19 16:37:53 +08:00
* via the ` definition ` "ResolveOptions" .
2018-09-18 19:57:44 +08:00
* /
2018-09-19 16:37:53 +08:00
export interface ResolveOptions {
2018-05-08 12:04:57 +08:00
/ * *
* Redirect module requests
* /
alias ? :
| {
/ * *
* New request
* /
[ k : string ] : string ;
}
| {
/ * *
* New request
* /
alias? : string ;
/ * *
* Request to be redirected
* /
name? : string ;
/ * *
* Redirect only exact matching request
* /
onlyModule? : boolean ;
} [ ] ;
/ * *
* Fields in the description file ( package . json ) which are used to redirect requests inside the module
* /
2018-09-19 16:37:53 +08:00
aliasFields? : ArrayOfStringOrStringArrayValues ;
2018-10-31 20:53:38 +08:00
/ * *
* Enable caching of successfully resolved requests ( cache entries are revalidated )
* /
cache? : boolean ;
2018-05-08 12:04:57 +08:00
/ * *
* Predicate function to decide which requests should be cached
* /
2018-09-19 18:59:48 +08:00
cachePredicate? : Function ;
2018-05-08 12:04:57 +08:00
/ * *
* Include the context information in the cache identifier when caching
* /
cacheWithContext? : boolean ;
/ * *
* Filenames used to find a description file
* /
2018-09-19 16:37:53 +08:00
descriptionFiles? : ArrayOfStringValues ;
2018-05-08 12:04:57 +08:00
/ * *
* Enforce using one of the extensions from the extensions option
* /
enforceExtension? : boolean ;
/ * *
* Enforce using one of the module extensions from the module Extensions option
* /
enforceModuleExtension? : boolean ;
/ * *
* Extensions added to the request when trying to find the file
* /
2018-09-19 16:37:53 +08:00
extensions? : ArrayOfStringValues ;
2018-05-08 12:04:57 +08:00
/ * *
* Filesystem for the resolver
* /
fileSystem ? : {
[ k : string ] : any ;
} ;
/ * *
* Field names from the description file ( package . json ) which are used to find the default entry point
* /
2018-09-19 16:37:53 +08:00
mainFields? : ArrayOfStringOrStringArrayValues ;
2018-05-08 12:04:57 +08:00
/ * *
* Filenames used to find the default entry point if there is no description file or main field
* /
2018-09-19 16:37:53 +08:00
mainFiles? : ArrayOfStringValues ;
2018-05-08 12:04:57 +08:00
/ * *
* Extensions added to the module request when trying to find the module
* /
2018-09-19 16:37:53 +08:00
module Extensions? : ArrayOfStringValues ;
2018-05-08 12:04:57 +08:00
/ * *
* Folder names or directory paths where to find module s
* /
2018-09-19 16:37:53 +08:00
module s? : ArrayOfStringValues ;
2018-05-08 12:04:57 +08:00
/ * *
* Plugins for the resolver
* /
2018-09-19 16:37:53 +08:00
plugins ? : ( WebpackPluginInstance | WebpackPluginFunction ) [ ] ;
2018-05-08 12:04:57 +08:00
/ * *
* Custom resolver
* /
resolver ? : {
[ k : string ] : any ;
} ;
/ * *
* Enable resolving symlinks to the original location
* /
symlinks? : boolean ;
/ * *
2018-10-31 20:53:38 +08:00
* Enable caching of successfully resolved requests ( cache entries are not revalidated )
2018-05-08 12:04:57 +08:00
* /
unsafeCache ? :
| boolean
| {
[ k : string ] : any ;
} ;
/ * *
* Use synchronous filesystem calls for the resolver
* /
useSyncFileSystemCalls? : boolean ;
}
/ * *
* Plugin instance
2018-09-18 19:57:44 +08:00
*
* This interface was referenced by ` WebpackOptions ` ' s JSON - Schema
2018-09-19 16:37:53 +08:00
* via the ` definition ` "WebpackPluginInstance" .
2018-05-08 12:04:57 +08:00
* /
2018-09-19 16:37:53 +08:00
export interface WebpackPluginInstance {
2018-05-08 12:04:57 +08:00
/ * *
* The run point of the plugin , required method .
* /
2018-09-18 21:17:44 +08:00
apply : ( compiler : import ( "../lib/Compiler" ) ) = > void ;
2018-05-08 12:04:57 +08:00
[ k : string ] : any ;
}
2018-09-18 19:57:44 +08:00
/ * *
* This interface was referenced by ` WebpackOptions ` ' s JSON - Schema
2018-09-19 16:37:53 +08:00
* via the ` definition ` "NodeOptions" .
2018-09-18 19:57:44 +08:00
* /
2018-09-19 16:37:53 +08:00
export interface NodeOptions {
2018-05-08 12:04:57 +08:00
/ * *
2018-09-19 16:37:53 +08:00
* Include a polyfill for the '__dirname' variable
2018-05-08 12:04:57 +08:00
* /
2018-09-19 16:37:53 +08:00
__dirname? : false | true | "mock" ;
2018-05-08 12:04:57 +08:00
/ * *
2018-09-19 16:37:53 +08:00
* Include a polyfill for the '__filename' variable
2018-05-08 12:04:57 +08:00
* /
2018-09-19 16:37:53 +08:00
__filename? : false | true | "mock" ;
2018-05-08 12:04:57 +08:00
/ * *
2018-09-19 16:37:53 +08:00
* Include a polyfill for the 'global' variable
2018-05-08 12:04:57 +08:00
* /
2018-09-19 16:37:53 +08:00
global ? : boolean ;
}
/ * *
* Enables / Disables integrated optimizations
*
* This interface was referenced by ` WebpackOptions ` ' s JSON - Schema
* via the ` definition ` "OptimizationOptions" .
* /
export interface OptimizationOptions {
/ * *
* Check for incompatible wasm types when importing / exporting from / to ESM
* /
checkWasmTypes? : boolean ;
/ * *
2018-12-07 19:26:35 +08:00
* 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 )
2018-09-19 16:37:53 +08:00
* /
2018-12-07 19:26:35 +08:00
chunkIds ? :
| "natural"
| "named"
| "deterministic"
| "size"
| "total-size"
| false ;
2018-09-19 16:37:53 +08:00
/ * *
* Concatenate module s when possible to generate less module s , more efficient code and enable more optimizations by the minimizer
* /
concatenateModules? : boolean ;
/ * *
* Also flag chunks as loaded which contain a subset of the module s
* /
flagIncludedChunks? : boolean ;
2019-01-28 17:40:32 +08:00
/ * *
* Rename exports when possible to generate shorter code ( depends on optimization . usedExports and optimization . providedExports )
* /
mangleExports? : boolean ;
2018-09-19 16:37:53 +08:00
/ * *
* Reduce size of WASM by changing imports to shorter strings .
* /
mangleWasmImports? : boolean ;
/ * *
* Merge chunks which contain the same module s
* /
mergeDuplicateChunks? : boolean ;
/ * *
* Enable minimizing the output . Uses optimization . minimizer .
* /
minimize? : boolean ;
/ * *
* Minimizer ( s ) to use for minimizing the output
* /
minimizer ? : ( WebpackPluginInstance | WebpackPluginFunction ) [ ] ;
/ * *
2018-10-12 22:53:14 +08:00
* 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 )
* /
module Ids? : "natural" | "named" | "hashed" | "deterministic" | "size" | false ;
2018-09-19 16:37:53 +08:00
/ * *
* Avoid emitting assets when errors occur
* /
noEmitOnErrors? : boolean ;
/ * *
* Set process . env . NODE_ENV to a specific value
* /
nodeEnv? : false | string ;
/ * *
* Generate records with relative paths to be able to move the context folder
* /
portableRecords? : boolean ;
/ * *
* Figure out which exports are provided by module s to generate more efficient code
* /
providedExports? : boolean ;
/ * *
* Removes module s from chunks when these module s are already included in all parents
* /
removeAvailableModules? : boolean ;
/ * *
* Remove chunks which are empty
* /
removeEmptyChunks? : boolean ;
/ * *
* Create an additional chunk which contains only the webpack runtime and chunk hash maps
* /
runtimeChunk ? :
| boolean
| ( "single" | "multiple" )
| {
/ * *
* The name or name factory for the runtime chunks
* /
2018-09-19 18:59:48 +08:00
name? : string | Function ;
2018-09-19 16:37:53 +08:00
} ;
/ * *
* Skip over module s which are flagged to contain no side effects when exports are not used
* /
sideEffects? : boolean ;
/ * *
* Optimize duplication and caching by splitting chunks by shared module s and cache group
* /
splitChunks? : false | OptimizationSplitChunksOptions ;
/ * *
* Figure out which exports are used by module s to mangle export names , omit unused exports and generate more efficient code
* /
usedExports? : boolean ;
}
/ * *
* This interface was referenced by ` WebpackOptions ` ' s JSON - Schema
* via the ` definition ` "OptimizationSplitChunksOptions" .
* /
export interface OptimizationSplitChunksOptions {
/ * *
* Sets the name delimiter for created chunks
* /
automaticNameDelimiter? : string ;
/ * *
* Assign module s to a cache group ( module s from different cache groups are tried to keep in separate chunks )
* /
cacheGroups ? : {
/ * *
* Configuration for a cache group
* /
[ k : string ] :
| false
2018-09-19 18:59:48 +08:00
| Function
| string
2018-09-21 14:39:15 +08:00
| RegExp
2018-12-11 03:50:37 +08:00
| OptimizationSplitChunksCacheGroup ;
2018-09-19 16:37:53 +08:00
} ;
/ * *
* Select chunks for determining shared module s ( defaults to "async" , "initial" and "all" requires adding these chunks to the HTML )
* /
2018-09-19 18:59:48 +08:00
chunks ? : ( "initial" | "async" | "all" ) | Function ;
2018-09-19 16:37:53 +08:00
/ * *
* Options for module s not selected by any other cache group
* /
fallbackCacheGroup ? : {
/ * *
* Sets the name delimiter for created chunks
* /
automaticNameDelimiter? : string ;
2018-12-12 03:47:50 +08:00
/ * *
* Maximal size hint for the on - demand chunks
* /
maxAsyncSize? : OptimizationSplitChunksSizes ;
/ * *
* Maximal size hint for the initial chunks
* /
maxInitialSize? : OptimizationSplitChunksSizes ;
2018-09-19 16:37:53 +08:00
/ * *
* Maximal size hint for the created chunks
* /
2018-12-04 23:40:06 +08:00
maxSize? : OptimizationSplitChunksSizes ;
2018-09-19 16:37:53 +08:00
/ * *
* Minimal size for the created chunk
* /
2018-12-04 23:40:06 +08:00
minSize? : OptimizationSplitChunksSizes ;
2018-09-19 16:37:53 +08:00
} ;
/ * *
* Sets the template for the filename for created chunks ( Only works for initial chunks )
* /
filename? : string ;
/ * *
* Prevents exposing path info when creating names for parts splitted by maxSize
* /
hidePathInfo? : boolean ;
/ * *
* Maximum number of requests which are accepted for on - demand loading
* /
maxAsyncRequests? : number ;
2018-12-11 03:50:37 +08:00
/ * *
* Maximal size hint for the on - demand chunks
* /
maxAsyncSize? : OptimizationSplitChunksSizes ;
2018-09-19 16:37:53 +08:00
/ * *
* Maximum number of initial chunks which are accepted for an entry point
* /
maxInitialRequests? : number ;
2018-12-11 03:50:37 +08:00
/ * *
* Maximal size hint for the initial chunks
* /
maxInitialSize? : OptimizationSplitChunksSizes ;
2018-09-19 16:37:53 +08:00
/ * *
* Maximal size hint for the created chunks
* /
2018-12-04 23:40:06 +08:00
maxSize? : OptimizationSplitChunksSizes ;
2018-09-19 16:37:53 +08:00
/ * *
* Minimum number of times a module has to be duplicated until it ' s considered for splitting
* /
minChunks? : number ;
2019-05-13 19:10:23 +08:00
/ * *
* Minimal size for the chunks the stay after moving the module s to a new chunk
* /
minRemainingSize? : OptimizationSplitChunksSizes ;
2018-09-19 16:37:53 +08:00
/ * *
* Minimal size for the created chunks
* /
2018-12-04 23:40:06 +08:00
minSize? : OptimizationSplitChunksSizes ;
2018-09-19 16:37:53 +08:00
/ * *
* Give chunks created a name ( chunks with equal name are merged )
* /
2018-12-07 19:26:35 +08:00
name? : false | Function | string ;
2018-09-19 16:37:53 +08:00
}
/ * *
* This interface was referenced by ` WebpackOptions ` ' s JSON - Schema
2018-12-11 03:50:37 +08:00
* via the ` definition ` "OptimizationSplitChunksCacheGroup" .
* /
export interface OptimizationSplitChunksCacheGroup {
/ * *
* Sets the name delimiter for created chunks
* /
automaticNameDelimiter? : string ;
/ * *
* Select chunks for determining cache group content ( defaults to "initial" , "initial" and "all" requires adding these chunks to the HTML )
* /
2018-12-12 17:46:44 +08:00
chunks ? :
| ( "initial" | "async" | "all" )
| OptimizationSplitChunksGetCacheGroups ;
2018-12-11 03:50:37 +08:00
/ * *
* Ignore minimum size , minimum chunks and maximum requests and always create chunks for this cache group
* /
enforce? : boolean ;
/ * *
* Sets the template for the filename for created chunks ( Only works for initial chunks )
* /
filename? : string ;
/ * *
* Sets the hint for chunk id
* /
idHint? : string ;
/ * *
* Maximum number of requests which are accepted for on - demand loading
* /
maxAsyncRequests? : number ;
2018-12-12 03:47:50 +08:00
/ * *
* Maximal size hint for the on - demand chunks
* /
maxAsyncSize? : OptimizationSplitChunksSizes ;
2018-12-11 03:50:37 +08:00
/ * *
* Maximum number of initial chunks which are accepted for an entry point
* /
maxInitialRequests? : number ;
2018-12-12 03:47:50 +08:00
/ * *
* Maximal size hint for the initial chunks
* /
maxInitialSize? : OptimizationSplitChunksSizes ;
2018-12-11 03:50:37 +08:00
/ * *
* Maximal size hint for the created chunks
* /
maxSize? : OptimizationSplitChunksSizes ;
/ * *
* Minimum number of times a module has to be duplicated until it ' s considered for splitting
* /
minChunks? : number ;
2019-05-13 19:10:23 +08:00
/ * *
* Minimal size for the chunks the stay after moving the module s to a new chunk
* /
minRemainingSize? : OptimizationSplitChunksSizes ;
2018-12-11 03:50:37 +08:00
/ * *
* Minimal size for the created chunk
* /
minSize? : OptimizationSplitChunksSizes ;
/ * *
* Give chunks for this cache group a name ( chunks with equal name are merged )
* /
name? : false | Function | string ;
/ * *
* Priority of this cache group
* /
priority? : number ;
/ * *
* Try to reuse existing chunk ( with name ) when it has matching module s
* /
reuseExistingChunk? : boolean ;
/ * *
* Assign module s to a cache group by module name
* /
test? : Function | string | RegExp ;
/ * *
* Assign module s to a cache group by module type
* /
type ? : Function | string | RegExp ;
}
2018-09-19 16:37:53 +08:00
/ * *
* This interface was referenced by ` WebpackOptions ` ' s JSON - Schema
* via the ` definition ` "OutputOptions" .
* /
export interface OutputOptions {
/ * *
* Add a comment in the UMD wrapper .
* /
auxiliaryComment ? :
| string
| {
/ * *
* Set comment for ` amd ` section in UMD
* /
amd? : string ;
/ * *
* Set comment for ` commonjs ` ( exports ) section in UMD
* /
commonjs? : string ;
/ * *
* Set comment for ` commonjs2 ` ( module .exports ) section in UMD
* /
commonjs2? : string ;
/ * *
* Set comment for ` root ` ( global variable ) section in UMD
* /
root? : string ;
} ;
/ * *
* The callback function name used by webpack for loading of chunks in WebWorkers .
* /
chunkCallbackName? : string ;
/ * *
* The filename of non - entry chunks as relative path inside the ` output.path ` directory .
* /
chunkFilename? : string ;
/ * *
* Number of milliseconds before chunk request expires
* /
chunkLoadTimeout? : number ;
/ * *
* This option enables cross - origin loading of chunks .
* /
crossOriginLoading? : false | "anonymous" | "use-credentials" ;
/ * *
* Similar to ` output.devtoolModuleFilenameTemplate ` , but used in the case of duplicate module identifiers.
* /
2018-09-19 18:59:48 +08:00
devtoolFallbackModuleFilenameTemplate? : string | Function ;
2018-05-08 12:04:57 +08:00
/ * *
* Filename template string of function for the sources array in a generated SourceMap .
* /
2018-09-19 18:59:48 +08:00
devtoolModuleFilenameTemplate? : string | Function ;
2018-05-08 12:04:57 +08:00
/ * *
* 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 .
* /
devtoolNamespace? : string ;
/ * *
* Specifies the name of each output file on disk . You must * * not * * specify an absolute path here ! The ` output.path ` option determines the location on disk the files are written to , filename is used solely for naming the individual files .
* /
2018-09-19 18:59:48 +08:00
filename? : string | Function ;
2018-09-19 16:17:33 +08:00
/ * *
* An expression which is used to address the global object / scope in runtime code
* /
globalObject? : string ;
2018-05-08 12:04:57 +08:00
/ * *
* Digest type used for the hash
* /
hashDigest? : string ;
/ * *
* Number of chars which are used for the hash
* /
hashDigestLength? : number ;
/ * *
* Algorithm used for generation the hash ( see node . js crypto package )
* /
2018-09-19 16:37:53 +08:00
hashFunction? : string | ( new ( ) = > import ( "../lib/util/createHash" ) . Hash ) ;
2018-05-08 12:04:57 +08:00
/ * *
* Any string which is added to the hash to salt it
* /
hashSalt? : string ;
/ * *
* The filename of the Hot Update Chunks . They are inside the output . path directory .
* /
2018-09-25 22:07:42 +08:00
hotUpdateChunkFilename? : string ;
2018-05-08 12:04:57 +08:00
/ * *
* The JSONP function used by webpack for async loading of hot update chunks .
* /
hotUpdateFunction? : string ;
/ * *
* The filename of the Hot Update Main File . It is inside the ` output.path ` directory .
* /
2018-09-25 22:07:42 +08:00
hotUpdateMainFilename? : string ;
2018-05-08 12:04:57 +08:00
/ * *
* The JSONP function used by webpack for async loading of chunks .
* /
jsonpFunction? : string ;
/ * *
2018-09-19 16:17:33 +08:00
* This option enables loading async chunks via a custom script type , such as script type = "module"
2018-05-08 12:04:57 +08:00
* /
2018-09-19 16:17:33 +08:00
jsonpScriptType? : false | "text/javascript" | "module" ;
2018-05-08 12:04:57 +08:00
/ * *
* If set , export the bundle as library . ` output.library ` is the name .
* /
2018-09-19 18:59:48 +08:00
library? : string | string [ ] | LibraryCustomUmdObject ;
2018-09-19 16:17:33 +08:00
/ * *
* Specify which export should be exposed as library
* /
2018-09-19 16:37:53 +08:00
libraryExport? : string | ArrayOfStringValues ;
2018-05-08 12:04:57 +08:00
/ * *
* Type of library
* /
libraryTarget ? :
| "var"
| "assign"
| "this"
| "window"
| "self"
| "global"
| "commonjs"
| "commonjs2"
| "commonjs-module"
| "amd"
2018-09-27 01:41:22 +08:00
| "amd-require"
2018-05-08 12:04:57 +08:00
| "umd"
| "umd2"
2019-03-02 05:26:36 +08:00
| "jsonp"
| "system" ;
2018-05-08 12:04:57 +08:00
/ * *
* The output directory as * * absolute path * * ( required ) .
* /
path? : string ;
/ * *
* Include comments with information about the module s.
* /
pathinfo? : boolean ;
/ * *
* The ` publicPath ` specifies the public URL address of the output files when referenced in a browser .
* /
2018-09-19 18:59:48 +08:00
publicPath? : string | Function ;
2018-05-08 12:04:57 +08:00
/ * *
* The filename of the SourceMaps for the JavaScript files . They are inside the ` output.path ` directory .
* /
sourceMapFilename? : string ;
/ * *
* Prefixes every line of the source in the bundle with this string .
* /
sourcePrefix? : string ;
/ * *
* Handles exceptions in module loading correctly at a performance cost .
* /
strictModuleExceptionHandling? : boolean ;
/ * *
* If ` output.libraryTarget ` is set to umd and ` output.library ` is set , setting this to true will name the AMD module .
* /
umdNamedDefine? : boolean ;
2018-09-19 16:17:33 +08:00
/ * *
* The filename of WebAssembly module s as relative path inside the ` output.path ` directory .
* /
webassemblyModuleFilename? : string ;
2018-05-08 12:04:57 +08:00
}
2018-09-19 18:59:48 +08:00
/ * *
* This interface was referenced by ` WebpackOptions ` ' s JSON - Schema
* via the ` definition ` "LibraryCustomUmdObject" .
* /
export interface LibraryCustomUmdObject {
/ * *
* Name of the exposed AMD library in the UMD
* /
amd? : string ;
/ * *
* Name of the exposed commonjs export in the UMD
* /
commonjs? : string ;
/ * *
* Name of the property exposed globally by a UMD library
* /
root? : string | ArrayOfStringValues ;
}
2018-09-19 16:37:53 +08:00
/ * *
* This interface was referenced by ` WebpackOptions ` ' s JSON - Schema
* via the ` definition ` "PerformanceOptions" .
* /
export interface PerformanceOptions {
/ * *
* Filter function to select assets that are checked
* /
2018-09-19 18:59:48 +08:00
assetFilter? : Function ;
2018-09-19 16:37:53 +08:00
/ * *
* Sets the format of the hints : warnings , errors or nothing at all
* /
hints? : false | "warning" | "error" ;
/ * *
* Filesize limit ( in bytes ) when exceeded , that webpack will provide performance hints
* /
maxAssetSize? : number ;
/ * *
* Total size of an entry point ( in bytes )
* /
maxEntrypointSize? : number ;
}
/ * *
* This interface was referenced by ` WebpackOptions ` ' s JSON - Schema
* via the ` definition ` "StatsOptions" .
* /
export interface StatsOptions {
/ * *
* fallback value for stats options when an option is not defined ( has precedence over local webpack defaults )
* /
all? : boolean ;
/ * *
* add assets information
* /
assets? : boolean ;
/ * *
* sort the assets by that field
* /
assetsSort? : string ;
/ * *
* add built at time information
* /
builtAt? : boolean ;
/ * *
2018-09-25 22:07:42 +08:00
* add information about cached ( not built ) module s
2018-09-19 16:37:53 +08:00
* /
cached? : boolean ;
/ * *
* Show cached assets ( setting this to ` false ` only shows emitted files )
* /
cachedAssets? : boolean ;
/ * *
* add children information
* /
children? : boolean ;
/ * *
* Display all chunk groups with the corresponding bundles
* /
chunkGroups? : boolean ;
/ * *
* add built module s information to chunk information
* /
chunkModules? : boolean ;
/ * *
* add the origins of chunks and chunk merging info
* /
chunkOrigins? : boolean ;
2018-12-22 20:19:13 +08:00
/ * *
* add information about parent , children and sibling chunks to chunk information
* /
chunkRelations? : boolean ;
2018-12-06 19:30:22 +08:00
/ * *
* add root module s information to chunk information
* /
chunkRootModules? : boolean ;
2018-09-19 16:37:53 +08:00
/ * *
* add chunk information
* /
chunks? : boolean ;
/ * *
* sort the chunks by that field
* /
chunksSort? : string ;
/ * *
* Enables / Disables colorful output
* /
colors ? :
| boolean
| {
/ * *
* Custom color for bold text
* /
bold? : string ;
/ * *
* Custom color for cyan text
* /
cyan? : string ;
/ * *
* Custom color for green text
* /
green? : string ;
/ * *
* Custom color for magenta text
* /
magenta? : string ;
/ * *
* Custom color for red text
* /
red? : string ;
/ * *
* Custom color for yellow text
* /
yellow? : string ;
} ;
/ * *
* context directory for request shortening
* /
context? : string ;
/ * *
* add module depth in module graph
* /
depth? : boolean ;
/ * *
* Display the entry points with the corresponding bundles
* /
entrypoints? : boolean ;
/ * *
* add -- env information
* /
env? : boolean ;
/ * *
* add details to errors ( like resolving log )
* /
errorDetails? : boolean ;
/ * *
* add errors
* /
errors? : boolean ;
/ * *
* Please use excludeModules instead .
* /
exclude? : FilterTypes | boolean ;
/ * *
* Suppress assets that match the specified filters . Filters can be Strings , RegExps or Functions
* /
excludeAssets? : FilterTypes ;
/ * *
* Suppress module s that match the specified filters . Filters can be Strings , RegExps , Booleans or Functions
* /
excludeModules? : FilterTypes | boolean ;
/ * *
* add the hash of the compilation
* /
hash? : boolean ;
/ * *
* Set the maximum number of module s to be shown
* /
maxModules? : number ;
/ * *
* add information about assets inside module s
* /
module Assets? : boolean ;
/ * *
* add dependencies and origin of warnings / errors
* /
module Trace? : boolean ;
/ * *
* add built module s information
* /
module s? : boolean ;
/ * *
* sort the module s by that field
* /
module sSort? : string ;
/ * *
* add information about module s nested in other module s ( like with module concatenation )
* /
nestedModules? : boolean ;
/ * *
* show reasons why optimization bailed out for module s
* /
optimizationBailout? : boolean ;
2018-09-25 22:07:42 +08:00
/ * *
* add information about orphan module s
* /
orphanModules? : boolean ;
2018-09-19 16:37:53 +08:00
/ * *
* Add output path information
* /
outputPath? : boolean ;
/ * *
* add performance hint flags
* /
performance? : boolean ;
2018-12-22 18:58:29 +08:00
/ * *
* preset for the default values
* /
preset? : boolean | string ;
2018-09-19 16:37:53 +08:00
/ * *
* show exports provided by module s
* /
providedExports? : boolean ;
/ * *
* Add public path information
* /
publicPath? : boolean ;
/ * *
* add information about the reasons why module s are included
* /
reasons? : boolean ;
2018-11-28 20:07:40 +08:00
/ * *
* add information about runtime module s
* /
runtime? : boolean ;
2018-09-19 16:37:53 +08:00
/ * *
* add the source code of module s
* /
source? : boolean ;
/ * *
* add timing information
* /
timings? : boolean ;
/ * *
* show exports used by module s
* /
usedExports? : boolean ;
/ * *
* add webpack version information
* /
version? : boolean ;
/ * *
* add warnings
* /
warnings? : boolean ;
/ * *
* Suppress warnings that match the specified filters . Filters can be Strings , RegExps or Functions
* /
warningsFilter? : FilterTypes ;
}
2018-12-10 18:34:59 +08:00
/ * *
* This interface was referenced by ` WebpackOptions ` ' s JSON - Schema
* via the ` definition ` "WatchOptions" .
* /
export interface WatchOptions {
/ * *
* Delay the rebuilt after the first change . Value is a time in ms .
* /
aggregateTimeout? : number ;
/ * *
* Ignore some files from watching
* /
ignored ? : {
[ k : string ] : any ;
} ;
/ * *
* Enable polling mode for watching
* /
poll? : boolean | number ;
/ * *
* Stop watching when stdin stream has ended
* /
stdin? : boolean ;
}