Interface Configuration

Options object as provided by the user.

Hierarchy

  • Configuration

Properties

amd? bail? cache? context? dependencies? devtool? entry? experiments? extends? externals? externalsPresets? externalsType? ignoreWarnings? infrastructureLogging? loader? mode? module? name? node? optimization? output? parallelism? performance? plugins? profile? recordsInputPath? recordsOutputPath? recordsPath? resolve? resolveLoader? snapshot? stats? target? watch? watchOptions?

Properties

Optional amd

amd?: false | {
    [index: string]: any;
}

Set the value of require.amd and define.amd. Or disable AMD support.

Type declaration

  • [index: string]: any

Optional bail

bail?: boolean

Report the first error as a hard error instead of tolerating it.

Optional cache

cache?: boolean | FileCacheOptions | MemoryCacheOptions

Cache generated modules and chunks to improve performance for multiple incremental builds.

Optional context

context?: string

The base directory (absolute path!) for resolving the entry option. If output.pathinfo is set, the included pathinfo is shortened to this directory.

Optional dependencies

dependencies?: string[]

References to other configurations to depend on.

Optional devtool

devtool?: string | false

A developer tool to enhance debugging (false | eval | [inline-|hidden-|eval-][nosources-][cheap-[module-]]source-map).

Optional entry

entry?: string | string[] | (() => string | string[] | EntryObject | Promise<EntryStatic>) | EntryObject

The entry point(s) of the compilation.

Type declaration

Optional experiments

experiments?: Experiments

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

Optional extends

extends?: string | string[]

Extend configuration from another configuration (only works when using webpack-cli).

Optional externals

externals?: string | RegExp | ExternalItemObjectKnown & ExternalItemObjectUnknown | ExternalItem[] | ((data, callback) => void) | ((data) => Promise<ExternalItemValue>)

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.

Type declaration

    • (data, callback): void

    • Parameters

      • data: ExternalItemFunctionData
      • callback: ((err?, result?) => void)
          • (err?, result?): void

          • Parameters

            • Optional err: Error
            • Optional result: string | boolean | string[] | {
                  [index: string]: any;
              }

            Returns void

      Returns void

Type declaration

Optional externalsPresets

externalsPresets?: ExternalsPresets

Enable presets of externals for specific targets.

Optional externalsType

externalsType?: "script" | "var" | "promise" | "import" | "module" | "assign" | "this" | "window" | "self" | "global" | "commonjs" | "commonjs2" | "commonjs-module" | "commonjs-static" | "amd" | "amd-require" | "umd" | "umd2" | "jsonp" | "system" | "node-commonjs"

Specifies the default type of externals ('amd*', 'umd*', 'system' and 'jsonp' depend on output.libraryTarget set to the same value).

Optional ignoreWarnings

ignoreWarnings?: (RegExp | {
    file?: RegExp;
    message?: RegExp;
    module?: RegExp;
} | ((warning, compilation) => boolean))[]

Ignore specific warnings.

Optional infrastructureLogging

infrastructureLogging?: InfrastructureLogging

Options for infrastructure level logging.

Optional loader

loader?: Loader

Custom values available in the loader context.

Optional mode

mode?: "development" | "none" | "production"

Enable production optimizations or development hints.

Optional module

module?: ModuleOptions

Options affecting the normal modules (NormalModuleFactory).

Optional name

name?: string

Name of the configuration. Used when loading multiple configurations.

Optional node

node?: false | NodeOptions

Include polyfills or mocks for various node stuff.

Optional optimization

optimization?: Optimization

Enables/Disables integrated optimizations.

Optional output

output?: Output

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

Optional parallelism

parallelism?: number

The number of parallel processed modules in the compilation.

Optional performance

performance?: false | PerformanceOptions

Configuration for web performance recommendations.

Optional plugins

plugins?: (WebpackPluginInstance | ((this, compiler) => void))[]

Add additional plugins to the compiler.

Optional profile

profile?: boolean

Capture timing information for each module.

Optional recordsInputPath

recordsInputPath?: string | false

Store compiler state to a json file.

Optional recordsOutputPath

recordsOutputPath?: string | false

Load compiler state from a json file.

Optional recordsPath

recordsPath?: string | false

Store/Load compiler state from/to a json file. This will result in persistent ids of modules and chunks. An absolute path is expected. recordsPath is used for recordsInputPath and recordsOutputPath if they left undefined.

Optional resolve

resolve?: ResolveOptionsWebpackOptions

Options for the resolver.

Optional resolveLoader

resolveLoader?: ResolveOptionsWebpackOptions

Options for the resolver when resolving loaders.

Optional snapshot

snapshot?: SnapshotOptions

Options affecting how file system snapshots are created and validated.

Optional stats

stats?: boolean | "summary" | "none" | StatsOptions | "verbose" | "errors-only" | "errors-warnings" | "minimal" | "normal" | "detailed"

Stats options object or preset name.

Optional target

target?: string | false | string[]

Environment to build for. An array of environments to build for all of them when possible.

Optional watch

watch?: boolean

Enter watch mode, which rebuilds on file change.

Optional watchOptions

watchOptions?: WatchOptions

Options for the watcher.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc