From 776c74ea7e28bcb90a41f762cc873d121a6aa6bd Mon Sep 17 00:00:00 2001 From: avivkeller Date: Fri, 6 Mar 2026 09:46:54 -0500 Subject: [PATCH 1/5] [WIP] API generation --- .gitignore | 1 + api/README.md | 94 + api/cli/commands.mdx | 268 -- api/cli/flags.mdx | 492 ---- api/compilation.mdx | 541 ----- api/compiler.mdx | 410 ---- api/interfaces/Argument.md | 45 + api/interfaces/Asset.md | 43 + api/interfaces/AssetEmittedInfo.md | 53 + api/interfaces/ColorsOptions.md | 23 + api/interfaces/Configuration.md | 395 +++ api/interfaces/EntryObject.md | 21 + api/interfaces/ExternalItemFunctionData.md | 63 + api/interfaces/ExternalItemObjectKnown.md | 25 + api/interfaces/ExternalItemObjectUnknown.md | 19 + api/interfaces/FileCacheOptions.md | 221 ++ .../GeneratorOptionsByModuleTypeKnown.md | 155 ++ api/interfaces/InputFileSystem.md | 195 ++ api/interfaces/LibraryOptions.md | 75 + api/interfaces/MemoryCacheOptions.md | 45 + api/interfaces/ModuleOptions.md | 205 ++ api/interfaces/MultiCompilerOptions.md | 23 + api/interfaces/ObjectDeserializerContext.md | 43 + api/interfaces/ObjectSerializerContext.md | 119 + api/interfaces/OutputFileSystem.md | 147 ++ .../ParserOptionsByModuleTypeKnown.md | 155 ++ api/interfaces/PathData.md | 133 + api/interfaces/Problem.md | 61 + api/interfaces/RenderManifestOptions.md | 99 + api/interfaces/ResolveData.md | 119 + api/interfaces/ResolveOptions.md | 347 +++ api/interfaces/RuleSetRule.md | 325 +++ api/interfaces/StatsOptions.md | 847 +++++++ api/interfaces/WebpackOptionsNormalized.md | 375 +++ api/interfaces/WebpackPluginInstance.md | 29 + api/loaders/api.mdx | 931 ------- api/loaders/overview.mdx | 371 --- api/loaders/pitching.mdx | 584 ----- api/module-methods/import.mdx | 364 --- api/module-methods/module-variables.mdx | 589 ----- api/module-methods/require-context.mdx | 547 ----- api/module-methods/require.mdx | 440 ---- api/node.mdx | 233 -- api/plugins/compilation-hooks.mdx | 785 ------ api/plugins/compiler-hooks.mdx | 560 ----- api/plugins/module-factories.mdx | 517 ---- api/plugins/overview.mdx | 192 -- api/plugins/parser.mdx | 719 ------ api/plugins/tapable.mdx | 574 ----- api/resolvers.mdx | 493 ---- api/stats.mdx | 498 ---- api/type-aliases/AssetInfo.md | 17 + api/type-aliases/ChunkGroup.md | 17 + api/type-aliases/CodeGenerationResults.md | 17 + api/type-aliases/Colors.md | 183 ++ api/type-aliases/Entry.md | 17 + api/type-aliases/EntryNormalized.md | 17 + api/type-aliases/EntryOptions.md | 23 + api/type-aliases/Entrypoint.md | 17 + api/type-aliases/ExternalItem.md | 17 + api/type-aliases/ExternalItemFunction.md | 17 + .../ExternalItemFunctionCallback.md | 31 + .../ExternalItemFunctionDataGetResolve.md | 27 + ...temFunctionDataGetResolveCallbackResult.md | 35 + ...xternalItemFunctionDataGetResolveResult.md | 31 + .../ExternalItemFunctionPromise.md | 27 + api/type-aliases/ExternalItemValue.md | 17 + api/type-aliases/Externals.md | 17 + api/type-aliases/MultiConfiguration.md | 17 + api/type-aliases/MultiStats.md | 17 + api/type-aliases/MultiStatsOptions.md | 17 + api/type-aliases/ParserState.md | 17 + api/type-aliases/RenderManifestEntry.md | 17 + api/type-aliases/ResolvePluginInstance.md | 57 + api/type-aliases/Resolver.md | 17 + api/type-aliases/RuleSetCondition.md | 17 + api/type-aliases/RuleSetConditionAbsolute.md | 17 + api/type-aliases/RuleSetUse.md | 17 + api/type-aliases/RuleSetUseFunction.md | 17 + api/type-aliases/RuleSetUseItem.md | 43 + api/type-aliases/StatsAsset.md | 17 + api/type-aliases/StatsChunk.md | 17 + api/type-aliases/StatsChunkGroup.md | 17 + api/type-aliases/StatsChunkOrigin.md | 17 + api/type-aliases/StatsCompilation.md | 17 + api/type-aliases/StatsError.md | 17 + api/type-aliases/StatsLogging.md | 17 + api/type-aliases/StatsLoggingEntry.md | 17 + api/type-aliases/StatsModule.md | 17 + api/type-aliases/StatsModuleIssuer.md | 17 + api/type-aliases/StatsModuleReason.md | 17 + .../StatsModuleTraceDependency.md | 17 + api/type-aliases/StatsModuleTraceItem.md | 17 + api/type-aliases/StatsProfile.md | 17 + api/type-aliases/TemplatePath.md | 17 + api/type-aliases/Watching.md | 17 + api/type-aliases/WebpackPluginFunction.md | 17 + api/variables/export=.md | 2154 +++++++++++++++++ package-lock.json | 1223 ++++++++++ package.json | 9 + scripts/typedoc/generate-markdown.mjs | 21 + scripts/typedoc/postprocessor.mjs | 17 + scripts/typedoc/tsconfig.json | 10 + 103 files changed, 9020 insertions(+), 10108 deletions(-) create mode 100644 .gitignore create mode 100644 api/README.md delete mode 100644 api/cli/commands.mdx delete mode 100644 api/cli/flags.mdx delete mode 100644 api/compilation.mdx delete mode 100644 api/compiler.mdx create mode 100644 api/interfaces/Argument.md create mode 100644 api/interfaces/Asset.md create mode 100644 api/interfaces/AssetEmittedInfo.md create mode 100644 api/interfaces/ColorsOptions.md create mode 100644 api/interfaces/Configuration.md create mode 100644 api/interfaces/EntryObject.md create mode 100644 api/interfaces/ExternalItemFunctionData.md create mode 100644 api/interfaces/ExternalItemObjectKnown.md create mode 100644 api/interfaces/ExternalItemObjectUnknown.md create mode 100644 api/interfaces/FileCacheOptions.md create mode 100644 api/interfaces/GeneratorOptionsByModuleTypeKnown.md create mode 100644 api/interfaces/InputFileSystem.md create mode 100644 api/interfaces/LibraryOptions.md create mode 100644 api/interfaces/MemoryCacheOptions.md create mode 100644 api/interfaces/ModuleOptions.md create mode 100644 api/interfaces/MultiCompilerOptions.md create mode 100644 api/interfaces/ObjectDeserializerContext.md create mode 100644 api/interfaces/ObjectSerializerContext.md create mode 100644 api/interfaces/OutputFileSystem.md create mode 100644 api/interfaces/ParserOptionsByModuleTypeKnown.md create mode 100644 api/interfaces/PathData.md create mode 100644 api/interfaces/Problem.md create mode 100644 api/interfaces/RenderManifestOptions.md create mode 100644 api/interfaces/ResolveData.md create mode 100644 api/interfaces/ResolveOptions.md create mode 100644 api/interfaces/RuleSetRule.md create mode 100644 api/interfaces/StatsOptions.md create mode 100644 api/interfaces/WebpackOptionsNormalized.md create mode 100644 api/interfaces/WebpackPluginInstance.md delete mode 100644 api/loaders/api.mdx delete mode 100644 api/loaders/overview.mdx delete mode 100644 api/loaders/pitching.mdx delete mode 100644 api/module-methods/import.mdx delete mode 100644 api/module-methods/module-variables.mdx delete mode 100644 api/module-methods/require-context.mdx delete mode 100644 api/module-methods/require.mdx delete mode 100644 api/node.mdx delete mode 100644 api/plugins/compilation-hooks.mdx delete mode 100644 api/plugins/compiler-hooks.mdx delete mode 100644 api/plugins/module-factories.mdx delete mode 100644 api/plugins/overview.mdx delete mode 100644 api/plugins/parser.mdx delete mode 100644 api/plugins/tapable.mdx delete mode 100644 api/resolvers.mdx delete mode 100644 api/stats.mdx create mode 100644 api/type-aliases/AssetInfo.md create mode 100644 api/type-aliases/ChunkGroup.md create mode 100644 api/type-aliases/CodeGenerationResults.md create mode 100644 api/type-aliases/Colors.md create mode 100644 api/type-aliases/Entry.md create mode 100644 api/type-aliases/EntryNormalized.md create mode 100644 api/type-aliases/EntryOptions.md create mode 100644 api/type-aliases/Entrypoint.md create mode 100644 api/type-aliases/ExternalItem.md create mode 100644 api/type-aliases/ExternalItemFunction.md create mode 100644 api/type-aliases/ExternalItemFunctionCallback.md create mode 100644 api/type-aliases/ExternalItemFunctionDataGetResolve.md create mode 100644 api/type-aliases/ExternalItemFunctionDataGetResolveCallbackResult.md create mode 100644 api/type-aliases/ExternalItemFunctionDataGetResolveResult.md create mode 100644 api/type-aliases/ExternalItemFunctionPromise.md create mode 100644 api/type-aliases/ExternalItemValue.md create mode 100644 api/type-aliases/Externals.md create mode 100644 api/type-aliases/MultiConfiguration.md create mode 100644 api/type-aliases/MultiStats.md create mode 100644 api/type-aliases/MultiStatsOptions.md create mode 100644 api/type-aliases/ParserState.md create mode 100644 api/type-aliases/RenderManifestEntry.md create mode 100644 api/type-aliases/ResolvePluginInstance.md create mode 100644 api/type-aliases/Resolver.md create mode 100644 api/type-aliases/RuleSetCondition.md create mode 100644 api/type-aliases/RuleSetConditionAbsolute.md create mode 100644 api/type-aliases/RuleSetUse.md create mode 100644 api/type-aliases/RuleSetUseFunction.md create mode 100644 api/type-aliases/RuleSetUseItem.md create mode 100644 api/type-aliases/StatsAsset.md create mode 100644 api/type-aliases/StatsChunk.md create mode 100644 api/type-aliases/StatsChunkGroup.md create mode 100644 api/type-aliases/StatsChunkOrigin.md create mode 100644 api/type-aliases/StatsCompilation.md create mode 100644 api/type-aliases/StatsError.md create mode 100644 api/type-aliases/StatsLogging.md create mode 100644 api/type-aliases/StatsLoggingEntry.md create mode 100644 api/type-aliases/StatsModule.md create mode 100644 api/type-aliases/StatsModuleIssuer.md create mode 100644 api/type-aliases/StatsModuleReason.md create mode 100644 api/type-aliases/StatsModuleTraceDependency.md create mode 100644 api/type-aliases/StatsModuleTraceItem.md create mode 100644 api/type-aliases/StatsProfile.md create mode 100644 api/type-aliases/TemplatePath.md create mode 100644 api/type-aliases/Watching.md create mode 100644 api/type-aliases/WebpackPluginFunction.md create mode 100644 api/variables/export=.md create mode 100644 package-lock.json create mode 100644 package.json create mode 100644 scripts/typedoc/generate-markdown.mjs create mode 100644 scripts/typedoc/postprocessor.mjs create mode 100644 scripts/typedoc/tsconfig.json diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..b512c09 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +node_modules \ No newline at end of file diff --git a/api/README.md b/api/README.md new file mode 100644 index 0000000..7cc1db8 --- /dev/null +++ b/api/README.md @@ -0,0 +1,94 @@ +--- +title: webpack +--- + +**webpack** + +*** + +# webpack + +## Interfaces + +- [Argument](interfaces/Argument.md) +- [Asset](interfaces/Asset.md) +- [AssetEmittedInfo](interfaces/AssetEmittedInfo.md) +- [ColorsOptions](interfaces/ColorsOptions.md) +- [Configuration](interfaces/Configuration.md) +- [EntryObject](interfaces/EntryObject.md) +- [ExternalItemFunctionData](interfaces/ExternalItemFunctionData.md) +- [ExternalItemObjectKnown](interfaces/ExternalItemObjectKnown.md) +- [ExternalItemObjectUnknown](interfaces/ExternalItemObjectUnknown.md) +- [FileCacheOptions](interfaces/FileCacheOptions.md) +- [GeneratorOptionsByModuleTypeKnown](interfaces/GeneratorOptionsByModuleTypeKnown.md) +- [InputFileSystem](interfaces/InputFileSystem.md) +- [LibraryOptions](interfaces/LibraryOptions.md) +- [MemoryCacheOptions](interfaces/MemoryCacheOptions.md) +- [ModuleOptions](interfaces/ModuleOptions.md) +- [MultiCompilerOptions](interfaces/MultiCompilerOptions.md) +- [ObjectDeserializerContext](interfaces/ObjectDeserializerContext.md) +- [ObjectSerializerContext](interfaces/ObjectSerializerContext.md) +- [OutputFileSystem](interfaces/OutputFileSystem.md) +- [ParserOptionsByModuleTypeKnown](interfaces/ParserOptionsByModuleTypeKnown.md) +- [PathData](interfaces/PathData.md) +- [Problem](interfaces/Problem.md) +- [RenderManifestOptions](interfaces/RenderManifestOptions.md) +- [ResolveData](interfaces/ResolveData.md) +- [ResolveOptions](interfaces/ResolveOptions.md) +- [RuleSetRule](interfaces/RuleSetRule.md) +- [StatsOptions](interfaces/StatsOptions.md) +- [WebpackOptionsNormalized](interfaces/WebpackOptionsNormalized.md) +- [WebpackPluginInstance](interfaces/WebpackPluginInstance.md) + +## Type Aliases + +- [AssetInfo](type-aliases/AssetInfo.md) +- [ChunkGroup](type-aliases/ChunkGroup.md) +- [CodeGenerationResults](type-aliases/CodeGenerationResults.md) +- [Colors](type-aliases/Colors.md) +- [Entry](type-aliases/Entry.md) +- [EntryNormalized](type-aliases/EntryNormalized.md) +- [EntryOptions](type-aliases/EntryOptions.md) +- [Entrypoint](type-aliases/Entrypoint.md) +- [ExternalItem](type-aliases/ExternalItem.md) +- [ExternalItemFunction](type-aliases/ExternalItemFunction.md) +- [ExternalItemFunctionCallback](type-aliases/ExternalItemFunctionCallback.md) +- [ExternalItemFunctionDataGetResolve](type-aliases/ExternalItemFunctionDataGetResolve.md) +- [ExternalItemFunctionDataGetResolveCallbackResult](type-aliases/ExternalItemFunctionDataGetResolveCallbackResult.md) +- [ExternalItemFunctionDataGetResolveResult](type-aliases/ExternalItemFunctionDataGetResolveResult.md) +- [ExternalItemFunctionPromise](type-aliases/ExternalItemFunctionPromise.md) +- [ExternalItemValue](type-aliases/ExternalItemValue.md) +- [Externals](type-aliases/Externals.md) +- [MultiConfiguration](type-aliases/MultiConfiguration.md) +- [MultiStats](type-aliases/MultiStats.md) +- [MultiStatsOptions](type-aliases/MultiStatsOptions.md) +- [ParserState](type-aliases/ParserState.md) +- [RenderManifestEntry](type-aliases/RenderManifestEntry.md) +- [ResolvePluginInstance](type-aliases/ResolvePluginInstance.md) +- [Resolver](type-aliases/Resolver.md) +- [RuleSetCondition](type-aliases/RuleSetCondition.md) +- [RuleSetConditionAbsolute](type-aliases/RuleSetConditionAbsolute.md) +- [RuleSetUse](type-aliases/RuleSetUse.md) +- [RuleSetUseFunction](type-aliases/RuleSetUseFunction.md) +- [RuleSetUseItem](type-aliases/RuleSetUseItem.md) +- [StatsAsset](type-aliases/StatsAsset.md) +- [StatsChunk](type-aliases/StatsChunk.md) +- [StatsChunkGroup](type-aliases/StatsChunkGroup.md) +- [StatsChunkOrigin](type-aliases/StatsChunkOrigin.md) +- [StatsCompilation](type-aliases/StatsCompilation.md) +- [StatsError](type-aliases/StatsError.md) +- [StatsLogging](type-aliases/StatsLogging.md) +- [StatsLoggingEntry](type-aliases/StatsLoggingEntry.md) +- [StatsModule](type-aliases/StatsModule.md) +- [StatsModuleIssuer](type-aliases/StatsModuleIssuer.md) +- [StatsModuleReason](type-aliases/StatsModuleReason.md) +- [StatsModuleTraceDependency](type-aliases/StatsModuleTraceDependency.md) +- [StatsModuleTraceItem](type-aliases/StatsModuleTraceItem.md) +- [StatsProfile](type-aliases/StatsProfile.md) +- [TemplatePath](type-aliases/TemplatePath.md) +- [Watching](type-aliases/Watching.md) +- [WebpackPluginFunction](type-aliases/WebpackPluginFunction.md) + +## Variables + +- [export=](variables/export=.md) diff --git a/api/cli/commands.mdx b/api/cli/commands.mdx deleted file mode 100644 index fe17e3a..0000000 --- a/api/cli/commands.mdx +++ /dev/null @@ -1,268 +0,0 @@ ---- -title: CLI Commands -description: Reference for webpack CLI commands including build, serve, watch, and init ---- - -Webpack provides several CLI commands to build, serve, and initialize your projects. - -## webpack build - -Compiles your webpack project. - -### Syntax - -```bash -webpack build [options] -``` - -### Description - -The `build` command compiles your webpack configuration and outputs bundled assets. This is the default command when running `webpack` without any subcommand. - -### Usage Examples - -```bash -# Basic build -webpack build - -# Build with custom config -webpack build --config webpack.prod.js - -# Build with mode -webpack build --mode production - -# Build and watch -webpack build --watch -``` - -### Return Value - -Exits with code `0` on success, non-zero on error. - ---- - -## webpack serve - -Starts a development server with live reloading. - -### Syntax - -```bash -webpack serve [options] -``` - -### Description - -The `serve` command starts webpack DevServer, which provides live reloading and hot module replacement for development. - - - Requires `webpack-dev-server` to be installed. - - -### Usage Examples - -```bash -# Start dev server -webpack serve - -# Serve on custom port -webpack serve --port 3000 - -# Serve with hot reload -webpack serve --hot - -# Open browser automatically -webpack serve --open -``` - -### Parameters - - - Port number for the dev server. Default: `8080` - - - - Host to use for the dev server. Default: `localhost` - - - - Enable hot module replacement. Default: `true` - - - - Open the browser after server starts. Default: `false` - - ---- - -## webpack watch - -Watches files and rebuilds on changes. - -### Syntax - -```bash -webpack watch [options] -``` - -### Description - -The `watch` command starts webpack in watch mode. It monitors your source files and automatically rebuilds when changes are detected. - -### Usage Examples - -```bash -# Start watch mode -webpack watch - -# Watch with specific config -webpack watch --config webpack.dev.js - -# Watch with info verbosity -webpack watch --stats verbose -``` - -### Parameters - - - Stop watching when stdin stream ends. Default: `false` - - - - Polling interval in milliseconds. Use when file watching doesn't work. - - -### Return Value - -Runs continuously until terminated. Exits with code `0` on graceful shutdown. - ---- - -## webpack init - -Scaffolds a new webpack project. - -### Syntax - -```bash -webpack init [scaffold-template] -``` - -### Description - -The `init` command helps you create a new webpack configuration interactively. It can use built-in templates or custom scaffolds. - - - Requires `@webpack-cli/generators` to be installed. - - -### Usage Examples - -```bash -# Interactive initialization -webpack init - -# Initialize with specific generator -webpack init react-app - -# Force initialization (overwrite existing files) -webpack init --force -``` - -### Parameters - - - Name of the scaffold template to use. If omitted, uses interactive mode. - - - - Overwrite existing files without prompting. Default: `false` - - - - Template to generate from. Can be a package name or local path. - - -### Return Value - -Exits with code `0` on successful initialization, non-zero on error. - ---- - -## Common Options - -These options work with all commands: - - - Path to webpack configuration file. Default: `webpack.config.js` - - ```bash - webpack build --config config/webpack.prod.js - ``` - - - - Build mode: `development`, `production`, or `none`. Sets `process.env.NODE_ENV` and applies defaults. - - ```bash - webpack build --mode production - ``` - - - - Environment variables passed to the config function. - - ```bash - webpack build --env production --env apiUrl=https://api.example.com - ``` - - - - Stats output preset: `none`, `errors-only`, `minimal`, `normal`, `verbose`, `detailed`. - - ```bash - webpack build --stats detailed - ``` - - - - Show compilation progress. Default: `false` - - ```bash - webpack build --progress - ``` - - - - Display help information. - - ```bash - webpack build --help - ``` - - - - Display webpack version. - - ```bash - webpack --version - ``` - - ---- - -## Exit Codes - -| Code | Description | -|------|-------------| -| `0` | Success | -| `1` | Errors from webpack | -| `2` | Configuration or options error | - ---- - -## See Also - -- [CLI Flags](/api/cli/flags) - Complete list of CLI flags and options -- [Configuration](/configuration/overview) - webpack configuration reference -- [DevServer](/configuration/devserver) - Development server options \ No newline at end of file diff --git a/api/cli/flags.mdx b/api/cli/flags.mdx deleted file mode 100644 index ffafe62..0000000 --- a/api/cli/flags.mdx +++ /dev/null @@ -1,492 +0,0 @@ ---- -title: CLI Flags -description: Complete reference for webpack CLI flags and options ---- - -Webpack CLI provides numerous flags to customize the build process, output, optimization, and more. - -## Entry and Output - - - Entry point(s) for the bundle. - - ```bash - webpack --entry ./src/index.js - webpack --entry ./src/app.js --entry ./src/vendor.js - ``` - - - - Output directory for all build files. - - ```bash - webpack --output-path ./dist - ``` - - - - Filename template for entry chunks. - - ```bash - webpack --output-filename [name].[contenthash].js - ``` - - - - Public URL of the output directory when referenced in a browser. - - ```bash - webpack --output-public-path /assets/ - ``` - - - - Clean the output directory before emit. Default: `false` - - ```bash - webpack --output-clean - ``` - - ---- - -## Mode and Environment - - - Build mode. Sets defaults and `process.env.NODE_ENV`. - - **Values:** `development` | `production` | `none` - - ```bash - webpack --mode production - ``` - - - - Environment variables passed to config function. - - ```bash - webpack --env production - webpack --env.production --env.platform=web - ``` - - - - Sets `process.env.NODE_ENV` to the specified value. - - ```bash - webpack --node-env production - ``` - - ---- - -## Configuration - - - Path to webpack configuration file. - - ```bash - webpack --config webpack.prod.js - webpack --config config/webpack.config.js - ``` - - - - Name of the configuration to use (for multi-config exports). - - ```bash - webpack --config-name production - ``` - - - - Merge two or more configurations. - - ```bash - webpack --config webpack.base.js --config webpack.prod.js --merge - ``` - - ---- - -## Development - - - Watch files for changes and rebuild. Default: `false` - - ```bash - webpack --watch - ``` - - - - Stop watching when stdin stream ends. - - ```bash - webpack --watch --watch-options-stdin - ``` - - - - Source map generation method. - - ```bash - webpack --devtool source-map - webpack --devtool eval-source-map - ``` - - - - Enable Hot Module Replacement. Default: `false` - - ```bash - webpack serve --hot - ``` - - ---- - -## Optimization - - - Minimize the output. Default: `true` in production mode. - - ```bash - webpack --optimization-minimize - webpack --no-optimization-minimize - ``` - - - - Enable module concatenation (scope hoisting). - - ```bash - webpack --optimization-concatenate-modules - ``` - - - - Create a separate chunk for the webpack runtime. - - ```bash - webpack --optimization-runtime-chunk single - ``` - - - - Enable/disable code splitting. - - ```bash - webpack --optimization-split-chunks - ``` - - ---- - -## Module Resolution - - - Create aliases for module imports. - - ```bash - webpack --resolve-alias @=./src - ``` - - - - Extensions to resolve. - - ```bash - webpack --resolve-extensions .js --resolve-extensions .jsx - ``` - - - - Directories to search for modules. - - ```bash - webpack --resolve-modules node_modules --resolve-modules src - ``` - - ---- - -## Performance - - - Show performance hints. - - **Values:** `warning` | `error` | `false` - - ```bash - webpack --performance-hints warning - ``` - - - - Max size (in bytes) for entrypoint assets. - - ```bash - webpack --performance-max-entrypoint-size 250000 - ``` - - - - Max size (in bytes) for individual assets. - - ```bash - webpack --performance-max-asset-size 250000 - ``` - - ---- - -## Stats and Output - - - Stats output preset. - - **Presets:** `none` | `errors-only` | `errors-warnings` | `minimal` | `normal` | `verbose` | `detailed` - - ```bash - webpack --stats verbose - webpack --stats detailed - ``` - - - - Show details for errors. - - ```bash - webpack --stats-error-details - ``` - - - - Show compilation progress percentage. - - ```bash - webpack --progress - ``` - - - - Output stats as JSON. Optionally specify output file path. - - ```bash - webpack --json - webpack --json=stats.json - ``` - - - - Enable/disable colors in console output. - - ```bash - webpack --color - webpack --no-color - ``` - - ---- - -## Target and Platform - - - Build target environment. - - **Common values:** `web` | `node` | `async-node` | `electron-main` | `electron-renderer` - - ```bash - webpack --target node - webpack --target web --target es2020 - ``` - - ---- - -## Cache - - - Enable/disable caching. - - ```bash - webpack --cache - webpack --no-cache - ``` - - - - Cache type. - - **Values:** `memory` | `filesystem` - - ```bash - webpack --cache-type filesystem - ``` - - ---- - -## Analyze and Debug - - - Generate bundle analysis. - - ```bash - webpack --analyze - ``` - - - - Capture timing information for each module. - - ```bash - webpack --profile - ``` - - - - Abort compilation on first error. - - ```bash - webpack --bail - ``` - - ---- - -## DevServer Options - -These flags are available when using `webpack serve`: - - - Port number for dev server. Default: `8080` - - ```bash - webpack serve --port 3000 - ``` - - - - Host to use. Default: `localhost` - - ```bash - webpack serve --host 0.0.0.0 - ``` - - - - Open browser. Optionally specify browser name or page path. - - ```bash - webpack serve --open - webpack serve --open chrome - webpack serve --open /about - ``` - - - - Directory to serve static files from. - - ```bash - webpack serve --static ./public - ``` - - - - Enable gzip compression. - - ```bash - webpack serve --compress - ``` - - - - Enable HTTPS. - - ```bash - webpack serve --https - ``` - - - - Enable HTTP/2. - - ```bash - webpack serve --http2 - ``` - - ---- - -## Utility Flags - - - Display help information. - - ```bash - webpack --help - webpack build --help - ``` - - - - Display webpack version. - - ```bash - webpack --version - ``` - - - - Prevent output from being displayed in stdout. - - ```bash - webpack --silent - ``` - - ---- - -## Negating Boolean Flags - -Boolean flags can be negated by prefixing with `no-`: - -```bash -# Disable optimization -webpack --no-optimization-minimize - -# Disable colors -webpack --no-color - -# Disable cache -webpack --no-cache -``` - ---- - -## Flag Priority - -When the same option is specified multiple times, the last value takes precedence: - -```bash -# Uses production mode -webpack --mode development --mode production -``` - -CLI flags override configuration file settings: - -```bash -# CLI flag overrides config -webpack --config webpack.config.js --mode production -``` - ---- - -## See Also - -- [CLI Commands](/api/cli/commands) - Available webpack commands -- [Configuration](/configuration/overview) - Configuration file options -- [Environment Variables](/plugins/environment-plugin) - Using environment variables \ No newline at end of file diff --git a/api/compilation.mdx b/api/compilation.mdx deleted file mode 100644 index 52b0860..0000000 --- a/api/compilation.mdx +++ /dev/null @@ -1,541 +0,0 @@ ---- -title: "Compilation API" -description: "webpack Compilation class API - assets, modules, chunks, and hooks" ---- - -The Compilation instance represents a single build of versioned assets. It provides access to all modules, chunks, and assets generated during the compilation process. - -## Accessing Compilation - -The Compilation object is passed to plugins via the `compilation` hook: - -```javascript -class MyPlugin { - apply(compiler) { - compiler.hooks.compilation.tap('MyPlugin', (compilation) => { - // Access compilation here - console.log('Compilation created'); - }); - } -} -``` - -## Properties - -### assets - -Object containing all assets that will be emitted. - -```javascript -compiler.hooks.emit.tapAsync('MyPlugin', (compilation, callback) => { - // Access assets - Object.keys(compilation.assets).forEach(filename => { - console.log('Asset:', filename); - console.log('Size:', compilation.assets[filename].size()); - }); - - callback(); -}); -``` - -### modules - -Set of all modules in the compilation. - -```javascript -compilation.hooks.afterOptimizeModules.tap('MyPlugin', (modules) => { - console.log(`Total modules: ${compilation.modules.size}`); - - for (const module of compilation.modules) { - console.log('Module:', module.identifier()); - } -}); -``` - -### chunks - -Set of all chunks in the compilation. - -```javascript -compilation.hooks.afterChunks.tap('MyPlugin', (chunks) => { - console.log(`Total chunks: ${compilation.chunks.size}`); - - for (const chunk of compilation.chunks) { - console.log('Chunk:', chunk.id, 'Files:', [...chunk.files]); - } -}); -``` - -### errors - -Array of errors that occurred during compilation. - -```javascript -compilation.hooks.afterSeal.tap('MyPlugin', () => { - if (compilation.errors.length > 0) { - console.error('Compilation errors:', compilation.errors); - } -}); -``` - -### warnings - -Array of warnings that occurred during compilation. - -```javascript -compilation.hooks.afterSeal.tap('MyPlugin', () => { - if (compilation.warnings.length > 0) { - console.warn('Compilation warnings:', compilation.warnings); - } -}); -``` - -### moduleGraph - -The ModuleGraph provides information about module dependencies. - -```javascript -compilation.hooks.finishModules.tap('MyPlugin', (modules) => { - const moduleGraph = compilation.moduleGraph; - - for (const module of modules) { - const exports = moduleGraph.getExportsInfo(module); - console.log('Module exports:', exports); - } -}); -``` - -### chunkGraph - -The ChunkGraph provides information about chunk relationships. - -```javascript -compilation.hooks.afterChunks.tap('MyPlugin', () => { - const chunkGraph = compilation.chunkGraph; - - for (const chunk of compilation.chunks) { - const modules = chunkGraph.getChunkModules(chunk); - console.log(`Chunk ${chunk.id} has ${modules.length} modules`); - } -}); -``` - -### compiler - -Reference to the parent Compiler instance. - -```javascript -compiler.hooks.compilation.tap('MyPlugin', (compilation) => { - console.log('Compiler context:', compilation.compiler.context); -}); -``` - -### options - -Webpack configuration options. - -```javascript -compilation.hooks.seal.tap('MyPlugin', () => { - console.log('Output path:', compilation.options.output.path); - console.log('Mode:', compilation.options.mode); -}); -``` - -## Methods - -### addModule() - -Adds a module to the compilation. - -```typescript -compilation.addModule( - module: Module, - callback: (err?: Error, module?: Module) => void -): void -``` - - - Module instance to add to the compilation. - - - - Callback invoked after the module is added. - - -### getAssets() - -Returns an array of all assets. - -```typescript -compilation.getAssets(): Asset[] -``` - - - Array of asset objects with properties: - - `name` (string) - Asset filename - - `source` (Source) - Asset source - - `info` (AssetInfo) - Asset metadata - - -**Example:** - -```javascript -compiler.hooks.emit.tap('MyPlugin', (compilation) => { - const assets = compilation.getAssets(); - - assets.forEach(asset => { - console.log('Asset:', asset.name); - console.log('Size:', asset.info.size); - console.log('Immutable:', asset.info.immutable); - }); -}); -``` - -### emitAsset() - -Emits a new asset to the compilation. - -```typescript -compilation.emitAsset( - file: string, - source: Source, - assetInfo?: AssetInfo -): void -``` - - - Filename for the asset. - - - - Source object (from webpack-sources). - - - - Optional metadata about the asset. - - -**Example:** - -```javascript -const { RawSource } = require('webpack-sources'); - -compiler.hooks.emit.tap('MyPlugin', (compilation) => { - const content = JSON.stringify({ - hash: compilation.hash, - version: require('./package.json').version - }); - - compilation.emitAsset( - 'manifest.json', - new RawSource(content), - { - size: content.length, - development: false - } - ); -}); -``` - -### updateAsset() - -Updates an existing asset. - -```typescript -compilation.updateAsset( - file: string, - newSourceOrFunction: Source | ((source: Source) => Source), - assetInfoUpdateOrFunction?: AssetInfo | ((assetInfo: AssetInfo) => AssetInfo) -): void -``` - - - Filename of the asset to update. - - - - New source or function that transforms the existing source. - - - - New asset info or function that updates the existing info. - - -**Example:** - -```javascript -const { RawSource } = require('webpack-sources'); - -compiler.hooks.processAssets.tap({ - name: 'MyPlugin', - stage: Compilation.PROCESS_ASSETS_STAGE_OPTIMIZE -}, (compilation) => { - for (const filename in compilation.assets) { - if (filename.endsWith('.js')) { - compilation.updateAsset( - filename, - (source) => { - const content = source.source(); - const minified = minifyCode(content); - return new RawSource(minified); - } - ); - } - } -}); -``` - -### deleteAsset() - -Deletes an asset from the compilation. - -```typescript -compilation.deleteAsset(file: string): void -``` - - - Filename of the asset to delete. - - -**Example:** - -```javascript -compiler.hooks.emit.tap('MyPlugin', (compilation) => { - // Remove source maps in production - if (compilation.options.mode === 'production') { - Object.keys(compilation.assets).forEach(filename => { - if (filename.endsWith('.map')) { - compilation.deleteAsset(filename); - } - }); - } -}); -``` - -### getLogger() - -Returns a logger for the compilation. - -```typescript -compilation.getLogger(name: string | (() => string)): Logger -``` - - - Logger name or function returning the logger name. - - - - Logger instance for logging compilation events. - - -**Example:** - -```javascript -compiler.hooks.compilation.tap('MyPlugin', (compilation) => { - const logger = compilation.getLogger('MyPlugin'); - - logger.log('Plugin initialized'); - logger.warn('Potential issue detected'); - logger.time('optimization'); - // ... do optimization - logger.timeEnd('optimization'); -}); -``` - -### getPath() - -Interpolates a template path with compilation data. - -```typescript -compilation.getPath( - filename: string, - data?: PathData -): string -``` - - - Template string with placeholders like [name], [hash], [chunkhash]. - - - - Data used for interpolation (chunk, module, etc). - - - - Interpolated path string. - - -**Example:** - -```javascript -compilation.hooks.afterSeal.tap('MyPlugin', () => { - const outputPath = compilation.getPath('[name].[contenthash].js', { - chunk: compilation.chunks.values().next().value - }); - - console.log('Output path:', outputPath); -}); -``` - -## Compilation Hooks - -Compilation provides many hooks for different stages of the build process. - -### buildModule - -Called before a module is built. - -```javascript -compilation.hooks.buildModule.tap('MyPlugin', (module) => { - console.log('Building module:', module.identifier()); -}); -``` - -### succeedModule - -Called after a module has been built successfully. - -```javascript -compilation.hooks.succeedModule.tap('MyPlugin', (module) => { - console.log('Module built successfully:', module.identifier()); -}); -``` - -### seal - -Called when compilation stops accepting new modules. - -```javascript -compilation.hooks.seal.tap('MyPlugin', () => { - console.log('Compilation sealed, optimizing...'); -}); -``` - -### optimize - -Called at the beginning of the optimization phase. - -```javascript -compilation.hooks.optimize.tap('MyPlugin', () => { - console.log('Starting optimization...'); -}); -``` - -### optimizeModules - -Called during module optimization. - -```javascript -compilation.hooks.optimizeModules.tap('MyPlugin', (modules) => { - console.log('Optimizing modules...'); - // Optimize modules -}); -``` - -### optimizeChunks - -Called during chunk optimization. - -```javascript -compilation.hooks.optimizeChunks.tap('MyPlugin', (chunks) => { - console.log('Optimizing chunks...'); - // Optimize chunks -}); -``` - -### processAssets - -Called during asset processing. This is the main hook for asset optimization. - -```javascript -compilation.hooks.processAssets.tap({ - name: 'MyPlugin', - stage: Compilation.PROCESS_ASSETS_STAGE_OPTIMIZE -}, (assets) => { - for (const name in assets) { - console.log('Processing asset:', name); - } -}); -``` - -**Asset processing stages:** - -- `PROCESS_ASSETS_STAGE_ADDITIONAL` - Add additional assets -- `PROCESS_ASSETS_STAGE_PRE_PROCESS` - Basic preprocessing -- `PROCESS_ASSETS_STAGE_DERIVED` - Derive assets from existing -- `PROCESS_ASSETS_STAGE_ADDITIONS` - Add additional assets -- `PROCESS_ASSETS_STAGE_OPTIMIZE` - Optimize existing assets -- `PROCESS_ASSETS_STAGE_OPTIMIZE_COUNT` - Optimize asset count -- `PROCESS_ASSETS_STAGE_OPTIMIZE_COMPATIBILITY` - Optimize compatibility -- `PROCESS_ASSETS_STAGE_OPTIMIZE_SIZE` - Optimize asset size -- `PROCESS_ASSETS_STAGE_DEV_TOOLING` - Add development tooling -- `PROCESS_ASSETS_STAGE_OPTIMIZE_INLINE` - Optimize for inlining -- `PROCESS_ASSETS_STAGE_SUMMARIZE` - Summarize assets -- `PROCESS_ASSETS_STAGE_OPTIMIZE_HASH` - Optimize asset hashes -- `PROCESS_ASSETS_STAGE_OPTIMIZE_TRANSFER` - Optimize for transfer -- `PROCESS_ASSETS_STAGE_ANALYSE` - Analyze assets -- `PROCESS_ASSETS_STAGE_REPORT` - Report asset information - -### afterProcessAssets - -Called after all assets have been processed. - -```javascript -compilation.hooks.afterProcessAssets.tap('MyPlugin', (assets) => { - console.log('All assets processed'); -}); -``` - -## Complete Example: Asset Generation Plugin - -```javascript -const { RawSource } = require('webpack-sources'); - -class AssetGenerationPlugin { - apply(compiler) { - compiler.hooks.compilation.tap('AssetGenerationPlugin', (compilation) => { - compilation.hooks.processAssets.tap({ - name: 'AssetGenerationPlugin', - stage: Compilation.PROCESS_ASSETS_STAGE_ADDITIONAL - }, (assets) => { - // Generate a manifest of all assets - const manifest = { - hash: compilation.hash, - time: new Date().toISOString(), - assets: Object.keys(assets).map(filename => ({ - name: filename, - size: assets[filename].size(), - chunks: [] - })) - }; - - const manifestSource = JSON.stringify(manifest, null, 2); - - compilation.emitAsset( - 'assets-manifest.json', - new RawSource(manifestSource), - { - size: manifestSource.length - } - ); - }); - - compilation.hooks.afterProcessAssets.tap( - 'AssetGenerationPlugin', - () => { - const logger = compilation.getLogger('AssetGenerationPlugin'); - logger.log(`Generated manifest with ${compilation.getAssets().length} assets`); - } - ); - }); - } -} - -module.exports = AssetGenerationPlugin; -``` - -## See Also - -- [Compiler API](/api/compiler) - Compiler instance methods -- [Stats Object](/api/stats) - Compilation statistics -- [Compilation Hooks](https://webpack.js.org/api/compilation-hooks/) - Full list of hooks \ No newline at end of file diff --git a/api/compiler.mdx b/api/compiler.mdx deleted file mode 100644 index 9d8fd74..0000000 --- a/api/compiler.mdx +++ /dev/null @@ -1,410 +0,0 @@ ---- -title: "Compiler API" -description: "webpack Compiler class API - hooks, methods, and properties" ---- - -The Compiler instance represents the fully configured webpack environment. It's created once when webpack is started and contains all the configuration, loaders, plugins, and resolver settings. - -## Creating a Compiler - -The Compiler is created when you call the `webpack()` function: - -```javascript -const webpack = require('webpack'); -const config = require('./webpack.config.js'); - -const compiler = webpack(config); -``` - -## Methods - -### run() - -Runs a single build. The callback is called when the compilation completes. - -```typescript -compiler.run( - callback: (err: Error | null, stats?: Stats) => void -): void -``` - - - Callback invoked when the compilation completes. - - **Parameters:** - - `err` - Error object if compilation failed, null otherwise - - `stats` - Stats object containing compilation results - - -**Example:** - -```javascript -compiler.run((err, stats) => { - if (err) { - console.error(err); - return; - } - - console.log(stats.toString({ - colors: true, - chunks: false - })); - - // Always close the compiler when done - compiler.close((closeErr) => { - if (closeErr) { - console.error('Failed to close compiler:', closeErr); - } - }); -}); -``` - -### watch() - -Runs webpack in watch mode. Watches for file changes and recompiles automatically. - -```typescript -compiler.watch( - watchOptions: WatchOptions, - handler: (err: Error | null, stats?: Stats) => void -): Watching -``` - - - Watch configuration options. - - **Properties:** - - `aggregateTimeout` (number) - Delay before rebuilding (default: 300ms) - - `poll` (number | boolean) - Enable polling and set interval in ms - - `ignored` (string | RegExp | string[]) - Paths to ignore - - - - Callback invoked after each compilation. - - - - Returns a Watching instance that can be used to stop watching. - - -**Example:** - -```javascript -const watching = compiler.watch({ - aggregateTimeout: 300, - poll: undefined, - ignored: /node_modules/ -}, (err, stats) => { - if (err) { - console.error(err); - return; - } - - console.log('Recompiled:', new Date().toLocaleTimeString()); - console.log(stats.toString({ colors: true })); -}); - -// Later: stop watching -watching.close((closeErr) => { - console.log('Watching closed.'); -}); -``` - -### close() - -Closes the compiler and releases resources. Should always be called after `run()` completes. - -```typescript -compiler.close( - callback: (err?: Error) => void -): void -``` - - - Callback invoked when the compiler is closed. - - -**Example:** - -```javascript -compiler.run((err, stats) => { - // Process results... - - compiler.close((closeErr) => { - if (closeErr) { - console.error('Error closing compiler:', closeErr); - } - console.log('Compiler closed.'); - }); -}); -``` - -### getCache() - -Returns a cache facade for the specified cache name. - -```typescript -compiler.getCache(name: string): CacheFacade -``` - - - Unique name for the cache. - - - - Cache facade instance for storing and retrieving cached data. - - -**Example:** - -```javascript -const cache = compiler.getCache('my-plugin'); - -// Store data -cache.store('key', null, data, (err) => { - if (err) console.error(err); -}); - -// Retrieve data -cache.get('key', null, (err, result) => { - if (err) console.error(err); - console.log('Cached data:', result); -}); -``` - -### getInfrastructureLogger() - -Returns a logger for infrastructure logging. - -```typescript -compiler.getInfrastructureLogger( - name: string | (() => string) -): Logger -``` - - - Logger name or function that returns the logger name. - - - - Logger instance for logging infrastructure events. - - -**Example:** - -```javascript -const logger = compiler.getInfrastructureLogger('my-plugin'); - -logger.log('Plugin initialized'); -logger.warn('Potential issue detected'); -logger.error('Critical error occurred'); -``` - -## Properties - -### options - -The webpack configuration options used to create this compiler. - -```javascript -const compiler = webpack(config); -console.log(compiler.options.entry); -console.log(compiler.options.output); -``` - -### hooks - -Tapable hooks for the compilation process. See [Compiler Hooks](#compiler-hooks) section. - -```javascript -compiler.hooks.done.tap('MyPlugin', (stats) => { - console.log('Compilation complete!'); -}); -``` - -### outputFileSystem - -The file system used for writing output files. - -```javascript -const fs = require('fs'); -compiler.outputFileSystem = fs; -``` - -### inputFileSystem - -The file system used for reading input files. - -```javascript -compiler.inputFileSystem = require('fs'); -``` - -### resolverFactory - -Factory for creating module resolvers. - -```javascript -const resolver = compiler.resolverFactory.get('normal'); -``` - -## Compiler Hooks - -The Compiler exposes hooks for plugins to tap into various stages of the compilation lifecycle. - -### run - -Called before a new compilation is started. - -```javascript -compiler.hooks.run.tapAsync('MyPlugin', (compiler, callback) => { - console.log('Starting compilation...'); - callback(); -}); -``` - -### compile - -Called before a new compilation is created. - -```javascript -compiler.hooks.compile.tap('MyPlugin', (params) => { - console.log('Creating compilation...'); -}); -``` - -### compilation - -Called after a new compilation is created. - -```javascript -compiler.hooks.compilation.tap('MyPlugin', (compilation, params) => { - console.log('Compilation created'); - - // Access compilation hooks - compilation.hooks.optimize.tap('MyPlugin', () => { - console.log('Optimizing...'); - }); -}); -``` - -### make - -Called during the compilation phase when modules are being processed. - -```javascript -compiler.hooks.make.tapAsync('MyPlugin', (compilation, callback) => { - console.log('Processing modules...'); - callback(); -}); -``` - -### emit - -Called before assets are written to output directory. - -```javascript -compiler.hooks.emit.tapAsync('MyPlugin', (compilation, callback) => { - // Modify or add assets - compilation.assets['custom-file.txt'] = { - source: () => 'Custom content', - size: () => 14 - }; - callback(); -}); -``` - -### afterEmit - -Called after assets have been written to output directory. - -```javascript -compiler.hooks.afterEmit.tapAsync('MyPlugin', (compilation, callback) => { - console.log('Assets emitted to disk'); - callback(); -}); -``` - -### done - -Called when compilation completes successfully. - -```javascript -compiler.hooks.done.tap('MyPlugin', (stats) => { - const json = stats.toJson(); - console.log('Build time:', json.time, 'ms'); - console.log('Hash:', json.hash); -}); -``` - -### failed - -Called when compilation fails. - -```javascript -compiler.hooks.failed.tap('MyPlugin', (error) => { - console.error('Compilation failed:', error.message); -}); -``` - -### invalid - -Called when watch compilation is invalidated. - -```javascript -compiler.hooks.invalid.tap('MyPlugin', (fileName, changeTime) => { - console.log(`File changed: ${fileName} at ${new Date(changeTime)}`); -}); -``` - -### watchRun - -Called before a watch compilation starts. - -```javascript -compiler.hooks.watchRun.tapAsync('MyPlugin', (compiler, callback) => { - console.log('Watch compilation starting...'); - callback(); -}); -``` - -## Complete Example: Custom Plugin - -```javascript -class MyCustomPlugin { - apply(compiler) { - const pluginName = 'MyCustomPlugin'; - - // Tap into compilation creation - compiler.hooks.compilation.tap(pluginName, (compilation) => { - console.log('New compilation created'); - }); - - // Tap into the emit phase - compiler.hooks.emit.tapAsync(pluginName, (compilation, callback) => { - // Create a custom asset - const buildTime = new Date().toString(); - compilation.assets['build-time.txt'] = { - source: () => buildTime, - size: () => buildTime.length - }; - - callback(); - }); - - // Tap into the done hook - compiler.hooks.done.tap(pluginName, (stats) => { - console.log('Compilation finished!'); - console.log('Hash:', stats.compilation.hash); - console.log('Time:', stats.endTime - stats.startTime, 'ms'); - }); - } -} - -module.exports = MyCustomPlugin; -``` - -## See Also - -- [Compilation API](/api/compilation) - Compilation instance methods -- [Stats Object](/api/stats) - Compilation statistics -- [Compiler Hooks](https://webpack.js.org/api/compiler-hooks/) - Full list of hooks \ No newline at end of file diff --git a/api/interfaces/Argument.md b/api/interfaces/Argument.md new file mode 100644 index 0000000..da090cc --- /dev/null +++ b/api/interfaces/Argument.md @@ -0,0 +1,45 @@ +--- +title: Argument +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / Argument + +# Interface: Argument + +Defined in: [lib/cli.js:63](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/cli.js#L63) + +## Properties + +### configs + +> **configs**: `ArgumentConfig`[] + +Defined in: [lib/cli.js:67](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/cli.js#L67) + +*** + +### description + +> **description**: `string` + +Defined in: [lib/cli.js:64](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/cli.js#L64) + +*** + +### multiple + +> **multiple**: `boolean` + +Defined in: [lib/cli.js:66](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/cli.js#L66) + +*** + +### simpleType + +> **simpleType**: `SimpleType` + +Defined in: [lib/cli.js:65](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/cli.js#L65) diff --git a/api/interfaces/Asset.md b/api/interfaces/Asset.md new file mode 100644 index 0000000..fa5009e --- /dev/null +++ b/api/interfaces/Asset.md @@ -0,0 +1,43 @@ +--- +title: Asset +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / Asset + +# Interface: Asset + +Defined in: [lib/Compilation.js:319](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/Compilation.js#L319) + +## Properties + +### info + +> **info**: [`AssetInfo`](../type-aliases/AssetInfo.md) + +Defined in: [lib/Compilation.js:322](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/Compilation.js#L322) + +info about the asset + +*** + +### name + +> **name**: `string` + +Defined in: [lib/Compilation.js:320](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/Compilation.js#L320) + +the filename of the asset + +*** + +### source + +> **source**: `Source` + +Defined in: [lib/Compilation.js:321](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/Compilation.js#L321) + +source of the asset diff --git a/api/interfaces/AssetEmittedInfo.md b/api/interfaces/AssetEmittedInfo.md new file mode 100644 index 0000000..a6c1cee --- /dev/null +++ b/api/interfaces/AssetEmittedInfo.md @@ -0,0 +1,53 @@ +--- +title: AssetEmittedInfo +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / AssetEmittedInfo + +# Interface: AssetEmittedInfo + +Defined in: [lib/Compiler.js:108](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/Compiler.js#L108) + +## Properties + +### compilation + +> **compilation**: `Compilation` + +Defined in: [lib/Compiler.js:111](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/Compiler.js#L111) + +*** + +### content + +> **content**: `Buffer`\<`ArrayBufferLike`\> + +Defined in: [lib/Compiler.js:109](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/Compiler.js#L109) + +*** + +### outputPath + +> **outputPath**: `string` + +Defined in: [lib/Compiler.js:112](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/Compiler.js#L112) + +*** + +### source + +> **source**: `Source` + +Defined in: [lib/Compiler.js:110](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/Compiler.js#L110) + +*** + +### targetPath + +> **targetPath**: `string` + +Defined in: [lib/Compiler.js:113](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/Compiler.js#L113) diff --git a/api/interfaces/ColorsOptions.md b/api/interfaces/ColorsOptions.md new file mode 100644 index 0000000..5aae179 --- /dev/null +++ b/api/interfaces/ColorsOptions.md @@ -0,0 +1,23 @@ +--- +title: ColorsOptions +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / ColorsOptions + +# Interface: ColorsOptions + +Defined in: [lib/cli.js:804](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/cli.js#L804) + +## Properties + +### useColor? + +> `optional` **useColor**: `boolean` + +Defined in: [lib/cli.js:805](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/cli.js#L805) + +force use colors diff --git a/api/interfaces/Configuration.md b/api/interfaces/Configuration.md new file mode 100644 index 0000000..26e5cfc --- /dev/null +++ b/api/interfaces/Configuration.md @@ -0,0 +1,395 @@ +--- +title: Configuration +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / Configuration + +# Interface: Configuration + +Defined in: [declarations/WebpackOptions.d.ts:896](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L896) + +Options object as provided by the user. + +## Properties + +### amd? + +> `optional` **amd**: `Amd` + +Defined in: [declarations/WebpackOptions.d.ts:900](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L900) + +Set the value of `require.amd` and `define.amd`. Or disable AMD support. + +*** + +### bail? + +> `optional` **bail**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:904](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L904) + +Report the first error as a hard error instead of tolerating it. + +*** + +### cache? + +> `optional` **cache**: `CacheOptions` + +Defined in: [declarations/WebpackOptions.d.ts:908](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L908) + +Cache generated modules and chunks to improve performance for multiple incremental builds. + +*** + +### context? + +> `optional` **context**: `string` + +Defined in: [declarations/WebpackOptions.d.ts:912](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L912) + +The base directory (absolute path!) for resolving the `entry` option. If `output.pathinfo` is set, the included pathinfo is shortened to this directory. + +*** + +### dependencies? + +> `optional` **dependencies**: `Dependencies` + +Defined in: [declarations/WebpackOptions.d.ts:916](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L916) + +References to other configurations to depend on. + +*** + +### devServer? + +> `optional` **devServer**: `DevServer` + +Defined in: [declarations/WebpackOptions.d.ts:920](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L920) + +Options for the webpack-dev-server. + +*** + +### devtool? + +> `optional` **devtool**: `DevTool` + +Defined in: [declarations/WebpackOptions.d.ts:924](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L924) + +A developer tool to enhance debugging (false | eval | [inline-|hidden-|eval-][nosources-][cheap-[module-]]source-map). + +*** + +### dotenv? + +> `optional` **dotenv**: `Dotenv` + +Defined in: [declarations/WebpackOptions.d.ts:928](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L928) + +Enable and configure the Dotenv plugin to load environment variables from .env files. + +*** + +### entry? + +> `optional` **entry**: [`Entry`](../type-aliases/Entry.md) + +Defined in: [declarations/WebpackOptions.d.ts:932](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L932) + +The entry point(s) of the compilation. + +*** + +### experiments? + +> `optional` **experiments**: `Experiments` + +Defined in: [declarations/WebpackOptions.d.ts:936](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L936) + +Enables/Disables experiments (experimental features with relax SemVer compatibility). + +*** + +### extends? + +> `optional` **extends**: `Extends` + +Defined in: [declarations/WebpackOptions.d.ts:940](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L940) + +Extend configuration from another configuration (only works when using webpack-cli). + +*** + +### externals? + +> `optional` **externals**: [`Externals`](../type-aliases/Externals.md) + +Defined in: [declarations/WebpackOptions.d.ts:944](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L944) + +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`. + +*** + +### externalsPresets? + +> `optional` **externalsPresets**: `ExternalsPresets` + +Defined in: [declarations/WebpackOptions.d.ts:948](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L948) + +Enable presets of externals for specific targets. + +*** + +### externalsType? + +> `optional` **externalsType**: `ExternalsType` + +Defined in: [declarations/WebpackOptions.d.ts:952](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L952) + +Specifies the default type of externals ('amd*', 'umd*', 'system' and 'jsonp' depend on output.libraryTarget set to the same value). + +*** + +### ignoreWarnings? + +> `optional` **ignoreWarnings**: `IgnoreWarnings` + +Defined in: [declarations/WebpackOptions.d.ts:956](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L956) + +Ignore specific warnings. + +*** + +### infrastructureLogging? + +> `optional` **infrastructureLogging**: `InfrastructureLogging` + +Defined in: [declarations/WebpackOptions.d.ts:960](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L960) + +Options for infrastructure level logging. + +*** + +### loader? + +> `optional` **loader**: `Loader` + +Defined in: [declarations/WebpackOptions.d.ts:964](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L964) + +Custom values available in the loader context. + +*** + +### mode? + +> `optional` **mode**: `Mode` + +Defined in: [declarations/WebpackOptions.d.ts:968](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L968) + +Enable production optimizations or development hints. + +*** + +### module? + +> `optional` **module**: [`ModuleOptions`](ModuleOptions.md) + +Defined in: [declarations/WebpackOptions.d.ts:972](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L972) + +Options affecting the normal modules (`NormalModuleFactory`). + +*** + +### name? + +> `optional` **name**: `string` + +Defined in: [declarations/WebpackOptions.d.ts:976](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L976) + +Name of the configuration. Used when loading multiple configurations. + +*** + +### node? + +> `optional` **node**: `Node` + +Defined in: [declarations/WebpackOptions.d.ts:980](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L980) + +Include polyfills or mocks for various node stuff. + +*** + +### optimization? + +> `optional` **optimization**: `Optimization` + +Defined in: [declarations/WebpackOptions.d.ts:984](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L984) + +Enables/Disables integrated optimizations. + +*** + +### output? + +> `optional` **output**: `Output` + +Defined in: [declarations/WebpackOptions.d.ts:988](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L988) + +Options affecting the output of the compilation. `output` options tell webpack how to write the compiled files to disk. + +*** + +### parallelism? + +> `optional` **parallelism**: `number` + +Defined in: [declarations/WebpackOptions.d.ts:992](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L992) + +The number of parallel processed modules in the compilation. + +*** + +### performance? + +> `optional` **performance**: `Performance` + +Defined in: [declarations/WebpackOptions.d.ts:996](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L996) + +Configuration for web performance recommendations. + +*** + +### plugins? + +> `optional` **plugins**: `Plugins` + +Defined in: [declarations/WebpackOptions.d.ts:1000](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1000) + +Add additional plugins to the compiler. + +*** + +### profile? + +> `optional` **profile**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:1004](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1004) + +Capture timing information for each module. + +*** + +### recordsInputPath? + +> `optional` **recordsInputPath**: `RecordsInputPath` + +Defined in: [declarations/WebpackOptions.d.ts:1008](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1008) + +Store compiler state to a json file. + +*** + +### recordsOutputPath? + +> `optional` **recordsOutputPath**: `RecordsOutputPath` + +Defined in: [declarations/WebpackOptions.d.ts:1012](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1012) + +Load compiler state from a json file. + +*** + +### recordsPath? + +> `optional` **recordsPath**: `RecordsPath` + +Defined in: [declarations/WebpackOptions.d.ts:1016](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1016) + +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. + +*** + +### resolve? + +> `optional` **resolve**: [`ResolveOptions`](ResolveOptions.md) + +Defined in: [declarations/WebpackOptions.d.ts:1020](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1020) + +Options for the resolver. + +*** + +### resolveLoader? + +> `optional` **resolveLoader**: [`ResolveOptions`](ResolveOptions.md) + +Defined in: [declarations/WebpackOptions.d.ts:1024](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1024) + +Options for the resolver when resolving loaders. + +*** + +### snapshot? + +> `optional` **snapshot**: `SnapshotOptions` + +Defined in: [declarations/WebpackOptions.d.ts:1028](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1028) + +Options affecting how file system snapshots are created and validated. + +*** + +### stats? + +> `optional` **stats**: `StatsValue` + +Defined in: [declarations/WebpackOptions.d.ts:1032](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1032) + +Stats options object or preset name. + +*** + +### target? + +> `optional` **target**: `Target` + +Defined in: [declarations/WebpackOptions.d.ts:1036](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1036) + +Environment to build for. An array of environments to build for all of them when possible. + +*** + +### validate? + +> `optional` **validate**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:1040](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1040) + +Enable validation of webpack configuration. Defaults to true in development mode. In production mode, defaults to true unless futureDefaults is enabled, then defaults to false. + +*** + +### watch? + +> `optional` **watch**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:1044](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1044) + +Enter watch mode, which rebuilds on file change. + +*** + +### watchOptions? + +> `optional` **watchOptions**: `WatchOptions` + +Defined in: [declarations/WebpackOptions.d.ts:1048](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1048) + +Options for the watcher. diff --git a/api/interfaces/EntryObject.md b/api/interfaces/EntryObject.md new file mode 100644 index 0000000..4c50e25 --- /dev/null +++ b/api/interfaces/EntryObject.md @@ -0,0 +1,21 @@ +--- +title: EntryObject +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / EntryObject + +# Interface: EntryObject + +Defined in: [declarations/WebpackOptions.d.ts:1177](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1177) + +Multiple entry bundles are created. The key is the entry name. The value can be a string, an array or an entry description object. + +## Indexable + +\[`k`: `string`\]: `EntryItem` \| `EntryDescription` + +An entry point with name. diff --git a/api/interfaces/ExternalItemFunctionData.md b/api/interfaces/ExternalItemFunctionData.md new file mode 100644 index 0000000..8b2e5c6 --- /dev/null +++ b/api/interfaces/ExternalItemFunctionData.md @@ -0,0 +1,63 @@ +--- +title: ExternalItemFunctionData +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / ExternalItemFunctionData + +# Interface: ExternalItemFunctionData + +Defined in: [lib/ExternalModuleFactoryPlugin.js:36](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/ExternalModuleFactoryPlugin.js#L36) + +## Properties + +### context + +> **context**: `string` + +Defined in: [lib/ExternalModuleFactoryPlugin.js:37](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/ExternalModuleFactoryPlugin.js#L37) + +the directory in which the request is placed + +*** + +### contextInfo + +> **contextInfo**: `ModuleFactoryCreateDataContextInfo` + +Defined in: [lib/ExternalModuleFactoryPlugin.js:38](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/ExternalModuleFactoryPlugin.js#L38) + +contextual information + +*** + +### dependencyType + +> **dependencyType**: `string` + +Defined in: [lib/ExternalModuleFactoryPlugin.js:39](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/ExternalModuleFactoryPlugin.js#L39) + +the category of the referencing dependency + +*** + +### getResolve + +> **getResolve**: [`ExternalItemFunctionDataGetResolve`](../type-aliases/ExternalItemFunctionDataGetResolve.md) + +Defined in: [lib/ExternalModuleFactoryPlugin.js:40](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/ExternalModuleFactoryPlugin.js#L40) + +get a resolve function with the current resolver options + +*** + +### request + +> **request**: `string` + +Defined in: [lib/ExternalModuleFactoryPlugin.js:41](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/ExternalModuleFactoryPlugin.js#L41) + +the request as written by the user in the require/import expression/statement diff --git a/api/interfaces/ExternalItemObjectKnown.md b/api/interfaces/ExternalItemObjectKnown.md new file mode 100644 index 0000000..c234958 --- /dev/null +++ b/api/interfaces/ExternalItemObjectKnown.md @@ -0,0 +1,25 @@ +--- +title: ExternalItemObjectKnown +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / ExternalItemObjectKnown + +# Interface: ExternalItemObjectKnown + +Defined in: [declarations/WebpackOptions.d.ts:4027](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L4027) + +If an dependency matches exactly a property of the object, the property value is used as dependency. + +## Properties + +### byLayer? + +> `optional` **byLayer**: \{\[`k`: `string`\]: [`ExternalItem`](../type-aliases/ExternalItem.md); \} \| `ExternalItemByLayerFn` + +Defined in: [declarations/WebpackOptions.d.ts:4031](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L4031) + +Specify externals depending on the layer. diff --git a/api/interfaces/ExternalItemObjectUnknown.md b/api/interfaces/ExternalItemObjectUnknown.md new file mode 100644 index 0000000..2595457 --- /dev/null +++ b/api/interfaces/ExternalItemObjectUnknown.md @@ -0,0 +1,19 @@ +--- +title: ExternalItemObjectUnknown +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / ExternalItemObjectUnknown + +# Interface: ExternalItemObjectUnknown + +Defined in: [declarations/WebpackOptions.d.ts:4040](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L4040) + +If an dependency matches exactly a property of the object, the property value is used as dependency. + +## Indexable + +\[`k`: `string`\]: [`ExternalItemValue`](../type-aliases/ExternalItemValue.md) diff --git a/api/interfaces/FileCacheOptions.md b/api/interfaces/FileCacheOptions.md new file mode 100644 index 0000000..5bf2515 --- /dev/null +++ b/api/interfaces/FileCacheOptions.md @@ -0,0 +1,221 @@ +--- +title: FileCacheOptions +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / FileCacheOptions + +# Interface: FileCacheOptions + +Defined in: [declarations/WebpackOptions.d.ts:1070](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1070) + +Options object for persistent file-based caching. + +## Properties + +### allowCollectingMemory? + +> `optional` **allowCollectingMemory**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:1074](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1074) + +Allows to collect unused memory allocated during deserialization. This requires copying data into smaller buffers and has a performance cost. + +*** + +### buildDependencies? + +> `optional` **buildDependencies**: `object` + +Defined in: [declarations/WebpackOptions.d.ts:1078](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1078) + +Dependencies the build depends on (in multiple categories, default categories: 'defaultWebpack'). + +#### Index Signature + +\[`k`: `string`\]: `string`[] + +List of dependencies the build depends on. + +*** + +### cacheDirectory? + +> `optional` **cacheDirectory**: `string` + +Defined in: [declarations/WebpackOptions.d.ts:1087](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1087) + +Base directory for the cache (defaults to node_modules/.cache/webpack). + +*** + +### cacheLocation? + +> `optional` **cacheLocation**: `string` + +Defined in: [declarations/WebpackOptions.d.ts:1091](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1091) + +Locations for the cache (defaults to cacheDirectory / name). + +*** + +### compression? + +> `optional` **compression**: `false` \| `"gzip"` \| `"brotli"` + +Defined in: [declarations/WebpackOptions.d.ts:1095](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1095) + +Compression type used for the cache files. + +*** + +### hashAlgorithm? + +> `optional` **hashAlgorithm**: `string` + +Defined in: [declarations/WebpackOptions.d.ts:1099](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1099) + +Algorithm used for generation the hash (see node.js crypto package). + +*** + +### idleTimeout? + +> `optional` **idleTimeout**: `number` + +Defined in: [declarations/WebpackOptions.d.ts:1103](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1103) + +Time in ms after which idle period the cache storing should happen. + +*** + +### idleTimeoutAfterLargeChanges? + +> `optional` **idleTimeoutAfterLargeChanges**: `number` + +Defined in: [declarations/WebpackOptions.d.ts:1107](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1107) + +Time in ms after which idle period the cache storing should happen when larger changes has been detected (cumulative build time > 2 x avg cache store time). + +*** + +### idleTimeoutForInitialStore? + +> `optional` **idleTimeoutForInitialStore**: `number` + +Defined in: [declarations/WebpackOptions.d.ts:1111](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1111) + +Time in ms after which idle period the initial cache storing should happen. + +*** + +### immutablePaths? + +> `optional` **immutablePaths**: (`string` \| `RegExp`)[] + +Defined in: [declarations/WebpackOptions.d.ts:1115](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1115) + +List of paths that are managed by a package manager and contain a version or hash in its path so all files are immutable. + +*** + +### managedPaths? + +> `optional` **managedPaths**: (`string` \| `RegExp`)[] + +Defined in: [declarations/WebpackOptions.d.ts:1119](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1119) + +List of paths that are managed by a package manager and can be trusted to not be modified otherwise. + +*** + +### maxAge? + +> `optional` **maxAge**: `number` + +Defined in: [declarations/WebpackOptions.d.ts:1123](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1123) + +Time for which unused cache entries stay in the filesystem cache at minimum (in milliseconds). + +*** + +### maxMemoryGenerations? + +> `optional` **maxMemoryGenerations**: `number` + +Defined in: [declarations/WebpackOptions.d.ts:1127](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1127) + +Number of generations unused cache entries stay in memory cache at minimum (0 = no memory cache used, 1 = may be removed after unused for a single compilation, ..., Infinity: kept forever). Cache entries will be deserialized from disk when removed from memory cache. + +*** + +### memoryCacheUnaffected? + +> `optional` **memoryCacheUnaffected**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:1131](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1131) + +Additionally cache computation of modules that are unchanged and reference only unchanged modules in memory. + +*** + +### name? + +> `optional` **name**: `string` + +Defined in: [declarations/WebpackOptions.d.ts:1135](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1135) + +Name for the cache. Different names will lead to different coexisting caches. + +*** + +### profile? + +> `optional` **profile**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:1139](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1139) + +Track and log detailed timing information for individual cache items. + +*** + +### readonly? + +> `optional` **readonly**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:1143](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1143) + +Enable/disable readonly mode. + +*** + +### store? + +> `optional` **store**: `"pack"` + +Defined in: [declarations/WebpackOptions.d.ts:1147](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1147) + +When to store data to the filesystem. (pack: Store data when compiler is idle in a single file). + +*** + +### type + +> **type**: `"filesystem"` + +Defined in: [declarations/WebpackOptions.d.ts:1151](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1151) + +Filesystem caching. + +*** + +### version? + +> `optional` **version**: `string` + +Defined in: [declarations/WebpackOptions.d.ts:1155](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1155) + +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. diff --git a/api/interfaces/GeneratorOptionsByModuleTypeKnown.md b/api/interfaces/GeneratorOptionsByModuleTypeKnown.md new file mode 100644 index 0000000..3dac91a --- /dev/null +++ b/api/interfaces/GeneratorOptionsByModuleTypeKnown.md @@ -0,0 +1,155 @@ +--- +title: GeneratorOptionsByModuleTypeKnown +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / GeneratorOptionsByModuleTypeKnown + +# Interface: GeneratorOptionsByModuleTypeKnown + +Defined in: [declarations/WebpackOptions.d.ts:4046](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L4046) + +Specify options for each generator. + +## Properties + +### asset? + +> `optional` **asset**: `AssetGeneratorOptions` + +Defined in: [declarations/WebpackOptions.d.ts:4050](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L4050) + +Generator options for asset modules. + +*** + +### asset/bytes? + +> `optional` **asset/bytes**: `EmptyGeneratorOptions` + +Defined in: [declarations/WebpackOptions.d.ts:4054](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L4054) + +No generator options are supported for this module type. + +*** + +### asset/inline? + +> `optional` **asset/inline**: `AssetInlineGeneratorOptions` + +Defined in: [declarations/WebpackOptions.d.ts:4058](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L4058) + +Generator options for asset/inline modules. + +*** + +### asset/resource? + +> `optional` **asset/resource**: `AssetResourceGeneratorOptions` + +Defined in: [declarations/WebpackOptions.d.ts:4062](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L4062) + +Generator options for asset/resource modules. + +*** + +### asset/source? + +> `optional` **asset/source**: `EmptyGeneratorOptions` + +Defined in: [declarations/WebpackOptions.d.ts:4066](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L4066) + +No generator options are supported for this module type. + +*** + +### css? + +> `optional` **css**: `CssGeneratorOptions` + +Defined in: [declarations/WebpackOptions.d.ts:4070](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L4070) + +Generator options for css modules. + +*** + +### css/auto? + +> `optional` **css/auto**: `CssModuleGeneratorOptions` + +Defined in: [declarations/WebpackOptions.d.ts:4074](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L4074) + +Generator options for css/module modules. + +*** + +### css/global? + +> `optional` **css/global**: `CssModuleGeneratorOptions` + +Defined in: [declarations/WebpackOptions.d.ts:4078](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L4078) + +Generator options for css/module modules. + +*** + +### css/module? + +> `optional` **css/module**: `CssModuleGeneratorOptions` + +Defined in: [declarations/WebpackOptions.d.ts:4082](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L4082) + +Generator options for css/module modules. + +*** + +### javascript? + +> `optional` **javascript**: `EmptyGeneratorOptions` + +Defined in: [declarations/WebpackOptions.d.ts:4086](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L4086) + +No generator options are supported for this module type. + +*** + +### javascript/auto? + +> `optional` **javascript/auto**: `EmptyGeneratorOptions` + +Defined in: [declarations/WebpackOptions.d.ts:4090](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L4090) + +No generator options are supported for this module type. + +*** + +### javascript/dynamic? + +> `optional` **javascript/dynamic**: `EmptyGeneratorOptions` + +Defined in: [declarations/WebpackOptions.d.ts:4094](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L4094) + +No generator options are supported for this module type. + +*** + +### javascript/esm? + +> `optional` **javascript/esm**: `EmptyGeneratorOptions` + +Defined in: [declarations/WebpackOptions.d.ts:4098](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L4098) + +No generator options are supported for this module type. + +*** + +### json? + +> `optional` **json**: `JsonGeneratorOptions` + +Defined in: [declarations/WebpackOptions.d.ts:4102](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L4102) + +Generator options for json modules. diff --git a/api/interfaces/InputFileSystem.md b/api/interfaces/InputFileSystem.md new file mode 100644 index 0000000..fb09f00 --- /dev/null +++ b/api/interfaces/InputFileSystem.md @@ -0,0 +1,195 @@ +--- +title: InputFileSystem +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / InputFileSystem + +# Interface: InputFileSystem + +Defined in: [lib/util/fs.js:286](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/util/fs.js#L286) + +## Properties + +### dirname()? + +> `optional` **dirname**: (`dirname`) => `string` + +Defined in: [lib/util/fs.js:304](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/util/fs.js#L304) + +#### Parameters + +##### dirname + +`string` + +#### Returns + +`string` + +*** + +### join()? + +> `optional` **join**: (`path1`, `path2`) => `string` + +Defined in: [lib/util/fs.js:302](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/util/fs.js#L302) + +#### Parameters + +##### path1 + +`string` + +##### path2 + +`string` + +#### Returns + +`string` + +*** + +### lstat? + +> `optional` **lstat**: `LStat` + +Defined in: [lib/util/fs.js:295](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/util/fs.js#L295) + +*** + +### lstatSync? + +> `optional` **lstatSync**: `LStatSync` + +Defined in: [lib/util/fs.js:296](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/util/fs.js#L296) + +*** + +### purge? + +> `optional` **purge**: `Purge` + +Defined in: [lib/util/fs.js:301](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/util/fs.js#L301) + +*** + +### readdir + +> **readdir**: `Readdir` + +Defined in: [lib/util/fs.js:291](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/util/fs.js#L291) + +*** + +### readdirSync? + +> `optional` **readdirSync**: `ReaddirSync` + +Defined in: [lib/util/fs.js:292](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/util/fs.js#L292) + +*** + +### readFile + +> **readFile**: `ReadFile` + +Defined in: [lib/util/fs.js:287](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/util/fs.js#L287) + +*** + +### readFileSync? + +> `optional` **readFileSync**: `ReadFileSync` + +Defined in: [lib/util/fs.js:288](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/util/fs.js#L288) + +*** + +### readJson? + +> `optional` **readJson**: `ReadJson` + +Defined in: [lib/util/fs.js:299](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/util/fs.js#L299) + +*** + +### readJsonSync? + +> `optional` **readJsonSync**: `ReadJsonSync` + +Defined in: [lib/util/fs.js:300](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/util/fs.js#L300) + +*** + +### readlink + +> **readlink**: `Readlink` + +Defined in: [lib/util/fs.js:289](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/util/fs.js#L289) + +*** + +### readlinkSync? + +> `optional` **readlinkSync**: `ReadlinkSync` + +Defined in: [lib/util/fs.js:290](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/util/fs.js#L290) + +*** + +### realpath? + +> `optional` **realpath**: `RealPath` + +Defined in: [lib/util/fs.js:297](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/util/fs.js#L297) + +*** + +### realpathSync? + +> `optional` **realpathSync**: `RealPathSync` + +Defined in: [lib/util/fs.js:298](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/util/fs.js#L298) + +*** + +### relative()? + +> `optional` **relative**: (`from`, `to`) => `string` + +Defined in: [lib/util/fs.js:303](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/util/fs.js#L303) + +#### Parameters + +##### from + +`string` + +##### to + +`string` + +#### Returns + +`string` + +*** + +### stat + +> **stat**: `Stat` + +Defined in: [lib/util/fs.js:293](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/util/fs.js#L293) + +*** + +### statSync? + +> `optional` **statSync**: `StatSync` + +Defined in: [lib/util/fs.js:294](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/util/fs.js#L294) diff --git a/api/interfaces/LibraryOptions.md b/api/interfaces/LibraryOptions.md new file mode 100644 index 0000000..a059c77 --- /dev/null +++ b/api/interfaces/LibraryOptions.md @@ -0,0 +1,75 @@ +--- +title: LibraryOptions +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / LibraryOptions + +# Interface: LibraryOptions + +Defined in: [declarations/WebpackOptions.d.ts:1235](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1235) + +Options for library. + +## Properties + +### amdContainer? + +> `optional` **amdContainer**: `string` + +Defined in: [declarations/WebpackOptions.d.ts:1239](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1239) + +Add a container for define/require functions in the AMD module. + +*** + +### auxiliaryComment? + +> `optional` **auxiliaryComment**: `AuxiliaryComment` + +Defined in: [declarations/WebpackOptions.d.ts:1243](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1243) + +Add a comment in the UMD wrapper. + +*** + +### export? + +> `optional` **export**: `LibraryExport` + +Defined in: [declarations/WebpackOptions.d.ts:1247](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1247) + +Specify which export should be exposed as library. + +*** + +### name? + +> `optional` **name**: `LibraryName` + +Defined in: [declarations/WebpackOptions.d.ts:1251](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1251) + +The name of the library (some types allow unnamed libraries too). + +*** + +### type + +> **type**: `string` + +Defined in: [declarations/WebpackOptions.d.ts:1255](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1255) + +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). + +*** + +### umdNamedDefine? + +> `optional` **umdNamedDefine**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:1259](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1259) + +If `output.libraryTarget` is set to umd and `output.library` is set, setting this to true will name the AMD module. diff --git a/api/interfaces/MemoryCacheOptions.md b/api/interfaces/MemoryCacheOptions.md new file mode 100644 index 0000000..b926b04 --- /dev/null +++ b/api/interfaces/MemoryCacheOptions.md @@ -0,0 +1,45 @@ +--- +title: MemoryCacheOptions +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / MemoryCacheOptions + +# Interface: MemoryCacheOptions + +Defined in: [declarations/WebpackOptions.d.ts:1053](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1053) + +Options object for in-memory caching. + +## Properties + +### cacheUnaffected? + +> `optional` **cacheUnaffected**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:1057](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1057) + +Additionally cache computation of modules that are unchanged and reference only unchanged modules. + +*** + +### maxGenerations? + +> `optional` **maxGenerations**: `number` + +Defined in: [declarations/WebpackOptions.d.ts:1061](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1061) + +Number of generations unused cache entries stay in memory cache at minimum (1 = may be removed after unused for a single compilation, ..., Infinity: kept forever). + +*** + +### type + +> **type**: `"memory"` + +Defined in: [declarations/WebpackOptions.d.ts:1065](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1065) + +In memory caching. diff --git a/api/interfaces/ModuleOptions.md b/api/interfaces/ModuleOptions.md new file mode 100644 index 0000000..8142633 --- /dev/null +++ b/api/interfaces/ModuleOptions.md @@ -0,0 +1,205 @@ +--- +title: ModuleOptions +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / ModuleOptions + +# Interface: ModuleOptions + +Defined in: [declarations/WebpackOptions.d.ts:1378](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1378) + +Options affecting the normal modules (`NormalModuleFactory`). + +## Properties + +### defaultRules? + +> `optional` **defaultRules**: `RuleSetRules` + +Defined in: [declarations/WebpackOptions.d.ts:1382](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1382) + +An array of rules applied by default for modules. + +*** + +### exprContextCritical? + +> `optional` **exprContextCritical**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:1386](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1386) + +Enable warnings for full dynamic dependencies. + +*** + +### exprContextRecursive? + +> `optional` **exprContextRecursive**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:1390](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1390) + +Enable recursive directory lookup for full dynamic dependencies. Deprecated: This option has moved to 'module.parser.javascript.exprContextRecursive'. + +*** + +### exprContextRegExp? + +> `optional` **exprContextRegExp**: `boolean` \| `RegExp` + +Defined in: [declarations/WebpackOptions.d.ts:1394](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1394) + +Sets the default regular expression for full dynamic dependencies. Deprecated: This option has moved to 'module.parser.javascript.exprContextRegExp'. + +*** + +### exprContextRequest? + +> `optional` **exprContextRequest**: `string` + +Defined in: [declarations/WebpackOptions.d.ts:1398](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1398) + +Set the default request for full dynamic dependencies. Deprecated: This option has moved to 'module.parser.javascript.exprContextRequest'. + +*** + +### generator? + +> `optional` **generator**: `GeneratorOptionsByModuleType` + +Defined in: [declarations/WebpackOptions.d.ts:1402](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1402) + +Specify options for each generator. + +*** + +### noParse? + +> `optional` **noParse**: `NoParse` + +Defined in: [declarations/WebpackOptions.d.ts:1406](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1406) + +Don't parse files matching. It's matched against the full resolved request. + +*** + +### parser? + +> `optional` **parser**: `ParserOptionsByModuleType` + +Defined in: [declarations/WebpackOptions.d.ts:1410](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1410) + +Specify options for each parser. + +*** + +### rules? + +> `optional` **rules**: `RuleSetRules` + +Defined in: [declarations/WebpackOptions.d.ts:1414](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1414) + +An array of rules applied for modules. + +*** + +### strictExportPresence? + +> `optional` **strictExportPresence**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:1418](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1418) + +Emit errors instead of warnings when imported names don't exist in imported module. Deprecated: This option has moved to 'module.parser.javascript.strictExportPresence'. + +*** + +### strictThisContextOnImports? + +> `optional` **strictThisContextOnImports**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:1422](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1422) + +Handle the this context correctly according to the spec for namespace objects. Deprecated: This option has moved to 'module.parser.javascript.strictThisContextOnImports'. + +*** + +### unknownContextCritical? + +> `optional` **unknownContextCritical**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:1426](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1426) + +Enable warnings when using the require function in a not statically analyse-able way. Deprecated: This option has moved to 'module.parser.javascript.unknownContextCritical'. + +*** + +### unknownContextRecursive? + +> `optional` **unknownContextRecursive**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:1430](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1430) + +Enable recursive directory lookup when using the require function in a not statically analyse-able way. Deprecated: This option has moved to 'module.parser.javascript.unknownContextRecursive'. + +*** + +### unknownContextRegExp? + +> `optional` **unknownContextRegExp**: `boolean` \| `RegExp` + +Defined in: [declarations/WebpackOptions.d.ts:1434](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1434) + +Sets the regular expression when using the require function in a not statically analyse-able way. Deprecated: This option has moved to 'module.parser.javascript.unknownContextRegExp'. + +*** + +### unknownContextRequest? + +> `optional` **unknownContextRequest**: `string` + +Defined in: [declarations/WebpackOptions.d.ts:1438](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1438) + +Sets the request when using the require function in a not statically analyse-able way. Deprecated: This option has moved to 'module.parser.javascript.unknownContextRequest'. + +*** + +### unsafeCache? + +> `optional` **unsafeCache**: `boolean` \| `UnsafeCachePredicate` + +Defined in: [declarations/WebpackOptions.d.ts:1442](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1442) + +Cache the resolving of module requests. + +*** + +### wrappedContextCritical? + +> `optional` **wrappedContextCritical**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:1446](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1446) + +Enable warnings for partial dynamic dependencies. Deprecated: This option has moved to 'module.parser.javascript.wrappedContextCritical'. + +*** + +### wrappedContextRecursive? + +> `optional` **wrappedContextRecursive**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:1450](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1450) + +Enable recursive directory lookup for partial dynamic dependencies. Deprecated: This option has moved to 'module.parser.javascript.wrappedContextRecursive'. + +*** + +### wrappedContextRegExp? + +> `optional` **wrappedContextRegExp**: `RegExp` + +Defined in: [declarations/WebpackOptions.d.ts:1454](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1454) + +Set the inner regular expression for partial dynamic dependencies. Deprecated: This option has moved to 'module.parser.javascript.wrappedContextRegExp'. diff --git a/api/interfaces/MultiCompilerOptions.md b/api/interfaces/MultiCompilerOptions.md new file mode 100644 index 0000000..0c998de --- /dev/null +++ b/api/interfaces/MultiCompilerOptions.md @@ -0,0 +1,23 @@ +--- +title: MultiCompilerOptions +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / MultiCompilerOptions + +# Interface: MultiCompilerOptions + +Defined in: [lib/MultiCompiler.js:50](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/MultiCompiler.js#L50) + +## Properties + +### parallelism? + +> `optional` **parallelism**: `number` + +Defined in: [lib/MultiCompiler.js:51](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/MultiCompiler.js#L51) + +how many Compilers are allows to run at the same time in parallel diff --git a/api/interfaces/ObjectDeserializerContext.md b/api/interfaces/ObjectDeserializerContext.md new file mode 100644 index 0000000..8f29425 --- /dev/null +++ b/api/interfaces/ObjectDeserializerContext.md @@ -0,0 +1,43 @@ +--- +title: ObjectDeserializerContext +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / ObjectDeserializerContext + +# Interface: ObjectDeserializerContext + +Defined in: [lib/serialization/ObjectMiddleware.js:73](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/serialization/ObjectMiddleware.js#L73) + +## Properties + +### read() + +> **read**: () => `EXPECTED_ANY` + +Defined in: [lib/serialization/ObjectMiddleware.js:74](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/serialization/ObjectMiddleware.js#L74) + +#### Returns + +`EXPECTED_ANY` + +*** + +### setCircularReference() + +> **setCircularReference**: (`value`) => `void` + +Defined in: [lib/serialization/ObjectMiddleware.js:75](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/serialization/ObjectMiddleware.js#L75) + +#### Parameters + +##### value + +`any` + +#### Returns + +`void` diff --git a/api/interfaces/ObjectSerializerContext.md b/api/interfaces/ObjectSerializerContext.md new file mode 100644 index 0000000..262cf2f --- /dev/null +++ b/api/interfaces/ObjectSerializerContext.md @@ -0,0 +1,119 @@ +--- +title: ObjectSerializerContext +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / ObjectSerializerContext + +# Interface: ObjectSerializerContext + +Defined in: [lib/serialization/ObjectMiddleware.js:63](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/serialization/ObjectMiddleware.js#L63) + +## Properties + +### rollback() + +> **rollback**: (`snapshot`) => `void` + +Defined in: [lib/serialization/ObjectMiddleware.js:67](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/serialization/ObjectMiddleware.js#L67) + +#### Parameters + +##### snapshot + +`ObjectSerializerSnapshot` + +#### Returns + +`void` + +*** + +### setCircularReference() + +> **setCircularReference**: (`value`) => `void` + +Defined in: [lib/serialization/ObjectMiddleware.js:65](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/serialization/ObjectMiddleware.js#L65) + +#### Parameters + +##### value + +`any` + +#### Returns + +`void` + +*** + +### snapshot() + +> **snapshot**: () => `ObjectSerializerSnapshot` + +Defined in: [lib/serialization/ObjectMiddleware.js:66](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/serialization/ObjectMiddleware.js#L66) + +#### Returns + +`ObjectSerializerSnapshot` + +*** + +### write() + +> **write**: (`value`) => `void` + +Defined in: [lib/serialization/ObjectMiddleware.js:64](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/serialization/ObjectMiddleware.js#L64) + +#### Parameters + +##### value + +`EXPECTED_ANY` + +#### Returns + +`void` + +*** + +### writeLazy()? + +> `optional` **writeLazy**: (`item`) => `void` + +Defined in: [lib/serialization/ObjectMiddleware.js:68](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/serialization/ObjectMiddleware.js#L68) + +#### Parameters + +##### item + +`any` + +#### Returns + +`void` + +*** + +### writeSeparate()? + +> `optional` **writeSeparate**: (`item`, `obj`) => `LazyFunction`\<`EXPECTED_ANY`, `EXPECTED_ANY`, `EXPECTED_ANY`, `LazyOptions`\> + +Defined in: [lib/serialization/ObjectMiddleware.js:69](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/serialization/ObjectMiddleware.js#L69) + +#### Parameters + +##### item + +`any` + +##### obj + +`LazyOptions` + +#### Returns + +`LazyFunction`\<`EXPECTED_ANY`, `EXPECTED_ANY`, `EXPECTED_ANY`, `LazyOptions`\> diff --git a/api/interfaces/OutputFileSystem.md b/api/interfaces/OutputFileSystem.md new file mode 100644 index 0000000..4937fab --- /dev/null +++ b/api/interfaces/OutputFileSystem.md @@ -0,0 +1,147 @@ +--- +title: OutputFileSystem +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / OutputFileSystem + +# Interface: OutputFileSystem + +Defined in: [lib/util/fs.js:356](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/util/fs.js#L356) + +## Properties + +### createReadStream? + +> `optional` **createReadStream**: `CreateReadStream` + +Defined in: [lib/util/fs.js:365](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/util/fs.js#L365) + +*** + +### dirname()? + +> `optional` **dirname**: (`dirname`) => `string` + +Defined in: [lib/util/fs.js:368](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/util/fs.js#L368) + +#### Parameters + +##### dirname + +`string` + +#### Returns + +`string` + +*** + +### join()? + +> `optional` **join**: (`path1`, `path2`) => `string` + +Defined in: [lib/util/fs.js:366](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/util/fs.js#L366) + +#### Parameters + +##### path1 + +`string` + +##### path2 + +`string` + +#### Returns + +`string` + +*** + +### lstat? + +> `optional` **lstat**: `LStat` + +Defined in: [lib/util/fs.js:363](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/util/fs.js#L363) + +*** + +### mkdir + +> **mkdir**: `Mkdir` + +Defined in: [lib/util/fs.js:357](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/util/fs.js#L357) + +*** + +### readdir? + +> `optional` **readdir**: `Readdir` + +Defined in: [lib/util/fs.js:358](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/util/fs.js#L358) + +*** + +### readFile + +> **readFile**: `ReadFile` + +Defined in: [lib/util/fs.js:364](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/util/fs.js#L364) + +*** + +### relative()? + +> `optional` **relative**: (`from`, `to`) => `string` + +Defined in: [lib/util/fs.js:367](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/util/fs.js#L367) + +#### Parameters + +##### from + +`string` + +##### to + +`string` + +#### Returns + +`string` + +*** + +### rmdir? + +> `optional` **rmdir**: `Rmdir` + +Defined in: [lib/util/fs.js:359](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/util/fs.js#L359) + +*** + +### stat + +> **stat**: `Stat` + +Defined in: [lib/util/fs.js:362](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/util/fs.js#L362) + +*** + +### unlink? + +> `optional` **unlink**: `Unlink` + +Defined in: [lib/util/fs.js:361](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/util/fs.js#L361) + +*** + +### writeFile + +> **writeFile**: `WriteFile` + +Defined in: [lib/util/fs.js:360](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/util/fs.js#L360) diff --git a/api/interfaces/ParserOptionsByModuleTypeKnown.md b/api/interfaces/ParserOptionsByModuleTypeKnown.md new file mode 100644 index 0000000..02d2b89 --- /dev/null +++ b/api/interfaces/ParserOptionsByModuleTypeKnown.md @@ -0,0 +1,155 @@ +--- +title: ParserOptionsByModuleTypeKnown +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / ParserOptionsByModuleTypeKnown + +# Interface: ParserOptionsByModuleTypeKnown + +Defined in: [declarations/WebpackOptions.d.ts:4118](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L4118) + +Specify options for each parser. + +## Properties + +### asset? + +> `optional` **asset**: `AssetParserOptions` + +Defined in: [declarations/WebpackOptions.d.ts:4122](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L4122) + +Parser options for asset modules. + +*** + +### asset/bytes? + +> `optional` **asset/bytes**: `EmptyParserOptions` + +Defined in: [declarations/WebpackOptions.d.ts:4126](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L4126) + +No parser options are supported for this module type. + +*** + +### asset/inline? + +> `optional` **asset/inline**: `EmptyParserOptions` + +Defined in: [declarations/WebpackOptions.d.ts:4130](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L4130) + +No parser options are supported for this module type. + +*** + +### asset/resource? + +> `optional` **asset/resource**: `EmptyParserOptions` + +Defined in: [declarations/WebpackOptions.d.ts:4134](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L4134) + +No parser options are supported for this module type. + +*** + +### asset/source? + +> `optional` **asset/source**: `EmptyParserOptions` + +Defined in: [declarations/WebpackOptions.d.ts:4138](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L4138) + +No parser options are supported for this module type. + +*** + +### css? + +> `optional` **css**: `CssParserOptions` + +Defined in: [declarations/WebpackOptions.d.ts:4142](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L4142) + +Parser options for css modules. + +*** + +### css/auto? + +> `optional` **css/auto**: `CssModuleParserOptions` + +Defined in: [declarations/WebpackOptions.d.ts:4146](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L4146) + +Parser options for css/module modules. + +*** + +### css/global? + +> `optional` **css/global**: `CssModuleParserOptions` + +Defined in: [declarations/WebpackOptions.d.ts:4150](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L4150) + +Parser options for css/module modules. + +*** + +### css/module? + +> `optional` **css/module**: `CssModuleParserOptions` + +Defined in: [declarations/WebpackOptions.d.ts:4154](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L4154) + +Parser options for css/module modules. + +*** + +### javascript? + +> `optional` **javascript**: `JavascriptParserOptions` + +Defined in: [declarations/WebpackOptions.d.ts:4158](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L4158) + +Parser options for javascript modules. + +*** + +### javascript/auto? + +> `optional` **javascript/auto**: `JavascriptParserOptions` + +Defined in: [declarations/WebpackOptions.d.ts:4162](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L4162) + +Parser options for javascript modules. + +*** + +### javascript/dynamic? + +> `optional` **javascript/dynamic**: `JavascriptParserOptions` + +Defined in: [declarations/WebpackOptions.d.ts:4166](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L4166) + +Parser options for javascript modules. + +*** + +### javascript/esm? + +> `optional` **javascript/esm**: `JavascriptParserOptions` + +Defined in: [declarations/WebpackOptions.d.ts:4170](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L4170) + +Parser options for javascript modules. + +*** + +### json? + +> `optional` **json**: `JsonParserOptions` + +Defined in: [declarations/WebpackOptions.d.ts:4174](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L4174) + +Parser options for JSON modules. diff --git a/api/interfaces/PathData.md b/api/interfaces/PathData.md new file mode 100644 index 0000000..e5d846b --- /dev/null +++ b/api/interfaces/PathData.md @@ -0,0 +1,133 @@ +--- +title: PathData +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / PathData + +# Interface: PathData + +Defined in: [lib/Compilation.js:337](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/Compilation.js#L337) + +## Properties + +### basename? + +> `optional` **basename**: `string` + +Defined in: [lib/Compilation.js:345](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/Compilation.js#L345) + +*** + +### chunk? + +> `optional` **chunk**: `Chunk` \| `ChunkPathData` + +Defined in: [lib/Compilation.js:341](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/Compilation.js#L341) + +*** + +### chunkGraph? + +> `optional` **chunkGraph**: `ChunkGraph` + +Defined in: [lib/Compilation.js:338](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/Compilation.js#L338) + +*** + +### contentHash? + +> `optional` **contentHash**: `string` + +Defined in: [lib/Compilation.js:348](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/Compilation.js#L348) + +*** + +### contentHashType? + +> `optional` **contentHashType**: `string` + +Defined in: [lib/Compilation.js:347](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/Compilation.js#L347) + +*** + +### contentHashWithLength? + +> `optional` **contentHashWithLength**: `HashWithLengthFunction` + +Defined in: [lib/Compilation.js:349](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/Compilation.js#L349) + +*** + +### filename? + +> `optional` **filename**: `string` + +Defined in: [lib/Compilation.js:344](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/Compilation.js#L344) + +*** + +### hash? + +> `optional` **hash**: `string` + +Defined in: [lib/Compilation.js:339](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/Compilation.js#L339) + +*** + +### hashWithLength? + +> `optional` **hashWithLength**: `HashWithLengthFunction` + +Defined in: [lib/Compilation.js:340](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/Compilation.js#L340) + +*** + +### module? + +> `optional` **module**: `Module` \| `ModulePathData` + +Defined in: [lib/Compilation.js:342](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/Compilation.js#L342) + +*** + +### noChunkHash? + +> `optional` **noChunkHash**: `boolean` + +Defined in: [lib/Compilation.js:350](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/Compilation.js#L350) + +*** + +### prepareId? + +> `optional` **prepareId**: `PrepareIdFunction` + +Defined in: [lib/Compilation.js:352](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/Compilation.js#L352) + +*** + +### query? + +> `optional` **query**: `string` + +Defined in: [lib/Compilation.js:346](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/Compilation.js#L346) + +*** + +### runtime? + +> `optional` **runtime**: `RuntimeSpec` + +Defined in: [lib/Compilation.js:343](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/Compilation.js#L343) + +*** + +### url? + +> `optional` **url**: `string` + +Defined in: [lib/Compilation.js:351](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/Compilation.js#L351) diff --git a/api/interfaces/Problem.md b/api/interfaces/Problem.md new file mode 100644 index 0000000..f829dcf --- /dev/null +++ b/api/interfaces/Problem.md @@ -0,0 +1,61 @@ +--- +title: Problem +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / Problem + +# Interface: Problem + +Defined in: [lib/cli.js:30](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/cli.js#L30) + +## Properties + +### argument + +> **argument**: `string` + +Defined in: [lib/cli.js:33](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/cli.js#L33) + +*** + +### expected? + +> `optional` **expected**: `string` + +Defined in: [lib/cli.js:36](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/cli.js#L36) + +*** + +### index? + +> `optional` **index**: `number` + +Defined in: [lib/cli.js:35](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/cli.js#L35) + +*** + +### path + +> **path**: `string` + +Defined in: [lib/cli.js:32](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/cli.js#L32) + +*** + +### type + +> **type**: `ProblemType` + +Defined in: [lib/cli.js:31](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/cli.js#L31) + +*** + +### value? + +> `optional` **value**: `Value` + +Defined in: [lib/cli.js:34](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/cli.js#L34) diff --git a/api/interfaces/RenderManifestOptions.md b/api/interfaces/RenderManifestOptions.md new file mode 100644 index 0000000..74d48eb --- /dev/null +++ b/api/interfaces/RenderManifestOptions.md @@ -0,0 +1,99 @@ +--- +title: RenderManifestOptions +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / RenderManifestOptions + +# Interface: RenderManifestOptions + +Defined in: [lib/Template.js:46](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/Template.js#L46) + +## Properties + +### chunk + +> **chunk**: `Chunk` + +Defined in: [lib/Template.js:47](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/Template.js#L47) + +the chunk used to render + +*** + +### chunkGraph + +> **chunkGraph**: `ChunkGraph` + +Defined in: [lib/Template.js:56](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/Template.js#L56) + +*** + +### codeGenerationResults + +> **codeGenerationResults**: `CodeGenerationResults` + +Defined in: [lib/Template.js:51](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/Template.js#L51) + +*** + +### dependencyTemplates + +> **dependencyTemplates**: `DependencyTemplates` + +Defined in: [lib/Template.js:53](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/Template.js#L53) + +*** + +### fullHash + +> **fullHash**: `string` + +Defined in: [lib/Template.js:49](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/Template.js#L49) + +*** + +### hash + +> **hash**: `string` + +Defined in: [lib/Template.js:48](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/Template.js#L48) + +*** + +### moduleGraph + +> **moduleGraph**: `ModuleGraph` + +Defined in: [lib/Template.js:55](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/Template.js#L55) + +*** + +### moduleTemplates + +> **moduleTemplates**: `object` + +Defined in: [lib/Template.js:52](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/Template.js#L52) + +#### javascript + +> **javascript**: `ModuleTemplate` + +*** + +### outputOptions + +> **outputOptions**: `OutputNormalizedWithDefaults` + +Defined in: [lib/Template.js:50](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/Template.js#L50) + +*** + +### runtimeTemplate + +> **runtimeTemplate**: `RuntimeTemplate` + +Defined in: [lib/Template.js:54](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/Template.js#L54) diff --git a/api/interfaces/ResolveData.md b/api/interfaces/ResolveData.md new file mode 100644 index 0000000..8e3f405 --- /dev/null +++ b/api/interfaces/ResolveData.md @@ -0,0 +1,119 @@ +--- +title: ResolveData +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / ResolveData + +# Interface: ResolveData + +Defined in: [lib/NormalModuleFactory.js:70](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/NormalModuleFactory.js#L70) + +## Properties + +### attributes + +> **attributes**: `ImportAttributes` + +Defined in: [lib/NormalModuleFactory.js:75](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/NormalModuleFactory.js#L75) + +*** + +### cacheable + +> **cacheable**: `boolean` + +Defined in: [lib/NormalModuleFactory.js:83](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/NormalModuleFactory.js#L83) + +allow to use the unsafe cache + +*** + +### context + +> **context**: `string` + +Defined in: [lib/NormalModuleFactory.js:73](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/NormalModuleFactory.js#L73) + +*** + +### contextDependencies + +> **contextDependencies**: `FileSystemDependencies` + +Defined in: [lib/NormalModuleFactory.js:81](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/NormalModuleFactory.js#L81) + +*** + +### contextInfo + +> **contextInfo**: `ModuleFactoryCreateDataContextInfo` + +Defined in: [lib/NormalModuleFactory.js:71](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/NormalModuleFactory.js#L71) + +*** + +### createData + +> **createData**: `Partial`\<`NormalModuleCreateData` & `object`\> + +Defined in: [lib/NormalModuleFactory.js:78](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/NormalModuleFactory.js#L78) + +*** + +### dependencies + +> **dependencies**: `ModuleDependency`[] + +Defined in: [lib/NormalModuleFactory.js:76](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/NormalModuleFactory.js#L76) + +*** + +### dependencyType + +> **dependencyType**: `string` + +Defined in: [lib/NormalModuleFactory.js:77](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/NormalModuleFactory.js#L77) + +*** + +### fileDependencies + +> **fileDependencies**: `FileSystemDependencies` + +Defined in: [lib/NormalModuleFactory.js:79](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/NormalModuleFactory.js#L79) + +*** + +### ignoredModule? + +> `optional` **ignoredModule**: `Module` + +Defined in: [lib/NormalModuleFactory.js:82](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/NormalModuleFactory.js#L82) + +*** + +### missingDependencies + +> **missingDependencies**: `FileSystemDependencies` + +Defined in: [lib/NormalModuleFactory.js:80](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/NormalModuleFactory.js#L80) + +*** + +### request + +> **request**: `string` + +Defined in: [lib/NormalModuleFactory.js:74](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/NormalModuleFactory.js#L74) + +*** + +### resolveOptions + +> **resolveOptions**: [`ResolveOptions`](ResolveOptions.md) + +Defined in: [lib/NormalModuleFactory.js:72](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/NormalModuleFactory.js#L72) diff --git a/api/interfaces/ResolveOptions.md b/api/interfaces/ResolveOptions.md new file mode 100644 index 0000000..d2f1f36 --- /dev/null +++ b/api/interfaces/ResolveOptions.md @@ -0,0 +1,347 @@ +--- +title: ResolveOptions +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / ResolveOptions + +# Interface: ResolveOptions + +Defined in: [declarations/WebpackOptions.d.ts:1624](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1624) + +Options object for resolving requests. + +## Properties + +### alias? + +> `optional` **alias**: `ResolveAlias` + +Defined in: [declarations/WebpackOptions.d.ts:1628](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1628) + +Redirect module requests. + +*** + +### aliasFields? + +> `optional` **aliasFields**: (`string` \| `string`[])[] + +Defined in: [declarations/WebpackOptions.d.ts:1632](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1632) + +Fields in the description file (usually package.json) which are used to redirect requests inside the module. + +*** + +### byDependency? + +> `optional` **byDependency**: `object` + +Defined in: [declarations/WebpackOptions.d.ts:1636](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1636) + +Extra resolve options per dependency category. Typical categories are "commonjs", "amd", "esm". + +#### Index Signature + +\[`k`: `string`\]: `ResolveOptions` + +Options object for resolving requests. + +*** + +### cache? + +> `optional` **cache**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:1645](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1645) + +Enable caching of successfully resolved requests (cache entries are revalidated). + +*** + +### cachePredicate()? + +> `optional` **cachePredicate**: (`request`) => `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:1649](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1649) + +Predicate function to decide which requests should be cached. + +#### Parameters + +##### request + +`ResolveRequest` + +#### Returns + +`boolean` + +*** + +### cacheWithContext? + +> `optional` **cacheWithContext**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:1655](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1655) + +Include the context information in the cache identifier when caching. + +*** + +### conditionNames? + +> `optional` **conditionNames**: `string`[] + +Defined in: [declarations/WebpackOptions.d.ts:1659](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1659) + +Condition names for exports field entry point. + +*** + +### descriptionFiles? + +> `optional` **descriptionFiles**: `string`[] + +Defined in: [declarations/WebpackOptions.d.ts:1663](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1663) + +Filenames used to find a description file (like a package.json). + +*** + +### enforceExtension? + +> `optional` **enforceExtension**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:1667](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1667) + +Enforce the resolver to use one of the extensions from the extensions option (User must specify requests without extension). + +*** + +### exportsFields? + +> `optional` **exportsFields**: `string`[] + +Defined in: [declarations/WebpackOptions.d.ts:1671](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1671) + +Field names from the description file (usually package.json) which are used to provide entry points of a package. + +*** + +### extensionAlias? + +> `optional` **extensionAlias**: `object` + +Defined in: [declarations/WebpackOptions.d.ts:1675](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1675) + +An object which maps extension to extension aliases. + +#### Index Signature + +\[`k`: `string`\]: `string` \| `string`[] + +Extension alias. + +*** + +### extensions? + +> `optional` **extensions**: `string`[] + +Defined in: [declarations/WebpackOptions.d.ts:1684](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1684) + +Extensions added to the request when trying to find the file. + +*** + +### fallback? + +> `optional` **fallback**: `ResolveAlias` + +Defined in: [declarations/WebpackOptions.d.ts:1688](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1688) + +Redirect module requests when normal resolving fails. + +*** + +### fileSystem? + +> `optional` **fileSystem**: [`InputFileSystem`](InputFileSystem.md) + +Defined in: [declarations/WebpackOptions.d.ts:1692](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1692) + +Filesystem for the resolver. + +*** + +### fullySpecified? + +> `optional` **fullySpecified**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:1696](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1696) + +Treats the request specified by the user as fully specified, meaning no extensions are added and the mainFiles in directories are not resolved (This doesn't affect requests from mainFields, aliasFields or aliases). + +*** + +### importsFields? + +> `optional` **importsFields**: `string`[] + +Defined in: [declarations/WebpackOptions.d.ts:1700](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1700) + +Field names from the description file (usually package.json) which are used to provide internal request of a package (requests starting with # are considered as internal). + +*** + +### mainFields? + +> `optional` **mainFields**: (`string` \| `string`[])[] + +Defined in: [declarations/WebpackOptions.d.ts:1704](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1704) + +Field names from the description file (package.json) which are used to find the default entry point. + +*** + +### mainFiles? + +> `optional` **mainFiles**: `string`[] + +Defined in: [declarations/WebpackOptions.d.ts:1708](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1708) + +Filenames used to find the default entry point if there is no description file or main field. + +*** + +### modules? + +> `optional` **modules**: `string`[] + +Defined in: [declarations/WebpackOptions.d.ts:1712](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1712) + +Folder names or directory paths where to find modules. + +*** + +### plugins? + +> `optional` **plugins**: (`"..."` \| [`ResolvePluginInstance`](../type-aliases/ResolvePluginInstance.md) \| `Falsy`)[] + +Defined in: [declarations/WebpackOptions.d.ts:1716](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1716) + +Plugins for the resolver. + +*** + +### preferAbsolute? + +> `optional` **preferAbsolute**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:1720](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1720) + +Prefer to resolve server-relative URLs (starting with '/') as absolute paths before falling back to resolve in 'resolve.roots'. + +*** + +### preferRelative? + +> `optional` **preferRelative**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:1724](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1724) + +Prefer to resolve module requests as relative request and fallback to resolving as module. + +*** + +### resolver? + +> `optional` **resolver**: `Resolver` + +Defined in: [declarations/WebpackOptions.d.ts:1728](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1728) + +Custom resolver. + +*** + +### restrictions? + +> `optional` **restrictions**: (`string` \| `RegExp`)[] + +Defined in: [declarations/WebpackOptions.d.ts:1732](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1732) + +A list of resolve restrictions. Resolve results must fulfill all of these restrictions to resolve successfully. Other resolve paths are taken when restrictions are not met. + +*** + +### roots? + +> `optional` **roots**: `string`[] + +Defined in: [declarations/WebpackOptions.d.ts:1736](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1736) + +A list of directories in which requests that are server-relative URLs (starting with '/') are resolved. + +*** + +### symlinks? + +> `optional` **symlinks**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:1740](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1740) + +Enable resolving symlinks to the original location. + +*** + +### tsconfig? + +> `optional` **tsconfig**: `string` \| `boolean` \| \{ `configFile?`: `string`; `references?`: `string`; \} + +Defined in: [declarations/WebpackOptions.d.ts:1744](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1744) + +TypeScript config for paths mapping. Can be `false` (disabled), `true` (use default `tsconfig.json`), a string path to `tsconfig.json`, or an object with `configFile` and `references` options. + +#### Type Declaration + +`string` + +`boolean` + +\{ `configFile?`: `string`; `references?`: `string`; \} + +#### configFile? + +> `optional` **configFile**: `string` + +A path to the tsconfig file. + +#### references? + +> `optional` **references**: `string` + +References to other tsconfig files. 'auto' inherits from TypeScript config, or an array of relative/absolute paths. + +*** + +### unsafeCache? + +> `optional` **unsafeCache**: `boolean` \| \{\[`k`: `string`\]: `any`; \} + +Defined in: [declarations/WebpackOptions.d.ts:1760](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1760) + +Enable caching of successfully resolved requests (cache entries are not revalidated). + +*** + +### useSyncFileSystemCalls? + +> `optional` **useSyncFileSystemCalls**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:1768](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1768) + +Use synchronous filesystem calls for the resolver. diff --git a/api/interfaces/RuleSetRule.md b/api/interfaces/RuleSetRule.md new file mode 100644 index 0000000..e08e0ff --- /dev/null +++ b/api/interfaces/RuleSetRule.md @@ -0,0 +1,325 @@ +--- +title: RuleSetRule +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / RuleSetRule + +# Interface: RuleSetRule + +Defined in: [declarations/WebpackOptions.d.ts:1459](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1459) + +A rule description with conditions and effects for modules. + +## Properties + +### assert? + +> `optional` **assert**: `object` + +Defined in: [declarations/WebpackOptions.d.ts:1463](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1463) + +Match on import assertions of the dependency. + +#### Index Signature + +\[`k`: `string`\]: `RuleSetConditionOrConditions` + +*** + +### compiler? + +> `optional` **compiler**: `RuleSetConditionOrConditions` + +Defined in: [declarations/WebpackOptions.d.ts:1469](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1469) + +Match the child compiler name. + +*** + +### dependency? + +> `optional` **dependency**: `RuleSetConditionOrConditions` + +Defined in: [declarations/WebpackOptions.d.ts:1473](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1473) + +Match dependency type. + +*** + +### descriptionData? + +> `optional` **descriptionData**: `object` + +Defined in: [declarations/WebpackOptions.d.ts:1477](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1477) + +Match values of properties in the description file (usually package.json). + +#### Index Signature + +\[`k`: `string`\]: `RuleSetConditionOrConditions` + +*** + +### enforce? + +> `optional` **enforce**: `"pre"` \| `"post"` + +Defined in: [declarations/WebpackOptions.d.ts:1483](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1483) + +Enforce this rule as pre or post step. + +*** + +### exclude? + +> `optional` **exclude**: `RuleSetConditionOrConditionsAbsolute` + +Defined in: [declarations/WebpackOptions.d.ts:1487](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1487) + +Shortcut for resource.exclude. + +*** + +### extractSourceMap? + +> `optional` **extractSourceMap**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:1491](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1491) + +Enable/Disable extracting source map. + +*** + +### generator? + +> `optional` **generator**: `object` + +Defined in: [declarations/WebpackOptions.d.ts:1495](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1495) + +The options for the module generator. + +#### Index Signature + +\[`k`: `string`\]: `any` + +*** + +### include? + +> `optional` **include**: `RuleSetConditionOrConditionsAbsolute` + +Defined in: [declarations/WebpackOptions.d.ts:1501](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1501) + +Shortcut for resource.include. + +*** + +### issuer? + +> `optional` **issuer**: `RuleSetConditionOrConditionsAbsolute` + +Defined in: [declarations/WebpackOptions.d.ts:1505](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1505) + +Match the issuer of the module (The module pointing to this module). + +*** + +### issuerLayer? + +> `optional` **issuerLayer**: `RuleSetConditionOrConditions` + +Defined in: [declarations/WebpackOptions.d.ts:1509](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1509) + +Match layer of the issuer of this module (The module pointing to this module). + +*** + +### layer? + +> `optional` **layer**: `string` + +Defined in: [declarations/WebpackOptions.d.ts:1513](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1513) + +Specifies the layer in which the module should be placed in. + +*** + +### loader? + +> `optional` **loader**: `string` + +Defined in: [declarations/WebpackOptions.d.ts:1517](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1517) + +Shortcut for use.loader. + +*** + +### mimetype? + +> `optional` **mimetype**: `RuleSetConditionOrConditions` + +Defined in: [declarations/WebpackOptions.d.ts:1521](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1521) + +Match module mimetype when load from Data URI. + +*** + +### oneOf? + +> `optional` **oneOf**: (`Falsy` \| `RuleSetRule`)[] + +Defined in: [declarations/WebpackOptions.d.ts:1525](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1525) + +Only execute the first matching rule in this array. + +*** + +### options? + +> `optional` **options**: `RuleSetLoaderOptions` + +Defined in: [declarations/WebpackOptions.d.ts:1529](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1529) + +Shortcut for use.options. + +*** + +### parser? + +> `optional` **parser**: `object` + +Defined in: [declarations/WebpackOptions.d.ts:1533](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1533) + +Options for parsing. + +#### Index Signature + +\[`k`: `string`\]: `any` + +*** + +### realResource? + +> `optional` **realResource**: `RuleSetConditionOrConditionsAbsolute` + +Defined in: [declarations/WebpackOptions.d.ts:1539](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1539) + +Match the real resource path of the module. + +*** + +### resolve? + +> `optional` **resolve**: [`ResolveOptions`](ResolveOptions.md) + +Defined in: [declarations/WebpackOptions.d.ts:1543](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1543) + +Options for the resolver. + +*** + +### resource? + +> `optional` **resource**: `RuleSetConditionOrConditionsAbsolute` + +Defined in: [declarations/WebpackOptions.d.ts:1547](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1547) + +Match the resource path of the module. + +*** + +### resourceFragment? + +> `optional` **resourceFragment**: `RuleSetConditionOrConditions` + +Defined in: [declarations/WebpackOptions.d.ts:1551](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1551) + +Match the resource fragment of the module. + +*** + +### resourceQuery? + +> `optional` **resourceQuery**: `RuleSetConditionOrConditions` + +Defined in: [declarations/WebpackOptions.d.ts:1555](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1555) + +Match the resource query of the module. + +*** + +### rules? + +> `optional` **rules**: (`Falsy` \| `RuleSetRule`)[] + +Defined in: [declarations/WebpackOptions.d.ts:1559](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1559) + +Match and execute these rules when this rule is matched. + +*** + +### scheme? + +> `optional` **scheme**: `RuleSetConditionOrConditions` + +Defined in: [declarations/WebpackOptions.d.ts:1563](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1563) + +Match module scheme. + +*** + +### sideEffects? + +> `optional` **sideEffects**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:1567](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1567) + +Flags a module as with or without side effects. + +*** + +### test? + +> `optional` **test**: `RuleSetConditionOrConditionsAbsolute` + +Defined in: [declarations/WebpackOptions.d.ts:1571](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1571) + +Shortcut for resource.test. + +*** + +### type? + +> `optional` **type**: `string` + +Defined in: [declarations/WebpackOptions.d.ts:1575](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1575) + +Module type to use for the module. + +*** + +### use? + +> `optional` **use**: [`RuleSetUse`](../type-aliases/RuleSetUse.md) + +Defined in: [declarations/WebpackOptions.d.ts:1579](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1579) + +Modifiers applied to the module when rule is matched. + +*** + +### with? + +> `optional` **with**: `object` + +Defined in: [declarations/WebpackOptions.d.ts:1583](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1583) + +Match on import attributes of the dependency. + +#### Index Signature + +\[`k`: `string`\]: `RuleSetConditionOrConditions` diff --git a/api/interfaces/StatsOptions.md b/api/interfaces/StatsOptions.md new file mode 100644 index 0000000..e5270fd --- /dev/null +++ b/api/interfaces/StatsOptions.md @@ -0,0 +1,847 @@ +--- +title: StatsOptions +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / StatsOptions + +# Interface: StatsOptions + +Defined in: [declarations/WebpackOptions.d.ts:2567](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2567) + +Stats options object. + +## Properties + +### all? + +> `optional` **all**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:2571](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2571) + +Fallback value for stats options when an option is not defined (has precedence over local webpack defaults). + +*** + +### assets? + +> `optional` **assets**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:2575](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2575) + +Add assets information. + +*** + +### assetsSort? + +> `optional` **assetsSort**: `string` \| `false` + +Defined in: [declarations/WebpackOptions.d.ts:2579](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2579) + +Sort the assets by that field. + +*** + +### assetsSpace? + +> `optional` **assetsSpace**: `number` + +Defined in: [declarations/WebpackOptions.d.ts:2583](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2583) + +Space to display assets (groups will be collapsed to fit this space). + +*** + +### builtAt? + +> `optional` **builtAt**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:2587](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2587) + +Add built at time information. + +*** + +### cached? + +> `optional` **cached**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:2591](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2591) + +Add information about cached (not built) modules (deprecated: use 'cachedModules' instead). + +*** + +### cachedAssets? + +> `optional` **cachedAssets**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:2595](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2595) + +Show cached assets (setting this to `false` only shows emitted files). + +*** + +### cachedModules? + +> `optional` **cachedModules**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:2599](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2599) + +Add information about cached (not built) modules. + +*** + +### children? + +> `optional` **children**: `StatsValue` \| `StatsValue`[] + +Defined in: [declarations/WebpackOptions.d.ts:2603](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2603) + +Add children information. + +*** + +### chunkGroupAuxiliary? + +> `optional` **chunkGroupAuxiliary**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:2607](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2607) + +Display auxiliary assets in chunk groups. + +*** + +### chunkGroupChildren? + +> `optional` **chunkGroupChildren**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:2611](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2611) + +Display children of chunk groups. + +*** + +### chunkGroupMaxAssets? + +> `optional` **chunkGroupMaxAssets**: `number` + +Defined in: [declarations/WebpackOptions.d.ts:2615](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2615) + +Limit of assets displayed in chunk groups. + +*** + +### chunkGroups? + +> `optional` **chunkGroups**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:2619](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2619) + +Display all chunk groups with the corresponding bundles. + +*** + +### chunkModules? + +> `optional` **chunkModules**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:2623](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2623) + +Add built modules information to chunk information. + +*** + +### chunkModulesSpace? + +> `optional` **chunkModulesSpace**: `number` + +Defined in: [declarations/WebpackOptions.d.ts:2627](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2627) + +Space to display chunk modules (groups will be collapsed to fit this space, value is in number of modules/group). + +*** + +### chunkOrigins? + +> `optional` **chunkOrigins**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:2631](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2631) + +Add the origins of chunks and chunk merging info. + +*** + +### chunkRelations? + +> `optional` **chunkRelations**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:2635](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2635) + +Add information about parent, children and sibling chunks to chunk information. + +*** + +### chunks? + +> `optional` **chunks**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:2639](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2639) + +Add chunk information. + +*** + +### chunksSort? + +> `optional` **chunksSort**: `string` \| `false` + +Defined in: [declarations/WebpackOptions.d.ts:2643](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2643) + +Sort the chunks by that field. + +*** + +### colors? + +> `optional` **colors**: `boolean` \| \{ `bold?`: `string`; `cyan?`: `string`; `green?`: `string`; `magenta?`: `string`; `red?`: `string`; `yellow?`: `string`; \} + +Defined in: [declarations/WebpackOptions.d.ts:2647](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2647) + +Enables/Disables colorful output. + +#### Type Declaration + +`boolean` + +\{ `bold?`: `string`; `cyan?`: `string`; `green?`: `string`; `magenta?`: `string`; `red?`: `string`; `yellow?`: `string`; \} + +#### bold? + +> `optional` **bold**: `string` + +Custom color for bold text. + +#### cyan? + +> `optional` **cyan**: `string` + +Custom color for cyan text. + +#### green? + +> `optional` **green**: `string` + +Custom color for green text. + +#### magenta? + +> `optional` **magenta**: `string` + +Custom color for magenta text. + +#### red? + +> `optional` **red**: `string` + +Custom color for red text. + +#### yellow? + +> `optional` **yellow**: `string` + +Custom color for yellow text. + +*** + +### context? + +> `optional` **context**: `string` + +Defined in: [declarations/WebpackOptions.d.ts:2678](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2678) + +Context directory for request shortening. + +*** + +### dependentModules? + +> `optional` **dependentModules**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:2682](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2682) + +Show chunk modules that are dependencies of other modules of the chunk. + +*** + +### depth? + +> `optional` **depth**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:2686](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2686) + +Add module depth in module graph. + +*** + +### entrypoints? + +> `optional` **entrypoints**: `boolean` \| `"auto"` + +Defined in: [declarations/WebpackOptions.d.ts:2690](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2690) + +Display the entry points with the corresponding bundles. + +*** + +### env? + +> `optional` **env**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:2694](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2694) + +Add --env information. + +*** + +### errorCause? + +> `optional` **errorCause**: `boolean` \| `"auto"` + +Defined in: [declarations/WebpackOptions.d.ts:2698](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2698) + +Add cause to errors. + +*** + +### errorDetails? + +> `optional` **errorDetails**: `boolean` \| `"auto"` + +Defined in: [declarations/WebpackOptions.d.ts:2702](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2702) + +Add details to errors (like resolving log). + +*** + +### errorErrors? + +> `optional` **errorErrors**: `boolean` \| `"auto"` + +Defined in: [declarations/WebpackOptions.d.ts:2706](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2706) + +Add nested errors to errors (like in AggregateError). + +*** + +### errors? + +> `optional` **errors**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:2714](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2714) + +Add errors. + +*** + +### errorsCount? + +> `optional` **errorsCount**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:2718](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2718) + +Add errors count. + +*** + +### errorsSpace? + +> `optional` **errorsSpace**: `number` + +Defined in: [declarations/WebpackOptions.d.ts:2722](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2722) + +Space to display errors (value is in number of lines). + +*** + +### errorStack? + +> `optional` **errorStack**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:2710](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2710) + +Add internal stack trace to errors. + +*** + +### exclude? + +> `optional` **exclude**: `boolean` \| `ModuleFilterTypes` + +Defined in: [declarations/WebpackOptions.d.ts:2726](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2726) + +Please use excludeModules instead. + +*** + +### excludeAssets? + +> `optional` **excludeAssets**: `AssetFilterTypes` + +Defined in: [declarations/WebpackOptions.d.ts:2730](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2730) + +Suppress assets that match the specified filters. Filters can be Strings, RegExps or Functions. + +*** + +### excludeModules? + +> `optional` **excludeModules**: `boolean` \| `ModuleFilterTypes` + +Defined in: [declarations/WebpackOptions.d.ts:2734](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2734) + +Suppress modules that match the specified filters. Filters can be Strings, RegExps, Booleans or Functions. + +*** + +### groupAssetsByChunk? + +> `optional` **groupAssetsByChunk**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:2738](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2738) + +Group assets by how their are related to chunks. + +*** + +### groupAssetsByEmitStatus? + +> `optional` **groupAssetsByEmitStatus**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:2742](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2742) + +Group assets by their status (emitted, compared for emit or cached). + +*** + +### groupAssetsByExtension? + +> `optional` **groupAssetsByExtension**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:2746](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2746) + +Group assets by their extension. + +*** + +### groupAssetsByInfo? + +> `optional` **groupAssetsByInfo**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:2750](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2750) + +Group assets by their asset info (immutable, development, hotModuleReplacement, etc). + +*** + +### groupAssetsByPath? + +> `optional` **groupAssetsByPath**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:2754](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2754) + +Group assets by their path. + +*** + +### groupModulesByAttributes? + +> `optional` **groupModulesByAttributes**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:2758](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2758) + +Group modules by their attributes (errors, warnings, assets, optional, orphan, or dependent). + +*** + +### groupModulesByCacheStatus? + +> `optional` **groupModulesByCacheStatus**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:2762](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2762) + +Group modules by their status (cached or built and cacheable). + +*** + +### groupModulesByExtension? + +> `optional` **groupModulesByExtension**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:2766](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2766) + +Group modules by their extension. + +*** + +### groupModulesByLayer? + +> `optional` **groupModulesByLayer**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:2770](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2770) + +Group modules by their layer. + +*** + +### groupModulesByPath? + +> `optional` **groupModulesByPath**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:2774](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2774) + +Group modules by their path. + +*** + +### groupModulesByType? + +> `optional` **groupModulesByType**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:2778](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2778) + +Group modules by their type. + +*** + +### groupReasonsByOrigin? + +> `optional` **groupReasonsByOrigin**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:2782](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2782) + +Group reasons by their origin module. + +*** + +### hash? + +> `optional` **hash**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:2786](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2786) + +Add the hash of the compilation. + +*** + +### ids? + +> `optional` **ids**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:2790](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2790) + +Add ids. + +*** + +### logging? + +> `optional` **logging**: `boolean` \| `"none"` \| `"error"` \| `"warn"` \| `"info"` \| `"log"` \| `"verbose"` + +Defined in: [declarations/WebpackOptions.d.ts:2794](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2794) + +Add logging output. + +*** + +### loggingDebug? + +> `optional` **loggingDebug**: `boolean` \| `FilterTypes` + +Defined in: [declarations/WebpackOptions.d.ts:2798](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2798) + +Include debug logging of specified loggers (i. e. for plugins or loaders). Filters can be Strings, RegExps or Functions. + +*** + +### loggingTrace? + +> `optional` **loggingTrace**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:2802](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2802) + +Add stack traces to logging output. + +*** + +### moduleAssets? + +> `optional` **moduleAssets**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:2806](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2806) + +Add information about assets inside modules. + +*** + +### modules? + +> `optional` **modules**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:2814](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2814) + +Add built modules information. + +*** + +### modulesSort? + +> `optional` **modulesSort**: `string` \| `false` + +Defined in: [declarations/WebpackOptions.d.ts:2818](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2818) + +Sort the modules by that field. + +*** + +### modulesSpace? + +> `optional` **modulesSpace**: `number` + +Defined in: [declarations/WebpackOptions.d.ts:2822](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2822) + +Space to display modules (groups will be collapsed to fit this space, value is in number of modules/groups). + +*** + +### moduleTrace? + +> `optional` **moduleTrace**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:2810](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2810) + +Add dependencies and origin of warnings/errors. + +*** + +### nestedModules? + +> `optional` **nestedModules**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:2826](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2826) + +Add information about modules nested in other modules (like with module concatenation). + +*** + +### nestedModulesSpace? + +> `optional` **nestedModulesSpace**: `number` + +Defined in: [declarations/WebpackOptions.d.ts:2830](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2830) + +Space to display modules nested within other modules (groups will be collapsed to fit this space, value is in number of modules/group). + +*** + +### optimizationBailout? + +> `optional` **optimizationBailout**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:2834](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2834) + +Show reasons why optimization bailed out for modules. + +*** + +### orphanModules? + +> `optional` **orphanModules**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:2838](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2838) + +Add information about orphan modules. + +*** + +### outputPath? + +> `optional` **outputPath**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:2842](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2842) + +Add output path information. + +*** + +### performance? + +> `optional` **performance**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:2846](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2846) + +Add performance hint flags. + +*** + +### preset? + +> `optional` **preset**: `string` \| `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:2850](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2850) + +Preset for the default values. + +*** + +### providedExports? + +> `optional` **providedExports**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:2854](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2854) + +Show exports provided by modules. + +*** + +### publicPath? + +> `optional` **publicPath**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:2858](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2858) + +Add public path information. + +*** + +### reasons? + +> `optional` **reasons**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:2862](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2862) + +Add information about the reasons why modules are included. + +*** + +### reasonsSpace? + +> `optional` **reasonsSpace**: `number` + +Defined in: [declarations/WebpackOptions.d.ts:2866](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2866) + +Space to display reasons (groups will be collapsed to fit this space). + +*** + +### relatedAssets? + +> `optional` **relatedAssets**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:2870](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2870) + +Add information about assets that are related to other assets (like SourceMaps for assets). + +*** + +### runtime? + +> `optional` **runtime**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:2874](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2874) + +Add information about runtime modules (deprecated: use 'runtimeModules' instead). + +*** + +### runtimeModules? + +> `optional` **runtimeModules**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:2878](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2878) + +Add information about runtime modules. + +*** + +### source? + +> `optional` **source**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:2882](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2882) + +Add the source code of modules. + +*** + +### timings? + +> `optional` **timings**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:2886](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2886) + +Add timing information. + +*** + +### usedExports? + +> `optional` **usedExports**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:2890](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2890) + +Show exports used by modules. + +*** + +### version? + +> `optional` **version**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:2894](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2894) + +Add webpack version information. + +*** + +### warnings? + +> `optional` **warnings**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:2898](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2898) + +Add warnings. + +*** + +### warningsCount? + +> `optional` **warningsCount**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:2902](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2902) + +Add warnings count. + +*** + +### warningsFilter? + +> `optional` **warningsFilter**: `WarningFilterTypes` + +Defined in: [declarations/WebpackOptions.d.ts:2906](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2906) + +Suppress listing warnings that match the specified filters (they will still be counted). Filters can be Strings, RegExps or Functions. + +*** + +### warningsSpace? + +> `optional` **warningsSpace**: `number` + +Defined in: [declarations/WebpackOptions.d.ts:2910](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L2910) + +Space to display warnings (value is in number of lines). diff --git a/api/interfaces/WebpackOptionsNormalized.md b/api/interfaces/WebpackOptionsNormalized.md new file mode 100644 index 0000000..d4f01f1 --- /dev/null +++ b/api/interfaces/WebpackOptionsNormalized.md @@ -0,0 +1,375 @@ +--- +title: WebpackOptionsNormalized +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / WebpackOptionsNormalized + +# Interface: WebpackOptionsNormalized + +Defined in: [declarations/WebpackOptions.d.ts:3835](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L3835) + +Normalized webpack options object. + +## Properties + +### amd? + +> `optional` **amd**: `Amd` + +Defined in: [declarations/WebpackOptions.d.ts:3839](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L3839) + +Set the value of `require.amd` and `define.amd`. Or disable AMD support. + +*** + +### bail? + +> `optional` **bail**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:3843](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L3843) + +Report the first error as a hard error instead of tolerating it. + +*** + +### cache + +> **cache**: `CacheOptionsNormalized` + +Defined in: [declarations/WebpackOptions.d.ts:3847](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L3847) + +Cache generated modules and chunks to improve performance for multiple incremental builds. + +*** + +### context? + +> `optional` **context**: `string` + +Defined in: [declarations/WebpackOptions.d.ts:3851](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L3851) + +The base directory (absolute path!) for resolving the `entry` option. If `output.pathinfo` is set, the included pathinfo is shortened to this directory. + +*** + +### dependencies? + +> `optional` **dependencies**: `Dependencies` + +Defined in: [declarations/WebpackOptions.d.ts:3855](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L3855) + +References to other configurations to depend on. + +*** + +### devServer? + +> `optional` **devServer**: `DevServer` + +Defined in: [declarations/WebpackOptions.d.ts:3859](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L3859) + +Options for the webpack-dev-server. + +*** + +### devtool? + +> `optional` **devtool**: `DevTool` + +Defined in: [declarations/WebpackOptions.d.ts:3863](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L3863) + +A developer tool to enhance debugging (false | eval | [inline-|hidden-|eval-][nosources-][cheap-[module-]]source-map). + +*** + +### dotenv? + +> `optional` **dotenv**: `Dotenv` + +Defined in: [declarations/WebpackOptions.d.ts:3867](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L3867) + +Enable and configure the Dotenv plugin to load environment variables from .env files. + +*** + +### entry + +> **entry**: [`EntryNormalized`](../type-aliases/EntryNormalized.md) + +Defined in: [declarations/WebpackOptions.d.ts:3871](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L3871) + +The entry point(s) of the compilation. + +*** + +### experiments + +> **experiments**: `ExperimentsNormalized` + +Defined in: [declarations/WebpackOptions.d.ts:3875](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L3875) + +Enables/Disables experiments (experimental features with relax SemVer compatibility). + +*** + +### externals + +> **externals**: [`Externals`](../type-aliases/Externals.md) + +Defined in: [declarations/WebpackOptions.d.ts:3879](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L3879) + +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`. + +*** + +### externalsPresets + +> **externalsPresets**: `ExternalsPresets` + +Defined in: [declarations/WebpackOptions.d.ts:3883](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L3883) + +Enable presets of externals for specific targets. + +*** + +### externalsType? + +> `optional` **externalsType**: `ExternalsType` + +Defined in: [declarations/WebpackOptions.d.ts:3887](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L3887) + +Specifies the default type of externals ('amd*', 'umd*', 'system' and 'jsonp' depend on output.libraryTarget set to the same value). + +*** + +### ignoreWarnings? + +> `optional` **ignoreWarnings**: `IgnoreWarningsNormalized` + +Defined in: [declarations/WebpackOptions.d.ts:3891](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L3891) + +Ignore specific warnings. + +*** + +### infrastructureLogging + +> **infrastructureLogging**: `InfrastructureLogging` + +Defined in: [declarations/WebpackOptions.d.ts:3895](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L3895) + +Options for infrastructure level logging. + +*** + +### loader? + +> `optional` **loader**: `Loader` + +Defined in: [declarations/WebpackOptions.d.ts:3899](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L3899) + +Custom values available in the loader context. + +*** + +### mode? + +> `optional` **mode**: `Mode` + +Defined in: [declarations/WebpackOptions.d.ts:3903](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L3903) + +Enable production optimizations or development hints. + +*** + +### module + +> **module**: `ModuleOptionsNormalized` + +Defined in: [declarations/WebpackOptions.d.ts:3907](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L3907) + +Options affecting the normal modules (`NormalModuleFactory`). + +*** + +### name? + +> `optional` **name**: `string` + +Defined in: [declarations/WebpackOptions.d.ts:3911](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L3911) + +Name of the configuration. Used when loading multiple configurations. + +*** + +### node + +> **node**: `Node` + +Defined in: [declarations/WebpackOptions.d.ts:3915](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L3915) + +Include polyfills or mocks for various node stuff. + +*** + +### optimization + +> **optimization**: `OptimizationNormalized` + +Defined in: [declarations/WebpackOptions.d.ts:3919](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L3919) + +Enables/Disables integrated optimizations. + +*** + +### output + +> **output**: `OutputNormalized` + +Defined in: [declarations/WebpackOptions.d.ts:3923](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L3923) + +Normalized options affecting the output of the compilation. `output` options tell webpack how to write the compiled files to disk. + +*** + +### parallelism? + +> `optional` **parallelism**: `number` + +Defined in: [declarations/WebpackOptions.d.ts:3927](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L3927) + +The number of parallel processed modules in the compilation. + +*** + +### performance? + +> `optional` **performance**: `Performance` + +Defined in: [declarations/WebpackOptions.d.ts:3931](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L3931) + +Configuration for web performance recommendations. + +*** + +### plugins + +> **plugins**: `PluginsNormalized` + +Defined in: [declarations/WebpackOptions.d.ts:3935](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L3935) + +Add additional plugins to the compiler. + +*** + +### profile? + +> `optional` **profile**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:3939](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L3939) + +Capture timing information for each module. + +*** + +### recordsInputPath? + +> `optional` **recordsInputPath**: `RecordsInputPath` + +Defined in: [declarations/WebpackOptions.d.ts:3943](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L3943) + +Store compiler state to a json file. + +*** + +### recordsOutputPath? + +> `optional` **recordsOutputPath**: `RecordsOutputPath` + +Defined in: [declarations/WebpackOptions.d.ts:3947](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L3947) + +Load compiler state from a json file. + +*** + +### resolve + +> **resolve**: [`ResolveOptions`](ResolveOptions.md) + +Defined in: [declarations/WebpackOptions.d.ts:3951](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L3951) + +Options for the resolver. + +*** + +### resolveLoader + +> **resolveLoader**: [`ResolveOptions`](ResolveOptions.md) + +Defined in: [declarations/WebpackOptions.d.ts:3955](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L3955) + +Options for the resolver when resolving loaders. + +*** + +### snapshot + +> **snapshot**: `SnapshotOptions` + +Defined in: [declarations/WebpackOptions.d.ts:3959](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L3959) + +Options affecting how file system snapshots are created and validated. + +*** + +### stats + +> **stats**: `StatsValue` + +Defined in: [declarations/WebpackOptions.d.ts:3963](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L3963) + +Stats options object or preset name. + +*** + +### target? + +> `optional` **target**: `Target` + +Defined in: [declarations/WebpackOptions.d.ts:3967](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L3967) + +Environment to build for. An array of environments to build for all of them when possible. + +*** + +### validate? + +> `optional` **validate**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:3971](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L3971) + +Enable validation of webpack configuration. Defaults to true in development mode. In production mode, defaults to true unless futureDefaults is enabled, then defaults to false. + +*** + +### watch? + +> `optional` **watch**: `boolean` + +Defined in: [declarations/WebpackOptions.d.ts:3975](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L3975) + +Enter watch mode, which rebuilds on file change. + +*** + +### watchOptions + +> **watchOptions**: `WatchOptions` + +Defined in: [declarations/WebpackOptions.d.ts:3979](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L3979) + +Options for the watcher. diff --git a/api/interfaces/WebpackPluginInstance.md b/api/interfaces/WebpackPluginInstance.md new file mode 100644 index 0000000..5e3ebdd --- /dev/null +++ b/api/interfaces/WebpackPluginInstance.md @@ -0,0 +1,29 @@ +--- +title: WebpackPluginInstance +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / WebpackPluginInstance + +# Interface: WebpackPluginInstance + +Defined in: [declarations/WebpackOptions.d.ts:1903](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1903) + +Plugin instance. + +## Indexable + +\[`k`: `string`\]: `any` + +## Properties + +### apply + +> **apply**: `WebpackPluginInstanceApplyFunction` + +Defined in: [declarations/WebpackOptions.d.ts:1907](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L1907) + +The run point of the plugin, required method. diff --git a/api/loaders/api.mdx b/api/loaders/api.mdx deleted file mode 100644 index 2a3b23e..0000000 --- a/api/loaders/api.mdx +++ /dev/null @@ -1,931 +0,0 @@ ---- -title: LoaderContext API -description: Complete reference for the webpack loader context API ---- - -## LoaderContext - -The loader context represents the properties and methods available on `this` inside a loader function. It is provided by webpack's loader-runner and enhanced with webpack-specific functionality. - -```javascript -module.exports = function(source) { - // 'this' is the LoaderContext - const options = this.getOptions(); - this.cacheable(); - return transform(source, options); -}; -``` - -## Core Methods - -### this.async() - -Makes the loader async and returns a callback function. - -```javascript -module.exports = function(source) { - const callback = this.async(); - - someAsyncOperation(source, (err, result, sourceMap, meta) => { - callback(err, result, sourceMap, meta); - }); -}; -``` - -**Returns:** `function(err, content, sourceMap?, meta?)` - - - The callback function to invoke when async work is complete. - - - Error object or `null` if successful - - - - Transformed content - - - - Source map for the transformation - - - - Additional metadata (e.g., `webpackAST`) - - - - - Call `this.async()` once and store the callback. Calling it multiple times returns the same callback. - - -### this.callback() - -A function to return multiple values from the loader. Can be called synchronously or asynchronously. - -```javascript -module.exports = function(source) { - const result = transform(source); - const map = generateSourceMap(); - - // Return result and source map - this.callback(null, result, map); - - // Or simply: return result; -}; -``` - - - Error object or `null` if successful - - - - Transformed content - - - - Optional source map as JSON object - - - - Optional metadata object. Can include: - - `webpackAST` - AST that can be reused by webpack - - Any custom metadata for other loaders - - - - After calling `this.callback()`, you should return `undefined` to avoid unexpected behavior. - - -### this.getOptions() - -Extract loader options and optionally validate them against a JSON schema. - -```javascript -module.exports = function(source) { - // Get options without validation - const options = this.getOptions(); - - return transform(source, options); -}; -``` - -**With schema validation:** - -```javascript -const schema = { - type: 'object', - properties: { - esModule: { - type: 'boolean' - }, - limit: { - anyOf: [ - { type: 'boolean' }, - { type: 'number' }, - { type: 'string' } - ] - } - }, - additionalProperties: false -}; - -module.exports = function(source) { - const options = this.getOptions(schema); - // Options are validated against schema - return transform(source, options); -}; -``` - - - Optional JSON schema for validation (uses [schema-utils](https://github.com/webpack/schema-utils)) - - -**Returns:** `object` - The loader options - -### this.emitFile() - -Emit a file to the output directory. This is the method used by loaders like `file-loader`. - -```javascript -module.exports = function(source) { - const url = interpolateName(this, '[hash].[ext]', { source }); - - // Emit the file - this.emitFile(url, source); - - // Return JavaScript that exports the URL - return `export default ${JSON.stringify(url)}`; -}; -``` - - - File name - - - - File content - - - - Optional source map - - - - Additional asset information: - - `development` - Is this a development-only asset? - - `hotModuleReplacement` - Related to HMR? - - `sourceFilename` - Original source file name - - `immutable` - Is the asset immutable? - - -### this.emitWarning() - -Emit a warning that will be displayed in the webpack compilation. - -```javascript -module.exports = function(source) { - if (source.includes('deprecated-api')) { - this.emitWarning( - new Error('Use of deprecated API detected') - ); - } - - return transform(source); -}; -``` - - - Warning object (should be an `Error` instance) - - - - Warnings don't stop the compilation but are displayed in the output. - - -### this.emitError() - -Emit an error. Unlike throwing an error, this doesn't stop the compilation. - -```javascript -module.exports = function(source) { - const result = parse(source); - - if (result.errors.length > 0) { - result.errors.forEach(error => { - this.emitError(new Error(error.message)); - }); - } - - return result.code; -}; -``` - - - Error object - - - - Use `this.emitError()` for recoverable errors. Throw errors for fatal issues that should stop loader execution. - - -## Dependency Methods - -### this.addDependency() - -Add a file as a dependency. When the file changes, the module will be rebuilt. - -```javascript -module.exports = function(source) { - // Add config file as dependency - this.addDependency('./config.json'); - - const config = require('./config.json'); - return transform(source, config); -}; -``` - - - Absolute path to the dependency file - - -**Alias:** `this.dependency(file)` - -### this.addContextDependency() - -Add a directory as a dependency. Changes to any file in the directory will trigger a rebuild. - -```javascript -module.exports = function(source) { - // Watch entire templates directory - this.addContextDependency(path.resolve(__dirname, 'templates')); - - return processTemplates(source); -}; -``` - - - Absolute path to the directory - - -### this.addMissingDependency() - -Add a file that doesn't exist as a dependency. The module will rebuild when the file is created. - -```javascript -module.exports = function(source) { - const optionalConfig = path.resolve(__dirname, 'optional-config.json'); - - if (!fs.existsSync(optionalConfig)) { - this.addMissingDependency(optionalConfig); - } - - return transform(source); -}; -``` - - - Absolute path to the missing file - - -### this.clearDependencies() - -Remove all dependencies added by this loader. - -```javascript -module.exports = function(source) { - // Clear any previously added dependencies - this.clearDependencies(); - - // Add fresh dependencies - this.addDependency('./new-config.json'); - - return transform(source); -}; -``` - -### this.getDependencies() - -Get all file dependencies added by this loader. - -```javascript -module.exports = function(source) { - const deps = this.getDependencies(); - console.log('Dependencies:', deps); - return source; -}; -``` - -**Returns:** `string[]` - Array of absolute file paths - -## Resolution Methods - -### this.resolve() - -Resolve a request like webpack would. - -```javascript -module.exports = function(source) { - this.resolve(this.context, './utils', (err, result) => { - if (err) return callback(err); - console.log('Resolved to:', result); - callback(null, source); - }); -}; -``` - - - Directory to resolve from - - - - The request to resolve - - - - Callback function `(err, result) => {}` - - -### this.getResolve() - -Create a resolve function with custom options. - -```javascript -module.exports = function(source) { - const resolve = this.getResolve({ - extensions: ['.js', '.json'] - }); - - // Use as callback - resolve(this.context, './module', (err, result) => { - console.log(result); - }); - - // Or use as promise - const result = await resolve(this.context, './module'); -}; -``` - - - Custom resolve options (extensions, alias, etc.) - - -**Returns:** Resolve function (supports both callback and Promise) - -## Caching Methods - -### this.cacheable() - -Control whether the loader result should be cacheable. - -```javascript -module.exports = function(source) { - // Make cacheable (default) - this.cacheable(true); - - // Disable caching - // this.cacheable(false); - - return transform(source); -}; -``` - - - `true` to enable caching, `false` to disable - - - - Loaders are cacheable by default. Only call `this.cacheable(false)` if your loader has non-deterministic behavior. - - -### this.addBuildDependency() - -Add a build dependency (like a config file). Changes trigger a full rebuild. - -```javascript -module.exports = function(source) { - // Track the loader itself - this.addBuildDependency(__filename); - - // Track config file - this.addBuildDependency(path.resolve(__dirname, 'config.js')); - - return transform(source); -}; -``` - - - Absolute path to the build dependency - - -## Logging - -### this.getLogger() - -Get a webpack logger instance for this loader. - -```javascript -module.exports = function(source) { - const logger = this.getLogger('my-loader'); - - logger.info('Processing file...'); - logger.warn('Deprecated option used'); - logger.error('Something went wrong'); - logger.debug('Debug info'); - - return transform(source); -}; -``` - - - Optional logger name (defaults to loader name) - - -**Logger methods:** -- `logger.error(message)` - Log errors -- `logger.warn(message)` - Log warnings -- `logger.info(message)` - Log info -- `logger.log(message)` - Log general messages -- `logger.debug(message)` - Log debug info -- `logger.trace(message)` - Log trace info - -## Context Properties - -### this.context - -The directory of the module. Can be used as a context for resolving other requests. - -```javascript -module.exports = function(source) { - console.log('Module directory:', this.context); - // e.g., '/project/src/components' - - return source; -}; -``` - -**Type:** `string` - -### this.resource - -The complete request string, including query and fragment. - -```javascript -// For: /path/to/file.js?query=value#fragment -module.exports = function(source) { - console.log(this.resource); - // /path/to/file.js?query=value#fragment - - return source; -}; -``` - -**Type:** `string` - -### this.resourcePath - -The resource file path, excluding query and fragment. - -```javascript -// For: /path/to/file.js?query=value#fragment -module.exports = function(source) { - console.log(this.resourcePath); - // /path/to/file.js - - return source; -}; -``` - -**Type:** `string` - -### this.resourceQuery - -The query string of the resource. - -```javascript -// For: /path/to/file.js?query=value#fragment -module.exports = function(source) { - console.log(this.resourceQuery); - // ?query=value - - return source; -}; -``` - -**Type:** `string` - -### this.resourceFragment - -The fragment of the resource. - -```javascript -// For: /path/to/file.js?query=value#fragment -module.exports = function(source) { - console.log(this.resourceFragment); - // #fragment - - return source; -}; -``` - -**Type:** `string` - -### this.rootContext - -The root context (project root), usually the directory containing `webpack.config.js`. - -```javascript -module.exports = function(source) { - console.log('Project root:', this.rootContext); - // /project - - return source; -}; -``` - -**Type:** `string` - -### this.data - -A data object shared between pitch and normal execution. Can be used to pass information. - -```javascript -module.exports.pitch = function(remaining, preceding, data) { - data.value = 'shared data'; -}; - -module.exports = function(source) { - console.log(this.data.value); // 'shared data' - return source; -}; -``` - -**Type:** `object` - -See [Pitching Loaders](./pitching) for more details. - -## Request Properties - -### this.loaderIndex - -The index of the current loader in the loaders array. - -```javascript -module.exports = function(source) { - console.log('Loader index:', this.loaderIndex); - return source; -}; -``` - -**Type:** `number` - -### this.loaders - -An array of all loaders. Writeable in the pitch phase. - -```javascript -module.exports = function(source) { - console.log('All loaders:', this.loaders); - // [{ loader: '/path/loader1.js', options: {...} }, ...] - - return source; -}; -``` - -**Type:** `object[]` - -Each loader object contains: -- `request` - Full request string -- `path` - Loader file path -- `query` - Loader query string -- `fragment` - Loader fragment -- `options` - Loader options -- `ident` - Unique identifier -- `normal` - Normal function -- `pitch` - Pitch function -- `raw` - Raw flag -- `data` - Data object - -### this.request - -The complete resolved request string. - -```javascript -module.exports = function(source) { - console.log(this.request); - // /path/loader1.js!/path/loader2.js!/path/to/file.js - - return source; -}; -``` - -**Type:** `string` - -### this.currentRequest - -The request string from the current loader onwards. - -```javascript -module.exports = function(source) { - console.log(this.currentRequest); - // Current loader + remaining loaders + resource - - return source; -}; -``` - -**Type:** `string` - -### this.previousRequest - -The request string of loaders preceding the current loader. - -```javascript -module.exports = function(source) { - console.log(this.previousRequest); - // Loaders before current loader - - return source; -}; -``` - -**Type:** `string` - -### this.remainingRequest - -The request string of loaders following the current loader, plus the resource. - -```javascript -module.exports = function(source) { - console.log(this.remainingRequest); - // Loaders after current + resource - - return source; -}; -``` - -**Type:** `string` - -## Configuration Properties - -### this.mode - -The webpack mode: `'development'`, `'production'`, or `'none'`. - -```javascript -module.exports = function(source) { - if (this.mode === 'production') { - return minify(source); - } - return source; -}; -``` - -**Type:** `'development' | 'production' | 'none'` - -### this.sourceMap - -Whether source maps should be generated. - -```javascript -module.exports = function(source) { - if (this.sourceMap) { - const map = generateSourceMap(source); - this.callback(null, result, map); - return; - } - return result; -}; -``` - -**Type:** `boolean` - -### this.target - -The webpack target. - -```javascript -module.exports = function(source) { - console.log('Target:', this.target); - // 'web', 'node', 'electron-main', etc. - - return source; -}; -``` - -**Type:** `string` - -### this.webpack - -Set to `true` to indicate this is a webpack loader context. - -```javascript -module.exports = function(source) { - if (this.webpack) { - // Running in webpack - } - return source; -}; -``` - -**Type:** `boolean` - -## Utility Properties - -### this.utils - -Utility functions for path manipulation and hashing. - -```javascript -module.exports = function(source) { - const { absolutify, contextify, createHash } = this.utils; - - // Convert to absolute path - const abs = absolutify(this.context, './relative/path'); - - // Convert to relative path - const rel = contextify(this.context, '/absolute/path'); - - // Create a hash - const hash = createHash('md5'); - hash.update(source); - const digest = hash.digest('hex'); - - return source; -}; -``` - - - Convert a context-relative path to absolute - - - - Convert an absolute path to context-relative - - - - Create a hash instance (same algorithm as webpack) - - -### this.fs - -Webpack's file system abstraction. Use this instead of Node's `fs` module. - -```javascript -module.exports = function(source) { - this.fs.readFile('/path/to/file', (err, data) => { - // Process file - }); - - return source; -}; -``` - -**Type:** `InputFileSystem` - -## Advanced Properties - -### this._module - -The current NormalModule instance (webpack internal). - -```javascript -module.exports = function(source) { - console.log('Module type:', this._module.type); - return source; -}; -``` - -**Type:** `NormalModule` - - - This is an internal property and may change between webpack versions. - - -### this._compilation - -The current compilation instance (webpack internal). - -```javascript -module.exports = function(source) { - const stats = this._compilation.getStats(); - return source; -}; -``` - -**Type:** `Compilation` - -### this._compiler - -The compiler instance (webpack internal). - -```javascript -module.exports = function(source) { - console.log('Webpack version:', this._compiler.webpack.version); - return source; -}; -``` - -**Type:** `Compiler` - -## Hash Properties - -### this.hashFunction - -The hash function used by webpack. - -```javascript -module.exports = function(source) { - console.log('Hash function:', this.hashFunction); - // 'md4', 'md5', 'sha256', etc. - - return source; -}; -``` - -**Type:** `string` - -### this.hashDigest - -The hash digest encoding. - -```javascript -module.exports = function(source) { - console.log('Hash digest:', this.hashDigest); - // 'hex', 'base64', etc. - - return source; -}; -``` - -**Type:** `string` - -### this.hashDigestLength - -The prefix length of the hash digest. - -```javascript -module.exports = function(source) { - console.log('Hash length:', this.hashDigestLength); - // 20 - - return source; -}; -``` - -**Type:** `number` - -## Best Practices - -### Use this.async() for Asynchronous Operations - -```javascript -// ✅ Good -module.exports = function(source) { - const callback = this.async(); - asyncOperation(source, callback); -}; - -// ❌ Bad - blocks webpack -module.exports = function(source) { - return syncWrapper(asyncOperation(source)); -}; -``` - -### Always Validate Options - -```javascript -// ✅ Good -module.exports = function(source) { - const options = this.getOptions(schema); - return transform(source, options); -}; - -// ❌ Bad - no validation -module.exports = function(source) { - const options = this.getOptions(); - return transform(source, options); -}; -``` - -### Add All File Dependencies - -```javascript -// ✅ Good -module.exports = function(source) { - this.addDependency(configPath); - const config = fs.readFileSync(configPath); - return transform(source, config); -}; - -// ❌ Bad - config changes won't trigger rebuild -module.exports = function(source) { - const config = fs.readFileSync(configPath); - return transform(source, config); -}; -``` - -## See Also - -- [Loader Overview](./overview) - Introduction to loaders -- [Pitching Loaders](./pitching) - Advanced execution flow -- [Writing a Loader](/api/loaders/api) - Tutorial diff --git a/api/loaders/overview.mdx b/api/loaders/overview.mdx deleted file mode 100644 index 7cf7f59..0000000 --- a/api/loaders/overview.mdx +++ /dev/null @@ -1,371 +0,0 @@ ---- -title: Loader System Overview -description: Understand how webpack loaders transform module source code ---- - -## What is a Loader? - -Loaders are transformations applied to the source code of a module. They allow you to pre-process files as you `import` or "load" them. Loaders can transform files from different languages (like TypeScript) to JavaScript, or inline images as data URLs. - -## How Loaders Work - -Loaders are executed from right to left (or bottom to top) in a chain. Each loader in the chain applies transformations to the processed resource. The final loader is expected to return JavaScript. - -```javascript -module.exports = { - module: { - rules: [ - { - test: /\.css$/, - use: [ - 'style-loader', // 3. Inject CSS into DOM - 'css-loader', // 2. Turns CSS into JS - 'sass-loader' // 1. Turns Sass into CSS - ] - } - ] - } -}; -``` - -## Basic Loader Structure - -A loader is a JavaScript module that exports a function: - -```javascript -module.exports = function(source) { - // source is the content of the resource file - // Transform the source and return it - return source.replace(/const/g, 'var'); -}; -``` - - - The `this` context in a loader is provided by webpack and contains useful methods and properties known as the [LoaderContext API](./api). - - -## Loader Execution Phases - -Loaders run in two phases: - -### 1. Pitching Phase - -Loaders are executed from **left to right** (or top to bottom) during the pitching phase. Pitching loaders can short-circuit the loader chain. - -### 2. Normal Phase - -Loaders are executed from **right to left** (or bottom to top) during the normal phase, processing the actual source code. - -``` -loader1.pitch → loader2.pitch → loader3.pitch - ↓ -loader1 ← loader2 ← loader3 ← resource content -``` - -See [Pitching Loaders](./pitching) for detailed information. - -## Synchronous vs Asynchronous Loaders - -### Synchronous Loaders - -Return the transformed source directly: - -```javascript -module.exports = function(source) { - const transformed = transform(source); - return transformed; -}; -``` - -### Asynchronous Loaders - -Use `this.async()` for async operations: - -```javascript -module.exports = function(source) { - const callback = this.async(); - - someAsyncOperation(source, (err, result) => { - if (err) return callback(err); - callback(null, result); - }); -}; -``` - -### Promise-based Loaders - -Return a Promise for async operations: - -```javascript -module.exports = async function(source) { - const result = await someAsyncOperation(source); - return result; -}; -``` - -## Raw Loaders - -By default, loaders receive the resource file as a UTF-8 string. Set `raw` to `true` to receive raw `Buffer`: - -```javascript -module.exports = function(source) { - // source is a Buffer - assert(Buffer.isBuffer(source)); - return doSomething(source); -}; - -module.exports.raw = true; -``` - - - Raw loaders are useful for processing binary files like images, fonts, or other non-text assets. - - -## Returning Multiple Values - -Loaders can return source maps and additional metadata using `this.callback()`: - -```javascript -module.exports = function(source, sourceMap, meta) { - // Transform the source - const result = transform(source); - - // Return result with source map - this.callback(null, result, sourceMap, meta); -}; -``` - -## Common Loader Patterns - -### Basic Transformation - -```javascript -module.exports = function(source) { - return source.replace(/foo/g, 'bar'); -}; -``` - -### With Options - -```javascript -module.exports = function(source) { - const options = this.getOptions(); - - return transform(source, options); -}; -``` - -### With Validation - -```javascript -const schema = { - type: 'object', - properties: { - test: { - type: 'boolean' - } - } -}; - -module.exports = function(source) { - const options = this.getOptions(schema); - - return transform(source, options); -}; -``` - -### Emitting Files - -```javascript -module.exports = function(source) { - const url = interpolateName(this, '[hash].[ext]', { source }); - - this.emitFile(url, source); - - return `export default ${JSON.stringify(url)}`; -}; -``` - -## Adding Dependencies - -Make webpack watch additional files: - -```javascript -module.exports = function(source) { - // Watch this file for changes - this.addDependency('./config.json'); - - // Watch this directory - this.addContextDependency('./templates'); - - return transform(source); -}; -``` - -## Caching - -Loaders are cacheable by default. Opt out if your loader has external dependencies: - -```javascript -module.exports = function(source) { - // Disable caching - this.cacheable(false); - - const config = fs.readFileSync('./config.json'); - return transform(source, config); -}; -``` - - - Instead of disabling caching, use `this.addDependency()` to add external files as dependencies. - - -## Error Handling - -### Synchronous Errors - -```javascript -module.exports = function(source) { - try { - return transform(source); - } catch (error) { - throw error; // or this.callback(error) - } -}; -``` - -### Asynchronous Errors - -```javascript -module.exports = function(source) { - const callback = this.async(); - - someAsyncOperation(source, (err, result) => { - if (err) return callback(err); - callback(null, result); - }); -}; -``` - -### Warnings - -```javascript -module.exports = function(source) { - if (deprecated(source)) { - this.emitWarning(new Error('Deprecated syntax detected')); - } - - return transform(source); -}; -``` - -## Loader Context - -Loaders have access to many useful methods via `this`: - -- `this.addDependency(file)` - Add a file dependency -- `this.async()` - Make the loader async -- `this.callback()` - Return multiple values -- `this.emitFile(name, content)` - Emit a file -- `this.emitWarning(warning)` - Emit a warning -- `this.emitError(error)` - Emit an error -- `this.getOptions()` - Get loader options -- `this.resolve()` - Resolve a request - -See the complete [LoaderContext API](./api) reference. - -## Real-World Example: Markdown Loader - -```javascript -const marked = require('marked'); - -const schema = { - type: 'object', - properties: { - pedantic: { type: 'boolean' }, - gfm: { type: 'boolean' } - } -}; - -module.exports = function(source) { - const options = this.getOptions(schema); - - // Mark this loader as cacheable - this.cacheable(); - - // Configure marked - marked.setOptions(options); - - // Transform markdown to HTML - const html = marked.parse(source); - - // Return as JavaScript module - return `export default ${JSON.stringify(html)}`; -}; -``` - -## Guidelines - -### 1. Keep Loaders Simple - -Each loader should do one thing well. Chain multiple loaders for complex transformations. - -### 2. Use Module Utilities - -Leverage webpack's utilities like `this.resolve()` instead of Node.js `require.resolve()`. - -### 3. Mark Dependencies - -Always use `this.addDependency()` for external files to enable proper watching. - -### 4. Resolve Modules Relatively - -Use `this.resolve()` to resolve modules relative to the current module. - -### 5. Extract Common Code - -Extract common code into a runtime module using `this.emitFile()`. - -### 6. Avoid Absolute Paths - -Generate relative paths or use webpack's utilities to make loaders portable. - -### 7. Use Peer Dependencies - -If your loader depends on a library, list it as a `peerDependency`. - -## Testing Loaders - -```javascript -const compiler = webpack({ - entry: './test-file.js', - module: { - rules: [ - { - test: /\.txt$/, - use: { - loader: path.resolve(__dirname, './my-loader.js'), - options: { - /* options */ - } - } - } - ] - } -}); - -compiler.run((err, stats) => { - // Test assertions -}); -``` - -## Next Steps - -- [LoaderContext API](./api) - Complete API reference -- [Pitching Loaders](./pitching) - Advanced loader execution -- [Writing a Loader](/api/loaders/api) - Step-by-step tutorial - -## Further Reading - -- [Official Loader API](https://webpack.js.org/api/loaders/) -- [loader-runner](https://github.com/webpack/loader-runner) - The loader execution engine diff --git a/api/loaders/pitching.mdx b/api/loaders/pitching.mdx deleted file mode 100644 index 951b039..0000000 --- a/api/loaders/pitching.mdx +++ /dev/null @@ -1,584 +0,0 @@ ---- -title: Pitching Loaders -description: Understand the pitching phase and advanced loader execution flow ---- - -## What is Pitching? - -The pitching phase is an advanced loader feature that allows loaders to execute **before** the normal loader chain. Loaders run in two phases: - -1. **Pitching phase**: Left to right (or top to bottom) -2. **Normal phase**: Right to left (or bottom to top) - -## Execution Flow - -Given this loader configuration: - -```javascript -module.exports = { - module: { - rules: [ - { - test: /\.js$/, - use: ['loader1', 'loader2', 'loader3'] - } - ] - } -}; -``` - -The execution order is: - -``` -┌─────────────────────────────────────────────────────┐ -│ Pitching Phase │ -│ (left to right / top to bottom) │ -├─────────────────────────────────────────────────────┤ -│ │ -│ loader1.pitch → loader2.pitch → loader3.pitch │ -│ ↓ │ -│ Read File │ -│ ↓ │ -│ loader1 ← loader2 ← loader3 ← file content │ -│ │ -├─────────────────────────────────────────────────────┤ -│ Normal Phase │ -│ (right to left / bottom to top) │ -└─────────────────────────────────────────────────────┘ -``` - -## Defining a Pitch Function - -A pitch function is defined as a property on the loader: - -```javascript -module.exports = function(source) { - // Normal loader - return transform(source); -}; - -module.exports.pitch = function(remainingRequest, precedingRequest, data) { - // Pitch loader - console.log('Pitching!'); -}; -``` - -## Pitch Function Parameters - -The pitch function receives three parameters: - - - The request string for loaders to the right (plus the resource) - - Example: `loader3!/path/to/file.js` - - - - The request string for loaders to the left (already executed pitches) - - Example: `loader1` - - - - A data object shared between pitch and normal execution. Use this to pass information from the pitch phase to the normal phase. - - -### Example: Inspecting Parameters - -```javascript -// loader2.js -module.exports = function(source) { - console.log('Normal phase - data:', this.data); - return source; -}; - -module.exports.pitch = function(remainingRequest, precedingRequest, data) { - console.log('Pitching phase'); - console.log('Remaining:', remainingRequest); - // loader3!/path/to/file.js - - console.log('Preceding:', precedingRequest); - // loader1 - - // Store data for normal phase - data.value = 'shared data'; -}; -``` - -## Short-Circuiting the Loader Chain - -If a pitch function returns a value, it **short-circuits** the loader chain: - -1. Remaining pitches are skipped -2. The resource file is not read -3. Execution jumps back to preceding loaders - -### Example: Short-Circuiting - -```javascript -// style-loader.js (simplified) -module.exports.pitch = function(remainingRequest) { - // Return early with inline require - return ( - `var content = require(${JSON.stringify(remainingRequest)});` + - `if (typeof content === 'string') content = [[module.id, content]];` + - `var update = require('style-loader/addStyles')(content);` + - `if (content.locals) module.exports = content.locals;` - ); -}; -``` - -**Execution flow when loader1 returns in pitch:** - -``` -loader1.pitch (returns value) ───────┐ - │ - ↓ - Skip loader2.pitch - Skip loader3.pitch - Skip reading file - │ - ↓ - (no preceding loaders) - │ - ↓ - Webpack -``` - -**Execution flow when loader2 returns in pitch:** - -``` -loader1.pitch ────────────────────────┐ - │ - ↓ -loader2.pitch (returns value) ────────┼──────┐ - │ │ - ↓ │ - Skip loader3.pitch - Skip reading file - │ - ↓ - loader1 - │ - ↓ - Webpack -``` - -## Use Cases - -### 1. Inline Requests - -Process the remaining loaders inline instead of separately: - -```javascript -module.exports.pitch = function(remainingRequest) { - return ` - import content from ${JSON.stringify('-!' + remainingRequest)}; - export default content; - `; -}; -``` - -The `-!` prefix disables all configured loaders. - -### 2. Early Validation - -Validate inputs before processing: - -```javascript -module.exports.pitch = function(remainingRequest, precedingRequest, data) { - const options = this.getOptions(); - - // Validate early - if (!options.required) { - throw new Error('Required option missing'); - } - - // Store for normal phase - data.options = options; -}; - -module.exports = function(source) { - const options = this.data.options; - return transform(source, options); -}; -``` - -### 3. Caching Information - -Collect information during pitching for use in the normal phase: - -```javascript -module.exports.pitch = function(remainingRequest, precedingRequest, data) { - // Cache expensive computations - data.startTime = Date.now(); - data.resourcePath = this.resourcePath; -}; - -module.exports = function(source) { - const duration = Date.now() - this.data.startTime; - console.log(`Processed ${this.data.resourcePath} in ${duration}ms`); - return source; -}; -``` - -### 4. Conditional Loading - -Decide whether to process based on file metadata: - -```javascript -module.exports.pitch = function(remainingRequest) { - const callback = this.async(); - - this.fs.stat(this.resourcePath, (err, stats) => { - if (err) return callback(err); - - // Skip large files - if (stats.size > 1024 * 1024) { - return callback( - null, - `module.exports = 'File too large'` - ); - } - - // Continue normal execution - callback(); - }); -}; -``` - -## Real-World Example: style-loader - -The `style-loader` uses pitching to inject CSS into the DOM: - -```javascript -// style-loader (simplified) -module.exports = function() {}; - -module.exports.pitch = function(remainingRequest) { - // This runs BEFORE css-loader - // It returns code that will require() the result of css-loader - return ` - var content = require(${JSON.stringify('!!' + remainingRequest)}); - var api = require('style-loader/runtime/injectStylesIntoStyleTag'); - var update = api(content); - - if (module.hot) { - module.hot.accept(${JSON.stringify('!!' + remainingRequest)}, function() { - var newContent = require(${JSON.stringify('!!' + remainingRequest)}); - update(newContent); - }); - - module.hot.dispose(function() { - update(); - }); - } - - module.exports = content.locals || {}; - `; -}; -``` - -**Why use pitching?** - -1. `style-loader` needs the output of `css-loader`, not the input -2. By returning in the pitch phase, it can inline a `require()` call -3. The `require()` goes through the remaining loaders (`css-loader`) -4. The result is injected into the DOM - -## Data Sharing Between Phases - -Use the `data` parameter to share information: - -```javascript -module.exports = function(source) { - // Access data from pitch phase - const { count, timestamp } = this.data; - - console.log(`Processing file #${count} at ${timestamp}`); - return source; -}; - -module.exports.pitch = function(remainingRequest, precedingRequest, data) { - // Store data for normal phase - data.count = ++globalCount; - data.timestamp = Date.now(); - data.remainingRequest = remainingRequest; -}; -``` - - - The `data` object is available as `this.data` in the normal loader function. - - -## Async Pitching - -Pitch functions can be asynchronous: - -```javascript -module.exports.pitch = function(remainingRequest, precedingRequest, data) { - const callback = this.async(); - - someAsyncOperation(this.resourcePath, (err, result) => { - if (err) return callback(err); - - if (result.shouldSkip) { - // Short-circuit - return callback(null, result.code); - } - - // Continue to next pitch/loader - callback(); - }); -}; -``` - -**Or with Promises:** - -```javascript -module.exports.pitch = async function(remainingRequest) { - const metadata = await fetchMetadata(this.resourcePath); - - if (metadata.shouldSkip) { - // Short-circuit - return generateCode(metadata); - } - - // Continue to next pitch/loader (return undefined) -}; -``` - -## Modifying the Loader Chain - -During pitching, the `loaders` array is writeable: - -```javascript -module.exports.pitch = function(remainingRequest, precedingRequest, data) { - // Add options to the next loader - const nextLoader = this.loaders[this.loaderIndex + 1]; - if (nextLoader) { - nextLoader.options = { - ...nextLoader.options, - customFlag: true - }; - } -}; -``` - - - Modifying the loader chain is an advanced technique. Use with caution as it can make your loader harder to understand and maintain. - - -## Complete Example: Custom Inline Loader - -```javascript -// inline-loader.js -const path = require('path'); - -module.exports = function(source) { - // This won't be called if pitch returns - return source; -}; - -module.exports.pitch = function(remainingRequest) { - const callback = this.async(); - - // Get the absolute path - const resourcePath = this.resourcePath; - - // Check if we should inline this file - this.fs.stat(resourcePath, (err, stats) => { - if (err) return callback(err); - - // Inline small files - if (stats.size < 8192) { - this.fs.readFile(resourcePath, (err, content) => { - if (err) return callback(err); - - // Return as base64 data URL - const ext = path.extname(resourcePath).slice(1); - const mimeType = getMimeType(ext); - const base64 = content.toString('base64'); - - callback( - null, - `module.exports = "data:${mimeType};base64,${base64}"` - ); - }); - } else { - // Continue normal processing for large files - callback(); - } - }); -}; - -function getMimeType(ext) { - const types = { - 'png': 'image/png', - 'jpg': 'image/jpeg', - 'svg': 'image/svg+xml' - }; - return types[ext] || 'application/octet-stream'; -} -``` - -## Debugging Pitching - -Log execution flow to understand pitching: - -```javascript -module.exports = function(source) { - console.log('[NORMAL]', this.resourcePath); - return source; -}; - -module.exports.pitch = function(remainingRequest, precedingRequest, data) { - console.log('[PITCH]', { - resource: this.resourcePath, - remaining: remainingRequest, - preceding: precedingRequest, - loaderIndex: this.loaderIndex - }); -}; -``` - -## Best Practices - -### 1. Use Pitching Sparingly - -Most loaders don't need pitching. Only use it when you need to: -- Short-circuit the chain -- Process loader output inline -- Share data between phases - -### 2. Document Pitching Behavior - -```javascript -/** - * This loader uses pitching to inline small files. - * Files < 8KB are converted to base64 data URLs during the pitch phase. - * Larger files continue through the normal loader chain. - */ -module.exports.pitch = function(remainingRequest) { - // ... -}; -``` - -### 3. Handle Both Phases - -If you use pitching, handle both phases gracefully: - -```javascript -module.exports = function(source) { - // Normal phase (for files not handled in pitch) - return transform(source); -}; - -module.exports.pitch = function(remainingRequest) { - // Pitch phase (optional short-circuit) - if (shouldShortCircuit()) { - return generateCode(); - } - // Continue to normal phase -}; -``` - -### 4. Test Thoroughly - -Test both short-circuit and normal execution paths: - -```javascript -it('should short-circuit for small files', async () => { - const stats = await compile('small-file.png'); - expect(stats.modules[0].source).toContain('data:'); -}); - -it('should use normal phase for large files', async () => { - const stats = await compile('large-file.png'); - expect(stats.modules[0].source).not.toContain('data:'); -}); -``` - -## Common Patterns - -### Pattern 1: Inline Require - -```javascript -module.exports.pitch = function(remainingRequest) { - return ` - var content = require(${JSON.stringify('!!' + remainingRequest)}); - module.exports = processContent(content); - `; -}; -``` - -### Pattern 2: Conditional Short-Circuit - -```javascript -module.exports.pitch = function(remainingRequest) { - if (this.resourceQuery.includes('inline')) { - return inlineContent(this.resourcePath); - } - // Continue normal execution -}; -``` - -### Pattern 3: Metadata Collection - -```javascript -module.exports.pitch = function(remainingRequest, precedingRequest, data) { - data.startTime = Date.now(); - data.loaderCount = this.loaders.length; -}; - -module.exports = function(source) { - const duration = Date.now() - this.data.startTime; - this.getLogger().info(`Processed in ${duration}ms`); - return source; -}; -``` - -## Pitfall: Infinite Loops - -Be careful not to create infinite loops: - -```javascript -// ❌ Bad - infinite loop! -module.exports.pitch = function(remainingRequest) { - // This creates an infinite loop - return `require(${JSON.stringify(remainingRequest)})`; -}; - -// ✅ Good - use prefix to disable loaders -module.exports.pitch = function(remainingRequest) { - return `require(${JSON.stringify('!!' + remainingRequest)})`; -}; -``` - -The `!!` prefix disables all loaders (both pre and normal), preventing the loop. - -## Prefix Meanings - -- `!` - Disable normal loaders -- `!!` - Disable all loaders (pre, normal, post) -- `-!` - Disable pre and normal loaders - -```javascript -module.exports.pitch = function(remainingRequest) { - // Use the appropriate prefix - return ` - // Disable all loaders - var content = require(${JSON.stringify('!!' + remainingRequest)}); - - // Or disable only normal loaders - var content2 = require(${JSON.stringify('!' + remainingRequest)}); - `; -}; -``` - -## See Also - -- [Loader Overview](./overview) - Introduction to loaders -- [LoaderContext API](./api) - Complete API reference -- [Writing a Loader](/api/loaders/api) - Step-by-step tutorial -- [loader-runner](https://github.com/webpack/loader-runner) - The execution engine diff --git a/api/module-methods/import.mdx b/api/module-methods/import.mdx deleted file mode 100644 index d2f7e4d..0000000 --- a/api/module-methods/import.mdx +++ /dev/null @@ -1,364 +0,0 @@ ---- -title: import() -description: Dynamic imports for code splitting and lazy loading in webpack ---- - -The `import()` syntax enables dynamic module loading and is webpack's primary mechanism for code splitting. - -## Syntax - -```javascript -import(modulePath) -import(modulePath, options) -``` - -### Parameters - - - Path to the module to import. Can be a string literal or template literal. - - ```javascript - import('./module.js') - import(`./locale/${language}.js`) - ``` - - - - Import attributes (formerly assertions) for the module. - - ```javascript - import('./data.json', { assert: { type: 'json' } }) - ``` - - -### Return Type - -**Returns:** `Promise` - -Returns a Promise that resolves to the module namespace object. - ---- - -## Basic Usage - -### Simple Dynamic Import - -```javascript -// Dynamically load a module -import('./math.js') - .then(module => { - console.log(module.add(2, 3)); // 5 - }) - .catch(err => { - console.error('Failed to load module:', err); - }); -``` - -### With Async/Await - -```javascript -async function loadModule() { - try { - const module = await import('./math.js'); - console.log(module.add(2, 3)); // 5 - } catch (err) { - console.error('Failed to load module:', err); - } -} -``` - -### Named Exports - -```javascript -// math.js -export function add(a, b) { - return a + b; -} -export function multiply(a, b) { - return a * b; -} - -// app.js -const { add, multiply } = await import('./math.js'); -console.log(add(2, 3)); // 5 -console.log(multiply(2, 3)); // 6 -``` - -### Default Export - -```javascript -// logger.js -export default class Logger { - log(message) { - console.log(message); - } -} - -// app.js -const { default: Logger } = await import('./logger.js'); -const logger = new Logger(); -logger.log('Hello!'); -``` - ---- - -## Code Splitting - -### Webpack Magic Comments - -Webpack supports special comments to configure chunk behavior: - -```javascript -import( - /* webpackChunkName: "my-chunk" */ - /* webpackMode: "lazy" */ - /* webpackPrefetch: true */ - /* webpackPreload: true */ - './module.js' -) -``` - -#### Available Magic Comments - - - Name for the generated chunk. - - ```javascript - import(/* webpackChunkName: "lodash" */ 'lodash') - // Generates: lodash.bundle.js - ``` - - - - Mode for resolving dynamic imports. - - **Values:** `lazy` (default) | `lazy-once` | `eager` | `weak` - - ```javascript - // Create separate chunk for each module - import(/* webpackMode: "lazy" */ `./locale/${lang}.js`) - - // Bundle all possible modules into one chunk - import(/* webpackMode: "lazy-once" */ `./locale/${lang}.js`) - - // No separate chunk, include in main bundle - import(/* webpackMode: "eager" */ './module.js') - ``` - - - - Prefetch the chunk when browser is idle. - - ```javascript - import(/* webpackPrefetch: true */ './future-feature.js') - // Adds: - ``` - - - - Preload the chunk in parallel with parent chunk. - - ```javascript - import(/* webpackPreload: true */ './critical.js') - // Adds: - ``` - - - - Include only modules matching this pattern. - - ```javascript - import( - /* webpackInclude: /\.json$/ */ - `./data/${file}` - ) - ``` - - - - Exclude modules matching this pattern. - - ```javascript - import( - /* webpackExclude: /\.test\.js$/ */ - `./components/${name}.js` - ) - ``` - - - - Import only specific exports to reduce bundle size. - - ```javascript - import( - /* webpackExports: ["add", "subtract"] */ - './math.js' - ) - ``` - - ---- - -## Advanced Patterns - -### Lazy Loading Routes - -```javascript -const routes = [ - { - path: '/home', - component: () => import(/* webpackChunkName: "home" */ './Home.vue') - }, - { - path: '/about', - component: () => import(/* webpackChunkName: "about" */ './About.vue') - } -]; -``` - -### Conditional Loading - -```javascript -async function loadFeature(featureName) { - if (featureName === 'advanced') { - const module = await import( - /* webpackChunkName: "advanced-features" */ - './features/advanced.js' - ); - return module.default; - } else { - const module = await import( - /* webpackChunkName: "basic-features" */ - './features/basic.js' - ); - return module.default; - } -} -``` - -### Dynamic Import with Variables - -```javascript -// Load locale files dynamically -async function loadLocale(language) { - const locale = await import( - /* webpackChunkName: "locale-[request]" */ - `./locales/${language}.json` - ); - return locale.default; -} - -// Usage -const messages = await loadLocale('en-US'); -``` - -### Error Handling with Retry - -```javascript -async function importWithRetry(modulePath, retries = 3) { - for (let i = 0; i < retries; i++) { - try { - return await import(modulePath); - } catch (err) { - if (i === retries - 1) throw err; - await new Promise(resolve => setTimeout(resolve, 1000 * (i + 1))); - } - } -} - -// Usage -const module = await importWithRetry('./heavy-module.js'); -``` - ---- - -## Import Attributes - -Import attributes (formerly assertions) specify the expected module type: - -```javascript -// JSON modules -const config = await import('./config.json', { - assert: { type: 'json' } -}); - -// CSS modules -const styles = await import('./styles.css', { - assert: { type: 'css' } -}); -``` - - - Import attributes syntax is evolving. Webpack supports both `assert` and `with` keywords. - - ---- - -## Performance Considerations - -### Prefetch vs Preload - -```javascript -// Prefetch: Low priority, loaded when browser is idle -import(/* webpackPrefetch: true */ './optional-feature.js') - -// Preload: High priority, loaded in parallel -import(/* webpackPreload: true */ './critical-feature.js') -``` - -**When to use:** - -- **Prefetch**: For features likely to be needed soon (future navigation) -- **Preload**: For features needed in current navigation - -### Chunk Grouping - -```javascript -// Group related modules into same chunk -import(/* webpackChunkName: "vendor" */ 'lodash'); -import(/* webpackChunkName: "vendor" */ 'axios'); -import(/* webpackChunkName: "vendor" */ 'moment'); -``` - ---- - -## TypeScript Support - -```typescript -// Type-safe dynamic imports -interface MathModule { - add(a: number, b: number): number; - multiply(a: number, b: number): number; -} - -async function loadMath(): Promise { - const module = await import('./math'); - return module; -} - -// Usage -const math = await loadMath(); -const result = math.add(2, 3); // Type-safe -``` - ---- - -## Browser Compatibility - -Webpack transforms `import()` to work in all browsers. Native `import()` requires: - -- Chrome 63+ -- Firefox 67+ -- Safari 11.1+ -- Edge 79+ - -Webpack's implementation provides broader compatibility through code transformation. - ---- - -## See Also - -- [require()](/api/module-methods/require) - CommonJS module loading -- [require.context()](/api/module-methods/require-context) - Require multiple modules -- [Code Splitting](/guides/code-splitting) - Guide to code splitting strategies -- [Lazy Loading](/guides/lazy-loading) - Lazy loading guide \ No newline at end of file diff --git a/api/module-methods/module-variables.mdx b/api/module-methods/module-variables.mdx deleted file mode 100644 index 748ff65..0000000 --- a/api/module-methods/module-variables.mdx +++ /dev/null @@ -1,589 +0,0 @@ ---- -title: Module Variables -description: Special webpack module variables for runtime configuration and metadata ---- - -Webpack provides several special variables that can be used in your modules for runtime configuration, metadata access, and module information. - -## __webpack_public_path__ - -Configures the public path for webpack assets at runtime. - -### Type - -```typescript -__webpack_public_path__: string -``` - -### Description - -Controls the base path for all assets (chunks, images, fonts) emitted by webpack. Can be set dynamically at runtime before importing modules. - -### Usage Examples - -#### Basic Assignment - -```javascript -// Set before importing any modules -__webpack_public_path__ = '/assets/'; - -// Now all assets will be loaded from /assets/ -import('./module.js'); -``` - -#### CDN Configuration - -```javascript -// Load assets from CDN -__webpack_public_path__ = 'https://cdn.example.com/assets/'; - -// Dynamic CDN selection -if (process.env.NODE_ENV === 'production') { - __webpack_public_path__ = 'https://cdn.example.com/'; -} else { - __webpack_public_path__ = '/dev-assets/'; -} -``` - -#### Runtime Detection - -```javascript -// Determine public path from script tag -const scriptSrc = document.currentScript?.src; -if (scriptSrc) { - __webpack_public_path__ = scriptSrc.substring(0, scriptSrc.lastIndexOf('/') + 1); -} -``` - -#### Relative to Current Origin - -```javascript -// Use current origin + path -__webpack_public_path__ = window.location.origin + '/static/'; -``` - - - Set `__webpack_public_path__` in your entry point before importing any other modules. Changes after modules are loaded won't affect already-loaded assets. - - ---- - -## __webpack_base_uri__ - -Sets the base URI for WebAssembly and Worker module resolution. - -### Type - -```typescript -__webpack_base_uri__: string -``` - -### Description - -Controls the base URI used for resolving WebAssembly modules and Web Workers. Defaults to `document.baseURI`. - -### Usage Examples - -```javascript -// Set custom base URI -__webpack_base_uri__ = 'https://wasm.example.com/'; - -// Load WASM module -import('./fibonacci.wasm'); -``` - ---- - -## __webpack_modules__ - -Access to webpack's internal module registry. - -### Type - -```typescript -__webpack_modules__: Record -``` - -### Description - -Provides access to all loaded modules. Each module is a function that executes the module code. - -### Usage Examples - -```javascript -// Access module registry -console.log(__webpack_modules__); - -// Check if module is loaded -const moduleId = 42; -if (__webpack_modules__[moduleId]) { - console.log('Module loaded'); -} - -// Iterate over all modules -Object.keys(__webpack_modules__).forEach(id => { - console.log(`Module ${id} is available`); -}); -``` - - - Direct manipulation of `__webpack_modules__` is not recommended. This API is primarily for debugging and advanced use cases. - - ---- - -## __webpack_chunk_load__ - -Function to load chunks programmatically. - -### Type - -```typescript -__webpack_chunk_load__(chunkId: string | number): Promise -``` - -### Description - -Manually load a specific chunk. Returns a Promise that resolves when the chunk is loaded. - -### Usage Examples - -```javascript -// Preload a chunk -await __webpack_chunk_load__('vendors'); - -// Load multiple chunks -await Promise.all([ - __webpack_chunk_load__('chunk-1'), - __webpack_chunk_load__('chunk-2'), - __webpack_chunk_load__('chunk-3') -]); -``` - ---- - -## __webpack_module__.id - -The module ID of the current module. - -### Type - -```typescript -__webpack_module__.id: string | number -``` - -### Description - -Provides the unique identifier for the current module. - -### Usage Examples - -```javascript -// Log current module ID -console.log('Current module ID:', __webpack_module__.id); - -// Use in module registry -const currentModule = __webpack_modules__[__webpack_module__.id]; -``` - ---- - -## __webpack_hash__ - -The compilation hash at runtime. - -### Type - -```typescript -__webpack_hash__: string -``` - -### Description - -Provides the hash of the current compilation. Useful for cache busting and version tracking. - -### Usage Examples - -```javascript -// Display build version -console.log('Build hash:', __webpack_hash__); - -// Cache key -const cacheKey = `app-cache-${__webpack_hash__}`; -localStorage.setItem(cacheKey, data); - -// API versioning -fetch(`/api/data?v=${__webpack_hash__}`); -``` - - - `__webpack_hash__` remains constant for a given build. It changes only when you rebuild with webpack. - - ---- - -## __webpack_chunkname__ - -The name of the current chunk. - -### Type - -```typescript -__webpack_chunkname__: string -``` - -### Description - -Provides the name of the chunk containing the current module. - -### Usage Examples - -```javascript -// Log chunk name -console.log('Running in chunk:', __webpack_chunkname__); - -// Conditional logic based on chunk -if (__webpack_chunkname__ === 'main') { - initializeApp(); -} -``` - ---- - -## __webpack_get_script_filename__ - -Function to get the filename for a chunk ID. - -### Type - -```typescript -__webpack_get_script_filename__(chunkId: string | number): string -``` - -### Description - -Returns the filename that would be used for a given chunk ID. - -### Usage Examples - -```javascript -// Get chunk filename -const filename = __webpack_get_script_filename__('vendors'); -console.log(filename); // 'vendors.1234abcd.js' - -// Preload hint -const link = document.createElement('link'); -link.rel = 'preload'; -link.as = 'script'; -link.href = __webpack_get_script_filename__('critical-feature'); -document.head.appendChild(link); -``` - ---- - -## __webpack_nonce__ - -Sets the nonce for script tags (Content Security Policy). - -### Type - -```typescript -__webpack_nonce__: string -``` - -### Description - -Configures the `nonce` attribute for all script and style tags created by webpack. Used for Content Security Policy. - -### Usage Examples - -```javascript -// Set nonce before loading modules -__webpack_nonce__ = 'c29tZSBjb29sIHN0cmluZyB3aWxsIHBvcCB1cCAxMjM='; - -// All dynamically created scripts will include this nonce -import('./module.js'); -// Creates: -``` - -#### Server-Side Integration - -```javascript -// Express middleware -app.use((req, res, next) => { - res.locals.cspNonce = crypto.randomBytes(16).toString('base64'); - next(); -}); - -// In HTML template - - -``` - ---- - -## __webpack_runtime_id__ - -The runtime ID for the current runtime. - -### Type - -```typescript -__webpack_runtime_id__: string -``` - -### Description - -Identifies the current runtime when using multiple runtimes. - -### Usage Examples - -```javascript -// Check runtime context -console.log('Runtime ID:', __webpack_runtime_id__); - -if (__webpack_runtime_id__ === 'main-runtime') { - // Main runtime logic -} else { - // Secondary runtime logic -} -``` - ---- - -## __webpack_layer__ - -The layer name of the current module. - -### Type - -```typescript -__webpack_layer__: string | null -``` - -### Description - -Provides the layer name when using webpack's experimental layers feature. - -### Usage Examples - -```javascript -// Check current layer -if (__webpack_layer__ === 'client') { - // Client-side code -} else if (__webpack_layer__ === 'server') { - // Server-side code -} -``` - ---- - -## __webpack_share_scopes__ - -Access to module federation share scopes. - -### Type - -```typescript -__webpack_share_scopes__: Record -``` - -### Description - -Provides access to shared module scopes when using Module Federation. - -### Usage Examples - -```javascript -// Access shared dependencies -const defaultScope = __webpack_share_scopes__.default; - -// Check if module is shared -if (__webpack_share_scopes__.default?.['react']) { - console.log('React is shared'); -} -``` - ---- - -## __webpack_init_sharing__ - -Initialize module federation sharing. - -### Type - -```typescript -__webpack_init_sharing__(scope: string): Promise -``` - -### Description - -Initializes a share scope for Module Federation. - -### Usage Examples - -```javascript -// Initialize default share scope -await __webpack_init_sharing__('default'); - -// Now shared modules are available -const container = await import('remote/App'); -``` - ---- - -## __non_webpack_require__ - -Native Node.js require (bypasses webpack). - -### Type - -```typescript -__non_webpack_require__: NodeRequire -``` - -### Description - -Provides access to Node.js's native `require` function, bypassing webpack's module system. Only available in Node.js targets. - -### Usage Examples - -```javascript -// Load native Node.js module -const fs = __non_webpack_require__('fs'); - -// Load module from absolute path -const config = __non_webpack_require__('/etc/app/config.json'); - -// Dynamic native require -const moduleName = 'path'; -const nativeModule = __non_webpack_require__(moduleName); -``` - - - `__non_webpack_require__` is only available when targeting Node.js environments. Using it in browser builds will cause errors. - - ---- - -## __system_context__ - -SystemJS context object. - -### Type - -```typescript -__system_context__: System.Context -``` - -### Description - -Provides the SystemJS context when using SystemJS output format. - -### Usage Examples - -```javascript -// Access SystemJS context -console.log(__system_context__.import); - -// Use SystemJS features -__system_context__.import('./module.js').then(module => { - console.log(module); -}); -``` - ---- - -## Common Patterns - -### Dynamic Public Path Configuration - -```javascript -// config.js -(function() { - // Detect environment - const isDev = process.env.NODE_ENV === 'development'; - const isStaging = window.location.hostname.includes('staging'); - - // Set public path - if (isDev) { - __webpack_public_path__ = '/assets/'; - } else if (isStaging) { - __webpack_public_path__ = 'https://staging-cdn.example.com/'; - } else { - __webpack_public_path__ = 'https://cdn.example.com/'; - } - - // Log for debugging - console.log('Public path:', __webpack_public_path__); -})(); -``` - -### CSP Nonce Setup - -```javascript -// entry.js -// Extract nonce from meta tag -const metaNonce = document.querySelector('meta[property="csp-nonce"]'); -if (metaNonce) { - __webpack_nonce__ = metaNonce.getAttribute('content'); -} - -// Now safe to load modules -import('./app.js'); -``` - -### Module Hot Reload with Hash - -```javascript -// Display version in footer -const versionEl = document.getElementById('version'); -if (versionEl) { - versionEl.textContent = `v${__webpack_hash__}`; -} - -// Clear old cache on new deploy -const CURRENT_CACHE = `app-v${__webpack_hash__}`; -const cacheNames = await caches.keys(); -await Promise.all( - cacheNames - .filter(name => name !== CURRENT_CACHE) - .map(name => caches.delete(name)) -); -``` - ---- - -## TypeScript Declarations - -Add these declarations to your TypeScript project: - -```typescript -// globals.d.ts -declare let __webpack_public_path__: string; -declare let __webpack_base_uri__: string; -declare const __webpack_modules__: Record; -declare const __webpack_chunk_load__: (chunkId: string | number) => Promise; -declare const __webpack_module__: { id: string | number }; -declare const __webpack_hash__: string; -declare const __webpack_chunkname__: string; -declare const __webpack_get_script_filename__: (chunkId: string | number) => string; -declare let __webpack_nonce__: string; -declare const __webpack_runtime_id__: string; -declare const __webpack_layer__: string | null; -declare const __webpack_share_scopes__: Record; -declare const __webpack_init_sharing__: (scope: string) => Promise; -declare const __non_webpack_require__: NodeRequire; -declare const __system_context__: any; -``` - ---- - -## See Also - -- [import()](/api/module-methods/import) - Dynamic imports -- [require()](/api/module-methods/require) - CommonJS require -- [Public Path](/configuration/output) - Configuring public path -- [Module Federation](/guides/module-federation) - Module federation guide \ No newline at end of file diff --git a/api/module-methods/require-context.mdx b/api/module-methods/require-context.mdx deleted file mode 100644 index bc357bd..0000000 --- a/api/module-methods/require-context.mdx +++ /dev/null @@ -1,547 +0,0 @@ ---- -title: require.context() -description: Dynamically require multiple modules with a single expression ---- - -`require.context()` allows you to create a context to dynamically require a set of modules matching specific criteria. - -## Syntax - -```javascript -require.context(directory, useSubdirectories, regExp, mode) -``` - -### Parameters - - - Directory to search in (relative to current file). - - ```javascript - require.context('./components', true, /\.js$/) - ``` - - - - Whether to search subdirectories. - - ```javascript - // Include subdirectories - require.context('./modules', true, /\.js$/) - - // Only direct children - require.context('./modules', false, /\.js$/) - ``` - - - - Regular expression to match files against. - - ```javascript - // Match .js files - require.context('./src', true, /\.js$/) - - // Match .vue files - require.context('./components', true, /\.vue$/) - - // Match specific pattern - require.context('./icons', true, /icon-.*\.svg$/) - ``` - - - - Module loading mode. - - **Values:** `sync` | `lazy` | `weak` | `eager` | `lazy-once` - - ```javascript - // Synchronous (default) - require.context('./modules', true, /\.js$/, 'sync') - - // Lazy loading (code splitting) - require.context('./features', true, /\.js$/, 'lazy') - ``` - - -### Return Type - -**Returns:** `WebpackContext` function with properties: - -- `keys()`: Returns array of all possible module paths -- `resolve(key)`: Returns module ID for a given key -- `id`: Context module ID - ---- - -## Basic Usage - -### Loading All Files in Directory - -```javascript -// Create context for all .js files in ./modules -const modulesContext = require.context('./modules', false, /\.js$/); - -// Get all module paths -const modulePaths = modulesContext.keys(); -// ['./module-a.js', './module-b.js', './module-c.js'] - -// Load all modules -modulePaths.forEach(path => { - const module = modulesContext(path); - console.log(module); -}); -``` - -### Auto-importing Components - -```javascript -// components/index.js -// Automatically import all Vue components - -const componentsContext = require.context( - './components', - false, - /\.vue$/ -); - -const components = {}; - -componentsContext.keys().forEach(fileName => { - const componentConfig = componentsContext(fileName); - const componentName = fileName - .replace(/^\.\//, '') - .replace(/\.vue$/, ''); - - components[componentName] = componentConfig.default || componentConfig; -}); - -export default components; -``` - -### Loading Locale Files - -```javascript -// i18n/index.js -const messages = {}; - -const localesContext = require.context( - './locales', - false, - /\.json$/ -); - -localesContext.keys().forEach(key => { - // Extract locale from filename: './en-US.json' -> 'en-US' - const locale = key.replace(/^\.\//, '').replace(/\.json$/, ''); - messages[locale] = localesContext(key); -}); - -// messages = { -// 'en-US': { ... }, -// 'es-ES': { ... }, -// 'fr-FR': { ... } -// } - -export default messages; -``` - ---- - -## Advanced Patterns - -### Vue Component Auto-registration - -```javascript -// main.js -import Vue from 'vue'; - -const requireComponent = require.context( - './components', - false, - /Base[A-Z]\w+\.vue$/ -); - -requireComponent.keys().forEach(fileName => { - const componentConfig = requireComponent(fileName); - - // Get PascalCase name of component - const componentName = fileName - .split('/') - .pop() - .replace(/\.\w+$/, ''); - - // Register component globally - Vue.component( - componentName, - componentConfig.default || componentConfig - ); -}); -``` - -### Vuex Module Auto-loading - -```javascript -// store/index.js -import Vue from 'vue'; -import Vuex from 'vuex'; - -Vue.use(Vuex); - -const modulesContext = require.context( - './modules', - false, - /\.js$/ -); - -const modules = {}; - -modulesContext.keys().forEach(fileName => { - const moduleName = fileName.replace(/^\.\//, '').replace(/\.js$/, ''); - modules[moduleName] = modulesContext(fileName).default; -}); - -export default new Vuex.Store({ - modules -}); -``` - -### SVG Icon Registry - -```javascript -// icons/index.js -const svgContext = require.context( - './svg', - false, - /\.svg$/ -); - -const icons = {}; - -svgContext.keys().forEach(path => { - const iconName = path.replace(/^\.\//, '').replace(/\.svg$/, ''); - icons[iconName] = svgContext(path).default; -}); - -export default icons; - -// Usage -import icons from './icons'; -const homeIcon = icons['home']; -``` - -### Plugin System - -```javascript -// plugins/index.js -class PluginManager { - constructor() { - this.plugins = new Map(); - this.loadPlugins(); - } - - loadPlugins() { - const pluginsContext = require.context( - './plugins', - true, - /\.js$/ - ); - - pluginsContext.keys().forEach(path => { - const plugin = pluginsContext(path).default; - if (plugin && plugin.name) { - this.plugins.set(plugin.name, plugin); - } - }); - } - - get(name) { - return this.plugins.get(name); - } - - has(name) { - return this.plugins.has(name); - } -} - -export default new PluginManager(); -``` - ---- - -## Lazy Loading with Context - -### Lazy Mode - -```javascript -// Load modules lazily (creates separate chunks) -const featuresContext = require.context( - './features', - false, - /\.js$/, - 'lazy' -); - -// Returns a Promise -async function loadFeature(name) { - const path = `./${name}.js`; - if (featuresContext.keys().includes(path)) { - const module = await featuresContext(path); - return module.default; - } - throw new Error(`Feature ${name} not found`); -} - -// Usage -const feature = await loadFeature('advanced-search'); -``` - -### Lazy-Once Mode - -```javascript -// Bundle all modules into one async chunk -const localesContext = require.context( - './locales', - false, - /\.json$/, - 'lazy-once' -); - -// All locales loaded together when first one is requested -async function loadLocale(locale) { - const messages = await localesContext(`./${locale}.json`); - return messages.default; -} -``` - ---- - -## Context API Methods - -### keys() - -Returns an array of all matching module paths. - -```javascript -const ctx = require.context('./modules', false, /\.js$/); - -const allPaths = ctx.keys(); -// ['./module-a.js', './module-b.js', './module-c.js'] - -// Filter paths -const testFiles = ctx.keys().filter(key => /\.test\.js$/.test(key)); -``` - -### resolve(key) - -Returns the module ID for a given key. - -```javascript -const ctx = require.context('./modules', false, /\.js$/); - -const moduleId = ctx.resolve('./module-a.js'); -console.log(moduleId); // 42 (numeric module ID) -``` - -### id - -The module ID of the context itself. - -```javascript -const ctx = require.context('./modules', false, /\.js$/); - -console.log(ctx.id); // './src/modules sync \.js$' -``` - ---- - -## Dynamic Contexts - -### Building Module Maps - -```javascript -function requireAll(context) { - const modules = {}; - - context.keys().forEach(key => { - const module = context(key); - const name = key.replace(/^\.\//, '').replace(/\.js$/, ''); - modules[name] = module.default || module; - }); - - return modules; -} - -// Usage -const utils = requireAll(require.context('./utils', false, /\.js$/)); -const helpers = requireAll(require.context('./helpers', false, /\.js$/)); -``` - -### Conditional Loading - -```javascript -function loadModulesByEnv() { - const isProd = process.env.NODE_ENV === 'production'; - - const context = isProd - ? require.context('./prod-modules', false, /\.js$/) - : require.context('./dev-modules', false, /\.js$/); - - return context.keys().map(key => context(key)); -} -``` - ---- - -## React Examples - -### Auto-import Redux Reducers - -```javascript -// reducers/index.js -import { combineReducers } from 'redux'; - -const reducersContext = require.context( - './reducers', - false, - /\.js$/ -); - -const reducers = {}; - -reducersContext.keys().forEach(fileName => { - if (fileName === './index.js') return; - - const reducerName = fileName - .replace(/^\.\//, '') - .replace(/\.js$/, ''); - - reducers[reducerName] = reducersContext(fileName).default; -}); - -export default combineReducers(reducers); -``` - -### Image Importing - -```javascript -// images/index.js -const imagesContext = require.context( - './images', - false, - /\.(png|jpe?g|svg)$/ -); - -const images = {}; - -imagesContext.keys().forEach(path => { - const imageName = path.replace(/^\.\//, '').replace(/\.[^.]+$/, ''); - images[imageName] = imagesContext(path); -}); - -export default images; - -// Usage in component -import images from './images'; - -function MyComponent() { - return Logo; -} -``` - ---- - -## Performance Considerations - -### Limit Context Scope - -```javascript -// Bad: Too broad, includes many files -const ctx = require.context('.', true, /\.js$/); - -// Good: Specific directory and pattern -const ctx = require.context('./components', false, /Component\.js$/); -``` - -### Use Lazy Loading for Large Sets - -```javascript -// Synchronous: All modules in main bundle -const ctx = require.context('./features', false, /\.js$/, 'sync'); - -// Lazy: Separate chunks, loaded on demand -const ctx = require.context('./features', false, /\.js$/, 'lazy'); -``` - ---- - -## TypeScript Support - -```typescript -// Type-safe context -interface Module { - default: React.ComponentType; -} - -const componentsContext = require.context( - './components', - false, - /\.tsx$/ -); - -const components: Record = {}; - -componentsContext.keys().forEach((fileName: string) => { - const component = componentsContext(fileName) as Module; - const componentName = fileName - .replace(/^\.\//, '') - .replace(/\.tsx$/, ''); - - components[componentName] = component.default; -}); - -export default components; -``` - ---- - -## Common Patterns - -### Test File Discovery - -```javascript -// test/setup.js -// Load all test files -const testsContext = require.context( - '../src', - true, - /\.test\.js$/ -); - -testsContext.keys().forEach(testsContext); -``` - -### Asset Manifest - -```javascript -// Generate asset manifest -const assetsContext = require.context( - './assets', - true, - /\.(png|svg|jpg|gif|woff|woff2|eot|ttf|otf)$/ -); - -const manifest = assetsContext.keys().reduce((acc, path) => { - acc[path] = assetsContext(path); - return acc; -}, {}); - -export default manifest; -``` - ---- - -## See Also - -- [import()](/api/module-methods/import) - Dynamic imports -- [require()](/api/module-methods/require) - CommonJS require -- [Module Variables](/api/module-methods/module-variables) - Module-scoped variables -- [Dependency Management](/concepts/dependency-graph) - Managing dependencies \ No newline at end of file diff --git a/api/module-methods/require.mdx b/api/module-methods/require.mdx deleted file mode 100644 index ac7ce25..0000000 --- a/api/module-methods/require.mdx +++ /dev/null @@ -1,440 +0,0 @@ ---- -title: require() and require.resolve() -description: CommonJS module loading methods in webpack ---- - -Webpack supports CommonJS `require()` and `require.resolve()` for synchronous module loading and resolution. - -## require() - -Synchronously loads and returns a module. - -### Syntax - -```javascript -require(modulePath) -``` - -### Parameters - - - Path to the module to require. Can be relative, absolute, or a module name. - - ```javascript - require('./module.js') - require('lodash') - require('/absolute/path/module.js') - ``` - - -### Return Type - -**Returns:** `Module` - -Returns the module's exports object. - ---- - -## Basic Usage - -### Requiring Local Modules - -```javascript -// math.js -module.exports = { - add: (a, b) => a + b, - multiply: (a, b) => a * b -}; - -// app.js -const math = require('./math.js'); -console.log(math.add(2, 3)); // 5 -console.log(math.multiply(2, 3)); // 6 -``` - -### Destructuring Exports - -```javascript -// Destructure specific exports -const { add, multiply } = require('./math.js'); - -console.log(add(2, 3)); // 5 -console.log(multiply(2, 3)); // 6 -``` - -### Requiring npm Packages - -```javascript -// Load from node_modules -const _ = require('lodash'); -const axios = require('axios'); -const moment = require('moment'); - -console.log(_.chunk([1, 2, 3, 4], 2)); // [[1, 2], [3, 4]] -``` - -### Default Exports - -```javascript -// logger.js -class Logger { - log(message) { - console.log(message); - } -} - -module.exports = Logger; - -// app.js -const Logger = require('./logger.js'); -const logger = new Logger(); -logger.log('Hello!'); // Hello! -``` - ---- - -## Module Exports Patterns - -### Single Function Export - -```javascript -// greet.js -module.exports = function(name) { - return `Hello, ${name}!`; -}; - -// app.js -const greet = require('./greet.js'); -console.log(greet('World')); // Hello, World! -``` - -### Multiple Named Exports - -```javascript -// utils.js -exports.capitalize = str => str.charAt(0).toUpperCase() + str.slice(1); -exports.lowercase = str => str.toLowerCase(); -exports.uppercase = str => str.toUpperCase(); - -// app.js -const utils = require('./utils.js'); -console.log(utils.capitalize('hello')); // Hello -``` - -### Mixed Exports - -```javascript -// api.js -function ApiClient(baseUrl) { - this.baseUrl = baseUrl; -} - -ApiClient.prototype.get = function(endpoint) { - return fetch(`${this.baseUrl}${endpoint}`); -}; - -// Add static methods -ApiClient.version = '1.0.0'; -ApiClient.create = function(baseUrl) { - return new ApiClient(baseUrl); -}; - -module.exports = ApiClient; - -// app.js -const ApiClient = require('./api.js'); -console.log(ApiClient.version); // 1.0.0 -const client = ApiClient.create('https://api.example.com'); -``` - ---- - -## require.resolve() - -Resolves a module path to its absolute file path without executing it. - -### Syntax - -```javascript -require.resolve(modulePath) -require.resolve(modulePath, options) -``` - -### Parameters - - - Path to the module to resolve. - - ```javascript - require.resolve('./module.js') - require.resolve('lodash') - ``` - - - - Resolution options. - - ```javascript - require.resolve('module', { paths: ['/custom/path'] }) - ``` - - **Properties:** - - `paths` (string[]): Additional paths to search for the module - - -### Return Type - -**Returns:** `string` (module ID) - -Returns the resolved module identifier (typically a numeric ID in webpack bundles). - ---- - -## require.resolve() Examples - -### Basic Resolution - -```javascript -// Get module ID without loading it -const moduleId = require.resolve('./utils.js'); -console.log(moduleId); // 42 (numeric module ID) - -// Later, load the module -const utils = require('./utils.js'); -``` - -### Checking Module Existence - -```javascript -function moduleExists(modulePath) { - try { - require.resolve(modulePath); - return true; - } catch (err) { - return false; - } -} - -if (moduleExists('./optional-feature.js')) { - const feature = require('./optional-feature.js'); - feature.init(); -} -``` - -### Custom Resolution Paths - -```javascript -// Resolve from custom paths -const modulePath = require.resolve('plugin', { - paths: [ - './plugins', - './node_modules', - '/usr/local/lib/node_modules' - ] -}); -``` - -### Module ID Mapping - -```javascript -// Build a module registry -const moduleRegistry = { - utils: require.resolve('./utils.js'), - helpers: require.resolve('./helpers.js'), - api: require.resolve('./api.js') -}; - -// Load modules by name -function loadModule(name) { - const moduleId = moduleRegistry[name]; - if (moduleId) { - return require(moduleId); - } - throw new Error(`Module ${name} not found`); -} -``` - ---- - -## Advanced Patterns - -### Conditional Requires - -```javascript -// Load different modules based on environment -let config; -if (process.env.NODE_ENV === 'production') { - config = require('./config.prod.js'); -} else { - config = require('./config.dev.js'); -} -``` - -### Dynamic Requires with Variables - -```javascript -// Load locale files -function loadLocale(language) { - // Webpack creates a context for this pattern - return require(`./locales/${language}.json`); -} - -const messages = loadLocale('en-US'); -``` - - - Dynamic requires with variables create a webpack context that includes all possible matches. Use `require.context()` for more control. - - -### Circular Dependencies - -```javascript -// a.js -exports.name = 'Module A'; -const b = require('./b.js'); -exports.getMessage = () => `${exports.name} knows ${b.name}`; - -// b.js -exports.name = 'Module B'; -const a = require('./a.js'); -exports.getMessage = () => `${exports.name} knows ${a.name}`; - -// app.js -const a = require('./a.js'); -const b = require('./b.js'); -console.log(a.getMessage()); // Module A knows Module B -console.log(b.getMessage()); // Module B knows Module A -``` - -### Module Caching - -```javascript -// Modules are cached after first require -const module1 = require('./module.js'); -const module2 = require('./module.js'); - -console.log(module1 === module2); // true (same instance) - -// Access module cache -console.log(require.cache); - -// Delete from cache to force reload -delete require.cache[require.resolve('./module.js')]; -const freshModule = require('./module.js'); // Reloaded -``` - ---- - -## require vs import() - -| Feature | require() | import() | -|---------|-----------|----------| -| Loading | Synchronous | Asynchronous | -| Code Splitting | No | Yes | -| Returns | Module exports | Promise\ | -| Dynamic paths | Limited support | Full support | -| Tree shaking | Limited | Full support | -| Top-level await | No | Yes | - -```javascript -// Synchronous (require) -const module = require('./module.js'); -module.doSomething(); - -// Asynchronous (import) -import('./module.js').then(module => { - module.doSomething(); -}); - -// Or with async/await -const module = await import('./module.js'); -module.doSomething(); -``` - ---- - -## CommonJS vs ES Modules - -### Importing ES Modules with require() - -```javascript -// ES module: math.js -export function add(a, b) { - return a + b; -} -export function multiply(a, b) { - return a * b; -} - -// CommonJS: app.js -const math = require('./math.js'); -console.log(math.add(2, 3)); // 5 -console.log(math.multiply(2, 3)); // 6 -``` - -### Default Export Handling - -```javascript -// ES module: logger.js -export default class Logger { - log(message) { - console.log(message); - } -} - -// CommonJS: app.js -const Logger = require('./logger.js').default; -const logger = new Logger(); -``` - ---- - -## TypeScript Support - -```typescript -// Type-safe requires -import type { MathUtils } from './math'; - -const math = require('./math') as MathUtils; -const result = math.add(2, 3); // Type-safe - -// With module resolution -const modulePath: string = require.resolve('./utils'); -``` - ---- - -## Performance Considerations - -### Prefer Static Imports - -```javascript -// Better: Static imports can be optimized -import { add } from './math.js'; - -// Less optimal: Dynamic requires -const { add } = require('./math.js'); -``` - -### Lazy Loading with import() - -```javascript -// Don't require immediately if not always needed -// Instead of: -const heavyModule = require('./heavy-module.js'); - -// Use dynamic import: -button.addEventListener('click', async () => { - const heavyModule = await import('./heavy-module.js'); - heavyModule.process(); -}); -``` - ---- - -## See Also - -- [import()](/api/module-methods/import) - Dynamic imports -- [require.context()](/api/module-methods/require-context) - Require multiple modules -- [Module Variables](/api/module-methods/module-variables) - Module-scoped variables -- [Module Resolution](/concepts/module-resolution) - How webpack resolves modules \ No newline at end of file diff --git a/api/node.mdx b/api/node.mdx deleted file mode 100644 index 08549e0..0000000 --- a/api/node.mdx +++ /dev/null @@ -1,233 +0,0 @@ ---- -title: "Node.js API" -description: "webpack Node.js API documentation - webpack() function for programmatic usage" ---- - -The Node.js API allows you to use webpack directly from Node.js, giving you full control over the compilation process. - -## webpack() - -The primary function exported by webpack. It can be used to create a Compiler or MultiCompiler instance. - -### Signature - -```typescript -function webpack( - options: WebpackOptions, - callback?: (err: Error | null, stats?: Stats) => void -): Compiler | null; - -function webpack( - options: WebpackOptions[], - callback?: (err: Error | null, stats?: MultiStats) => void -): MultiCompiler | null; -``` - - - Webpack configuration object or array of configuration objects for multi-compiler mode. - - - - Optional callback function that receives compilation errors and stats. When provided, webpack will automatically run the compilation. - - **Callback parameters:** - - `err` - Compilation error or null - - `stats` - Stats object containing compilation information - - - - Returns a Compiler instance for single config, MultiCompiler for array of configs, or null if callback was provided and an error occurred. - - -### Basic Usage - -```javascript -const webpack = require('webpack'); -const config = require('./webpack.config.js'); - -// Without callback - get compiler instance -const compiler = webpack(config); - -compiler.run((err, stats) => { - if (err) { - console.error(err); - return; - } - - console.log(stats.toString({ - colors: true - })); - - compiler.close((closeErr) => { - if (closeErr) { - console.error(closeErr); - } - }); -}); -``` - -### With Callback - -When a callback is provided, webpack automatically runs the compilation: - -```javascript -const webpack = require('webpack'); -const config = require('./webpack.config.js'); - -webpack(config, (err, stats) => { - if (err) { - console.error(err.stack || err); - if (err.details) { - console.error(err.details); - } - return; - } - - const info = stats.toJson(); - - if (stats.hasErrors()) { - console.error(info.errors); - } - - if (stats.hasWarnings()) { - console.warn(info.warnings); - } - - // Compiler is automatically closed when using callback -}); -``` - -### Multi-Compiler Mode - -Pass an array of configurations to create a MultiCompiler: - -```javascript -const webpack = require('webpack'); -const config1 = require('./webpack.config1.js'); -const config2 = require('./webpack.config2.js'); - -const multiCompiler = webpack([config1, config2]); - -multiCompiler.run((err, multiStats) => { - if (err) { - console.error(err); - return; - } - - // Access individual stats - multiStats.stats.forEach((stats, index) => { - console.log(`Compiler ${index}:`, stats.toString()); - }); - - multiCompiler.close((closeErr) => { - // Handle close errors - }); -}); -``` - -### Watch Mode - -For watch mode, use the compiler's `watch()` method: - -```javascript -const webpack = require('webpack'); -const config = require('./webpack.config.js'); - -const compiler = webpack(config); - -const watching = compiler.watch({ - aggregateTimeout: 300, - poll: undefined -}, (err, stats) => { - // Stats is updated on each compilation - console.log(stats.toString()); -}); - -// Stop watching -watching.close((closeErr) => { - console.log('Watching closed.'); -}); -``` - -## Related Functions - -### webpack.validate() - -Validates a webpack configuration object: - -```javascript -const webpack = require('webpack'); -const config = require('./webpack.config.js'); - -try { - webpack.validate(config); - console.log('Configuration is valid'); -} catch (err) { - console.error('Configuration error:', err.message); -} -``` - -### webpack.version - -Returns the current webpack version: - -```javascript -const webpack = require('webpack'); -console.log(webpack.version); // "5.x.x" -``` - -## Error Handling - -Webpack operations can fail at different stages: - -```javascript -const webpack = require('webpack'); - -webpack(config, (err, stats) => { - // Fatal webpack errors (wrong configuration, etc) - if (err) { - console.error(err.stack || err); - if (err.details) { - console.error(err.details); - } - return; - } - - const info = stats.toJson(); - - // Compilation errors (missing modules, syntax errors, etc) - if (stats.hasErrors()) { - console.error(info.errors); - } - - // Compilation warnings - if (stats.hasWarnings()) { - console.warn(info.warnings); - } -}); -``` - -## TypeScript Support - -Webpack provides TypeScript type definitions: - -```typescript -import webpack, { Configuration, Stats, Compiler } from 'webpack'; - -const config: Configuration = { - entry: './src/index.ts', - // ... other options -}; - -const compiler: Compiler = webpack(config); - -compiler.run((err: Error | null, stats?: Stats) => { - // Type-safe callback -}); -``` - -## See Also - -- [Compiler API](/api/compiler) - Compiler instance methods and hooks -- [Stats Object](/api/stats) - Compilation statistics and output -- [Compilation API](/api/compilation) - Compilation instance API \ No newline at end of file diff --git a/api/plugins/compilation-hooks.mdx b/api/plugins/compilation-hooks.mdx deleted file mode 100644 index c4c7f84..0000000 --- a/api/plugins/compilation-hooks.mdx +++ /dev/null @@ -1,785 +0,0 @@ ---- -title: Compilation Hooks -description: Reference for webpack Compilation lifecycle hooks ---- - -The `Compilation` module is created by the `Compiler` and represents a single build of the assets. In watch mode, a new compilation is created each time a file changes. - -## Accessing Compilation Hooks - -Access compilation hooks through the compiler's `compilation` hook: - -```javascript -class MyPlugin { - apply(compiler) { - compiler.hooks.compilation.tap('MyPlugin', (compilation) => { - compilation.hooks.buildModule.tap('MyPlugin', (module) => { - console.log('Building module'); - }); - }); - } -} -``` - -## Module Hooks - -### `buildModule` - -```typescript -SyncHook<[Module]> -``` - -Called before a module is built. - -```javascript -compilation.hooks.buildModule.tap('MyPlugin', (module) => { - console.log('Building:', module.identifier()); -}); -``` - -### `rebuildModule` - -```typescript -SyncHook<[Module]> -``` - -Called when a module is rebuilt in watch mode. - -```javascript -compilation.hooks.rebuildModule.tap('MyPlugin', (module) => { - console.log('Rebuilding:', module.identifier()); -}); -``` - -### `succeedModule` - -```typescript -SyncHook<[Module]> -``` - -Called when a module is successfully built. - -```javascript -compilation.hooks.succeedModule.tap('MyPlugin', (module) => { - console.log('Successfully built:', module.identifier()); -}); -``` - -### `failedModule` - -```typescript -SyncHook<[Module, WebpackError]> -``` - -Called when a module build fails. - -```javascript -compilation.hooks.failedModule.tap('MyPlugin', (module, error) => { - console.error('Failed to build:', module.identifier(), error); -}); -``` - -### `stillValidModule` - -```typescript -SyncHook<[Module]> -``` - -Called when a module is still valid (cached). - -```javascript -compilation.hooks.stillValidModule.tap('MyPlugin', (module) => { - console.log('Module still valid:', module.identifier()); -}); -``` - -### `finishModules` - -```typescript -AsyncSeriesHook<[Iterable]> -``` - -Called when all modules have been built. - -```javascript -compilation.hooks.finishModules.tapAsync( - 'MyPlugin', - (modules, callback) => { - console.log(`Finished building ${modules.size} modules`); - callback(); - } -); -``` - -### `finishRebuildingModule` - -```typescript -AsyncSeriesHook<[Module]> -``` - -Called when a module finishes rebuilding. - -```javascript -compilation.hooks.finishRebuildingModule.tapAsync( - 'MyPlugin', - (module, callback) => { - console.log('Finished rebuilding:', module.identifier()); - callback(); - } -); -``` - -## Entry Hooks - -### `addEntry` - -```typescript -SyncHook<[Dependency, EntryOptions]> -``` - -Called when an entry is added. - -```javascript -compilation.hooks.addEntry.tap('MyPlugin', (entry, options) => { - console.log('Adding entry:', options.name); -}); -``` - -### `succeedEntry` - -```typescript -SyncHook<[Dependency, EntryOptions, Module]> -``` - -Called when an entry is successfully processed. - -```javascript -compilation.hooks.succeedEntry.tap( - 'MyPlugin', - (entry, options, module) => { - console.log('Entry succeeded:', options.name); - } -); -``` - -### `failedEntry` - -```typescript -SyncHook<[Dependency, EntryOptions, Error]> -``` - -Called when an entry fails. - -```javascript -compilation.hooks.failedEntry.tap( - 'MyPlugin', - (entry, options, error) => { - console.error('Entry failed:', options.name, error); - } -); -``` - -## Sealing Hooks - -### `seal` - -```typescript -SyncHook<[]> -``` - -Called when compilation sealing begins. After this, no more modules are added. - -```javascript -compilation.hooks.seal.tap('MyPlugin', () => { - console.log('Compilation sealed'); -}); -``` - -### `unseal` - -```typescript -SyncHook<[]> -``` - -Called when compilation is unsealed. - -```javascript -compilation.hooks.unseal.tap('MyPlugin', () => { - console.log('Compilation unsealed'); -}); -``` - -### `afterSeal` - -```typescript -AsyncSeriesHook<[]> -``` - -Called after compilation is sealed. - -```javascript -compilation.hooks.afterSeal.tapAsync('MyPlugin', (callback) => { - console.log('After seal'); - callback(); -}); -``` - -## Chunk Hooks - -### `beforeChunks` - -```typescript -SyncHook<[]> -``` - -Called before chunk creation. - -```javascript -compilation.hooks.beforeChunks.tap('MyPlugin', () => { - console.log('Before chunks created'); -}); -``` - -### `afterChunks` - -```typescript -SyncHook<[Iterable]> -``` - -Called after chunks are created. Perfect for analyzing the chunk graph. - -```javascript -compilation.hooks.afterChunks.tap('MyPlugin', (chunks) => { - console.log(`Created ${chunks.size} chunks`); - for (const chunk of chunks) { - console.log('Chunk:', chunk.id, 'files:', Array.from(chunk.files)); - } -}); -``` - -## Optimization Hooks - -### `optimize` - -```typescript -SyncHook<[]> -``` - -Called at the beginning of optimization phase. - -```javascript -compilation.hooks.optimize.tap('MyPlugin', () => { - console.log('Optimization started'); -}); -``` - -### `optimizeModules` - -```typescript -SyncBailHook<[Iterable]> -``` - -Called during module optimization. Return `true` to skip remaining optimizations. - -```javascript -compilation.hooks.optimizeModules.tap('MyPlugin', (modules) => { - for (const module of modules) { - // Optimize module - } -}); -``` - -### `afterOptimizeModules` - -```typescript -SyncHook<[Iterable]> -``` - -Called after module optimization. - -```javascript -compilation.hooks.afterOptimizeModules.tap('MyPlugin', (modules) => { - console.log('Module optimization complete'); -}); -``` - -### `optimizeChunks` - -```typescript -SyncBailHook<[Iterable, ChunkGroup[]]> -``` - -Called during chunk optimization. - -```javascript -compilation.hooks.optimizeChunks.tap( - 'MyPlugin', - (chunks, chunkGroups) => { - for (const chunk of chunks) { - // Optimize chunk - } - } -); -``` - -### `afterOptimizeChunks` - -```typescript -SyncHook<[Iterable, ChunkGroup[]]> -``` - -Called after chunk optimization. - -```javascript -compilation.hooks.afterOptimizeChunks.tap( - 'MyPlugin', - (chunks, chunkGroups) => { - console.log('Chunk optimization complete'); - } -); -``` - -### `optimizeTree` - -```typescript -AsyncSeriesHook<[Iterable, Iterable]> -``` - -Optimize the dependency tree. - -```javascript -compilation.hooks.optimizeTree.tapAsync( - 'MyPlugin', - (chunks, modules, callback) => { - // Optimize module and chunk tree - callback(); - } -); -``` - -### `optimizeChunkModules` - -```typescript -AsyncSeriesBailHook<[Iterable, Iterable]> -``` - -Optimize modules within chunks. - -```javascript -compilation.hooks.optimizeChunkModules.tapAsync( - 'MyPlugin', - (chunks, modules, callback) => { - // Optimize how modules are assigned to chunks - callback(); - } -); -``` - -## Module & Chunk IDs - -### `moduleIds` - -```typescript -SyncHook<[Iterable]> -``` - -Called to assign module IDs. - -```javascript -compilation.hooks.moduleIds.tap('MyPlugin', (modules) => { - for (const module of modules) { - if (module.id === null) { - // Assign custom ID - module.id = customIdGenerator(); - } - } -}); -``` - -### `chunkIds` - -```typescript -SyncHook<[Iterable]> -``` - -Called to assign chunk IDs. - -```javascript -compilation.hooks.chunkIds.tap('MyPlugin', (chunks) => { - for (const chunk of chunks) { - if (chunk.id === null) { - // Assign custom ID - chunk.id = customIdGenerator(); - } - } -}); -``` - -## Hash Hooks - -### `beforeHash` - -```typescript -SyncHook<[]> -``` - -Called before hashing. - -```javascript -compilation.hooks.beforeHash.tap('MyPlugin', () => { - console.log('Before hash generation'); -}); -``` - -### `afterHash` - -```typescript -SyncHook<[]> -``` - -Called after compilation is hashed. - -```javascript -compilation.hooks.afterHash.tap('MyPlugin', () => { - console.log('Hash:', compilation.hash); -}); -``` - -### `fullHash` - -```typescript -SyncHook<[Hash]> -``` - -Called to add custom data to the full hash. - -```javascript -compilation.hooks.fullHash.tap('MyPlugin', (hash) => { - hash.update('my custom data'); -}); -``` - -### `chunkHash` - -```typescript -SyncHook<[Chunk, Hash, ChunkHashContext]> -``` - -Called to add custom data to each chunk's hash. - -```javascript -compilation.hooks.chunkHash.tap('MyPlugin', (chunk, hash, context) => { - hash.update('my custom chunk data'); -}); -``` - -### `contentHash` - -```typescript -SyncHook<[Chunk]> -``` - -Called to create content hash for a chunk. - -```javascript -compilation.hooks.contentHash.tap('MyPlugin', (chunk) => { - // Update content hash -}); -``` - -## Asset Hooks - -### `beforeModuleAssets` - -```typescript -SyncHook<[]> -``` - -Called before module assets are created. - -```javascript -compilation.hooks.beforeModuleAssets.tap('MyPlugin', () => { - console.log('Creating module assets'); -}); -``` - -### `beforeChunkAssets` - -```typescript -SyncHook<[]> -``` - -Called before chunk assets are created. - -```javascript -compilation.hooks.beforeChunkAssets.tap('MyPlugin', () => { - console.log('Creating chunk assets'); -}); -``` - -### `processAssets` - -```typescript -AsyncSeriesHook<[CompilationAssets]> -``` - -The main hook for processing assets. Supports stages for ordering. - -```javascript -const { Compilation } = require('webpack'); - -compilation.hooks.processAssets.tap( - { - name: 'MyPlugin', - stage: Compilation.PROCESS_ASSETS_STAGE_OPTIMIZE - }, - (assets) => { - for (const name in assets) { - console.log('Processing asset:', name); - // Modify or analyze asset - } - } -); -``` - -**Asset Processing Stages:** - -```javascript -// Add additional assets to compilation -PROCESS_ASSETS_STAGE_ADDITIONAL = -2000 - -// Basic preprocessing -PROCESS_ASSETS_STAGE_PRE_PROCESS = -1000 - -// Derive new assets from existing -PROCESS_ASSETS_STAGE_DERIVED = -200 - -// Add additional sections to existing assets -PROCESS_ASSETS_STAGE_ADDITIONS = -100 - -// Optimize existing assets -PROCESS_ASSETS_STAGE_OPTIMIZE = 100 - -// Optimize size of assets -PROCESS_ASSETS_STAGE_OPTIMIZE_SIZE = 400 - -// Add development tooling -PROCESS_ASSETS_STAGE_DEV_TOOLING = 500 - -// Optimize asset transfer -PROCESS_ASSETS_STAGE_OPTIMIZE_TRANSFER = 700 - -// Analyze existing assets -PROCESS_ASSETS_STAGE_ANALYSE = 4000 - -// Summarize the list of assets -PROCESS_ASSETS_STAGE_SUMMARIZE = Infinity -``` - -**Example: BannerPlugin** (lib/BannerPlugin.js:100): - -```javascript -compilation.hooks.processAssets.tap( - { - name: 'BannerPlugin', - stage: Compilation.PROCESS_ASSETS_STAGE_ADDITIONS - }, - () => { - for (const chunk of compilation.chunks) { - for (const file of chunk.files) { - compilation.updateAsset(file, (old) => { - return new ConcatSource(banner, '\n', old); - }); - } - } - } -); -``` - -### `afterProcessAssets` - -```typescript -SyncHook<[CompilationAssets]> -``` - -Called after asset processing is complete. - -```javascript -compilation.hooks.afterProcessAssets.tap('MyPlugin', (assets) => { - console.log('Asset processing complete'); -}); -``` - -### `moduleAsset` - -```typescript -SyncHook<[Module, string]> -``` - -Called when a module asset is created. - -```javascript -compilation.hooks.moduleAsset.tap('MyPlugin', (module, filename) => { - console.log('Module asset:', filename); -}); -``` - -### `chunkAsset` - -```typescript -SyncHook<[Chunk, string]> -``` - -Called when a chunk asset is created. - -```javascript -compilation.hooks.chunkAsset.tap('MyPlugin', (chunk, filename) => { - console.log('Chunk asset:', filename); -}); -``` - -## Record Hooks - -### `record` - -```typescript -SyncHook<[Compilation, Records]> -``` - -Store information about the compilation. - -```javascript -compilation.hooks.record.tap('MyPlugin', (compilation, records) => { - records.myPluginData = { /* custom data */ }; -}); -``` - -## Stats Hooks - -### `statsPreset` - -```typescript -HookMap, CreateStatsOptionsContext]>> -``` - -Customize stats presets. - -```javascript -compilation.hooks.statsPreset - .for('my-preset') - .tap('MyPlugin', (options, context) => { - options.assets = true; - options.modules = true; - }); -``` - -### `statsNormalize` - -```typescript -SyncHook<[Partial, CreateStatsOptionsContext]> -``` - -Normalize stats options. - -```javascript -compilation.hooks.statsNormalize.tap('MyPlugin', (options, context) => { - // Normalize options -}); -``` - -### `statsFactory` - -```typescript -SyncHook<[StatsFactory, NormalizedStatsOptions]> -``` - -Customize how stats are created. - -```javascript -compilation.hooks.statsFactory.tap('MyPlugin', (statsFactory, options) => { - statsFactory.hooks.extract.tap('MyPlugin', (object, data) => { - // Extract custom stats - }); -}); -``` - -### `statsPrinter` - -```typescript -SyncHook<[StatsPrinter, NormalizedStatsOptions]> -``` - -Customize how stats are printed. - -```javascript -compilation.hooks.statsPrinter.tap('MyPlugin', (statsPrinter, options) => { - statsPrinter.hooks.print.tap('MyPlugin', (value, context) => { - // Custom printing - }); -}); -``` - -## Runtime Requirements Hooks - -### `additionalTreeRuntimeRequirements` - -```typescript -SyncHook<[Chunk, RuntimeRequirements, RuntimeRequirementsContext]> -``` - -Add runtime requirements for a chunk. - -```javascript -compilation.hooks.additionalTreeRuntimeRequirements.tap( - 'MyPlugin', - (chunk, runtimeRequirements, context) => { - runtimeRequirements.add('myCustomRuntime'); - } -); -``` - -## Complete Example - -```javascript -class MyCompilationPlugin { - apply(compiler) { - compiler.hooks.compilation.tap('MyPlugin', (compilation) => { - // Module building - compilation.hooks.buildModule.tap('MyPlugin', (module) => { - console.log('Building:', module.identifier()); - }); - - // Optimize modules - compilation.hooks.optimizeModules.tap('MyPlugin', (modules) => { - console.log(`Optimizing ${modules.size} modules`); - }); - - // Process assets - compilation.hooks.processAssets.tap( - { - name: 'MyPlugin', - stage: compilation.PROCESS_ASSETS_STAGE_OPTIMIZE - }, - (assets) => { - for (const name in assets) { - const asset = assets[name]; - console.log(`Asset: ${name}, Size: ${asset.size()}`); - } - } - ); - - // After seal - compilation.hooks.afterSeal.tapAsync('MyPlugin', (callback) => { - console.log('Compilation sealed'); - callback(); - }); - }); - } -} -``` - -## See Also - -- [Compiler Hooks](./compiler-hooks) - Hooks for the compiler lifecycle -- [Module Factories](./module-factories) - Module creation hooks -- [Parser Hooks](./parser) - Code parsing hooks \ No newline at end of file diff --git a/api/plugins/compiler-hooks.mdx b/api/plugins/compiler-hooks.mdx deleted file mode 100644 index c7bc85c..0000000 --- a/api/plugins/compiler-hooks.mdx +++ /dev/null @@ -1,560 +0,0 @@ ---- -title: Compiler Hooks -description: Reference for all webpack Compiler lifecycle hooks ---- - -The `Compiler` module is the main engine that creates a compilation instance with all the options passed through the webpack configuration. It extends `Tapable` and provides lifecycle hooks. - -## Accessing Compiler Hooks - -Compiler hooks are accessed in your plugin's `apply` method: - -```javascript -class MyPlugin { - apply(compiler) { - compiler.hooks.run.tap('MyPlugin', (compiler) => { - console.log('The webpack build process is starting'); - }); - } -} -``` - -## Hook Types Reference - -Each hook is an instance of a Tapable hook class. The type determines how you can tap into it: - -- `SyncHook` - Use `.tap()` only -- `SyncBailHook` - Use `.tap()`, can return value to exit early -- `AsyncSeriesHook` - Use `.tap()`, `.tapAsync()`, or `.tapPromise()` -- `AsyncParallelHook` - Use `.tap()`, `.tapAsync()`, or `.tapPromise()` (runs in parallel) - -## Lifecycle Hooks - -### `initialize` - -```typescript -SyncHook<[]> -``` - -Called when the compiler is initialized. - -```javascript -compiler.hooks.initialize.tap('MyPlugin', () => { - console.log('Compiler initialized'); -}); -``` - -### `environment` - -```typescript -SyncHook<[]> -``` - -Called after the environment is set up. - -```javascript -compiler.hooks.environment.tap('MyPlugin', () => { - // Prepare environment -}); -``` - -### `afterEnvironment` - -```typescript -SyncHook<[]> -``` - -Called after environment setup is complete. - -```javascript -compiler.hooks.afterEnvironment.tap('MyPlugin', () => { - // Environment is ready -}); -``` - -### `afterPlugins` - -```typescript -SyncHook<[Compiler]> -``` - -Called after all plugins from the configuration have been applied. - -```javascript -compiler.hooks.afterPlugins.tap('MyPlugin', (compiler) => { - console.log('All plugins applied'); -}); -``` - -### `afterResolvers` - -```typescript -SyncHook<[Compiler]> -``` - -Called after the resolvers are set up. - -```javascript -compiler.hooks.afterResolvers.tap('MyPlugin', (compiler) => { - // Modify resolvers if needed -}); -``` - -### `entryOption` - -```typescript -SyncBailHook<[string, Entry]> -``` - -Called after the entry configuration has been processed. Return `true` to prevent default entry processing. - -```javascript -compiler.hooks.entryOption.tap('MyPlugin', (context, entry) => { - // Custom entry handling -}); -``` - -## Build Lifecycle Hooks - -### `beforeRun` - -```typescript -AsyncSeriesHook<[Compiler]> -``` - -Called before the compiler starts running. Perfect for cleanup or setup tasks. - -```javascript -compiler.hooks.beforeRun.tapAsync('MyPlugin', (compiler, callback) => { - // Prepare for build - callback(); -}); -``` - -**Example from source** (lib/Compiler.js:607): - -```javascript -this.hooks.beforeRun.callAsync(this, (err) => { - if (err) return finalCallback(err); - this.hooks.run.callAsync(this, (err) => { - // Continue build process - }); -}); -``` - -### `run` - -```typescript -AsyncSeriesHook<[Compiler]> -``` - -Called when the compiler starts running. - -```javascript -compiler.hooks.run.tapPromise('MyPlugin', async (compiler) => { - console.log('Build started'); -}); -``` - -### `watchRun` - -```typescript -AsyncSeriesHook<[Compiler]> -``` - -Called when watch mode is triggered. Receives the compiler instance. - -```javascript -compiler.hooks.watchRun.tapAsync('MyPlugin', (compiler, callback) => { - console.log('Watch compilation started'); - // Access changed files - const changedFiles = compiler.modifiedFiles; - callback(); -}); -``` - -## Compilation Hooks - -### `beforeCompile` - -```typescript -AsyncSeriesHook<[CompilationParams]> -``` - -Called before compilation parameters are created. - -```javascript -compiler.hooks.beforeCompile.tapAsync( - 'MyPlugin', - (params, callback) => { - // params.normalModuleFactory - // params.contextModuleFactory - callback(); - } -); -``` - -### `compile` - -```typescript -SyncHook<[CompilationParams]> -``` - -Called immediately before a new compilation is created. - -```javascript -compiler.hooks.compile.tap('MyPlugin', (params) => { - console.log('Creating new compilation'); -}); -``` - -### `thisCompilation` - -```typescript -SyncHook<[Compilation, CompilationParams]> -``` - -Called when a compilation is created, before `compilation` hook. - -```javascript -compiler.hooks.thisCompilation.tap( - 'MyPlugin', - (compilation, params) => { - // Called before compilation hook - } -); -``` - -### `compilation` - -```typescript -SyncHook<[Compilation, CompilationParams]> -``` - -Called when a compilation is created. This is your main entry point for compilation-level hooks. - -```javascript -compiler.hooks.compilation.tap( - 'MyPlugin', - (compilation, { normalModuleFactory }) => { - // Access compilation hooks - compilation.hooks.buildModule.tap('MyPlugin', (module) => { - // Module is being built - }); - } -); -``` - -**Example: DefinePlugin** (lib/DefinePlugin.js:388): - -```javascript -compiler.hooks.compilation.tap( - 'DefinePlugin', - (compilation, { normalModuleFactory }) => { - const handler = (parser) => { - // Walk definitions and hook into parser - }; - normalModuleFactory.hooks.parser - .for('javascript/auto') - .tap('DefinePlugin', handler); - } -); -``` - -### `make` - -```typescript -AsyncParallelHook<[Compilation]> -``` - -Called when compilation starts. This is where entries are processed. - -```javascript -compiler.hooks.make.tapAsync('MyPlugin', (compilation, callback) => { - // Add entries or process modules - callback(); -}); -``` - -### `finishMake` - -```typescript -AsyncSeriesHook<[Compilation]> -``` - -Called when make phase finishes. - -```javascript -compiler.hooks.finishMake.tapAsync('MyPlugin', (compilation, callback) => { - // Make phase complete - callback(); -}); -``` - -### `afterCompile` - -```typescript -AsyncSeriesHook<[Compilation]> -``` - -Called after compilation finishes. - -```javascript -compiler.hooks.afterCompile.tapAsync('MyPlugin', (compilation, callback) => { - // Compilation complete, before sealing - callback(); -}); -``` - -## Module Factory Hooks - -### `normalModuleFactory` - -```typescript -SyncHook<[NormalModuleFactory]> -``` - -Called after creating a NormalModuleFactory. - -```javascript -compiler.hooks.normalModuleFactory.tap('MyPlugin', (factory) => { - factory.hooks.parser.for('javascript/auto').tap('MyPlugin', (parser) => { - // Customize parser - }); -}); -``` - -### `contextModuleFactory` - -```typescript -SyncHook<[ContextModuleFactory]> -``` - -Called after creating a ContextModuleFactory. - -```javascript -compiler.hooks.contextModuleFactory.tap('MyPlugin', (factory) => { - // Customize context module creation -}); -``` - -## Emit Hooks - -### `shouldEmit` - -```typescript -SyncBailHook<[Compilation], boolean | void> -``` - -Return `false` to prevent emitting assets. - -```javascript -compiler.hooks.shouldEmit.tap('MyPlugin', (compilation) => { - // Return false to skip emit - if (compilation.errors.length > 0) { - return false; - } -}); -``` - -### `emit` - -```typescript -AsyncSeriesHook<[Compilation]> -``` - -Called immediately before assets are emitted to output directory. - -```javascript -compiler.hooks.emit.tapAsync('MyPlugin', (compilation, callback) => { - // Modify assets before writing to disk - for (const filename in compilation.assets) { - console.log(`Emitting ${filename}`); - } - callback(); -}); -``` - -### `assetEmitted` - -```typescript -AsyncSeriesHook<[string, AssetEmittedInfo]> -``` - -Called when an asset has been written to disk. - -```javascript -compiler.hooks.assetEmitted.tap( - 'MyPlugin', - (file, { content, outputPath, targetPath }) => { - console.log(`Asset emitted: ${file}`); - } -); -``` - -### `afterEmit` - -```typescript -AsyncSeriesHook<[Compilation]> -``` - -Called after assets have been emitted. - -```javascript -compiler.hooks.afterEmit.tapAsync('MyPlugin', (compilation, callback) => { - // All assets written to disk - callback(); -}); -``` - -## Completion Hooks - -### `done` - -```typescript -AsyncSeriesHook<[Stats]> -``` - -Called when compilation completes successfully. - -```javascript -compiler.hooks.done.tap('MyPlugin', (stats) => { - console.log('Build completed'); - console.log(stats.toString()); -}); -``` - -### `afterDone` - -```typescript -SyncHook<[Stats]> -``` - -Called after `done` hook completes. - -```javascript -compiler.hooks.afterDone.tap('MyPlugin', (stats) => { - // Final cleanup -}); -``` - -### `failed` - -```typescript -SyncHook<[Error]> -``` - -Called when compilation fails. - -```javascript -compiler.hooks.failed.tap('MyPlugin', (error) => { - console.error('Build failed:', error); -}); -``` - -## Watch Mode Hooks - -### `invalid` - -```typescript -SyncHook<[string | null, number]> -``` - -Called when a watched file changes. - -```javascript -compiler.hooks.invalid.tap('MyPlugin', (filename, changeTime) => { - console.log(`File changed: ${filename}`); -}); -``` - -### `watchClose` - -```typescript -SyncHook<[]> -``` - -Called when watch mode stops. - -```javascript -compiler.hooks.watchClose.tap('MyPlugin', () => { - console.log('Watch mode stopped'); -}); -``` - -## Other Hooks - -### `shutdown` - -```typescript -AsyncSeriesHook<[]> -``` - -Called when compiler is shutting down. - -```javascript -compiler.hooks.shutdown.tapAsync('MyPlugin', (callback) => { - // Cleanup resources - callback(); -}); -``` - -### `infrastructureLog` - -```typescript -SyncBailHook<[string, string, any[]], true | void> -``` - -Custom infrastructure logging. - -```javascript -compiler.hooks.infrastructureLog.tap( - 'MyPlugin', - (origin, type, args) => { - // Custom logging - } -); -``` - -## Complete Example - -```javascript -class MyCompilerPlugin { - apply(compiler) { - // Setup phase - compiler.hooks.environment.tap('MyPlugin', () => { - console.log('Environment setup'); - }); - - // Before build - compiler.hooks.beforeRun.tapAsync('MyPlugin', (compiler, callback) => { - console.log('Preparing to build'); - callback(); - }); - - // During compilation - compiler.hooks.compilation.tap('MyPlugin', (compilation) => { - compilation.hooks.buildModule.tap('MyPlugin', (module) => { - console.log('Building module:', module.identifier()); - }); - }); - - // After emit - compiler.hooks.afterEmit.tapAsync('MyPlugin', (compilation, callback) => { - console.log('Assets emitted'); - callback(); - }); - - // Build complete - compiler.hooks.done.tap('MyPlugin', (stats) => { - console.log('Build completed in', stats.endTime - stats.startTime, 'ms'); - }); - } -} -``` - -## See Also - -- [Compilation Hooks](./compilation-hooks) - Hooks for the compilation phase -- [Module Factories](./module-factories) - Module creation hooks -- [Tapable](./tapable) - Understanding the hook system \ No newline at end of file diff --git a/api/plugins/module-factories.mdx b/api/plugins/module-factories.mdx deleted file mode 100644 index 09050bc..0000000 --- a/api/plugins/module-factories.mdx +++ /dev/null @@ -1,517 +0,0 @@ ---- -title: Module Factory Hooks -description: Customize how webpack creates and resolves modules ---- - -Module factories are responsible for creating module instances in webpack. The two main factories are `NormalModuleFactory` and `ContextModuleFactory`. - -## NormalModuleFactory - -The NormalModuleFactory creates normal modules (most JavaScript/TypeScript files, JSON, etc.). - -### Accessing NormalModuleFactory - -```javascript -class MyPlugin { - apply(compiler) { - compiler.hooks.compilation.tap( - 'MyPlugin', - (compilation, { normalModuleFactory }) => { - // Access normalModuleFactory hooks - } - ); - } -} -``` - -### NormalModuleFactory Hooks - -#### `resolve` - -```typescript -AsyncSeriesBailHook<[ResolveData]> -``` - -Called before resolving a module request. - -```javascript -normalModuleFactory.hooks.resolve.tap('MyPlugin', (resolveData) => { - console.log('Resolving:', resolveData.request); - console.log('Context:', resolveData.context); -}); -``` - -#### `factorize` - -```typescript -AsyncSeriesBailHook<[ResolveData]> -``` - -Called before the module is created. - -```javascript -normalModuleFactory.hooks.factorize.tapAsync( - 'MyPlugin', - (resolveData, callback) => { - // Custom module creation logic - callback(); - } -); -``` - -#### `beforeResolve` - -```typescript -AsyncSeriesBailHook<[ResolveData]> -``` - -Called before module resolution begins. Return `false` to skip resolving. - -```javascript -normalModuleFactory.hooks.beforeResolve.tap('MyPlugin', (resolveData) => { - if (resolveData.request.includes('ignore-me')) { - return false; // Skip this module - } -}); -``` - -#### `afterResolve` - -```typescript -AsyncSeriesBailHook<[ResolveData]> -``` - -Called after module is resolved. - -```javascript -normalModuleFactory.hooks.afterResolve.tap('MyPlugin', (resolveData) => { - console.log('Resolved to:', resolveData.createData.resource); -}); -``` - -#### `createModule` - -```typescript -AsyncSeriesBailHook<[CreateData, ResolveData]> -``` - -Called when creating a module. Can return a custom module. - -```javascript -normalModuleFactory.hooks.createModule.tap( - 'MyPlugin', - (createData, resolveData) => { - if (shouldUseCustomModule(createData)) { - return new MyCustomModule(createData); - } - } -); -``` - -#### `module` - -```typescript -SyncWaterfallHook<[Module, CreateData, ResolveData]> -``` - -Called after a module is created. Can modify or replace the module. - -```javascript -normalModuleFactory.hooks.module.tap( - 'MyPlugin', - (module, createData, resolveData) => { - // Modify module - module.customData = 'my custom data'; - return module; - } -); -``` - -#### `createParser` - -```typescript -HookMap> -``` - -Create a custom parser for a module type. - -```javascript -normalModuleFactory.hooks.createParser - .for('javascript/auto') - .tap('MyPlugin', (parserOptions) => { - return new MyCustomParser(parserOptions); - }); -``` - -#### `parser` - -```typescript -HookMap> -``` - -Access and customize the parser for a module type. This is where most parser customization happens. - -```javascript -normalModuleFactory.hooks.parser - .for('javascript/auto') - .tap('MyPlugin', (parser, parserOptions) => { - // Hook into parser events - parser.hooks.program.tap('MyPlugin', (ast) => { - console.log('Parsing JavaScript'); - }); - }); -``` - -**Example: DefinePlugin** (lib/DefinePlugin.js:780): - -```javascript -normalModuleFactory.hooks.parser - .for('javascript/auto') - .tap('DefinePlugin', (parser) => { - // Define global constants - parser.hooks.expression.for('MY_VAR').tap('DefinePlugin', (expr) => { - return toConstantDependency(parser, JSON.stringify('value'))(expr); - }); - }); -``` - -#### `createGenerator` - -```typescript -HookMap> -``` - -Create a custom generator for a module type. - -```javascript -normalModuleFactory.hooks.createGenerator - .for('javascript/auto') - .tap('MyPlugin', (generatorOptions) => { - return new MyCustomGenerator(generatorOptions); - }); -``` - -#### `generator` - -```typescript -HookMap> -``` - -Access and customize the generator for a module type. - -```javascript -normalModuleFactory.hooks.generator - .for('javascript/auto') - .tap('MyPlugin', (generator, generatorOptions) => { - // Customize code generation - }); -``` - -## ContextModuleFactory - -The ContextModuleFactory handles dynamic requires like `require('./templates/' + name + '.js')`. - -### Accessing ContextModuleFactory - -```javascript -compiler.hooks.compilation.tap( - 'MyPlugin', - (compilation, { contextModuleFactory }) => { - // Access contextModuleFactory hooks - } -); -``` - -### ContextModuleFactory Hooks - -#### `beforeResolve` - -```typescript -AsyncSeriesBailHook<[ResolveData]> -``` - -Called before context resolution. - -```javascript -contextModuleFactory.hooks.beforeResolve.tap('MyPlugin', (resolveData) => { - console.log('Context request:', resolveData.request); -}); -``` - -#### `afterResolve` - -```typescript -AsyncSeriesBailHook<[ResolveData]> -``` - -Called after context resolution. - -```javascript -contextModuleFactory.hooks.afterResolve.tap('MyPlugin', (resolveData) => { - console.log('Context resolved:', resolveData.resource); -}); -``` - -#### `contextModuleFiles` - -```typescript -SyncWaterfallHook<[string[]]> -``` - -Called with the list of files found in the context. - -```javascript -contextModuleFactory.hooks.contextModuleFiles.tap( - 'MyPlugin', - (files) => { - console.log('Context files:', files); - // Can filter or modify files - return files.filter(f => !f.endsWith('.test.js')); - } -); -``` - -## Parser Hooks (JavaScript) - -When you access a parser through `normalModuleFactory.hooks.parser`, you get access to numerous hooks for customizing code parsing. - -### Common Parser Hooks - -#### `program` - -```typescript -SyncBailHook<[Program, Comment[]]> -``` - -Called when parsing starts. - -```javascript -parser.hooks.program.tap('MyPlugin', (ast, comments) => { - console.log('Parsing program'); -}); -``` - -#### `statement` - -```typescript -SyncBailHook<[Statement]> -``` - -Called for each statement. - -```javascript -parser.hooks.statement.tap('MyPlugin', (statement) => { - if (statement.type === 'ImportDeclaration') { - console.log('Found import'); - } -}); -``` - -#### `expression` - -```typescript -HookMap> -``` - -Called when an expression is encountered. - -```javascript -parser.hooks.expression.for('MY_GLOBAL').tap('MyPlugin', (expr) => { - // Replace MY_GLOBAL with a constant - const dep = new ConstDependency('"my value"', expr.range); - parser.state.module.addDependency(dep); - return true; -}); -``` - -**Example: ProvidePlugin** (lib/ProvidePlugin.js:75): - -```javascript -parser.hooks.expression.for('$').tap('ProvidePlugin', (expr) => { - const dep = new ProvidedDependency( - 'jquery', - 'jquery', - [], - expr.range - ); - parser.state.module.addDependency(dep); - return true; -}); -``` - -#### `call` - -```typescript -HookMap> -``` - -Called when a function call is encountered. - -```javascript -parser.hooks.call.for('require').tap('MyPlugin', (expr) => { - console.log('Found require call'); -}); -``` - -#### `import` - -```typescript -SyncBailHook<[Statement, ImportSource]> -``` - -Called for import statements. - -```javascript -parser.hooks.import.tap('MyPlugin', (statement, source) => { - console.log('Importing:', source); -}); -``` - -## Complete Example: Custom Module Type - -```javascript -class CustomModulePlugin { - apply(compiler) { - compiler.hooks.compilation.tap( - 'CustomModulePlugin', - (compilation, { normalModuleFactory }) => { - // Register custom module type - normalModuleFactory.hooks.createParser - .for('custom/type') - .tap('CustomModulePlugin', (parserOptions) => { - return new CustomParser(parserOptions); - }); - - normalModuleFactory.hooks.createGenerator - .for('custom/type') - .tap('CustomModulePlugin', (generatorOptions) => { - return new CustomGenerator(generatorOptions); - }); - - // Customize parsing for JavaScript - normalModuleFactory.hooks.parser - .for('javascript/auto') - .tap('CustomModulePlugin', (parser) => { - // Hook into require calls - parser.hooks.call.for('customRequire').tap( - 'CustomModulePlugin', - (expr) => { - if (expr.arguments.length !== 1) return; - - const param = parser.evaluateExpression(expr.arguments[0]); - if (!param.isString()) return; - - // Add custom dependency - const dep = new CustomDependency( - param.string, - expr.range - ); - parser.state.module.addDependency(dep); - return true; - } - ); - }); - } - ); - } -} -``` - -## Complete Example: Provide Global Variables - -```javascript -class ProvideGlobalsPlugin { - constructor(definitions) { - this.definitions = definitions; - } - - apply(compiler) { - compiler.hooks.compilation.tap( - 'ProvideGlobalsPlugin', - (compilation, { normalModuleFactory }) => { - const handler = (parser) => { - for (const [name, modulePath] of Object.entries(this.definitions)) { - // Hook into identifier expressions - parser.hooks.expression.for(name).tap( - 'ProvideGlobalsPlugin', - (expr) => { - const dep = new ProvidedDependency( - modulePath, - name, - [], - expr.range - ); - dep.loc = expr.loc; - parser.state.module.addDependency(dep); - return true; - } - ); - } - }; - - normalModuleFactory.hooks.parser - .for('javascript/auto') - .tap('ProvideGlobalsPlugin', handler); - normalModuleFactory.hooks.parser - .for('javascript/dynamic') - .tap('ProvideGlobalsPlugin', handler); - normalModuleFactory.hooks.parser - .for('javascript/esm') - .tap('ProvideGlobalsPlugin', handler); - } - ); - } -} - -// Usage -new ProvideGlobalsPlugin({ - $: 'jquery', - _: 'lodash' -}); -``` - -## Module Types - -Common module types you can hook into: - -- `javascript/auto` - Auto-detect ESM or CommonJS -- `javascript/dynamic` - CommonJS -- `javascript/esm` - ES Modules -- `json` - JSON files -- `asset` - Asset modules -- `asset/source` - Source assets -- `asset/resource` - Resource assets -- `asset/inline` - Inline assets -- `webassembly/async` - Async WebAssembly -- `webassembly/sync` - Sync WebAssembly -- `css` - CSS files -- `css/module` - CSS Modules - -## ResolveData Structure - -The `ResolveData` object contains: - -```typescript -interface ResolveData { - contextInfo: { - issuer: string; // Path of the importing module - compiler: string; // Compiler name - }; - context: string; // Directory context - request: string; // The import request - dependencies: Dependency[]; - createData: { - resource: string; // Resolved file path - loaders: LoaderItem[]; // Loaders to apply - type: string; // Module type - parser: Parser; // Parser instance - generator: Generator; // Generator instance - }; -} -``` - -## See Also - -- [Parser Hooks](./parser) - Detailed parser hooks reference -- [Compilation Hooks](./compilation-hooks) - Compilation lifecycle -- [Compiler Hooks](./compiler-hooks) - Compiler lifecycle \ No newline at end of file diff --git a/api/plugins/overview.mdx b/api/plugins/overview.mdx deleted file mode 100644 index 40724e1..0000000 --- a/api/plugins/overview.mdx +++ /dev/null @@ -1,192 +0,0 @@ ---- -title: Plugin System Overview -description: Learn how to create webpack plugins using the Tapable hook system ---- - -## What is a Plugin? - -Plugins are the backbone of webpack. Webpack itself is built on the same plugin system that you use in your webpack configuration. They allow you to hook into the entire compilation lifecycle and customize webpack's behavior. - -## Basic Plugin Structure - -A webpack plugin is a JavaScript object that has an `apply` method. This `apply` method is called by the webpack compiler, giving the plugin access to the entire compilation lifecycle. - -```javascript -class MyPlugin { - apply(compiler) { - compiler.hooks.compilation.tap('MyPlugin', (compilation) => { - // Access compilation hooks - compilation.hooks.optimize.tap('MyPlugin', () => { - console.log('Optimizing...'); - }); - }); - } -} - -module.exports = MyPlugin; -``` - -## Plugin Anatomy - -### 1. The `apply` Method - -Every plugin must have an `apply` method that receives the compiler instance: - -```javascript -apply(compiler) { - // Plugin logic here -} -``` - -### 2. Tapping into Hooks - -Webpack uses [Tapable](./tapable) to expose hooks. You can tap into these hooks using: - -- `tap` - Synchronous hook -- `tapAsync` - Asynchronous hook with callback -- `tapPromise` - Asynchronous hook with promises - -```javascript -// Synchronous -compiler.hooks.run.tap('MyPlugin', (compiler) => { - console.log('Webpack is running'); -}); - -// Asynchronous with callback -compiler.hooks.emit.tapAsync('MyPlugin', (compilation, callback) => { - setTimeout(() => { - console.log('Done with async work'); - callback(); - }, 1000); -}); - -// Asynchronous with Promise -compiler.hooks.afterEmit.tapPromise('MyPlugin', (compilation) => { - return new Promise((resolve) => { - setTimeout(() => { - console.log('Done with async work'); - resolve(); - }, 1000); - }); -}); -``` - -## Real-World Example: BannerPlugin - -Here's a simplified version of webpack's BannerPlugin: - -```javascript -const { ConcatSource } = require('webpack-sources'); - -class BannerPlugin { - constructor(options) { - this.banner = options.banner; - } - - apply(compiler) { - compiler.hooks.compilation.tap('BannerPlugin', (compilation) => { - compilation.hooks.processAssets.tap( - { - name: 'BannerPlugin', - stage: compilation.PROCESS_ASSETS_STAGE_ADDITIONS - }, - () => { - for (const chunk of compilation.chunks) { - for (const file of chunk.files) { - compilation.updateAsset(file, (old) => { - return new ConcatSource(this.banner, '\n', old); - }); - } - } - } - ); - }); - } -} -``` - -## Plugin Types - -### Compiler Plugins - -Hook into the compiler lifecycle for tasks that happen once per build: - -```javascript -compiler.hooks.beforeRun.tap('MyPlugin', (compiler) => { - // Runs before webpack starts -}); -``` - -### Compilation Plugins - -Hook into each compilation for tasks that happen during module processing: - -```javascript -compiler.hooks.compilation.tap('MyPlugin', (compilation) => { - compilation.hooks.buildModule.tap('MyPlugin', (module) => { - // Runs before each module is built - }); -}); -``` - -### Module Factory Plugins - -Customize how modules are created and resolved: - -```javascript -compiler.hooks.compilation.tap( - 'MyPlugin', - (compilation, { normalModuleFactory }) => { - normalModuleFactory.hooks.parser - .for('javascript/auto') - .tap('MyPlugin', (parser) => { - // Customize the JavaScript parser - }); - } -); -``` - -## Key Concepts - -### Compiler vs Compilation - -- **Compiler**: Represents the entire webpack configuration. Created once per webpack process. -- **Compilation**: Represents a single build. In watch mode, a new compilation is created on each file change. - -### Hook Stages - -Many hooks support a `stage` option to control execution order: - -```javascript -compilation.hooks.processAssets.tap( - { - name: 'MyPlugin', - stage: Compilation.PROCESS_ASSETS_STAGE_OPTIMIZE - }, - (assets) => { - // Process assets during optimization stage - } -); -``` - -Common stages: -- `PROCESS_ASSETS_STAGE_ADDITIONAL` - Add additional assets -- `PROCESS_ASSETS_STAGE_PRE_PROCESS` - Basic preprocessing -- `PROCESS_ASSETS_STAGE_OPTIMIZE` - Optimize assets -- `PROCESS_ASSETS_STAGE_SUMMARIZE` - Summarize assets - -## Next Steps - -- [Compiler Hooks](./compiler-hooks) - Learn about compiler lifecycle hooks -- [Compilation Hooks](./compilation-hooks) - Explore compilation hooks -- [Module Factories](./module-factories) - Understand module creation -- [Parser Hooks](./parser) - Customize code parsing -- [Tapable](./tapable) - Master the hook system - -## Best Practices - -1. **Name your taps**: Always provide a clear plugin name when tapping hooks -2. **Handle errors**: Properly handle errors in async hooks -3. **Clean up**: Remove side effects in watch mode -4. **Document**: Add comments explaining what your plugin does -5. **Test**: Write tests for different webpack configurations \ No newline at end of file diff --git a/api/plugins/parser.mdx b/api/plugins/parser.mdx deleted file mode 100644 index 9a056be..0000000 --- a/api/plugins/parser.mdx +++ /dev/null @@ -1,719 +0,0 @@ ---- -title: Parser Hooks -description: Customize how webpack parses your code with parser hooks ---- - -Parser hooks allow you to customize how webpack parses and analyzes your code. These hooks are primarily used for JavaScript/TypeScript files but can also apply to other module types. - -## Accessing Parser Hooks - -Parser hooks are accessed through the NormalModuleFactory: - -```javascript -class MyPlugin { - apply(compiler) { - compiler.hooks.compilation.tap( - 'MyPlugin', - (compilation, { normalModuleFactory }) => { - normalModuleFactory.hooks.parser - .for('javascript/auto') - .tap('MyPlugin', (parser) => { - // Access parser hooks here - }); - } - ); - } -} -``` - -## Program-Level Hooks - -### `program` - -```typescript -SyncBailHook<[Program, Comment[]]> -``` - -Called when parsing begins with the AST root node. - -```javascript -parser.hooks.program.tap('MyPlugin', (ast, comments) => { - console.log('Parsing started'); - console.log('Number of comments:', comments.length); -}); -``` - -### `finish` - -```typescript -SyncHook<[Program, Comment[]]> -``` - -Called when parsing finishes. - -```javascript -parser.hooks.finish.tap('MyPlugin', (ast, comments) => { - console.log('Parsing complete'); -}); -``` - -## Statement Hooks - -### `statement` - -```typescript -SyncBailHook<[Statement]> -``` - -Called for every statement in the code. - -```javascript -parser.hooks.statement.tap('MyPlugin', (statement) => { - if (statement.type === 'IfStatement') { - console.log('Found if statement'); - } -}); -``` - -### `statementIf` - -```typescript -SyncBailHook<[IfStatement]> -``` - -Called for if statements. - -```javascript -parser.hooks.statementIf.tap('MyPlugin', (statement) => { - console.log('If statement condition:', statement.test); -}); -``` - -### `label` - -```typescript -HookMap> -``` - -Called for labeled statements. - -```javascript -parser.hooks.label.for('myLabel').tap('MyPlugin', (statement) => { - console.log('Found labeled statement'); -}); -``` - -## Expression Hooks - -### `expression` - -```typescript -HookMap> -``` - -Called when an expression matching the key is encountered. This is one of the most powerful hooks. - -```javascript -// Replace process.env.NODE_ENV with a constant -parser.hooks.expression - .for('process.env.NODE_ENV') - .tap('MyPlugin', (expr) => { - const dep = new ConstDependency( - JSON.stringify('production'), - expr.range - ); - dep.loc = expr.loc; - parser.state.module.addDependency(dep); - return true; // Handled - }); -``` - -**Example: DefinePlugin** (lib/DefinePlugin.js:628): - -```javascript -parser.hooks.expression.for(key).tap('DefinePlugin', (expr) => { - const strCode = toCode( - code, - parser, - compilation.valueCacheVersions, - key, - runtimeTemplate, - logger, - !parser.isAsiPosition(expr.range[0]) - ); - return toConstantDependency(parser, strCode)(expr); -}); -``` - -### `expressionAnyMember` - -```typescript -HookMap> -``` - -Called for member expressions with any property. - -```javascript -parser.hooks.expressionAnyMember - .for('process.env') - .tap('MyPlugin', (expr) => { - // Handle process.env.ANYTHING - }); -``` - -### `expressionConditionalOperator` - -```typescript -SyncBailHook<[ConditionalExpression]> -``` - -Called for ternary operators. - -```javascript -parser.hooks.expressionConditionalOperator.tap( - 'MyPlugin', - (expr) => { - console.log('Found ternary:', expr); - } -); -``` - -### `expressionLogicalOperator` - -```typescript -SyncBailHook<[LogicalExpression]> -``` - -Called for logical operators (`&&`, `||`, `??`). - -```javascript -parser.hooks.expressionLogicalOperator.tap('MyPlugin', (expr) => { - if (expr.operator === '&&') { - console.log('Found AND operator'); - } -}); -``` - -## Call Expression Hooks - -### `call` - -```typescript -HookMap> -``` - -Called when a function call is encountered. - -```javascript -parser.hooks.call.for('require').tap('MyPlugin', (expr) => { - if (expr.arguments.length === 1) { - const arg = parser.evaluateExpression(expr.arguments[0]); - if (arg.isString()) { - console.log('Requiring:', arg.string); - } - } -}); -``` - -**Example: ProvidePlugin** (lib/ProvidePlugin.js:90): - -```javascript -parser.hooks.call.for(name).tap('ProvidePlugin', (expr) => { - const dep = new ProvidedDependency( - request[0], - nameIdentifier, - request.slice(1), - expr.callee.range - ); - dep.loc = expr.callee.loc; - parser.state.module.addDependency(dep); - parser.walkExpressions(expr.arguments); - return true; -}); -``` - -### `callAnyMember` - -```typescript -HookMap> -``` - -Called for method calls on objects. - -```javascript -parser.hooks.callAnyMember - .for('console') - .tap('MyPlugin', (expr) => { - // Matches console.log(), console.error(), etc. - }); -``` - -### `new` - -```typescript -HookMap> -``` - -Called for `new` expressions. - -```javascript -parser.hooks.new.for('Worker').tap('MyPlugin', (expr) => { - console.log('Creating new Worker'); -}); -``` - -## Member Expression Hooks - -### `member` - -```typescript -HookMap> -``` - -Called for member access expressions. - -```javascript -parser.hooks.member - .for('module.exports') - .tap('MyPlugin', (expr) => { - console.log('Accessing module.exports'); - }); -``` - -### `memberChain` - -```typescript -HookMap> -``` - -Called for chained member expressions. - -```javascript -parser.hooks.memberChain - .for('process') - .tap('MyPlugin', (expr, members) => { - // members might be ['env', 'NODE_ENV'] - console.log('Process chain:', members); - }); -``` - -## Import/Export Hooks - -### `import` - -```typescript -SyncBailHook<[Statement, ImportSource]> -``` - -Called for ES6 import statements. - -```javascript -parser.hooks.import.tap('MyPlugin', (statement, source) => { - console.log('Importing from:', source); -}); -``` - -### `export` - -```typescript -SyncBailHook<[Statement]> -``` - -Called for export statements. - -```javascript -parser.hooks.export.tap('MyPlugin', (statement) => { - console.log('Export statement found'); -}); -``` - -### `exportImport` - -```typescript -SyncBailHook<[Statement, ImportSource]> -``` - -Called for `export ... from` statements. - -```javascript -parser.hooks.exportImport.tap('MyPlugin', (statement, source) => { - console.log('Re-exporting from:', source); -}); -``` - -### `exportExpression` - -```typescript -SyncBailHook<[Statement, Declaration]> -``` - -Called for export expressions. - -```javascript -parser.hooks.exportExpression.tap('MyPlugin', (statement, declaration) => { - console.log('Exporting expression'); -}); -``` - -### `exportSpecifier` - -```typescript -SyncBailHook<[Statement, string, string, number]> -``` - -Called for each export specifier. - -```javascript -parser.hooks.exportSpecifier.tap( - 'MyPlugin', - (statement, localName, exportedName, index) => { - console.log(`Exporting ${localName} as ${exportedName}`); - } -); -``` - -### `importSpecifier` - -```typescript -SyncBailHook<[Statement, ImportSource, string, string]> -``` - -Called for each import specifier. - -```javascript -parser.hooks.importSpecifier.tap( - 'MyPlugin', - (statement, source, importedName, localName) => { - console.log(`Importing ${importedName} as ${localName} from ${source}`); - } -); -``` - -## Evaluation Hooks - -### `evaluate` - -```typescript -HookMap> -``` - -Evaluate expressions at build time. - -```javascript -parser.hooks.evaluate - .for('Identifier') - .tap('MyPlugin', (expr) => { - if (expr.name === 'MY_CONSTANT') { - return new BasicEvaluatedExpression() - .setString('my value') - .setRange(expr.range); - } - }); -``` - -### `evaluateTypeof` - -```typescript -HookMap> -``` - -Evaluate typeof expressions. - -```javascript -parser.hooks.evaluateTypeof - .for('MY_VAR') - .tap('MyPlugin', (expr) => { - return new BasicEvaluatedExpression() - .setString('object') - .setRange(expr.range); - }); -``` - -### `evaluateIdentifier` - -```typescript -HookMap> -``` - -Evaluate identifiers. - -```javascript -parser.hooks.evaluateIdentifier - .for('MY_VAR') - .tap('MyPlugin', (expr) => { - return new BasicEvaluatedExpression() - .setBoolean(true) - .setRange(expr.range); - }); -``` - -### `evaluateDefinedIdentifier` - -```typescript -HookMap> -``` - -Evaluate defined identifiers. - -```javascript -parser.hooks.evaluateDefinedIdentifier - .for('MY_VAR') - .tap('MyPlugin', (expr) => { - return new BasicEvaluatedExpression() - .setBoolean(true) - .setRange(expr.range); - }); -``` - -## Type Detection Hooks - -### `typeof` - -```typescript -HookMap> -``` - -Customize typeof operator results. - -```javascript -parser.hooks.typeof - .for('MY_VAR') - .tap('MyPlugin', (expr) => { - return toConstantDependency(parser, JSON.stringify('string'))(expr); - }); -``` - -## Variable Hooks - -### `varDeclaration` - -```typescript -HookMap> -``` - -Called for variable declarations. - -```javascript -parser.hooks.varDeclaration - .for('myVar') - .tap('MyPlugin', (declaration) => { - console.log('Variable declared:', declaration); - }); -``` - -### `pattern` - -```typescript -HookMap> -``` - -Called for pattern matching in destructuring. - -```javascript -parser.hooks.pattern - .for('myVar') - .tap('MyPlugin', (identifier) => { - console.log('Pattern match:', identifier); - }); -``` - -### `canRename` - -```typescript -HookMap> -``` - -Determines if an identifier can be renamed. - -```javascript -parser.hooks.canRename - .for('MY_VAR') - .tap('MyPlugin', () => { - return true; // Allow renaming - }); -``` - -### `rename` - -```typescript -HookMap> -``` - -Rename an identifier. - -```javascript -parser.hooks.rename - .for('oldName') - .tap('MyPlugin', (expr) => { - return 'newName'; - }); -``` - -## Assign Hooks - -### `assign` - -```typescript -HookMap> -``` - -Called for assignment expressions. - -```javascript -parser.hooks.assign - .for('module.exports') - .tap('MyPlugin', (expr) => { - console.log('Assigning to module.exports'); - }); -``` - -### `assignMemberChain` - -```typescript -HookMap> -``` - -Called for chained member assignments. - -```javascript -parser.hooks.assignMemberChain - .for('module') - .tap('MyPlugin', (expr, members) => { - // members might be ['exports', 'default'] - }); -``` - -## Import Meta Hooks - -### `importMeta` - -```typescript -SyncBailHook<[MemberExpression]> -``` - -Called for `import.meta` expressions. - -```javascript -parser.hooks.importMeta.tap('MyPlugin', (expr) => { - console.log('import.meta accessed'); -}); -``` - -## Complete Example: Environment Variables Plugin - -```javascript -const ConstDependency = require('webpack/lib/dependencies/ConstDependency'); - -class EnvironmentPlugin { - constructor(env) { - this.env = env; - } - - apply(compiler) { - compiler.hooks.compilation.tap( - 'EnvironmentPlugin', - (compilation, { normalModuleFactory }) => { - const handler = (parser) => { - // Handle process.env.VAR_NAME - parser.hooks.expressionAnyMember - .for('process.env') - .tap('EnvironmentPlugin', (expr) => { - if (expr.property.type === 'Identifier') { - const name = expr.property.name; - const value = this.env[name]; - - if (value !== undefined) { - const dep = new ConstDependency( - JSON.stringify(value), - expr.range - ); - dep.loc = expr.loc; - parser.state.module.addDependency(dep); - return true; - } - } - }); - - // Handle typeof process.env.VAR_NAME - parser.hooks.typeof - .for('process.env') - .tap('EnvironmentPlugin', (expr) => { - // Return 'object' for process.env - const dep = new ConstDependency( - JSON.stringify('object'), - expr.range - ); - dep.loc = expr.loc; - parser.state.module.addDependency(dep); - return true; - }); - }; - - normalModuleFactory.hooks.parser - .for('javascript/auto') - .tap('EnvironmentPlugin', handler); - normalModuleFactory.hooks.parser - .for('javascript/dynamic') - .tap('EnvironmentPlugin', handler); - normalModuleFactory.hooks.parser - .for('javascript/esm') - .tap('EnvironmentPlugin', handler); - } - ); - } -} - -// Usage -new EnvironmentPlugin({ - NODE_ENV: 'production', - API_URL: 'https://api.example.com' -}); -``` - -## Parser State - -The parser maintains state during parsing: - -```javascript -parser.state.module // Current module being parsed -parser.state.compilation // Current compilation -parser.scope // Current scope information -``` - -## Helper Functions - -### `evaluateExpression` - -Evaluate an expression at build time: - -```javascript -const result = parser.evaluateExpression(expr); -if (result.isString()) { - console.log('String value:', result.string); -} -``` - -### `walkExpressions` - -Walk through an array of expressions: - -```javascript -parser.walkExpressions(node.arguments); -``` - -### `getNameForExpression` - -Get the name for an expression: - -```javascript -const nameInfo = parser.getNameForExpression(expr); -if (nameInfo) { - console.log('Name:', nameInfo.name); -} -``` - -## See Also - -- [Module Factories](./module-factories) - Module creation hooks -- [Compilation Hooks](./compilation-hooks) - Compilation lifecycle -- [DefinePlugin Source](https://github.com/webpack/webpack/blob/main/lib/DefinePlugin.js) - Real-world example \ No newline at end of file diff --git a/api/plugins/tapable.mdx b/api/plugins/tapable.mdx deleted file mode 100644 index 3f2abd4..0000000 --- a/api/plugins/tapable.mdx +++ /dev/null @@ -1,574 +0,0 @@ ---- -title: Tapable -description: Understanding the Tapable hook system that powers webpack plugins ---- - -Tapable is the backbone of webpack's plugin system. It provides a variety of hooks that allow plugins to tap into different stages of the compilation process. - -## What is Tapable? - -Tapable is a small library that webpack uses to create hooks. These hooks are extension points where plugins can register callbacks to execute at specific times. - -## Hook Types - -Tapable provides several hook types, each with different execution patterns: - -### Sync Hooks - -#### `SyncHook` - -The simplest hook - calls all taps sequentially. - -```javascript -const { SyncHook } = require('tapable'); - -const hook = new SyncHook(['arg1', 'arg2']); - -// Tap into the hook -hook.tap('MyPlugin', (arg1, arg2) => { - console.log('Hook called with:', arg1, arg2); -}); - -// Call the hook -hook.call('value1', 'value2'); -``` - -**Used in webpack:** - -```javascript -// lib/Compiler.js:166 -initialize: new SyncHook([]) - -// lib/Compiler.js:188 -thisCompilation: new SyncHook(['compilation', 'params']) -``` - -#### `SyncBailHook` - -Like SyncHook, but stops executing if any tap returns a non-undefined value. - -```javascript -const { SyncBailHook } = require('tapable'); - -const hook = new SyncBailHook(['value']); - -hook.tap('Plugin1', (value) => { - console.log('Plugin 1'); - if (value === 'stop') return true; // Stop here -}); - -hook.tap('Plugin2', (value) => { - console.log('Plugin 2'); // Won't run if Plugin1 returned -}); - -hook.call('stop'); // Only Plugin1 runs -``` - -**Used in webpack:** - -```javascript -// lib/Compiler.js:169 -shouldEmit: new SyncBailHook(['compilation']) - -// lib/Compiler.js:237 -entryOption: new SyncBailHook(['context', 'entry']) -``` - -#### `SyncWaterfallHook` - -Passes the return value of each tap to the next tap. - -```javascript -const { SyncWaterfallHook } = require('tapable'); - -const hook = new SyncWaterfallHook(['value']); - -hook.tap('Plugin1', (value) => { - return value + ' -> Plugin1'; -}); - -hook.tap('Plugin2', (value) => { - return value + ' -> Plugin2'; -}); - -const result = hook.call('Start'); -console.log(result); // 'Start -> Plugin1 -> Plugin2' -``` - -**Used in webpack:** - -```javascript -// lib/Compilation.js:1012 -assetPath: new SyncWaterfallHook(['path', 'options', 'assetInfo']) -``` - -#### `SyncLoopHook` - -Keeps looping through all taps while any tap returns a non-undefined value. - -```javascript -const { SyncLoopHook } = require('tapable'); - -let count = 0; -const hook = new SyncLoopHook([]); - -hook.tap('Loop', () => { - count++; - if (count < 3) { - console.log('Loop again'); - return true; // Loop - } - console.log('Done'); - // Return undefined to stop -}); - -hook.call(); // Runs 3 times -``` - -### Async Hooks - -#### `AsyncSeriesHook` - -Executes async taps in series. - -```javascript -const { AsyncSeriesHook } = require('tapable'); - -const hook = new AsyncSeriesHook(['data']); - -// Using tapAsync -hook.tapAsync('Plugin1', (data, callback) => { - setTimeout(() => { - console.log('Plugin 1 done'); - callback(); - }, 100); -}); - -// Using tapPromise -hook.tapPromise('Plugin2', async (data) => { - await new Promise(resolve => setTimeout(resolve, 100)); - console.log('Plugin 2 done'); -}); - -// Call with callback -hook.callAsync('data', (err) => { - console.log('All done'); -}); - -// Or call with promise -await hook.promise('data'); -``` - -**Used in webpack:** - -```javascript -// lib/Compiler.js:177 -beforeRun: new AsyncSeriesHook(['compiler']) - -// lib/Compiler.js:181 -emit: new AsyncSeriesHook(['compilation']) - -// lib/Compiler.js:197 -beforeCompile: new AsyncSeriesHook(['params']) -``` - -#### `AsyncSeriesBailHook` - -Like AsyncSeriesHook, but stops if a tap returns a non-undefined value. - -```javascript -const { AsyncSeriesBailHook } = require('tapable'); - -const hook = new AsyncSeriesBailHook(['input']); - -hook.tapAsync('Plugin1', (input, callback) => { - if (input === 'stop') { - callback(null, 'stopped'); // Bail with result - } else { - callback(); // Continue - } -}); - -hook.tapAsync('Plugin2', (input, callback) => { - console.log('Plugin 2'); // Won't run if Plugin1 bailed - callback(); -}); - -hook.callAsync('stop', (err, result) => { - console.log(result); // 'stopped' -}); -``` - -#### `AsyncSeriesWaterfallHook` - -Like SyncWaterfallHook but async. - -```javascript -const { AsyncSeriesWaterfallHook } = require('tapable'); - -const hook = new AsyncSeriesWaterfallHook(['value']); - -hook.tapAsync('Plugin1', (value, callback) => { - callback(null, value + ' -> Plugin1'); -}); - -hook.tapPromise('Plugin2', async (value) => { - return value + ' -> Plugin2'; -}); - -hook.callAsync('Start', (err, result) => { - console.log(result); // 'Start -> Plugin1 -> Plugin2' -}); -``` - -#### `AsyncParallelHook` - -Executes async taps in parallel. - -```javascript -const { AsyncParallelHook } = require('tapable'); - -const hook = new AsyncParallelHook(['data']); - -hook.tapAsync('Plugin1', (data, callback) => { - setTimeout(() => { - console.log('Plugin 1'); - callback(); - }, 100); -}); - -hook.tapAsync('Plugin2', (data, callback) => { - setTimeout(() => { - console.log('Plugin 2'); - callback(); - }, 50); -}); - -// Both run in parallel -hook.callAsync('data', () => { - console.log('All done'); -}); -``` - -**Used in webpack:** - -```javascript -// lib/Compiler.js:201 -make: new AsyncParallelHook(['compilation']) -``` - -#### `AsyncParallelBailHook` - -Like AsyncParallelHook, but bails when any tap returns a result. - -```javascript -const { AsyncParallelBailHook } = require('tapable'); - -const hook = new AsyncParallelBailHook(['data']); - -hook.tapAsync('Plugin1', (data, callback) => { - setTimeout(() => { - callback(null, 'result from Plugin1'); - }, 100); -}); - -hook.tapAsync('Plugin2', (data, callback) => { - setTimeout(() => { - callback(); // No result - }, 50); -}); - -hook.callAsync('data', (err, result) => { - console.log(result); // 'result from Plugin1' -}); -``` - -## Hook Maps - -HookMap allows you to create multiple hooks with different keys. - -```javascript -const { HookMap, SyncHook } = require('tapable'); - -const hookMap = new HookMap(() => new SyncHook(['arg'])); - -// Access hook for specific key -hookMap.for('javascript/auto').tap('MyPlugin', (arg) => { - console.log('JavaScript auto:', arg); -}); - -hookMap.for('css').tap('MyPlugin', (arg) => { - console.log('CSS:', arg); -}); - -// Call specific hook -hookMap.for('javascript/auto').call('data'); -``` - -**Used in webpack:** - -```javascript -// lib/NormalModuleFactory.js - parser hooks for different module types -parser: new HookMap(() => new SyncHook(['parser', 'parserOptions'])) -``` - -## Tap Methods - -### `.tap()` - Synchronous - -```javascript -hook.tap('MyPlugin', (arg) => { - // Synchronous code -}); - -// With options -hook.tap({ - name: 'MyPlugin', - stage: 100 // Control execution order -}, (arg) => { - // Code -}); -``` - -### `.tapAsync()` - Callback-based - -```javascript -hook.tapAsync('MyPlugin', (arg, callback) => { - setTimeout(() => { - callback(); // Must call callback - }, 100); -}); -``` - -### `.tapPromise()` - Promise-based - -```javascript -hook.tapPromise('MyPlugin', async (arg) => { - await someAsyncOperation(); - return result; // Can return value -}); -``` - -## Tap Options - -### `name` - -Required. Identifies your plugin. - -```javascript -hook.tap({ name: 'MyPlugin' }, () => {}); -``` - -### `stage` - -Controls execution order. Lower numbers run first. - -```javascript -hook.tap({ name: 'Plugin1', stage: 100 }, () => {}); -hook.tap({ name: 'Plugin2', stage: -100 }, () => {}); // Runs first -``` - -**Example from webpack:** - -```javascript -// lib/BannerPlugin.js:100 -compilation.hooks.processAssets.tap( - { - name: 'BannerPlugin', - stage: Compilation.PROCESS_ASSETS_STAGE_ADDITIONS - }, - () => { - // Add banner to assets - } -); -``` - -### `before` - -Run before specific plugins. - -```javascript -hook.tap({ - name: 'MyPlugin', - before: ['OtherPlugin'] -}, () => {}); -``` - -### `after` - -Run after specific plugins. - -```javascript -hook.tap({ - name: 'MyPlugin', - after: ['OtherPlugin'] -}, () => {}); -``` - -## Interceptors - -Interceptors allow you to monitor and control hook behavior. - -```javascript -hook.intercept({ - // Called when a new tap is registered - register: (tap) => { - console.log('New tap:', tap.name); - return tap; // Can modify tap - }, - - // Called before the hook is called - call: (...args) => { - console.log('Hook called with:', args); - }, - - // Called before each tap - tap: (tap) => { - console.log('Running tap:', tap.name); - }, - - // Called when loop restarts (SyncLoopHook) - loop: (...args) => { - console.log('Loop restarted'); - } -}); -``` - -## Context - -Share data between taps using context. - -```javascript -hook.intercept({ - context: true, // Enable context - tap: (context, tap) => { - // Access context - } -}); - -hook.tap({ - name: 'Plugin1', - context: true -}, (context, arg) => { - context.shared = 'data'; -}); - -hook.tap({ - name: 'Plugin2', - context: true -}, (context, arg) => { - console.log(context.shared); // 'data' -}); -``` - -## Complete Example: Custom Hook System - -```javascript -const { SyncHook, AsyncSeriesHook } = require('tapable'); - -class BuildSystem { - constructor() { - this.hooks = { - beforeBuild: new AsyncSeriesHook(['options']), - build: new SyncHook(['modules']), - afterBuild: new AsyncSeriesHook(['result']) - }; - } - - async run(options) { - // Before build - await this.hooks.beforeBuild.promise(options); - - // Build - const modules = ['module1', 'module2']; - this.hooks.build.call(modules); - - // After build - await this.hooks.afterBuild.promise({ success: true }); - } -} - -// Use the system -const builder = new BuildSystem(); - -// Register plugins -builder.hooks.beforeBuild.tapAsync('PreparePlugin', (options, callback) => { - console.log('Preparing build'); - setTimeout(callback, 100); -}); - -builder.hooks.build.tap('BuildPlugin', (modules) => { - console.log('Building modules:', modules); -}); - -builder.hooks.afterBuild.tapPromise('CleanupPlugin', async (result) => { - console.log('Cleaning up'); -}); - -// Run -builder.run({ mode: 'production' }); -``` - -## Best Practices - -### 1. Always Name Your Taps - -```javascript -// Good -hook.tap('MyPlugin', () => {}); - -// Bad -hook.tap(() => {}); // Error: name is required -``` - -### 2. Use Appropriate Hook Type - -```javascript -// For I/O operations -hook.tapAsync('MyPlugin', (data, callback) => { - fs.readFile(path, callback); -}); - -// For promises -hook.tapPromise('MyPlugin', async (data) => { - return await fetch(url); -}); -``` - -### 3. Handle Errors in Async Hooks - -```javascript -hook.tapAsync('MyPlugin', (data, callback) => { - doSomething((err, result) => { - if (err) return callback(err); // Pass error - callback(); // Success - }); -}); -``` - -### 4. Use Stage for Ordering - -```javascript -// Run first -hook.tap({ name: 'Setup', stage: -100 }, () => {}); - -// Run last -hook.tap({ name: 'Cleanup', stage: 100 }, () => {}); -``` - -### 5. Return Boolean from Bail Hooks - -```javascript -hook.tap('MyPlugin', (value) => { - if (shouldStop(value)) { - return true; // Bail - } - // Continue by returning undefined -}); -``` - -## See Also - -- [Tapable GitHub](https://github.com/webpack/tapable) - Official repository -- [Compiler Hooks](./compiler-hooks) - Hooks in the compiler -- [Compilation Hooks](./compilation-hooks) - Hooks in compilation \ No newline at end of file diff --git a/api/resolvers.mdx b/api/resolvers.mdx deleted file mode 100644 index 0049cd0..0000000 --- a/api/resolvers.mdx +++ /dev/null @@ -1,493 +0,0 @@ ---- -title: "Resolver API" -description: "webpack Resolver API - module resolution and ResolverFactory" ---- - -The Resolver API provides webpack's module resolution functionality, allowing you to resolve module paths programmatically and customize the resolution process. - -## ResolverFactory - -The ResolverFactory is responsible for creating and caching resolver instances. - -### Accessing ResolverFactory - -The ResolverFactory is available on the Compiler instance: - -```javascript -class MyPlugin { - apply(compiler) { - const resolverFactory = compiler.resolverFactory; - - // Create or get a resolver - const resolver = resolverFactory.get('normal'); - } -} -``` - -### get() - -Returns a resolver for the specified type. - -```typescript -resolverFactory.get( - type: string, - resolveOptions?: ResolveOptions -): Resolver -``` - - - Type of resolver to get. Common types: - - `'normal'` - Standard module resolution - - `'loader'` - Loader resolution - - `'context'` - Context module resolution - - - - Optional resolve configuration options. - - - - Resolver instance with `resolve()` method and other utilities. - - -**Example:** - -```javascript -const resolver = compiler.resolverFactory.get('normal', { - extensions: ['.js', '.json', '.ts'], - alias: { - '@': path.resolve(__dirname, 'src') - } -}); -``` - -## Resolver - -A Resolver instance provides methods for resolving module paths. - -### resolve() - -Resolves a module path. - -```typescript -resolver.resolve( - context: object, - path: string, - request: string, - resolveContext: object, - callback: (err: Error | null, result?: string, details?: object) => void -): void -``` - - - Context object (usually an empty object `{}`). - - - - The directory from which to resolve. - - - - The module request to resolve (e.g., 'lodash', './utils', '@/components'). - - - - Resolve context object (usually an empty object `{}`). - - - - Callback invoked when resolution completes. - - **Parameters:** - - `err` - Error if resolution failed, null otherwise - - `result` - Resolved absolute path - - `details` - Additional resolution details - - -**Example:** - -```javascript -const resolver = compiler.resolverFactory.get('normal'); - -resolver.resolve( - {}, - process.cwd(), - 'lodash', - {}, - (err, result) => { - if (err) { - console.error('Failed to resolve:', err); - return; - } - console.log('Resolved to:', result); - // Output: /path/to/project/node_modules/lodash/lodash.js - } -); -``` - -### withOptions() - -Creates a new resolver with modified options. - -```typescript -resolver.withOptions( - options: Partial -): Resolver -``` - - - Options to override or add to the existing resolver configuration. - - - - New resolver instance with merged options. - - -**Example:** - -```javascript -const baseResolver = compiler.resolverFactory.get('normal'); - -const tsResolver = baseResolver.withOptions({ - extensions: ['.ts', '.tsx', '.js', '.jsx'] -}); - -tsResolver.resolve({}, process.cwd(), './App', {}, (err, result) => { - console.log('Resolved TypeScript module:', result); -}); -``` - -## Resolve Options - -Configuration options for customizing resolver behavior. - -### Common Options - -```javascript -const resolveOptions = { - // File extensions to try - extensions: ['.js', '.json', '.jsx', '.ts', '.tsx'], - - // Main fields to try when resolving packages - mainFields: ['browser', 'module', 'main'], - - // Main files to try when resolving directories - mainFiles: ['index'], - - // Module directories to search - modules: ['node_modules'], - - // Alias configuration - alias: { - '@': path.resolve(__dirname, 'src'), - 'components': path.resolve(__dirname, 'src/components'), - 'utils$': path.resolve(__dirname, 'src/utils/index.js') - }, - - // Fallback options when resolution fails - fallback: { - 'crypto': require.resolve('crypto-browserify'), - 'stream': require.resolve('stream-browserify') - }, - - // Symlink options - symlinks: true, - - // Cache resolution results - unsafeCache: true, - - // Resolve to context - resolveToContext: false, - - // Enforce certain file extensions - enforceExtension: false, - - // Description files (package.json) - descriptionFiles: ['package.json'], - - // Custom conditions - conditionNames: ['webpack', 'production', 'development'] -}; - -const resolver = compiler.resolverFactory.get('normal', resolveOptions); -``` - -## Hooking into Resolution - -The ResolverFactory provides hooks to customize the resolution process. - -### resolveOptions Hook - -Called before a resolver is created, allowing you to modify resolve options. - -```javascript -compiler.resolverFactory.hooks.resolveOptions - .for('normal') - .tap('MyPlugin', (resolveOptions) => { - // Modify resolve options - return { - ...resolveOptions, - extensions: [...resolveOptions.extensions, '.custom'] - }; - }); -``` - -### resolver Hook - -Called after a resolver is created, allowing you to add plugins to it. - -```javascript -compiler.resolverFactory.hooks.resolver - .for('normal') - .tap('MyPlugin', (resolver, resolveOptions, userResolveOptions) => { - // Add custom plugin to resolver - resolver.hooks.result.tap('MyPlugin', (result) => { - console.log('Resolved:', result); - return result; - }); - }); -``` - -## Practical Examples - -### Custom Module Resolution Plugin - -```javascript -class CustomResolverPlugin { - apply(compiler) { - compiler.hooks.compilation.tap( - 'CustomResolverPlugin', - (compilation, { normalModuleFactory }) => { - normalModuleFactory.hooks.beforeResolve.tapAsync( - 'CustomResolverPlugin', - (resolveData, callback) => { - const resolver = compiler.resolverFactory.get('normal'); - - // Custom resolution logic - if (resolveData.request.startsWith('custom:')) { - const customPath = resolveData.request.replace('custom:', './custom/'); - - resolver.resolve( - {}, - resolveData.context, - customPath, - {}, - (err, result) => { - if (err) return callback(err); - - resolveData.request = result; - callback(); - } - ); - } else { - callback(); - } - } - ); - } - ); - } -} - -module.exports = CustomResolverPlugin; -``` - -### Aliasing Plugin - -```javascript -class AliasPlugin { - constructor(aliases) { - this.aliases = aliases; - } - - apply(compiler) { - compiler.resolverFactory.hooks.resolveOptions - .for('normal') - .tap('AliasPlugin', (resolveOptions) => { - return { - ...resolveOptions, - alias: { - ...resolveOptions.alias, - ...this.aliases - } - }; - }); - } -} - -module.exports = AliasPlugin; -``` - -**Usage:** - -```javascript -const AliasPlugin = require('./AliasPlugin'); - -module.exports = { - // ... - plugins: [ - new AliasPlugin({ - '@components': path.resolve(__dirname, 'src/components'), - '@utils': path.resolve(__dirname, 'src/utils'), - '@api': path.resolve(__dirname, 'src/api') - }) - ] -}; -``` - -### Resolution Logger Plugin - -```javascript -class ResolutionLoggerPlugin { - apply(compiler) { - compiler.resolverFactory.hooks.resolver - .for('normal') - .tap('ResolutionLoggerPlugin', (resolver) => { - resolver.hooks.result.tap('ResolutionLoggerPlugin', (result) => { - console.log('Resolved:', { - path: result.path, - request: result.request, - context: result.context - }); - }); - }); - } -} - -module.exports = ResolutionLoggerPlugin; -``` - -### Conditional Resolution Plugin - -```javascript -class ConditionalResolvePlugin { - apply(compiler) { - const isDevelopment = compiler.options.mode === 'development'; - - compiler.resolverFactory.hooks.resolveOptions - .for('normal') - .tap('ConditionalResolvePlugin', (resolveOptions) => { - return { - ...resolveOptions, - alias: { - ...resolveOptions.alias, - // Use mock API in development - './api': isDevelopment - ? './api.mock.js' - : './api.prod.js' - } - }; - }); - } -} - -module.exports = ConditionalResolvePlugin; -``` - -## Using Resolver Programmatically - -```javascript -const webpack = require('webpack'); -const path = require('path'); - -// Create a simple compiler to get resolver -const compiler = webpack({ - mode: 'development', - entry: './src/index.js' -}); - -// Get resolver -const resolver = compiler.resolverFactory.get('normal'); - -// Resolve multiple modules -const modulesToResolve = [ - 'react', - 'lodash', - './utils/helpers', - '@/components/App' -]; - -modulesToResolve.forEach(request => { - resolver.resolve( - {}, - process.cwd(), - request, - {}, - (err, result) => { - if (err) { - console.error(`Failed to resolve ${request}:`, err.message); - } else { - console.log(`${request} → ${result}`); - } - } - ); -}); -``` - -## Advanced: Custom Resolver Plugin - -Create a completely custom resolver for special file types: - -```javascript -class VirtualModuleResolverPlugin { - constructor(virtualModules) { - this.virtualModules = virtualModules; - } - - apply(compiler) { - compiler.hooks.compilation.tap( - 'VirtualModuleResolverPlugin', - (compilation, { normalModuleFactory }) => { - normalModuleFactory.hooks.beforeResolve.tap( - 'VirtualModuleResolverPlugin', - (resolveData) => { - const request = resolveData.request; - - if (this.virtualModules[request]) { - // Provide virtual module content - resolveData.request = `virtual-module://${request}`; - } - - return resolveData; - } - ); - - normalModuleFactory.hooks.afterResolve.tap( - 'VirtualModuleResolverPlugin', - (resolveData) => { - if (resolveData.request.startsWith('virtual-module://')) { - const moduleName = resolveData.request.replace('virtual-module://', ''); - resolveData.createData.resource = resolveData.request; - resolveData.createData.loaders = []; - } - - return resolveData; - } - ); - } - ); - } -} - -module.exports = VirtualModuleResolverPlugin; -``` - -**Usage:** - -```javascript -module.exports = { - // ... - plugins: [ - new VirtualModuleResolverPlugin({ - 'config': `module.exports = { apiUrl: 'https://api.example.com' };`, - 'version': `module.exports = '1.0.0';` - }) - ] -}; -``` - -## See Also - -- [Compiler API](/api/compiler) - Compiler instance methods -- [Resolve Configuration](https://webpack.js.org/configuration/resolve/) - Configuration options -- [Module Resolution](https://webpack.js.org/concepts/module-resolution/) - How webpack resolves modules \ No newline at end of file diff --git a/api/stats.mdx b/api/stats.mdx deleted file mode 100644 index f1ae5c7..0000000 --- a/api/stats.mdx +++ /dev/null @@ -1,498 +0,0 @@ ---- -title: "Stats Object" -description: "webpack Stats object API - compilation statistics and output information" ---- - -The Stats object provides detailed information about the compilation process, including modules, chunks, assets, errors, and warnings. - -## Obtaining Stats - -The Stats object is passed to the callback function after compilation: - -```javascript -const webpack = require('webpack'); - -webpack(config, (err, stats) => { - if (err) { - console.error(err); - return; - } - - // Use stats object here - console.log(stats.toString({ - colors: true - })); -}); -``` - -Or via compiler hooks: - -```javascript -compiler.hooks.done.tap('MyPlugin', (stats) => { - console.log('Compilation hash:', stats.hash); -}); -``` - -## Properties - -### compilation - -Reference to the Compilation instance. - -```javascript -compiler.hooks.done.tap('MyPlugin', (stats) => { - const compilation = stats.compilation; - console.log('Modules:', compilation.modules.size); - console.log('Chunks:', compilation.chunks.size); -}); -``` - -### hash - -The compilation hash. - -```javascript -console.log('Build hash:', stats.hash); -``` - -### startTime - -Timestamp when compilation started. - -```javascript -console.log('Started at:', new Date(stats.startTime)); -``` - -### endTime - -Timestamp when compilation ended. - -```javascript -const duration = stats.endTime - stats.startTime; -console.log('Build duration:', duration, 'ms'); -``` - -## Methods - -### hasErrors() - -Returns true if the compilation had errors. - -```typescript -stats.hasErrors(): boolean -``` - - - True if there were compilation errors, false otherwise. - - -**Example:** - -```javascript -webpack(config, (err, stats) => { - if (err) { - console.error(err); - return; - } - - if (stats.hasErrors()) { - console.error('Build failed with errors'); - const info = stats.toJson(); - console.error(info.errors); - process.exit(1); - } -}); -``` - -### hasWarnings() - -Returns true if the compilation had warnings. - -```typescript -stats.hasWarnings(): boolean -``` - - - True if there were compilation warnings, false otherwise. - - -**Example:** - -```javascript -if (stats.hasWarnings()) { - console.warn('Build completed with warnings'); - const info = stats.toJson(); - console.warn(info.warnings); -} -``` - -### toJson() - -Returns compilation information as a JSON object. - -```typescript -stats.toJson(options?: StatsOptions): StatsCompilation -``` - - - Options to control what information is included. Can be a string preset or an options object. - - **Common presets:** - - `'normal'` - Standard output (default) - - `'minimal'` - Only errors and warnings - - `'errors-only'` - Only errors - - `'errors-warnings'` - Only errors and warnings - - `'verbose'` - All information - - `'none'` - No information - - - - Object containing compilation statistics with properties like: - - `hash` (string) - Compilation hash - - `version` (string) - webpack version - - `time` (number) - Compilation time in ms - - `builtAt` (number) - Build timestamp - - `publicPath` (string) - Output public path - - `outputPath` (string) - Output file system path - - `assets` (Asset[]) - Array of asset objects - - `modules` (Module[]) - Array of module objects - - `chunks` (Chunk[]) - Array of chunk objects - - `entrypoints` (Object) - Entry point information - - `errors` (Error[]) - Array of errors - - `warnings` (Warning[]) - Array of warnings - - -**Example:** - -```javascript -const statsJson = stats.toJson({ - all: false, - assets: true, - errors: true, - warnings: true, - timings: true -}); - -console.log('Assets:', statsJson.assets.map(a => a.name)); -console.log('Time:', statsJson.time, 'ms'); - -if (statsJson.errors.length > 0) { - console.error('Errors:', statsJson.errors); -} -``` - -### toString() - -Returns compilation information as a formatted string. - -```typescript -stats.toString(options?: StatsOptions): string -``` - - - Options to control output format. Can be a string preset or an options object. - - - - Formatted string representation of the stats. - - -**Example:** - -```javascript -const output = stats.toString({ - colors: true, - modules: false, - children: false, - chunks: false, - chunkModules: false -}); - -console.log(output); -``` - -## Stats Options - -Detailed configuration for controlling stats output. - -### Common Options - -```javascript -const statsOptions = { - // Basic options - all: false, // Fallback value for stats options (default: undefined) - colors: true, // Enable colored output - - // Assets - assets: true, // Show assets information - assetsSort: 'size', // Sort assets by: 'id', 'name', 'size', 'chunks' - - // Modules - modules: true, // Show modules information - modulesSort: 'size', // Sort modules - maxModules: 15, // Maximum number of modules to show - - // Chunks - chunks: true, // Show chunks information - chunkModules: false, // Show modules contained in chunks - chunkOrigins: false, // Show chunk origins - - // Depth - depth: false, // Show module depth in dependency graph - - // Entry points - entrypoints: true, // Show entry point information - - // Errors and warnings - errors: true, // Show errors - errorDetails: true, // Show details for errors - warnings: true, // Show warnings - - // Timing - timings: true, // Show timing information - builtAt: true, // Show build timestamp - - // Other - hash: true, // Show compilation hash - version: true, // Show webpack version - publicPath: true, // Show public path - performance: true, // Show performance hints - reasons: false, // Show reasons why modules are included - source: false, // Show source code of modules - children: false // Show stats for child compilations -}; - -const output = stats.toString(statsOptions); -``` - -### Preset Configurations - -```javascript -// Minimal output - only errors and warnings -stats.toString('minimal'); - -// Errors only -stats.toString('errors-only'); - -// Errors and warnings -stats.toString('errors-warnings'); - -// Normal output (default) -stats.toString('normal'); - -// Verbose output - everything -stats.toString('verbose'); - -// No output -stats.toString('none'); -``` - -## Working with Stats Data - -### Analyzing Assets - -```javascript -webpack(config, (err, stats) => { - if (err) return console.error(err); - - const json = stats.toJson(); - - console.log('Total assets:', json.assets.length); - - // Find large assets - const largeAssets = json.assets.filter(asset => asset.size > 100000); - console.log('Large assets (>100KB):', largeAssets); - - // Group by type - const assetsByType = {}; - json.assets.forEach(asset => { - const ext = asset.name.split('.').pop(); - assetsByType[ext] = assetsByType[ext] || []; - assetsByType[ext].push(asset); - }); - - console.log('Assets by type:', Object.keys(assetsByType)); -}); -``` - -### Analyzing Modules - -```javascript -webpack(config, (err, stats) => { - if (err) return console.error(err); - - const json = stats.toJson({ modules: true }); - - console.log('Total modules:', json.modules.length); - - // Find modules from node_modules - const nodeModules = json.modules.filter(module => - module.identifier.includes('node_modules') - ); - console.log('Modules from node_modules:', nodeModules.length); - - // Calculate total size - const totalSize = json.modules.reduce((sum, mod) => sum + mod.size, 0); - console.log('Total modules size:', totalSize, 'bytes'); -}); -``` - -### Analyzing Chunks - -```javascript -webpack(config, (err, stats) => { - if (err) return console.error(err); - - const json = stats.toJson({ chunks: true }); - - console.log('Total chunks:', json.chunks.length); - - json.chunks.forEach(chunk => { - console.log(`Chunk ${chunk.id}:`); - console.log(' Names:', chunk.names); - console.log(' Size:', chunk.size); - console.log(' Files:', chunk.files); - console.log(' Entry:', chunk.entry); - console.log(' Initial:', chunk.initial); - }); -}); -``` - -### Error Handling - -```javascript -webpack(config, (err, stats) => { - // Fatal webpack errors (wrong configuration, etc) - if (err) { - console.error('Fatal error:', err.message); - if (err.details) { - console.error('Details:', err.details); - } - return; - } - - const json = stats.toJson(); - - // Compilation errors (missing modules, syntax errors, etc) - if (stats.hasErrors()) { - console.error('Compilation errors:'); - json.errors.forEach(error => { - console.error(error.message); - if (error.moduleName) { - console.error(' in module:', error.moduleName); - } - if (error.loc) { - console.error(' at location:', error.loc); - } - }); - } - - // Compilation warnings - if (stats.hasWarnings()) { - console.warn('Compilation warnings:'); - json.warnings.forEach(warning => { - console.warn(warning.message); - }); - } -}); -``` - -## Complete Example: Build Reporter - -```javascript -const webpack = require('webpack'); -const config = require('./webpack.config.js'); - -webpack(config, (err, stats) => { - if (err) { - console.error('\n❌ Fatal error:'); - console.error(err.message); - process.exit(1); - } - - const json = stats.toJson({ - all: false, - assets: true, - modules: true, - chunks: true, - errors: true, - warnings: true, - timings: true - }); - - // Build info - console.log('\n📦 Build Information:'); - console.log(' Hash:', json.hash); - console.log(' Time:', json.time, 'ms'); - console.log(' Built:', new Date(json.builtAt).toLocaleString()); - - // Assets summary - console.log('\n📄 Assets:'); - json.assets.forEach(asset => { - const sizeKB = (asset.size / 1024).toFixed(2); - console.log(` ${asset.name}: ${sizeKB} KB`); - }); - - // Chunks summary - console.log('\n📦 Chunks:', json.chunks.length); - json.chunks.forEach(chunk => { - const sizeKB = (chunk.size / 1024).toFixed(2); - console.log(` ${chunk.names.join(', ') || chunk.id}: ${sizeKB} KB`); - }); - - // Modules summary - console.log('\n📋 Modules:', json.modules.length); - const totalSize = json.modules.reduce((sum, mod) => sum + mod.size, 0); - console.log(' Total size:', (totalSize / 1024).toFixed(2), 'KB'); - - // Errors - if (stats.hasErrors()) { - console.log('\n❌ Errors:', json.errors.length); - json.errors.forEach((error, i) => { - console.log(`\n Error ${i + 1}:`); - console.log(' ', error.message); - }); - process.exit(1); - } - - // Warnings - if (stats.hasWarnings()) { - console.log('\n⚠️ Warnings:', json.warnings.length); - json.warnings.forEach((warning, i) => { - console.log(`\n Warning ${i + 1}:`); - console.log(' ', warning.message); - }); - } - - console.log('\n✅ Build completed successfully!\n'); -}); -``` - -## TypeScript Types - -```typescript -import { Stats, StatsCompilation } from 'webpack'; - -const handleStats = (stats: Stats): void => { - const json: StatsCompilation = stats.toJson({ - all: false, - assets: true, - errors: true, - warnings: true - }); - - if (stats.hasErrors()) { - console.error('Build failed'); - return; - } - - console.log('Hash:', json.hash); - console.log('Time:', json.time); -}; -``` - -## See Also - -- [Compiler API](/api/compiler) - Compiler instance methods -- [Compilation API](/api/compilation) - Compilation instance API -- [Stats Configuration](https://webpack.js.org/configuration/stats/) - Full stats options reference \ No newline at end of file diff --git a/api/type-aliases/AssetInfo.md b/api/type-aliases/AssetInfo.md new file mode 100644 index 0000000..35bb407 --- /dev/null +++ b/api/type-aliases/AssetInfo.md @@ -0,0 +1,17 @@ +--- +title: AssetInfo +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / AssetInfo + +# Type Alias: AssetInfo + +> **AssetInfo**\<\> = `KnownAssetInfo` & `Record`\<`string`, `EXPECTED_ANY`\> + +Defined in: [lib/Compilation.js:314](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/Compilation.js#L314) + +## Type Parameters diff --git a/api/type-aliases/ChunkGroup.md b/api/type-aliases/ChunkGroup.md new file mode 100644 index 0000000..8ea050f --- /dev/null +++ b/api/type-aliases/ChunkGroup.md @@ -0,0 +1,17 @@ +--- +title: ChunkGroup +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / ChunkGroup + +# Type Alias: ChunkGroup + +> **ChunkGroup**\<\> = `__module` + +Defined in: [lib/index.js:38](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L38) + +## Type Parameters diff --git a/api/type-aliases/CodeGenerationResults.md b/api/type-aliases/CodeGenerationResults.md new file mode 100644 index 0000000..ed1271e --- /dev/null +++ b/api/type-aliases/CodeGenerationResults.md @@ -0,0 +1,17 @@ +--- +title: CodeGenerationResults +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / CodeGenerationResults + +# Type Alias: CodeGenerationResults + +> **CodeGenerationResults**\<\> = `__module` + +Defined in: [lib/index.js:44](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L44) + +## Type Parameters diff --git a/api/type-aliases/Colors.md b/api/type-aliases/Colors.md new file mode 100644 index 0000000..cbbdaeb --- /dev/null +++ b/api/type-aliases/Colors.md @@ -0,0 +1,183 @@ +--- +title: Colors +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / Colors + +# Type Alias: Colors + +> **Colors**\<\> = `object` + +Defined in: [lib/cli.js:800](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/cli.js#L800) + +## Type Parameters + +## Type Declaration + +### bgBlack + +> **bgBlack**: `PrintFunction` + +### bgBlackBright + +> **bgBlackBright**: `PrintFunction` + +### bgBlue + +> **bgBlue**: `PrintFunction` + +### bgBlueBright + +> **bgBlueBright**: `PrintFunction` + +### bgCyan + +> **bgCyan**: `PrintFunction` + +### bgCyanBright + +> **bgCyanBright**: `PrintFunction` + +### bgGreen + +> **bgGreen**: `PrintFunction` + +### bgGreenBright + +> **bgGreenBright**: `PrintFunction` + +### bgMagenta + +> **bgMagenta**: `PrintFunction` + +### bgMagentaBright + +> **bgMagentaBright**: `PrintFunction` + +### bgRed + +> **bgRed**: `PrintFunction` + +### bgRedBright + +> **bgRedBright**: `PrintFunction` + +### bgWhite + +> **bgWhite**: `PrintFunction` + +### bgWhiteBright + +> **bgWhiteBright**: `PrintFunction` + +### bgYellow + +> **bgYellow**: `PrintFunction` + +### bgYellowBright + +> **bgYellowBright**: `PrintFunction` + +### black + +> **black**: `PrintFunction` + +### blackBright + +> **blackBright**: `PrintFunction` + +### blue + +> **blue**: `PrintFunction` + +### blueBright + +> **blueBright**: `PrintFunction` + +### bold + +> **bold**: `PrintFunction` + +### cyan + +> **cyan**: `PrintFunction` + +### cyanBright + +> **cyanBright**: `PrintFunction` + +### dim + +> **dim**: `PrintFunction` + +### gray + +> **gray**: `PrintFunction` + +### green + +> **green**: `PrintFunction` + +### greenBright + +> **greenBright**: `PrintFunction` + +### hidden + +> **hidden**: `PrintFunction` + +### inverse + +> **inverse**: `PrintFunction` + +### italic + +> **italic**: `PrintFunction` + +### magenta + +> **magenta**: `PrintFunction` + +### magentaBright + +> **magentaBright**: `PrintFunction` + +### red + +> **red**: `PrintFunction` + +### redBright + +> **redBright**: `PrintFunction` + +### reset + +> **reset**: `PrintFunction` + +### strikethrough + +> **strikethrough**: `PrintFunction` + +### underline + +> **underline**: `PrintFunction` + +### white + +> **white**: `PrintFunction` + +### whiteBright + +> **whiteBright**: `PrintFunction` + +### yellow + +> **yellow**: `PrintFunction` + +### yellowBright + +> **yellowBright**: `PrintFunction` diff --git a/api/type-aliases/Entry.md b/api/type-aliases/Entry.md new file mode 100644 index 0000000..70bab2d --- /dev/null +++ b/api/type-aliases/Entry.md @@ -0,0 +1,17 @@ +--- +title: Entry +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / Entry + +# Type Alias: Entry + +> **Entry** = `EntryDynamic` \| `EntryStatic` + +Defined in: [declarations/WebpackOptions.d.ts:72](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L72) + +The entry point(s) of the compilation. diff --git a/api/type-aliases/EntryNormalized.md b/api/type-aliases/EntryNormalized.md new file mode 100644 index 0000000..589a519 --- /dev/null +++ b/api/type-aliases/EntryNormalized.md @@ -0,0 +1,17 @@ +--- +title: EntryNormalized +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / EntryNormalized + +# Type Alias: EntryNormalized + +> **EntryNormalized** = `EntryDynamicNormalized` \| `EntryStaticNormalized` + +Defined in: [declarations/WebpackOptions.d.ts:841](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L841) + +The entry point(s) of the compilation. diff --git a/api/type-aliases/EntryOptions.md b/api/type-aliases/EntryOptions.md new file mode 100644 index 0000000..b90e973 --- /dev/null +++ b/api/type-aliases/EntryOptions.md @@ -0,0 +1,23 @@ +--- +title: EntryOptions +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / EntryOptions + +# Type Alias: EntryOptions + +> **EntryOptions**\<\> = `object` & `Omit`\<`EntryDescription`, `"import"`\> + +Defined in: [lib/Entrypoint.js:14](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/Entrypoint.js#L14) + +## Type Declaration + +### name? + +> `optional` **name**: `string` + +## Type Parameters diff --git a/api/type-aliases/Entrypoint.md b/api/type-aliases/Entrypoint.md new file mode 100644 index 0000000..b206c4b --- /dev/null +++ b/api/type-aliases/Entrypoint.md @@ -0,0 +1,17 @@ +--- +title: Entrypoint +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / Entrypoint + +# Type Alias: Entrypoint + +> **Entrypoint**\<\> = `__module` + +Defined in: [lib/index.js:45](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L45) + +## Type Parameters diff --git a/api/type-aliases/ExternalItem.md b/api/type-aliases/ExternalItem.md new file mode 100644 index 0000000..c2ec189 --- /dev/null +++ b/api/type-aliases/ExternalItem.md @@ -0,0 +1,17 @@ +--- +title: ExternalItem +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / ExternalItem + +# Type Alias: ExternalItem + +> **ExternalItem** = `RegExp` \| `string` \| [`ExternalItemObjectKnown`](../interfaces/ExternalItemObjectKnown.md) & [`ExternalItemObjectUnknown`](../interfaces/ExternalItemObjectUnknown.md) \| [`ExternalItemFunction`](ExternalItemFunction.md) + +Defined in: [declarations/WebpackOptions.d.ts:199](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L199) + +Specify dependency that shouldn't be resolved by webpack, but should become dependencies of the resulting bundle. The kind of the dependency depends on `output.libraryTarget`. diff --git a/api/type-aliases/ExternalItemFunction.md b/api/type-aliases/ExternalItemFunction.md new file mode 100644 index 0000000..bee054f --- /dev/null +++ b/api/type-aliases/ExternalItemFunction.md @@ -0,0 +1,17 @@ +--- +title: ExternalItemFunction +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / ExternalItemFunction + +# Type Alias: ExternalItemFunction + +> **ExternalItemFunction** = `ExternalItemFunctionCallback` \| `ExternalItemFunctionPromise` + +Defined in: [declarations/WebpackOptions.d.ts:207](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L207) + +The function is called on each dependency. diff --git a/api/type-aliases/ExternalItemFunctionCallback.md b/api/type-aliases/ExternalItemFunctionCallback.md new file mode 100644 index 0000000..3146689 --- /dev/null +++ b/api/type-aliases/ExternalItemFunctionCallback.md @@ -0,0 +1,31 @@ +--- +title: ExternalItemFunctionCallback +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / ExternalItemFunctionCallback + +# Type Alias: ExternalItemFunctionCallback() + +> **ExternalItemFunctionCallback**\<\> = (`data`, `callback`) => `void` + +Defined in: [lib/ExternalModuleFactoryPlugin.js:44](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/ExternalModuleFactoryPlugin.js#L44) + +## Type Parameters + +## Parameters + +### data + +[`ExternalItemFunctionData`](../interfaces/ExternalItemFunctionData.md) + +### callback + +(`err?`, `result?`) => `void` + +## Returns + +`void` diff --git a/api/type-aliases/ExternalItemFunctionDataGetResolve.md b/api/type-aliases/ExternalItemFunctionDataGetResolve.md new file mode 100644 index 0000000..b17e6f4 --- /dev/null +++ b/api/type-aliases/ExternalItemFunctionDataGetResolve.md @@ -0,0 +1,27 @@ +--- +title: ExternalItemFunctionDataGetResolve +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / ExternalItemFunctionDataGetResolve + +# Type Alias: ExternalItemFunctionDataGetResolve() + +> **ExternalItemFunctionDataGetResolve**\<\> = (`options?`) => [`ExternalItemFunctionDataGetResolveCallbackResult`](ExternalItemFunctionDataGetResolveCallbackResult.md) \| [`ExternalItemFunctionDataGetResolveResult`](ExternalItemFunctionDataGetResolveResult.md) + +Defined in: [lib/ExternalModuleFactoryPlugin.js:33](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/ExternalModuleFactoryPlugin.js#L33) + +## Type Parameters + +## Parameters + +### options? + +`ResolveOptions` + +## Returns + +[`ExternalItemFunctionDataGetResolveCallbackResult`](ExternalItemFunctionDataGetResolveCallbackResult.md) \| [`ExternalItemFunctionDataGetResolveResult`](ExternalItemFunctionDataGetResolveResult.md) diff --git a/api/type-aliases/ExternalItemFunctionDataGetResolveCallbackResult.md b/api/type-aliases/ExternalItemFunctionDataGetResolveCallbackResult.md new file mode 100644 index 0000000..33b1aec --- /dev/null +++ b/api/type-aliases/ExternalItemFunctionDataGetResolveCallbackResult.md @@ -0,0 +1,35 @@ +--- +title: ExternalItemFunctionDataGetResolveCallbackResult +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / ExternalItemFunctionDataGetResolveCallbackResult + +# Type Alias: ExternalItemFunctionDataGetResolveCallbackResult() + +> **ExternalItemFunctionDataGetResolveCallbackResult**\<\> = (`context`, `request`, `callback`) => `void` + +Defined in: [lib/ExternalModuleFactoryPlugin.js:31](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/ExternalModuleFactoryPlugin.js#L31) + +## Type Parameters + +## Parameters + +### context + +`string` + +### request + +`string` + +### callback + +(`err?`, `result?`, `resolveRequest?`) => `void` + +## Returns + +`void` diff --git a/api/type-aliases/ExternalItemFunctionDataGetResolveResult.md b/api/type-aliases/ExternalItemFunctionDataGetResolveResult.md new file mode 100644 index 0000000..f634a57 --- /dev/null +++ b/api/type-aliases/ExternalItemFunctionDataGetResolveResult.md @@ -0,0 +1,31 @@ +--- +title: ExternalItemFunctionDataGetResolveResult +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / ExternalItemFunctionDataGetResolveResult + +# Type Alias: ExternalItemFunctionDataGetResolveResult() + +> **ExternalItemFunctionDataGetResolveResult**\<\> = (`context`, `request`) => `Promise`\<`string`\> + +Defined in: [lib/ExternalModuleFactoryPlugin.js:32](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/ExternalModuleFactoryPlugin.js#L32) + +## Type Parameters + +## Parameters + +### context + +`string` + +### request + +`string` + +## Returns + +`Promise`\<`string`\> diff --git a/api/type-aliases/ExternalItemFunctionPromise.md b/api/type-aliases/ExternalItemFunctionPromise.md new file mode 100644 index 0000000..a352e8c --- /dev/null +++ b/api/type-aliases/ExternalItemFunctionPromise.md @@ -0,0 +1,27 @@ +--- +title: ExternalItemFunctionPromise +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / ExternalItemFunctionPromise + +# Type Alias: ExternalItemFunctionPromise() + +> **ExternalItemFunctionPromise**\<\> = (`data`) => `Promise`\<`ExternalItemValue`\> + +Defined in: [lib/ExternalModuleFactoryPlugin.js:45](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/ExternalModuleFactoryPlugin.js#L45) + +## Type Parameters + +## Parameters + +### data + +[`ExternalItemFunctionData`](../interfaces/ExternalItemFunctionData.md) + +## Returns + +`Promise`\<`ExternalItemValue`\> diff --git a/api/type-aliases/ExternalItemValue.md b/api/type-aliases/ExternalItemValue.md new file mode 100644 index 0000000..0944fd6 --- /dev/null +++ b/api/type-aliases/ExternalItemValue.md @@ -0,0 +1,17 @@ +--- +title: ExternalItemValue +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / ExternalItemValue + +# Type Alias: ExternalItemValue + +> **ExternalItemValue** = `string`[] \| `boolean` \| `string` \| \{\[`k`: `string`\]: `any`; \} + +Defined in: [declarations/WebpackOptions.d.ts:850](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L850) + +The dependency used for the external. diff --git a/api/type-aliases/Externals.md b/api/type-aliases/Externals.md new file mode 100644 index 0000000..eb5f450 --- /dev/null +++ b/api/type-aliases/Externals.md @@ -0,0 +1,17 @@ +--- +title: Externals +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / Externals + +# Type Alias: Externals + +> **Externals** = [`ExternalItem`](ExternalItem.md)[] \| [`ExternalItem`](ExternalItem.md) + +Defined in: [declarations/WebpackOptions.d.ts:195](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L195) + +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`. diff --git a/api/type-aliases/MultiConfiguration.md b/api/type-aliases/MultiConfiguration.md new file mode 100644 index 0000000..92ca6c4 --- /dev/null +++ b/api/type-aliases/MultiConfiguration.md @@ -0,0 +1,17 @@ +--- +title: MultiConfiguration +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / MultiConfiguration + +# Type Alias: MultiConfiguration + +> **MultiConfiguration**\<\> = `ReadonlyArray`\<`WebpackOptions`\> & [`MultiCompilerOptions`](../interfaces/MultiCompilerOptions.md) + +Defined in: [lib/MultiCompiler.js:54](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/MultiCompiler.js#L54) + +## Type Parameters diff --git a/api/type-aliases/MultiStats.md b/api/type-aliases/MultiStats.md new file mode 100644 index 0000000..2bfee58 --- /dev/null +++ b/api/type-aliases/MultiStats.md @@ -0,0 +1,17 @@ +--- +title: MultiStats +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / MultiStats + +# Type Alias: MultiStats + +> **MultiStats**\<\> = `__module` + +Defined in: [lib/index.js:54](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L54) + +## Type Parameters diff --git a/api/type-aliases/MultiStatsOptions.md b/api/type-aliases/MultiStatsOptions.md new file mode 100644 index 0000000..548d4e3 --- /dev/null +++ b/api/type-aliases/MultiStatsOptions.md @@ -0,0 +1,17 @@ +--- +title: MultiStatsOptions +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / MultiStatsOptions + +# Type Alias: MultiStatsOptions + +> **MultiStatsOptions**\<\> = `StatsOptions` + +Defined in: [lib/MultiStats.js:29](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/MultiStats.js#L29) + +## Type Parameters diff --git a/api/type-aliases/ParserState.md b/api/type-aliases/ParserState.md new file mode 100644 index 0000000..d915b01 --- /dev/null +++ b/api/type-aliases/ParserState.md @@ -0,0 +1,17 @@ +--- +title: ParserState +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / ParserState + +# Type Alias: ParserState + +> **ParserState**\<\> = `ParserStateBase` & `Record`\<`string`, `EXPECTED_ANY`\> + +Defined in: [lib/Parser.js:23](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/Parser.js#L23) + +## Type Parameters diff --git a/api/type-aliases/RenderManifestEntry.md b/api/type-aliases/RenderManifestEntry.md new file mode 100644 index 0000000..8c18314 --- /dev/null +++ b/api/type-aliases/RenderManifestEntry.md @@ -0,0 +1,17 @@ +--- +title: RenderManifestEntry +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / RenderManifestEntry + +# Type Alias: RenderManifestEntry + +> **RenderManifestEntry**\<\> = `RenderManifestEntryTemplated` \| `RenderManifestEntryStatic` + +Defined in: [lib/Template.js:59](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/Template.js#L59) + +## Type Parameters diff --git a/api/type-aliases/ResolvePluginInstance.md b/api/type-aliases/ResolvePluginInstance.md new file mode 100644 index 0000000..08a3330 --- /dev/null +++ b/api/type-aliases/ResolvePluginInstance.md @@ -0,0 +1,57 @@ +--- +title: ResolvePluginInstance +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / ResolvePluginInstance + +# Type Alias: ResolvePluginInstance + +> **ResolvePluginInstance** = \{\[`k`: `string`\]: `any`; `apply`: (`arg0`) => `void`; \} \| (`this`, `arg1`) => `void` + +Defined in: [declarations/WebpackOptions.d.ts:364](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L364) + +Plugin instance. + +## Type Declaration + +\{\[`k`: `string`\]: `any`; `apply`: (`arg0`) => `void`; \} + +## Index Signature + +\[`k`: `string`\]: `any` + +### apply() + +> **apply**: (`arg0`) => `void` + +The run point of the plugin, required method. + +#### Parameters + +##### arg0 + +`Resolver` + +#### Returns + +`void` + +(`this`, `arg1`) => `void` + +## Parameters + +### this + +`Resolver` + +### arg1 + +`Resolver` + +## Returns + +`void` diff --git a/api/type-aliases/Resolver.md b/api/type-aliases/Resolver.md new file mode 100644 index 0000000..5d12532 --- /dev/null +++ b/api/type-aliases/Resolver.md @@ -0,0 +1,17 @@ +--- +title: Resolver +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / Resolver + +# Type Alias: Resolver + +> **Resolver**\<\> = `Resolver` + +Defined in: [lib/ResolverFactory.js:17](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/ResolverFactory.js#L17) + +## Type Parameters diff --git a/api/type-aliases/RuleSetCondition.md b/api/type-aliases/RuleSetCondition.md new file mode 100644 index 0000000..daa5d6c --- /dev/null +++ b/api/type-aliases/RuleSetCondition.md @@ -0,0 +1,17 @@ +--- +title: RuleSetCondition +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / RuleSetCondition + +# Type Alias: RuleSetCondition + +> **RuleSetCondition** = `RegExp` \| `string` \| `RuleSetConditionFn` \| `RuleSetLogicalConditions` \| `RuleSetConditions` + +Defined in: [declarations/WebpackOptions.d.ts:296](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L296) + +A condition matcher. diff --git a/api/type-aliases/RuleSetConditionAbsolute.md b/api/type-aliases/RuleSetConditionAbsolute.md new file mode 100644 index 0000000..80506ed --- /dev/null +++ b/api/type-aliases/RuleSetConditionAbsolute.md @@ -0,0 +1,17 @@ +--- +title: RuleSetConditionAbsolute +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / RuleSetConditionAbsolute + +# Type Alias: RuleSetConditionAbsolute + +> **RuleSetConditionAbsolute** = `RegExp` \| `string` \| `RuleSetConditionFn` \| `RuleSetLogicalConditionsAbsolute` \| `RuleSetConditionsAbsolute` + +Defined in: [declarations/WebpackOptions.d.ts:315](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L315) + +A condition matcher matching an absolute path. diff --git a/api/type-aliases/RuleSetUse.md b/api/type-aliases/RuleSetUse.md new file mode 100644 index 0000000..a179a9d --- /dev/null +++ b/api/type-aliases/RuleSetUse.md @@ -0,0 +1,17 @@ +--- +title: RuleSetUse +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / RuleSetUse + +# Type Alias: RuleSetUse + +> **RuleSetUse** = (`Falsy` \| [`RuleSetUseItem`](RuleSetUseItem.md))[] \| [`RuleSetUseFunction`](RuleSetUseFunction.md) \| [`RuleSetUseItem`](RuleSetUseItem.md) + +Defined in: [declarations/WebpackOptions.d.ts:379](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L379) + +A list of descriptions of loaders applied. diff --git a/api/type-aliases/RuleSetUseFunction.md b/api/type-aliases/RuleSetUseFunction.md new file mode 100644 index 0000000..15b2d28 --- /dev/null +++ b/api/type-aliases/RuleSetUseFunction.md @@ -0,0 +1,17 @@ +--- +title: RuleSetUseFunction +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / RuleSetUseFunction + +# Type Alias: RuleSetUseFunction + +> **RuleSetUseFunction** = `RuleSetUseFn` + +Defined in: [declarations/WebpackOptions.d.ts:406](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L406) + +The function is called on each data and return rule set item. diff --git a/api/type-aliases/RuleSetUseItem.md b/api/type-aliases/RuleSetUseItem.md new file mode 100644 index 0000000..92dfbfb --- /dev/null +++ b/api/type-aliases/RuleSetUseItem.md @@ -0,0 +1,43 @@ +--- +title: RuleSetUseItem +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / RuleSetUseItem + +# Type Alias: RuleSetUseItem + +> **RuleSetUseItem** = \{ `ident?`: `string`; `loader?`: `RuleSetLoader`; `options?`: `RuleSetLoaderOptions`; \} \| [`RuleSetUseFunction`](RuleSetUseFunction.md) \| `RuleSetLoader` + +Defined in: [declarations/WebpackOptions.d.ts:386](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L386) + +A description of an applied loader. + +## Type Declaration + +\{ `ident?`: `string`; `loader?`: `RuleSetLoader`; `options?`: `RuleSetLoaderOptions`; \} + +### ident? + +> `optional` **ident**: `string` + +Unique loader options identifier. + +### loader? + +> `optional` **loader**: `RuleSetLoader` + +Loader name. + +### options? + +> `optional` **options**: `RuleSetLoaderOptions` + +Loader options. + +[`RuleSetUseFunction`](RuleSetUseFunction.md) + +`RuleSetLoader` diff --git a/api/type-aliases/StatsAsset.md b/api/type-aliases/StatsAsset.md new file mode 100644 index 0000000..52cc8a2 --- /dev/null +++ b/api/type-aliases/StatsAsset.md @@ -0,0 +1,17 @@ +--- +title: StatsAsset +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / StatsAsset + +# Type Alias: StatsAsset + +> **StatsAsset**\<\> = `KnownStatsAsset` & `Record`\<`string`, `EXPECTED_ANY`\> + +Defined in: [lib/stats/DefaultStatsFactoryPlugin.js:115](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/stats/DefaultStatsFactoryPlugin.js#L115) + +## Type Parameters diff --git a/api/type-aliases/StatsChunk.md b/api/type-aliases/StatsChunk.md new file mode 100644 index 0000000..29f2358 --- /dev/null +++ b/api/type-aliases/StatsChunk.md @@ -0,0 +1,17 @@ +--- +title: StatsChunk +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / StatsChunk + +# Type Alias: StatsChunk + +> **StatsChunk**\<\> = `KnownStatsChunk` & `Record`\<`string`, `EXPECTED_ANY`\> + +Defined in: [lib/stats/DefaultStatsFactoryPlugin.js:239](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/stats/DefaultStatsFactoryPlugin.js#L239) + +## Type Parameters diff --git a/api/type-aliases/StatsChunkGroup.md b/api/type-aliases/StatsChunkGroup.md new file mode 100644 index 0000000..a2ee137 --- /dev/null +++ b/api/type-aliases/StatsChunkGroup.md @@ -0,0 +1,17 @@ +--- +title: StatsChunkGroup +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / StatsChunkGroup + +# Type Alias: StatsChunkGroup + +> **StatsChunkGroup**\<\> = `KnownStatsChunkGroup` & `Record`\<`string`, `EXPECTED_ANY`\> + +Defined in: [lib/stats/DefaultStatsFactoryPlugin.js:137](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/stats/DefaultStatsFactoryPlugin.js#L137) + +## Type Parameters diff --git a/api/type-aliases/StatsChunkOrigin.md b/api/type-aliases/StatsChunkOrigin.md new file mode 100644 index 0000000..dade743 --- /dev/null +++ b/api/type-aliases/StatsChunkOrigin.md @@ -0,0 +1,17 @@ +--- +title: StatsChunkOrigin +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / StatsChunkOrigin + +# Type Alias: StatsChunkOrigin + +> **StatsChunkOrigin**\<\> = `KnownStatsChunkOrigin` & `Record`\<`string`, `EXPECTED_ANY`\> + +Defined in: [lib/stats/DefaultStatsFactoryPlugin.js:265](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/stats/DefaultStatsFactoryPlugin.js#L265) + +## Type Parameters diff --git a/api/type-aliases/StatsCompilation.md b/api/type-aliases/StatsCompilation.md new file mode 100644 index 0000000..2a6332f --- /dev/null +++ b/api/type-aliases/StatsCompilation.md @@ -0,0 +1,17 @@ +--- +title: StatsCompilation +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / StatsCompilation + +# Type Alias: StatsCompilation + +> **StatsCompilation**\<\> = `KnownStatsCompilation` & `Record`\<`string`, `EXPECTED_ANY`\> + +Defined in: [lib/stats/DefaultStatsFactoryPlugin.js:66](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/stats/DefaultStatsFactoryPlugin.js#L66) + +## Type Parameters diff --git a/api/type-aliases/StatsError.md b/api/type-aliases/StatsError.md new file mode 100644 index 0000000..662578b --- /dev/null +++ b/api/type-aliases/StatsError.md @@ -0,0 +1,17 @@ +--- +title: StatsError +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / StatsError + +# Type Alias: StatsError + +> **StatsError**\<\> = `KnownStatsError` & `Record`\<`string`, `EXPECTED_ANY`\> + +Defined in: [lib/stats/DefaultStatsFactoryPlugin.js:294](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/stats/DefaultStatsFactoryPlugin.js#L294) + +## Type Parameters diff --git a/api/type-aliases/StatsLogging.md b/api/type-aliases/StatsLogging.md new file mode 100644 index 0000000..2c08da4 --- /dev/null +++ b/api/type-aliases/StatsLogging.md @@ -0,0 +1,17 @@ +--- +title: StatsLogging +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / StatsLogging + +# Type Alias: StatsLogging + +> **StatsLogging**\<\> = `KnownStatsLogging` & `Record`\<`string`, `EXPECTED_ANY`\> + +Defined in: [lib/stats/DefaultStatsFactoryPlugin.js:96](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/stats/DefaultStatsFactoryPlugin.js#L96) + +## Type Parameters diff --git a/api/type-aliases/StatsLoggingEntry.md b/api/type-aliases/StatsLoggingEntry.md new file mode 100644 index 0000000..c1e90b5 --- /dev/null +++ b/api/type-aliases/StatsLoggingEntry.md @@ -0,0 +1,17 @@ +--- +title: StatsLoggingEntry +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / StatsLoggingEntry + +# Type Alias: StatsLoggingEntry + +> **StatsLoggingEntry**\<\> = `KnownStatsLoggingEntry` & `Record`\<`string`, `EXPECTED_ANY`\> + +Defined in: [lib/stats/DefaultStatsFactoryPlugin.js:104](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/stats/DefaultStatsFactoryPlugin.js#L104) + +## Type Parameters diff --git a/api/type-aliases/StatsModule.md b/api/type-aliases/StatsModule.md new file mode 100644 index 0000000..30ca26e --- /dev/null +++ b/api/type-aliases/StatsModule.md @@ -0,0 +1,17 @@ +--- +title: StatsModule +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / StatsModule + +# Type Alias: StatsModule + +> **StatsModule**\<\> = `KnownStatsModule` & `Record`\<`string`, `EXPECTED_ANY`\> + +Defined in: [lib/stats/DefaultStatsFactoryPlugin.js:154](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/stats/DefaultStatsFactoryPlugin.js#L154) + +## Type Parameters diff --git a/api/type-aliases/StatsModuleIssuer.md b/api/type-aliases/StatsModuleIssuer.md new file mode 100644 index 0000000..ccb0bdc --- /dev/null +++ b/api/type-aliases/StatsModuleIssuer.md @@ -0,0 +1,17 @@ +--- +title: StatsModuleIssuer +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / StatsModuleIssuer + +# Type Alias: StatsModuleIssuer + +> **StatsModuleIssuer**\<\> = `KnownStatsModuleIssuer` & `Record`\<`string`, `EXPECTED_ANY`\> + +Defined in: [lib/stats/DefaultStatsFactoryPlugin.js:213](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/stats/DefaultStatsFactoryPlugin.js#L213) + +## Type Parameters diff --git a/api/type-aliases/StatsModuleReason.md b/api/type-aliases/StatsModuleReason.md new file mode 100644 index 0000000..e10a425 --- /dev/null +++ b/api/type-aliases/StatsModuleReason.md @@ -0,0 +1,17 @@ +--- +title: StatsModuleReason +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / StatsModuleReason + +# Type Alias: StatsModuleReason + +> **StatsModuleReason**\<\> = `KnownStatsModuleReason` & `Record`\<`string`, `EXPECTED_ANY`\> + +Defined in: [lib/stats/DefaultStatsFactoryPlugin.js:222](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/stats/DefaultStatsFactoryPlugin.js#L222) + +## Type Parameters diff --git a/api/type-aliases/StatsModuleTraceDependency.md b/api/type-aliases/StatsModuleTraceDependency.md new file mode 100644 index 0000000..d2fd55d --- /dev/null +++ b/api/type-aliases/StatsModuleTraceDependency.md @@ -0,0 +1,17 @@ +--- +title: StatsModuleTraceDependency +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / StatsModuleTraceDependency + +# Type Alias: StatsModuleTraceDependency + +> **StatsModuleTraceDependency**\<\> = `KnownStatsModuleTraceDependency` & `Record`\<`string`, `EXPECTED_ANY`\> + +Defined in: [lib/stats/DefaultStatsFactoryPlugin.js:288](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/stats/DefaultStatsFactoryPlugin.js#L288) + +## Type Parameters diff --git a/api/type-aliases/StatsModuleTraceItem.md b/api/type-aliases/StatsModuleTraceItem.md new file mode 100644 index 0000000..aeea8a1 --- /dev/null +++ b/api/type-aliases/StatsModuleTraceItem.md @@ -0,0 +1,17 @@ +--- +title: StatsModuleTraceItem +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / StatsModuleTraceItem + +# Type Alias: StatsModuleTraceItem + +> **StatsModuleTraceItem**\<\> = `KnownStatsModuleTraceItem` & `Record`\<`string`, `EXPECTED_ANY`\> + +Defined in: [lib/stats/DefaultStatsFactoryPlugin.js:276](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/stats/DefaultStatsFactoryPlugin.js#L276) + +## Type Parameters diff --git a/api/type-aliases/StatsProfile.md b/api/type-aliases/StatsProfile.md new file mode 100644 index 0000000..fa7db34 --- /dev/null +++ b/api/type-aliases/StatsProfile.md @@ -0,0 +1,17 @@ +--- +title: StatsProfile +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / StatsProfile + +# Type Alias: StatsProfile + +> **StatsProfile**\<\> = `KnownStatsProfile` & `Record`\<`string`, `EXPECTED_ANY`\> + +Defined in: [lib/stats/DefaultStatsFactoryPlugin.js:198](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/stats/DefaultStatsFactoryPlugin.js#L198) + +## Type Parameters diff --git a/api/type-aliases/TemplatePath.md b/api/type-aliases/TemplatePath.md new file mode 100644 index 0000000..b4ff4ab --- /dev/null +++ b/api/type-aliases/TemplatePath.md @@ -0,0 +1,17 @@ +--- +title: TemplatePath +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / TemplatePath + +# Type Alias: TemplatePath + +> **TemplatePath**\<\> = `string` \| `TemplatePathFn` + +Defined in: [lib/TemplatedPathPlugin.js:136](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/TemplatedPathPlugin.js#L136) + +## Type Parameters diff --git a/api/type-aliases/Watching.md b/api/type-aliases/Watching.md new file mode 100644 index 0000000..bfd6ca5 --- /dev/null +++ b/api/type-aliases/Watching.md @@ -0,0 +1,17 @@ +--- +title: Watching +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / Watching + +# Type Alias: Watching + +> **Watching**\<\> = `__module` + +Defined in: [lib/index.js:63](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L63) + +## Type Parameters diff --git a/api/type-aliases/WebpackPluginFunction.md b/api/type-aliases/WebpackPluginFunction.md new file mode 100644 index 0000000..8d8f49d --- /dev/null +++ b/api/type-aliases/WebpackPluginFunction.md @@ -0,0 +1,17 @@ +--- +title: WebpackPluginFunction +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / WebpackPluginFunction + +# Type Alias: WebpackPluginFunction + +> **WebpackPluginFunction** = `WebpackPluginFunction` + +Defined in: [declarations/WebpackOptions.d.ts:441](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/declarations/WebpackOptions.d.ts#L441) + +Function acting as plugin. diff --git a/api/variables/export=.md b/api/variables/export=.md new file mode 100644 index 0000000..44a3265 --- /dev/null +++ b/api/variables/export=.md @@ -0,0 +1,2154 @@ +--- +title: export= +--- + +[**webpack**](../README.md) + +*** + +[webpack](../README.md) / export= + +# Variable: export= + +> **export=**: \{(`options`, `callback`): `Compiler`; (`options`): `Compiler`; (`options`, `callback`): `MultiCompiler`; (`options`): `MultiCompiler`; \} & `object` + +Defined in: [lib/index.js:140](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L140) + +## Type Declaration + +### cache + +> **cache**: `object` + +#### cache.MemoryCachePlugin + +##### Get Signature + +> **get** **MemoryCachePlugin**(): *typeof* `MemoryCachePlugin` + +Defined in: [lib/index.js:395](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L395) + +###### Returns + +*typeof* `MemoryCachePlugin` + +### config + +> **config**: `object` + +#### config.applyWebpackOptionsDefaults + +##### Get Signature + +> **get** **applyWebpackOptionsDefaults**(): (`options`, `compilerIndex`) => `ResolvedOptions` + +Defined in: [lib/index.js:404](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L404) + +###### Returns + +> (`options`, `compilerIndex`): `ResolvedOptions` + +###### Parameters + +###### options + +[`WebpackOptionsNormalized`](../interfaces/WebpackOptionsNormalized.md) + +options to be modified + +###### compilerIndex + +`number` + +index of compiler + +###### Returns + +`ResolvedOptions` + +Resolved options after apply defaults + +#### config.getNormalizedWebpackOptions + +##### Get Signature + +> **get** **getNormalizedWebpackOptions**(): (`config`) => [`WebpackOptionsNormalized`](../interfaces/WebpackOptionsNormalized.md) + +Defined in: [lib/index.js:401](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L401) + +###### Returns + +> (`config`): [`WebpackOptionsNormalized`](../interfaces/WebpackOptionsNormalized.md) + +###### Parameters + +###### config + +[`Configuration`](../interfaces/Configuration.md) + +input config + +###### Returns + +[`WebpackOptionsNormalized`](../interfaces/WebpackOptionsNormalized.md) + +normalized options + +### container + +> **container**: `object` + +#### container.ContainerPlugin + +##### Get Signature + +> **get** **ContainerPlugin**(): *typeof* `ContainerPlugin` + +Defined in: [lib/index.js:603](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L603) + +###### Returns + +*typeof* `ContainerPlugin` + +#### container.ContainerReferencePlugin + +##### Get Signature + +> **get** **ContainerReferencePlugin**(): *typeof* `ContainerReferencePlugin` + +Defined in: [lib/index.js:606](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L606) + +###### Returns + +*typeof* `ContainerReferencePlugin` + +#### container.ModuleFederationPlugin + +##### Get Signature + +> **get** **ModuleFederationPlugin**(): *typeof* `ModuleFederationPlugin` + +Defined in: [lib/index.js:609](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L609) + +###### Returns + +*typeof* `ModuleFederationPlugin` + +#### container.scope + +##### Get Signature + +> **get** **scope**(): \<`T`\>(`scope`, `options`) => `Record`\<`string`, `string` \| `string`[] \| `T`\> + +Defined in: [lib/index.js:612](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L612) + +###### Returns + +> \<`T`\>(`scope`, `options`): `Record`\<`string`, `string` \| `string`[] \| `T`\> + +###### Type Parameters + +###### T + +`T` + +###### Parameters + +###### scope + +`string` + +scope name + +###### options + +`ContainerOptionsFormat`\<`T`\> + +options passed by the user + +###### Returns + +`Record`\<`string`, `string` \| `string`[] \| `T`\> + +options to spread or pass + +### css + +> **css**: `object` + +#### css.CssModulesPlugin + +##### Get Signature + +> **get** **CssModulesPlugin**(): *typeof* `CssModulesPlugin` + +Defined in: [lib/index.js:588](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L588) + +###### Returns + +*typeof* `CssModulesPlugin` + +### debug + +> **debug**: `object` + +#### debug.ProfilingPlugin + +##### Get Signature + +> **get** **ProfilingPlugin**(): *typeof* `ProfilingPlugin` + +Defined in: [lib/index.js:633](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L633) + +###### Returns + +*typeof* `ProfilingPlugin` + +### dependencies + +> **dependencies**: `object` + +#### dependencies.ConstDependency + +##### Get Signature + +> **get** **ConstDependency**(): *typeof* `ConstDependency` + +Defined in: [lib/index.js:416](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L416) + +###### Returns + +*typeof* `ConstDependency` + +#### dependencies.HarmonyImportDependency + +##### Get Signature + +> **get** **HarmonyImportDependency**(): *typeof* `HarmonyImportDependency` + +Defined in: [lib/index.js:413](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L413) + +###### Returns + +*typeof* `HarmonyImportDependency` + +#### dependencies.ModuleDependency + +##### Get Signature + +> **get** **ModuleDependency**(): *typeof* `ModuleDependency` + +Defined in: [lib/index.js:410](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L410) + +###### Returns + +*typeof* `ModuleDependency` + +#### dependencies.NullDependency + +##### Get Signature + +> **get** **NullDependency**(): *typeof* `NullDependency` + +Defined in: [lib/index.js:419](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L419) + +###### Returns + +*typeof* `NullDependency` + +### electron + +> **electron**: `object` + +#### electron.ElectronTargetPlugin + +##### Get Signature + +> **get** **ElectronTargetPlugin**(): *typeof* `ElectronTargetPlugin` + +Defined in: [lib/index.js:573](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L573) + +###### Returns + +*typeof* `ElectronTargetPlugin` + +### esm + +> **esm**: `object` + +#### esm.ModuleChunkLoadingRuntimeModule + +##### Get Signature + +> **get** **ModuleChunkLoadingRuntimeModule**(): *typeof* `ModuleChunkLoadingRuntimeModule` + +Defined in: [lib/index.js:540](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L540) + +###### Returns + +*typeof* `ModuleChunkLoadingRuntimeModule` + +### experiments + +> **experiments**: `object` + +#### experiments.ids + +> **ids**: `object` + +#### experiments.ids.SyncModuleIdsPlugin + +##### Get Signature + +> **get** **SyncModuleIdsPlugin**(): *typeof* `SyncModuleIdsPlugin` + +Defined in: [lib/index.js:676](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L676) + +###### Returns + +*typeof* `SyncModuleIdsPlugin` + +#### experiments.schemes + +> **schemes**: `object` + +#### experiments.schemes.HttpUriPlugin + +##### Get Signature + +> **get** **HttpUriPlugin**(): *typeof* `HttpUriPlugin` + +Defined in: [lib/index.js:668](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L668) + +###### Returns + +*typeof* `HttpUriPlugin` + +#### experiments.schemes.VirtualUrlPlugin + +##### Get Signature + +> **get** **VirtualUrlPlugin**(): *typeof* `VirtualUrlPlugin` + +Defined in: [lib/index.js:671](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L671) + +###### Returns + +*typeof* `VirtualUrlPlugin` + +### ids + +> **ids**: `object` + +#### ids.ChunkModuleIdRangePlugin + +##### Get Signature + +> **get** **ChunkModuleIdRangePlugin**(): *typeof* `ChunkModuleIdRangePlugin` + +Defined in: [lib/index.js:425](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L425) + +###### Returns + +*typeof* `ChunkModuleIdRangePlugin` + +#### ids.DeterministicChunkIdsPlugin + +##### Get Signature + +> **get** **DeterministicChunkIdsPlugin**(): *typeof* `DeterministicChunkIdsPlugin` + +Defined in: [lib/index.js:437](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L437) + +###### Returns + +*typeof* `DeterministicChunkIdsPlugin` + +#### ids.DeterministicModuleIdsPlugin + +##### Get Signature + +> **get** **DeterministicModuleIdsPlugin**(): *typeof* `DeterministicModuleIdsPlugin` + +Defined in: [lib/index.js:440](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L440) + +###### Returns + +*typeof* `DeterministicModuleIdsPlugin` + +#### ids.HashedModuleIdsPlugin + +##### Get Signature + +> **get** **HashedModuleIdsPlugin**(): *typeof* `HashedModuleIdsPlugin` + +Defined in: [lib/index.js:449](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L449) + +###### Returns + +*typeof* `HashedModuleIdsPlugin` + +#### ids.NamedChunkIdsPlugin + +##### Get Signature + +> **get** **NamedChunkIdsPlugin**(): *typeof* `NamedChunkIdsPlugin` + +Defined in: [lib/index.js:443](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L443) + +###### Returns + +*typeof* `NamedChunkIdsPlugin` + +#### ids.NamedModuleIdsPlugin + +##### Get Signature + +> **get** **NamedModuleIdsPlugin**(): *typeof* `NamedModuleIdsPlugin` + +Defined in: [lib/index.js:434](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L434) + +###### Returns + +*typeof* `NamedModuleIdsPlugin` + +#### ids.NaturalModuleIdsPlugin + +##### Get Signature + +> **get** **NaturalModuleIdsPlugin**(): *typeof* `NaturalModuleIdsPlugin` + +Defined in: [lib/index.js:428](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L428) + +###### Returns + +*typeof* `NaturalModuleIdsPlugin` + +#### ids.OccurrenceChunkIdsPlugin + +##### Get Signature + +> **get** **OccurrenceChunkIdsPlugin**(): *typeof* `OccurrenceChunkIdsPlugin` + +Defined in: [lib/index.js:446](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L446) + +###### Returns + +*typeof* `OccurrenceChunkIdsPlugin` + +#### ids.OccurrenceModuleIdsPlugin + +##### Get Signature + +> **get** **OccurrenceModuleIdsPlugin**(): *typeof* `OccurrenceModuleIdsPlugin` + +Defined in: [lib/index.js:431](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L431) + +###### Returns + +*typeof* `OccurrenceModuleIdsPlugin` + +### javascript + +> **javascript**: `object` + +#### javascript.EnableChunkLoadingPlugin + +##### Get Signature + +> **get** **EnableChunkLoadingPlugin**(): *typeof* `EnableChunkLoadingPlugin` + +Defined in: [lib/index.js:455](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L455) + +###### Returns + +*typeof* `EnableChunkLoadingPlugin` + +#### javascript.JavascriptModulesPlugin + +##### Get Signature + +> **get** **JavascriptModulesPlugin**(): *typeof* `JavascriptModulesPlugin` + +Defined in: [lib/index.js:458](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L458) + +###### Returns + +*typeof* `JavascriptModulesPlugin` + +#### javascript.JavascriptParser + +##### Get Signature + +> **get** **JavascriptParser**(): *typeof* `JavascriptParser` + +Defined in: [lib/index.js:461](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L461) + +###### Returns + +*typeof* `JavascriptParser` + +### library + +> **library**: `object` + +#### library.AbstractLibraryPlugin + +##### Get Signature + +> **get** **AbstractLibraryPlugin**(): *typeof* `AbstractLibraryPlugin` + +Defined in: [lib/index.js:594](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L594) + +###### Returns + +*typeof* `AbstractLibraryPlugin` + +#### library.EnableLibraryPlugin + +##### Get Signature + +> **get** **EnableLibraryPlugin**(): *typeof* `EnableLibraryPlugin` + +Defined in: [lib/index.js:597](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L597) + +###### Returns + +*typeof* `EnableLibraryPlugin` + +### node + +> **node**: `object` + +#### node.NodeEnvironmentPlugin + +##### Get Signature + +> **get** **NodeEnvironmentPlugin**(): *typeof* `NodeEnvironmentPlugin` + +Defined in: [lib/index.js:552](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L552) + +###### Returns + +*typeof* `NodeEnvironmentPlugin` + +#### node.NodeSourcePlugin + +##### Get Signature + +> **get** **NodeSourcePlugin**(): *typeof* `NodeSourcePlugin` + +Defined in: [lib/index.js:555](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L555) + +###### Returns + +*typeof* `NodeSourcePlugin` + +#### node.NodeTargetPlugin + +##### Get Signature + +> **get** **NodeTargetPlugin**(): *typeof* `NodeTargetPlugin` + +Defined in: [lib/index.js:558](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L558) + +###### Returns + +*typeof* `NodeTargetPlugin` + +#### node.NodeTemplatePlugin + +##### Get Signature + +> **get** **NodeTemplatePlugin**(): *typeof* `NodeTemplatePlugin` + +Defined in: [lib/index.js:561](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L561) + +###### Returns + +*typeof* `NodeTemplatePlugin` + +#### node.ReadFileCompileAsyncWasmPlugin + +##### Get Signature + +> **get** **ReadFileCompileAsyncWasmPlugin**(): *typeof* `ReadFileCompileAsyncWasmPlugin` + +Defined in: [lib/index.js:567](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L567) + +###### Returns + +*typeof* `ReadFileCompileAsyncWasmPlugin` + +#### node.ReadFileCompileWasmPlugin + +##### Get Signature + +> **get** **ReadFileCompileWasmPlugin**(): *typeof* `ReadFileCompileWasmPlugin` + +Defined in: [lib/index.js:564](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L564) + +###### Returns + +*typeof* `ReadFileCompileWasmPlugin` + +### optimize + +> **optimize**: `object` + +#### optimize.AggressiveMergingPlugin + +##### Get Signature + +> **get** **AggressiveMergingPlugin**(): *typeof* `AggressiveMergingPlugin` + +Defined in: [lib/index.js:467](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L467) + +###### Returns + +*typeof* `AggressiveMergingPlugin` + +#### optimize.AggressiveSplittingPlugin + +##### Get Signature + +> **get** **AggressiveSplittingPlugin**(): *typeof* `AggressiveSplittingPlugin` + +Defined in: [lib/index.js:470](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L470) + +###### Returns + +*typeof* `AggressiveSplittingPlugin` + +#### optimize.InnerGraph + +##### Get Signature + +> **get** **InnerGraph**(): `__module` + +Defined in: [lib/index.js:477](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L477) + +###### Returns + +`__module` + +#### optimize.LimitChunkCountPlugin + +##### Get Signature + +> **get** **LimitChunkCountPlugin**(): *typeof* `LimitChunkCountPlugin` + +Defined in: [lib/index.js:480](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L480) + +###### Returns + +*typeof* `LimitChunkCountPlugin` + +#### optimize.MergeDuplicateChunksPlugin + +##### Get Signature + +> **get** **MergeDuplicateChunksPlugin**(): *typeof* `MergeDuplicateChunksPlugin` + +Defined in: [lib/index.js:483](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L483) + +###### Returns + +*typeof* `MergeDuplicateChunksPlugin` + +#### optimize.MinChunkSizePlugin + +##### Get Signature + +> **get** **MinChunkSizePlugin**(): *typeof* `MinChunkSizePlugin` + +Defined in: [lib/index.js:486](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L486) + +###### Returns + +*typeof* `MinChunkSizePlugin` + +#### optimize.ModuleConcatenationPlugin + +##### Get Signature + +> **get** **ModuleConcatenationPlugin**(): *typeof* `ModuleConcatenationPlugin` + +Defined in: [lib/index.js:489](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L489) + +###### Returns + +*typeof* `ModuleConcatenationPlugin` + +#### optimize.RealContentHashPlugin + +##### Get Signature + +> **get** **RealContentHashPlugin**(): *typeof* `RealContentHashPlugin` + +Defined in: [lib/index.js:492](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L492) + +###### Returns + +*typeof* `RealContentHashPlugin` + +#### optimize.RuntimeChunkPlugin + +##### Get Signature + +> **get** **RuntimeChunkPlugin**(): *typeof* `RuntimeChunkPlugin` + +Defined in: [lib/index.js:495](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L495) + +###### Returns + +*typeof* `RuntimeChunkPlugin` + +#### optimize.SideEffectsFlagPlugin + +##### Get Signature + +> **get** **SideEffectsFlagPlugin**(): *typeof* `SideEffectsFlagPlugin` + +Defined in: [lib/index.js:498](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L498) + +###### Returns + +*typeof* `SideEffectsFlagPlugin` + +#### optimize.SplitChunksPlugin + +##### Get Signature + +> **get** **SplitChunksPlugin**(): *typeof* `SplitChunksPlugin` + +Defined in: [lib/index.js:501](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L501) + +###### Returns + +*typeof* `SplitChunksPlugin` + +### prefetch + +> **prefetch**: `object` + +#### prefetch.ChunkPrefetchPreloadPlugin + +##### Get Signature + +> **get** **ChunkPrefetchPreloadPlugin**(): *typeof* `ChunkPrefetchPreloadPlugin` + +Defined in: [lib/index.js:516](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L516) + +###### Returns + +*typeof* `ChunkPrefetchPreloadPlugin` + +### runtime + +> **runtime**: `object` + +#### runtime.GetChunkFilenameRuntimeModule + +##### Get Signature + +> **get** **GetChunkFilenameRuntimeModule**(): *typeof* `GetChunkFilenameRuntimeModule` + +Defined in: [lib/index.js:507](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L507) + +###### Returns + +*typeof* `GetChunkFilenameRuntimeModule` + +#### runtime.LoadScriptRuntimeModule + +##### Get Signature + +> **get** **LoadScriptRuntimeModule**(): *typeof* `LoadScriptRuntimeModule` + +Defined in: [lib/index.js:510](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L510) + +###### Returns + +*typeof* `LoadScriptRuntimeModule` + +### sharing + +> **sharing**: `object` + +#### sharing.ConsumeSharedPlugin + +##### Get Signature + +> **get** **ConsumeSharedPlugin**(): *typeof* `ConsumeSharedPlugin` + +Defined in: [lib/index.js:618](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L618) + +###### Returns + +*typeof* `ConsumeSharedPlugin` + +#### sharing.ProvideSharedPlugin + +##### Get Signature + +> **get** **ProvideSharedPlugin**(): *typeof* `ProvideSharedPlugin` + +Defined in: [lib/index.js:621](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L621) + +###### Returns + +*typeof* `ProvideSharedPlugin` + +#### sharing.scope + +##### Get Signature + +> **get** **scope**(): \<`T`\>(`scope`, `options`) => `Record`\<`string`, `string` \| `string`[] \| `T`\> + +Defined in: [lib/index.js:627](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L627) + +###### Returns + +> \<`T`\>(`scope`, `options`): `Record`\<`string`, `string` \| `string`[] \| `T`\> + +###### Type Parameters + +###### T + +`T` + +###### Parameters + +###### scope + +`string` + +scope name + +###### options + +`ContainerOptionsFormat`\<`T`\> + +options passed by the user + +###### Returns + +`Record`\<`string`, `string` \| `string`[] \| `T`\> + +options to spread or pass + +#### sharing.SharePlugin + +##### Get Signature + +> **get** **SharePlugin**(): *typeof* `SharePlugin` + +Defined in: [lib/index.js:624](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L624) + +###### Returns + +*typeof* `SharePlugin` + +### util + +> **util**: `object` + +#### util.cleverMerge + +##### Get Signature + +> **get** **cleverMerge**(): \<`T`, `O`\>(`first`, `second`) => `T` \| `O` \| `T` & `O` + +Defined in: [lib/index.js:651](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L651) + +###### Returns + +> \<`T`, `O`\>(`first`, `second`): `T` \| `O` \| `T` & `O` + +Merges two given objects and caches the result to avoid computation if same objects passed as arguments again. + +###### Type Parameters + +###### T + +`T` + +###### O + +`O` + +###### Parameters + +###### first + +`T` + +first object + +###### second + +`O` + +second object + +###### Returns + +`T` \| `O` \| `T` & `O` + +merged object of first and second object + +###### Example + +```ts +// performs cleverMerge(first, second), stores the result in WeakMap and returns result +cachedCleverMerge({a: 1}, {a: 2}) +{a: 2} + // when same arguments passed, gets the result from WeakMap and returns it. +cachedCleverMerge({a: 1}, {a: 2}) +{a: 2} +``` + +#### util.comparators + +##### Get Signature + +> **get** **comparators**(): `__module` + +Defined in: [lib/index.js:642](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L642) + +###### Returns + +`__module` + +#### util.compileBooleanMatcher + +##### Get Signature + +> **get** **compileBooleanMatcher**(): \{(`map`): `boolean` \| (`value`) => `string`; `fromLists`: (`positiveItems`, `negativeItems`) => (`value`) => `string`; `itemsToRegexp`: (`itemsArr`) => `string`; \} + +Defined in: [lib/index.js:657](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L657) + +###### Returns + +> (`map`): `boolean` \| (`value`) => `string` + +###### Parameters + +###### map + +`Record`\<`string` \| `number`, `boolean`\> + +value map + +###### Returns + +`boolean` \| (`value`) => `string` + +true/false, when unconditionally true/false, or a template function to determine the value at runtime + +###### fromLists() + +> **fromLists**: (`positiveItems`, `negativeItems`) => (`value`) => `string` + +###### Parameters + +###### positiveItems + +`string`[] + +positive items + +###### negativeItems + +`string`[] + +negative items + +###### Returns + +a template function to determine the value at runtime + +> (`value`): `string` + +###### Parameters + +###### value + +`string` + +###### Returns + +`string` + +###### itemsToRegexp() + +> **itemsToRegexp**: (`itemsArr`) => `string` + +###### Parameters + +###### itemsArr + +`string`[] + +array of items + +###### Returns + +`string` + +regexp + +#### util.createHash + +##### Get Signature + +> **get** **createHash**(): `Function` + +Defined in: [lib/index.js:639](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L639) + +###### Returns + +`Function` + +#### util.LazySet + +##### Get Signature + +> **get** **LazySet**(): *typeof* `LazySet` + +Defined in: [lib/index.js:654](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L654) + +###### Returns + +*typeof* `LazySet` + +#### util.runtime + +##### Get Signature + +> **get** **runtime**(): `__module` + +Defined in: [lib/index.js:645](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L645) + +###### Returns + +`__module` + +#### util.serialization + +##### Get Signature + +> **get** **serialization**(): `object` + +Defined in: [lib/index.js:648](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L648) + +###### Returns + +###### MEASURE\_END\_OPERATION + +> **MEASURE\_END\_OPERATION**\<\> = *typeof* `MEASURE_END_OPERATION` + +###### Type Parameters + +###### MEASURE\_START\_OPERATION + +> **MEASURE\_START\_OPERATION**\<\> = *typeof* `MEASURE_START_OPERATION` + +###### Type Parameters + +###### createFileSerializer() + +> **createFileSerializer**: \<`D`, `S`, `C`\>(`fs`, `hashFunction`) => `Serializer`\<`D`, `S`, `C`\> + +###### Type Parameters + +###### D + +`D` + +###### S + +`S` + +###### C + +`C` + +###### Parameters + +###### fs + +`IntermediateFileSystem` + +filesystem + +###### hashFunction + +`HashFunction` + +hash function to use + +###### Returns + +`Serializer`\<`D`, `S`, `C`\> + +file serializer + +###### buffersSerializer + +###### Get Signature + +> **get** **buffersSerializer**(): `Serializer`\<`EXPECTED_ANY`, `EXPECTED_ANY`, `EXPECTED_ANY`\> + +###### Returns + +`Serializer`\<`EXPECTED_ANY`, `EXPECTED_ANY`, `EXPECTED_ANY`\> + +###### MEASURE\_END\_OPERATION + +###### Get Signature + +> **get** **MEASURE\_END\_OPERATION**(): *typeof* `MEASURE_END_OPERATION` + +###### Returns + +*typeof* `MEASURE_END_OPERATION` + +###### MEASURE\_START\_OPERATION + +###### Get Signature + +> **get** **MEASURE\_START\_OPERATION**(): *typeof* `MEASURE_START_OPERATION` + +###### Returns + +*typeof* `MEASURE_START_OPERATION` + +###### NOT\_SERIALIZABLE + +###### Get Signature + +> **get** **NOT\_SERIALIZABLE**(): `object` + +###### Returns + +`object` + +###### register + +###### Get Signature + +> **get** **register**(): (`Constructor`, `request`, `name`, `serializer`) => `void` + +###### Returns + +> (`Constructor`, `request`, `name`, `serializer`): `void` + +###### Parameters + +###### Constructor + +`Constructor` + +the constructor + +###### request + +`string` + +the request which will be required when deserializing + +###### name + +`string` + +the name to make multiple serializer unique when sharing a request + +###### serializer + +`ObjectSerializer` + +the serializer + +###### Returns + +`void` + +###### registerLoader + +###### Get Signature + +> **get** **registerLoader**(): (`regExp`, `loader`) => `void` + +###### Returns + +> (`regExp`, `loader`): `void` + +###### Parameters + +###### regExp + +`RegExp` + +RegExp for which the request is tested + +###### loader + +(`request`) => `boolean` + +loader to load the request, returns true when successful + +###### Returns + +`void` + +###### registerNotSerializable + +###### Get Signature + +> **get** **registerNotSerializable**(): (`Constructor`) => `void` + +###### Returns + +> (`Constructor`): `void` + +###### Parameters + +###### Constructor + +`Constructor` + +the constructor + +###### Returns + +`void` + +### wasm + +> **wasm**: `object` + +#### wasm.AsyncWebAssemblyModulesPlugin + +##### Get Signature + +> **get** **AsyncWebAssemblyModulesPlugin**(): *typeof* `AsyncWebAssemblyModulesPlugin` + +Defined in: [lib/index.js:579](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L579) + +###### Returns + +*typeof* `AsyncWebAssemblyModulesPlugin` + +#### wasm.EnableWasmLoadingPlugin + +##### Get Signature + +> **get** **EnableWasmLoadingPlugin**(): *typeof* `EnableWasmLoadingPlugin` + +Defined in: [lib/index.js:582](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L582) + +###### Returns + +*typeof* `EnableWasmLoadingPlugin` + +### web + +> **web**: `object` + +#### web.CssLoadingRuntimeModule + +##### Get Signature + +> **get** **CssLoadingRuntimeModule**(): *typeof* `CssLoadingRuntimeModule` + +Defined in: [lib/index.js:534](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L534) + +###### Returns + +*typeof* `CssLoadingRuntimeModule` + +#### web.FetchCompileAsyncWasmPlugin + +##### Get Signature + +> **get** **FetchCompileAsyncWasmPlugin**(): *typeof* `FetchCompileAsyncWasmPlugin` + +Defined in: [lib/index.js:525](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L525) + +###### Returns + +*typeof* `FetchCompileAsyncWasmPlugin` + +#### web.FetchCompileWasmPlugin + +##### Get Signature + +> **get** **FetchCompileWasmPlugin**(): *typeof* `FetchCompileWasmPlugin` + +Defined in: [lib/index.js:522](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L522) + +###### Returns + +*typeof* `FetchCompileWasmPlugin` + +#### web.JsonpChunkLoadingRuntimeModule + +##### Get Signature + +> **get** **JsonpChunkLoadingRuntimeModule**(): *typeof* `JsonpChunkLoadingRuntimeModule` + +Defined in: [lib/index.js:528](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L528) + +###### Returns + +*typeof* `JsonpChunkLoadingRuntimeModule` + +#### web.JsonpTemplatePlugin + +##### Get Signature + +> **get** **JsonpTemplatePlugin**(): *typeof* `JsonpTemplatePlugin` + +Defined in: [lib/index.js:531](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L531) + +###### Returns + +*typeof* `JsonpTemplatePlugin` + +### webworker + +> **webworker**: `object` + +#### webworker.WebWorkerTemplatePlugin + +##### Get Signature + +> **get** **WebWorkerTemplatePlugin**(): *typeof* `WebWorkerTemplatePlugin` + +Defined in: [lib/index.js:546](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/lib/index.js#L546) + +###### Returns + +*typeof* `WebWorkerTemplatePlugin` + +### AsyncDependenciesBlock + +#### Get Signature + +> **get** **AsyncDependenciesBlock**(): *typeof* `AsyncDependenciesBlock` + +##### Returns + +*typeof* `AsyncDependenciesBlock` + +### AutomaticPrefetchPlugin + +#### Get Signature + +> **get** **AutomaticPrefetchPlugin**(): *typeof* `AutomaticPrefetchPlugin` + +##### Returns + +*typeof* `AutomaticPrefetchPlugin` + +### BannerPlugin + +#### Get Signature + +> **get** **BannerPlugin**(): *typeof* `BannerPlugin` + +##### Returns + +*typeof* `BannerPlugin` + +### Cache + +#### Get Signature + +> **get** **Cache**(): *typeof* `Cache` + +##### Returns + +*typeof* `Cache` + +### Chunk + +#### Get Signature + +> **get** **Chunk**(): *typeof* `Chunk` + +##### Returns + +*typeof* `Chunk` + +### ChunkGraph + +#### Get Signature + +> **get** **ChunkGraph**(): *typeof* `ChunkGraph` + +##### Returns + +*typeof* `ChunkGraph` + +### CleanPlugin + +#### Get Signature + +> **get** **CleanPlugin**(): *typeof* `CleanPlugin` + +##### Returns + +*typeof* `CleanPlugin` + +### cli + +#### Get Signature + +> **get** **cli**(): `__module` + +##### Returns + +`__module` + +### Compilation + +#### Get Signature + +> **get** **Compilation**(): *typeof* `Compilation` + +##### Returns + +*typeof* `Compilation` + +### Compiler + +#### Get Signature + +> **get** **Compiler**(): *typeof* `Compiler` + +##### Returns + +*typeof* `Compiler` + +### ConcatenationScope + +#### Get Signature + +> **get** **ConcatenationScope**(): *typeof* `ConcatenationScope` + +##### Returns + +*typeof* `ConcatenationScope` + +### ContextExclusionPlugin + +#### Get Signature + +> **get** **ContextExclusionPlugin**(): *typeof* `ContextExclusionPlugin` + +##### Returns + +*typeof* `ContextExclusionPlugin` + +### ContextReplacementPlugin + +#### Get Signature + +> **get** **ContextReplacementPlugin**(): *typeof* `ContextReplacementPlugin` + +##### Returns + +*typeof* `ContextReplacementPlugin` + +### DefinePlugin + +#### Get Signature + +> **get** **DefinePlugin**(): *typeof* `DefinePlugin` + +##### Returns + +*typeof* `DefinePlugin` + +### DelegatedPlugin + +#### Get Signature + +> **get** **DelegatedPlugin**(): *typeof* `DelegatedPlugin` + +##### Returns + +*typeof* `DelegatedPlugin` + +### Dependency + +#### Get Signature + +> **get** **Dependency**(): *typeof* `Dependency` + +##### Returns + +*typeof* `Dependency` + +### DllPlugin + +#### Get Signature + +> **get** **DllPlugin**(): *typeof* `DllPlugin` + +##### Returns + +*typeof* `DllPlugin` + +### DllReferencePlugin + +#### Get Signature + +> **get** **DllReferencePlugin**(): *typeof* `DllReferencePlugin` + +##### Returns + +*typeof* `DllReferencePlugin` + +### DotenvPlugin + +#### Get Signature + +> **get** **DotenvPlugin**(): *typeof* `DotenvPlugin` + +##### Returns + +*typeof* `DotenvPlugin` + +### DynamicEntryPlugin + +#### Get Signature + +> **get** **DynamicEntryPlugin**(): *typeof* `DynamicEntryPlugin` + +##### Returns + +*typeof* `DynamicEntryPlugin` + +### EntryOptionPlugin + +#### Get Signature + +> **get** **EntryOptionPlugin**(): *typeof* `EntryOptionPlugin` + +##### Returns + +*typeof* `EntryOptionPlugin` + +### EntryPlugin + +#### Get Signature + +> **get** **EntryPlugin**(): *typeof* `EntryPlugin` + +##### Returns + +*typeof* `EntryPlugin` + +### EnvironmentPlugin + +#### Get Signature + +> **get** **EnvironmentPlugin**(): *typeof* `EnvironmentPlugin` + +##### Returns + +*typeof* `EnvironmentPlugin` + +### EvalDevToolModulePlugin + +#### Get Signature + +> **get** **EvalDevToolModulePlugin**(): *typeof* `EvalDevToolModulePlugin` + +##### Returns + +*typeof* `EvalDevToolModulePlugin` + +### EvalSourceMapDevToolPlugin + +#### Get Signature + +> **get** **EvalSourceMapDevToolPlugin**(): *typeof* `EvalSourceMapDevToolPlugin` + +##### Returns + +*typeof* `EvalSourceMapDevToolPlugin` + +### ExternalModule + +#### Get Signature + +> **get** **ExternalModule**(): *typeof* `ExternalModule` + +##### Returns + +*typeof* `ExternalModule` + +### ExternalsPlugin + +#### Get Signature + +> **get** **ExternalsPlugin**(): *typeof* `ExternalsPlugin` + +##### Returns + +*typeof* `ExternalsPlugin` + +### Generator + +#### Get Signature + +> **get** **Generator**(): *typeof* `Generator` + +##### Returns + +*typeof* `Generator` + +### HotModuleReplacementPlugin + +#### Get Signature + +> **get** **HotModuleReplacementPlugin**(): *typeof* `HotModuleReplacementPlugin` + +##### Returns + +*typeof* `HotModuleReplacementPlugin` + +### HotUpdateChunk + +#### Get Signature + +> **get** **HotUpdateChunk**(): *typeof* `HotUpdateChunk` + +##### Returns + +*typeof* `HotUpdateChunk` + +### IgnorePlugin + +#### Get Signature + +> **get** **IgnorePlugin**(): *typeof* `IgnorePlugin` + +##### Returns + +*typeof* `IgnorePlugin` + +### InitFragment + +#### Get Signature + +> **get** **InitFragment**(): *typeof* `InitFragment` + +##### Returns + +*typeof* `InitFragment` + +### JavascriptModulesPlugin + +#### Get Signature + +> **get** **JavascriptModulesPlugin**(): *typeof* `JavascriptModulesPlugin` + +##### Returns + +*typeof* `JavascriptModulesPlugin` + +### LibManifestPlugin + +#### Get Signature + +> **get** **LibManifestPlugin**(): *typeof* `LibManifestPlugin` + +##### Returns + +*typeof* `LibManifestPlugin` + +### LibraryTemplatePlugin + +#### Get Signature + +> **get** **LibraryTemplatePlugin**(): *typeof* `LibraryTemplatePlugin` + +##### Returns + +*typeof* `LibraryTemplatePlugin` + +### LoaderOptionsPlugin + +#### Get Signature + +> **get** **LoaderOptionsPlugin**(): *typeof* `LoaderOptionsPlugin` + +##### Returns + +*typeof* `LoaderOptionsPlugin` + +### LoaderTargetPlugin + +#### Get Signature + +> **get** **LoaderTargetPlugin**(): *typeof* `LoaderTargetPlugin` + +##### Returns + +*typeof* `LoaderTargetPlugin` + +### ManifestPlugin + +#### Get Signature + +> **get** **ManifestPlugin**(): *typeof* `ManifestPlugin` + +##### Returns + +*typeof* `ManifestPlugin` + +### Module + +#### Get Signature + +> **get** **Module**(): *typeof* `Module` + +##### Returns + +*typeof* `Module` + +### ModuleFactory + +#### Get Signature + +> **get** **ModuleFactory**(): *typeof* `ModuleFactory` + +##### Returns + +*typeof* `ModuleFactory` + +### ModuleFilenameHelpers + +#### Get Signature + +> **get** **ModuleFilenameHelpers**(): `__module` + +##### Returns + +`__module` + +### ModuleGraph + +#### Get Signature + +> **get** **ModuleGraph**(): *typeof* `ModuleGraph` + +##### Returns + +*typeof* `ModuleGraph` + +### ModuleGraphConnection + +#### Get Signature + +> **get** **ModuleGraphConnection**(): *typeof* `ModuleGraphConnection` + +##### Returns + +*typeof* `ModuleGraphConnection` + +### MultiCompiler + +#### Get Signature + +> **get** **MultiCompiler**(): *typeof* `MultiCompiler` + +##### Returns + +*typeof* `MultiCompiler` + +### NoEmitOnErrorsPlugin + +#### Get Signature + +> **get** **NoEmitOnErrorsPlugin**(): *typeof* `NoEmitOnErrorsPlugin` + +##### Returns + +*typeof* `NoEmitOnErrorsPlugin` + +### NormalModule + +#### Get Signature + +> **get** **NormalModule**(): *typeof* `NormalModule` + +##### Returns + +*typeof* `NormalModule` + +### NormalModuleReplacementPlugin + +#### Get Signature + +> **get** **NormalModuleReplacementPlugin**(): *typeof* `NormalModuleReplacementPlugin` + +##### Returns + +*typeof* `NormalModuleReplacementPlugin` + +### OptimizationStages + +#### Get Signature + +> **get** **OptimizationStages**(): `__module` + +##### Returns + +`__module` + +### Parser + +#### Get Signature + +> **get** **Parser**(): *typeof* `Parser` + +##### Returns + +*typeof* `Parser` + +### PlatformPlugin + +#### Get Signature + +> **get** **PlatformPlugin**(): *typeof* `PlatformPlugin` + +##### Returns + +*typeof* `PlatformPlugin` + +### PrefetchPlugin + +#### Get Signature + +> **get** **PrefetchPlugin**(): *typeof* `PrefetchPlugin` + +##### Returns + +*typeof* `PrefetchPlugin` + +### ProgressPlugin + +#### Get Signature + +> **get** **ProgressPlugin**(): *typeof* `ProgressPlugin` + +##### Returns + +*typeof* `ProgressPlugin` + +### ProvidePlugin + +#### Get Signature + +> **get** **ProvidePlugin**(): *typeof* `ProvidePlugin` + +##### Returns + +*typeof* `ProvidePlugin` + +### RuntimeGlobals + +#### Get Signature + +> **get** **RuntimeGlobals**(): `__module` + +##### Returns + +`__module` + +### RuntimeModule + +#### Get Signature + +> **get** **RuntimeModule**(): *typeof* `RuntimeModule` + +##### Returns + +*typeof* `RuntimeModule` + +### SingleEntryPlugin + +#### Get Signature + +> **get** **SingleEntryPlugin**(): *typeof* `EntryPlugin` + +##### Returns + +*typeof* `EntryPlugin` + +### SourceMapDevToolPlugin + +#### Get Signature + +> **get** **SourceMapDevToolPlugin**(): *typeof* `SourceMapDevToolPlugin` + +##### Returns + +*typeof* `SourceMapDevToolPlugin` + +### sources + +#### Get Signature + +> **get** **sources**(): *typeof* `exports` + +##### Returns + +*typeof* `exports` + +### Stats + +#### Get Signature + +> **get** **Stats**(): *typeof* `Stats` + +##### Returns + +*typeof* `Stats` + +### Template + +#### Get Signature + +> **get** **Template**(): *typeof* `Template` + +##### Returns + +*typeof* `Template` + +### UsageState + +#### Get Signature + +> **get** **UsageState**(): `Readonly`\<\{ `NoInfo`: `2`; `OnlyPropertiesUsed`: `1`; `Unknown`: `3`; `Unused`: `0`; `Used`: `4`; \}\> + +##### Returns + +`Readonly`\<\{ `NoInfo`: `2`; `OnlyPropertiesUsed`: `1`; `Unknown`: `3`; `Unused`: `0`; `Used`: `4`; \}\> + +### validate + +#### Get Signature + +> **get** **validate**(): (`configuration`) => `void` + +##### Returns + +validate fn + +> (`configuration`): `void` + +###### Parameters + +###### configuration + +[`Configuration`](../interfaces/Configuration.md) | [`MultiConfiguration`](../type-aliases/MultiConfiguration.md) + +###### Returns + +`void` + +### validateSchema + +#### Get Signature + +> **get** **validateSchema**(): (`schema`, `options`, `validationConfiguration`) => `void` + +##### Returns + +> (`schema`, `options`, `validationConfiguration`): `void` + +###### Parameters + +###### schema + +`Schema` + +a json schema + +###### options + +the options that should be validated + +`object` | `object`[] + +###### validationConfiguration + +`ValidationErrorConfiguration` + +configuration for generating errors + +###### Returns + +`void` + +### ValidationError + +#### Get Signature + +> **get** **ValidationError**(): *typeof* `ValidationError` + +##### Returns + +*typeof* `ValidationError` + +### version + +#### Get Signature + +> **get** **version**(): `string` + +##### Returns + +`string` + +### WatchIgnorePlugin + +#### Get Signature + +> **get** **WatchIgnorePlugin**(): *typeof* `WatchIgnorePlugin` + +##### Returns + +*typeof* `WatchIgnorePlugin` + +### webpack + +#### Get Signature + +> **get** **webpack**(): \{(`options`, `callback`): `Compiler`; (`options`): `Compiler`; (`options`, `callback`): `MultiCompiler`; (`options`): `MultiCompiler`; \} + +##### Returns + +> (`options`, `callback`): `Compiler` + +###### Parameters + +###### options + +[`Configuration`](../interfaces/Configuration.md) + +options object + +###### callback + +`Callback`\<`Stats`\> + +callback + +###### Returns + +`Compiler` + +the compiler object + +> (`options`): `Compiler` + +###### Parameters + +###### options + +[`Configuration`](../interfaces/Configuration.md) + +options object + +###### Returns + +`Compiler` + +the compiler object + +> (`options`, `callback`): `MultiCompiler` + +###### Parameters + +###### options + +[`MultiConfiguration`](../type-aliases/MultiConfiguration.md) + +options objects + +###### callback + +`Callback`\<`MultiStats`\> + +callback + +###### Returns + +`MultiCompiler` + +the multi compiler object + +> (`options`): `MultiCompiler` + +###### Parameters + +###### options + +[`MultiConfiguration`](../type-aliases/MultiConfiguration.md) + +options objects + +###### Returns + +`MultiCompiler` + +the multi compiler object + +### WebpackError + +#### Get Signature + +> **get** **WebpackError**(): *typeof* `WebpackError` + +##### Returns + +*typeof* `WebpackError` + +### WebpackOptionsApply + +#### Get Signature + +> **get** **WebpackOptionsApply**(): *typeof* `WebpackOptionsApply` + +##### Returns + +*typeof* `WebpackOptionsApply` + +### WebpackOptionsDefaulter + +#### Get Signature + +> **get** **WebpackOptionsDefaulter**(): *typeof* `WebpackOptionsDefaulter` + +##### Returns + +*typeof* `WebpackOptionsDefaulter` + +### WebpackOptionsValidationError + +#### Get Signature + +> **get** **WebpackOptionsValidationError**(): *typeof* `ValidationError` + +##### Returns + +*typeof* `ValidationError` diff --git a/package-lock.json b/package-lock.json new file mode 100644 index 0000000..0974dca --- /dev/null +++ b/package-lock.json @@ -0,0 +1,1223 @@ +{ + "name": "docs.webpack.js.org", + "lockfileVersion": 3, + "requires": true, + "packages": { + "": { + "devDependencies": { + "dedent": "^1.7.2", + "typedoc": "^0.28.17", + "typedoc-plugin-frontmatter": "^1.3.1", + "typedoc-plugin-markdown": "^4.10.0", + "webpack": "^5.105.4" + } + }, + "node_modules/@gerrit0/mini-shiki": { + "version": "3.23.0", + "resolved": "https://registry.npmjs.org/@gerrit0/mini-shiki/-/mini-shiki-3.23.0.tgz", + "integrity": "sha512-bEMORlG0cqdjVyCEuU0cDQbORWX+kYCeo0kV1lbxF5bt4r7SID2l9bqsxJEM0zndaxpOUT7riCyIVEuqq/Ynxg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@shikijs/engine-oniguruma": "^3.23.0", + "@shikijs/langs": "^3.23.0", + "@shikijs/themes": "^3.23.0", + "@shikijs/types": "^3.23.0", + "@shikijs/vscode-textmate": "^10.0.2" + } + }, + "node_modules/@jridgewell/gen-mapping": { + "version": "0.3.13", + "resolved": "https://registry.npmjs.org/@jridgewell/gen-mapping/-/gen-mapping-0.3.13.tgz", + "integrity": "sha512-2kkt/7niJ6MgEPxF0bYdQ6etZaA+fQvDcLKckhy1yIQOzaoKjBBjSj63/aLVjYE3qhRt5dvM+uUyfCg6UKCBbA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jridgewell/sourcemap-codec": "^1.5.0", + "@jridgewell/trace-mapping": "^0.3.24" + } + }, + "node_modules/@jridgewell/resolve-uri": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/@jridgewell/resolve-uri/-/resolve-uri-3.1.2.tgz", + "integrity": "sha512-bRISgCIjP20/tbWSPWMEi54QVPRZExkuD9lJL+UIxUKtwVJA8wW1Trb1jMs1RFXo1CBTNZ/5hpC9QvmKWdopKw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/@jridgewell/source-map": { + "version": "0.3.11", + "resolved": "https://registry.npmjs.org/@jridgewell/source-map/-/source-map-0.3.11.tgz", + "integrity": "sha512-ZMp1V8ZFcPG5dIWnQLr3NSI1MiCU7UETdS/A0G8V/XWHvJv3ZsFqutJn1Y5RPmAPX6F3BiE397OqveU/9NCuIA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jridgewell/gen-mapping": "^0.3.5", + "@jridgewell/trace-mapping": "^0.3.25" + } + }, + "node_modules/@jridgewell/sourcemap-codec": { + "version": "1.5.5", + "resolved": "https://registry.npmjs.org/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.5.5.tgz", + "integrity": "sha512-cYQ9310grqxueWbl+WuIUIaiUaDcj7WOq5fVhEljNVgRfOUhY9fy2zTvfoqWsnebh8Sl70VScFbICvJnLKB0Og==", + "dev": true, + "license": "MIT" + }, + "node_modules/@jridgewell/trace-mapping": { + "version": "0.3.31", + "resolved": "https://registry.npmjs.org/@jridgewell/trace-mapping/-/trace-mapping-0.3.31.tgz", + "integrity": "sha512-zzNR+SdQSDJzc8joaeP8QQoCQr8NuYx2dIIytl1QeBEZHJ9uW6hebsrYgbz8hJwUQao3TWCMtmfV8Nu1twOLAw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jridgewell/resolve-uri": "^3.1.0", + "@jridgewell/sourcemap-codec": "^1.4.14" + } + }, + "node_modules/@shikijs/engine-oniguruma": { + "version": "3.23.0", + "resolved": "https://registry.npmjs.org/@shikijs/engine-oniguruma/-/engine-oniguruma-3.23.0.tgz", + "integrity": "sha512-1nWINwKXxKKLqPibT5f4pAFLej9oZzQTsby8942OTlsJzOBZ0MWKiwzMsd+jhzu8YPCHAswGnnN1YtQfirL35g==", + "dev": true, + "license": "MIT", + "dependencies": { + "@shikijs/types": "3.23.0", + "@shikijs/vscode-textmate": "^10.0.2" + } + }, + "node_modules/@shikijs/langs": { + "version": "3.23.0", + "resolved": "https://registry.npmjs.org/@shikijs/langs/-/langs-3.23.0.tgz", + "integrity": "sha512-2Ep4W3Re5aB1/62RSYQInK9mM3HsLeB91cHqznAJMuylqjzNVAVCMnNWRHFtcNHXsoNRayP9z1qj4Sq3nMqYXg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@shikijs/types": "3.23.0" + } + }, + "node_modules/@shikijs/themes": { + "version": "3.23.0", + "resolved": "https://registry.npmjs.org/@shikijs/themes/-/themes-3.23.0.tgz", + "integrity": "sha512-5qySYa1ZgAT18HR/ypENL9cUSGOeI2x+4IvYJu4JgVJdizn6kG4ia5Q1jDEOi7gTbN4RbuYtmHh0W3eccOrjMA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@shikijs/types": "3.23.0" + } + }, + "node_modules/@shikijs/types": { + "version": "3.23.0", + "resolved": "https://registry.npmjs.org/@shikijs/types/-/types-3.23.0.tgz", + "integrity": "sha512-3JZ5HXOZfYjsYSk0yPwBrkupyYSLpAE26Qc0HLghhZNGTZg/SKxXIIgoxOpmmeQP0RRSDJTk1/vPfw9tbw+jSQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@shikijs/vscode-textmate": "^10.0.2", + "@types/hast": "^3.0.4" + } + }, + "node_modules/@shikijs/vscode-textmate": { + "version": "10.0.2", + "resolved": "https://registry.npmjs.org/@shikijs/vscode-textmate/-/vscode-textmate-10.0.2.tgz", + "integrity": "sha512-83yeghZ2xxin3Nj8z1NMd/NCuca+gsYXswywDy5bHvwlWL8tpTQmzGeUuHd9FC3E/SBEMvzJRwWEOz5gGes9Qg==", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/eslint": { + "version": "9.6.1", + "resolved": "https://registry.npmjs.org/@types/eslint/-/eslint-9.6.1.tgz", + "integrity": "sha512-FXx2pKgId/WyYo2jXw63kk7/+TY7u7AziEJxJAnSFzHlqTAS3Ync6SvgYAN/k4/PQpnnVuzoMuVnByKK2qp0ag==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/estree": "*", + "@types/json-schema": "*" + } + }, + "node_modules/@types/eslint-scope": { + "version": "3.7.7", + "resolved": "https://registry.npmjs.org/@types/eslint-scope/-/eslint-scope-3.7.7.tgz", + "integrity": "sha512-MzMFlSLBqNF2gcHWO0G1vP/YQyfvrxZ0bF+u7mzUdZ1/xK4A4sru+nraZz5i3iEIk1l1uyicaDVTB4QbbEkAYg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/eslint": "*", + "@types/estree": "*" + } + }, + "node_modules/@types/estree": { + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/@types/estree/-/estree-1.0.8.tgz", + "integrity": "sha512-dWHzHa2WqEXI/O1E9OjrocMTKJl2mSrEolh1Iomrv6U+JuNwaHXsXx9bLu5gG7BUWFIN0skIQJQ/L1rIex4X6w==", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/hast": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@types/hast/-/hast-3.0.4.tgz", + "integrity": "sha512-WPs+bbQw5aCj+x6laNGWLH3wviHtoCv/P3+otBhbOhJgG8qtpdAMlTCxLtsTWA7LH1Oh/bFCHsBn0TPS5m30EQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/unist": "*" + } + }, + "node_modules/@types/json-schema": { + "version": "7.0.15", + "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.15.tgz", + "integrity": "sha512-5+fP8P8MFNC+AyZCDxrB2pkZFPGzqQWUzpSeuuVLvm8VMcorNYavBqoFcxK8bQz4Qsbn4oUEEem4wDLfcysGHA==", + "dev": true, + "license": "MIT" + }, + "node_modules/@types/node": { + "version": "25.3.5", + "resolved": "https://registry.npmjs.org/@types/node/-/node-25.3.5.tgz", + "integrity": "sha512-oX8xrhvpiyRCQkG1MFchB09f+cXftgIXb3a7UUa4Y3wpmZPw5tyZGTLWhlESOLq1Rq6oDlc8npVU2/9xiCuXMA==", + "dev": true, + "license": "MIT", + "dependencies": { + "undici-types": "~7.18.0" + } + }, + "node_modules/@types/unist": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/@types/unist/-/unist-3.0.3.tgz", + "integrity": "sha512-ko/gIFJRv177XgZsZcBwnqJN5x/Gien8qNOn0D5bQU/zAzVf9Zt3BlcUiLqhV9y4ARk0GbT3tnUiPNgnTXzc/Q==", + "dev": true, + "license": "MIT" + }, + "node_modules/@webassemblyjs/ast": { + "version": "1.14.1", + "resolved": "https://registry.npmjs.org/@webassemblyjs/ast/-/ast-1.14.1.tgz", + "integrity": "sha512-nuBEDgQfm1ccRp/8bCQrx1frohyufl4JlbMMZ4P1wpeOfDhF6FQkxZJ1b/e+PLwr6X1Nhw6OLme5usuBWYBvuQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@webassemblyjs/helper-numbers": "1.13.2", + "@webassemblyjs/helper-wasm-bytecode": "1.13.2" + } + }, + "node_modules/@webassemblyjs/floating-point-hex-parser": { + "version": "1.13.2", + "resolved": "https://registry.npmjs.org/@webassemblyjs/floating-point-hex-parser/-/floating-point-hex-parser-1.13.2.tgz", + "integrity": "sha512-6oXyTOzbKxGH4steLbLNOu71Oj+C8Lg34n6CqRvqfS2O71BxY6ByfMDRhBytzknj9yGUPVJ1qIKhRlAwO1AovA==", + "dev": true, + "license": "MIT" + }, + "node_modules/@webassemblyjs/helper-api-error": { + "version": "1.13.2", + "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-api-error/-/helper-api-error-1.13.2.tgz", + "integrity": "sha512-U56GMYxy4ZQCbDZd6JuvvNV/WFildOjsaWD3Tzzvmw/mas3cXzRJPMjP83JqEsgSbyrmaGjBfDtV7KDXV9UzFQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/@webassemblyjs/helper-buffer": { + "version": "1.14.1", + "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-buffer/-/helper-buffer-1.14.1.tgz", + "integrity": "sha512-jyH7wtcHiKssDtFPRB+iQdxlDf96m0E39yb0k5uJVhFGleZFoNw1c4aeIcVUPPbXUVJ94wwnMOAqUHyzoEPVMA==", + "dev": true, + "license": "MIT" + }, + "node_modules/@webassemblyjs/helper-numbers": { + "version": "1.13.2", + "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-numbers/-/helper-numbers-1.13.2.tgz", + "integrity": "sha512-FE8aCmS5Q6eQYcV3gI35O4J789wlQA+7JrqTTpJqn5emA4U2hvwJmvFRC0HODS+3Ye6WioDklgd6scJ3+PLnEA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@webassemblyjs/floating-point-hex-parser": "1.13.2", + "@webassemblyjs/helper-api-error": "1.13.2", + "@xtuc/long": "4.2.2" + } + }, + "node_modules/@webassemblyjs/helper-wasm-bytecode": { + "version": "1.13.2", + "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-wasm-bytecode/-/helper-wasm-bytecode-1.13.2.tgz", + "integrity": "sha512-3QbLKy93F0EAIXLh0ogEVR6rOubA9AoZ+WRYhNbFyuB70j3dRdwH9g+qXhLAO0kiYGlg3TxDV+I4rQTr/YNXkA==", + "dev": true, + "license": "MIT" + }, + "node_modules/@webassemblyjs/helper-wasm-section": { + "version": "1.14.1", + "resolved": "https://registry.npmjs.org/@webassemblyjs/helper-wasm-section/-/helper-wasm-section-1.14.1.tgz", + "integrity": "sha512-ds5mXEqTJ6oxRoqjhWDU83OgzAYjwsCV8Lo/N+oRsNDmx/ZDpqalmrtgOMkHwxsG0iI//3BwWAErYRHtgn0dZw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@webassemblyjs/ast": "1.14.1", + "@webassemblyjs/helper-buffer": "1.14.1", + "@webassemblyjs/helper-wasm-bytecode": "1.13.2", + "@webassemblyjs/wasm-gen": "1.14.1" + } + }, + "node_modules/@webassemblyjs/ieee754": { + "version": "1.13.2", + "resolved": "https://registry.npmjs.org/@webassemblyjs/ieee754/-/ieee754-1.13.2.tgz", + "integrity": "sha512-4LtOzh58S/5lX4ITKxnAK2USuNEvpdVV9AlgGQb8rJDHaLeHciwG4zlGr0j/SNWlr7x3vO1lDEsuePvtcDNCkw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@xtuc/ieee754": "^1.2.0" + } + }, + "node_modules/@webassemblyjs/leb128": { + "version": "1.13.2", + "resolved": "https://registry.npmjs.org/@webassemblyjs/leb128/-/leb128-1.13.2.tgz", + "integrity": "sha512-Lde1oNoIdzVzdkNEAWZ1dZ5orIbff80YPdHx20mrHwHrVNNTjNr8E3xz9BdpcGqRQbAEa+fkrCb+fRFTl/6sQw==", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "@xtuc/long": "4.2.2" + } + }, + "node_modules/@webassemblyjs/utf8": { + "version": "1.13.2", + "resolved": "https://registry.npmjs.org/@webassemblyjs/utf8/-/utf8-1.13.2.tgz", + "integrity": "sha512-3NQWGjKTASY1xV5m7Hr0iPeXD9+RDobLll3T9d2AO+g3my8xy5peVyjSag4I50mR1bBSN/Ct12lo+R9tJk0NZQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/@webassemblyjs/wasm-edit": { + "version": "1.14.1", + "resolved": "https://registry.npmjs.org/@webassemblyjs/wasm-edit/-/wasm-edit-1.14.1.tgz", + "integrity": "sha512-RNJUIQH/J8iA/1NzlE4N7KtyZNHi3w7at7hDjvRNm5rcUXa00z1vRz3glZoULfJ5mpvYhLybmVcwcjGrC1pRrQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@webassemblyjs/ast": "1.14.1", + "@webassemblyjs/helper-buffer": "1.14.1", + "@webassemblyjs/helper-wasm-bytecode": "1.13.2", + "@webassemblyjs/helper-wasm-section": "1.14.1", + "@webassemblyjs/wasm-gen": "1.14.1", + "@webassemblyjs/wasm-opt": "1.14.1", + "@webassemblyjs/wasm-parser": "1.14.1", + "@webassemblyjs/wast-printer": "1.14.1" + } + }, + "node_modules/@webassemblyjs/wasm-gen": { + "version": "1.14.1", + "resolved": "https://registry.npmjs.org/@webassemblyjs/wasm-gen/-/wasm-gen-1.14.1.tgz", + "integrity": "sha512-AmomSIjP8ZbfGQhumkNvgC33AY7qtMCXnN6bL2u2Js4gVCg8fp735aEiMSBbDR7UQIj90n4wKAFUSEd0QN2Ukg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@webassemblyjs/ast": "1.14.1", + "@webassemblyjs/helper-wasm-bytecode": "1.13.2", + "@webassemblyjs/ieee754": "1.13.2", + "@webassemblyjs/leb128": "1.13.2", + "@webassemblyjs/utf8": "1.13.2" + } + }, + "node_modules/@webassemblyjs/wasm-opt": { + "version": "1.14.1", + "resolved": "https://registry.npmjs.org/@webassemblyjs/wasm-opt/-/wasm-opt-1.14.1.tgz", + "integrity": "sha512-PTcKLUNvBqnY2U6E5bdOQcSM+oVP/PmrDY9NzowJjislEjwP/C4an2303MCVS2Mg9d3AJpIGdUFIQQWbPds0Sw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@webassemblyjs/ast": "1.14.1", + "@webassemblyjs/helper-buffer": "1.14.1", + "@webassemblyjs/wasm-gen": "1.14.1", + "@webassemblyjs/wasm-parser": "1.14.1" + } + }, + "node_modules/@webassemblyjs/wasm-parser": { + "version": "1.14.1", + "resolved": "https://registry.npmjs.org/@webassemblyjs/wasm-parser/-/wasm-parser-1.14.1.tgz", + "integrity": "sha512-JLBl+KZ0R5qB7mCnud/yyX08jWFw5MsoalJ1pQ4EdFlgj9VdXKGuENGsiCIjegI1W7p91rUlcB/LB5yRJKNTcQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@webassemblyjs/ast": "1.14.1", + "@webassemblyjs/helper-api-error": "1.13.2", + "@webassemblyjs/helper-wasm-bytecode": "1.13.2", + "@webassemblyjs/ieee754": "1.13.2", + "@webassemblyjs/leb128": "1.13.2", + "@webassemblyjs/utf8": "1.13.2" + } + }, + "node_modules/@webassemblyjs/wast-printer": { + "version": "1.14.1", + "resolved": "https://registry.npmjs.org/@webassemblyjs/wast-printer/-/wast-printer-1.14.1.tgz", + "integrity": "sha512-kPSSXE6De1XOR820C90RIo2ogvZG+c3KiHzqUoO/F34Y2shGzesfqv7o57xrxovZJH/MetF5UjroJ/R/3isoiw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@webassemblyjs/ast": "1.14.1", + "@xtuc/long": "4.2.2" + } + }, + "node_modules/@xtuc/ieee754": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/@xtuc/ieee754/-/ieee754-1.2.0.tgz", + "integrity": "sha512-DX8nKgqcGwsc0eJSqYt5lwP4DH5FlHnmuWWBRy7X0NcaGR0ZtuyeESgMwTYVEtxmsNGY+qit4QYT/MIYTOTPeA==", + "dev": true, + "license": "BSD-3-Clause" + }, + "node_modules/@xtuc/long": { + "version": "4.2.2", + "resolved": "https://registry.npmjs.org/@xtuc/long/-/long-4.2.2.tgz", + "integrity": "sha512-NuHqBY1PB/D8xU6s/thBgOAiAP7HOYDQ32+BFZILJ8ivkUkAHQnWfn6WhL79Owj1qmUnoN/YPhktdIoucipkAQ==", + "dev": true, + "license": "Apache-2.0" + }, + "node_modules/acorn": { + "version": "8.16.0", + "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.16.0.tgz", + "integrity": "sha512-UVJyE9MttOsBQIDKw1skb9nAwQuR5wuGD3+82K6JgJlm/Y+KI92oNsMNGZCYdDsVtRHSak0pcV5Dno5+4jh9sw==", + "dev": true, + "license": "MIT", + "bin": { + "acorn": "bin/acorn" + }, + "engines": { + "node": ">=0.4.0" + } + }, + "node_modules/acorn-import-phases": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/acorn-import-phases/-/acorn-import-phases-1.0.4.tgz", + "integrity": "sha512-wKmbr/DDiIXzEOiWrTTUcDm24kQ2vGfZQvM2fwg2vXqR5uW6aapr7ObPtj1th32b9u90/Pf4AItvdTh42fBmVQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=10.13.0" + }, + "peerDependencies": { + "acorn": "^8.14.0" + } + }, + "node_modules/ajv": { + "version": "8.18.0", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.18.0.tgz", + "integrity": "sha512-PlXPeEWMXMZ7sPYOHqmDyCJzcfNrUr3fGNKtezX14ykXOEIvyK81d+qydx89KY5O71FKMPaQ2vBfBFI5NHR63A==", + "dev": true, + "license": "MIT", + "dependencies": { + "fast-deep-equal": "^3.1.3", + "fast-uri": "^3.0.1", + "json-schema-traverse": "^1.0.0", + "require-from-string": "^2.0.2" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" + } + }, + "node_modules/ajv-formats": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/ajv-formats/-/ajv-formats-2.1.1.tgz", + "integrity": "sha512-Wx0Kx52hxE7C18hkMEggYlEifqWZtYaRgouJor+WMdPnQyEK13vgEWyVNup7SoeeoLMsr4kf5h6dOW11I15MUA==", + "dev": true, + "license": "MIT", + "dependencies": { + "ajv": "^8.0.0" + }, + "peerDependencies": { + "ajv": "^8.0.0" + }, + "peerDependenciesMeta": { + "ajv": { + "optional": true + } + } + }, + "node_modules/ajv-keywords": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/ajv-keywords/-/ajv-keywords-5.1.0.tgz", + "integrity": "sha512-YCS/JNFAUyr5vAuhk1DWm1CBxRHW9LbJ2ozWeemrIqpbsqKjHVxYPyi5GC0rjZIT5JxJ3virVTS8wk4i/Z+krw==", + "dev": true, + "license": "MIT", + "dependencies": { + "fast-deep-equal": "^3.1.3" + }, + "peerDependencies": { + "ajv": "^8.8.2" + } + }, + "node_modules/argparse": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", + "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", + "dev": true, + "license": "Python-2.0" + }, + "node_modules/balanced-match": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz", + "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==", + "dev": true, + "license": "MIT" + }, + "node_modules/baseline-browser-mapping": { + "version": "2.10.0", + "resolved": "https://registry.npmjs.org/baseline-browser-mapping/-/baseline-browser-mapping-2.10.0.tgz", + "integrity": "sha512-lIyg0szRfYbiy67j9KN8IyeD7q7hcmqnJ1ddWmNt19ItGpNN64mnllmxUNFIOdOm6by97jlL6wfpTTJrmnjWAA==", + "dev": true, + "license": "Apache-2.0", + "bin": { + "baseline-browser-mapping": "dist/cli.cjs" + }, + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/brace-expansion": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.2.tgz", + "integrity": "sha512-Jt0vHyM+jmUBqojB7E1NIYadt0vI0Qxjxd2TErW94wDz+E2LAm5vKMXXwg6ZZBTHPuUlDgQHKXvjGBdfcF1ZDQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "balanced-match": "^1.0.0" + } + }, + "node_modules/browserslist": { + "version": "4.28.1", + "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.28.1.tgz", + "integrity": "sha512-ZC5Bd0LgJXgwGqUknZY/vkUQ04r8NXnJZ3yYi4vDmSiZmC/pdSN0NbNRPxZpbtO4uAfDUAFffO8IZoM3Gj8IkA==", + "dev": true, + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/browserslist" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/browserslist" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "MIT", + "dependencies": { + "baseline-browser-mapping": "^2.9.0", + "caniuse-lite": "^1.0.30001759", + "electron-to-chromium": "^1.5.263", + "node-releases": "^2.0.27", + "update-browserslist-db": "^1.2.0" + }, + "bin": { + "browserslist": "cli.js" + }, + "engines": { + "node": "^6 || ^7 || ^8 || ^9 || ^10 || ^11 || ^12 || >=13.7" + } + }, + "node_modules/buffer-from": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/buffer-from/-/buffer-from-1.1.2.tgz", + "integrity": "sha512-E+XQCRwSbaaiChtv6k6Dwgc+bx+Bs6vuKJHHl5kox/BaKbhiXzqQOwK4cO22yElGp2OCmjwVhT3HmxgyPGnJfQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/caniuse-lite": { + "version": "1.0.30001777", + "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001777.tgz", + "integrity": "sha512-tmN+fJxroPndC74efCdp12j+0rk0RHwV5Jwa1zWaFVyw2ZxAuPeG8ZgWC3Wz7uSjT3qMRQ5XHZ4COgQmsCMJAQ==", + "dev": true, + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/browserslist" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/caniuse-lite" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "CC-BY-4.0" + }, + "node_modules/chrome-trace-event": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/chrome-trace-event/-/chrome-trace-event-1.0.4.tgz", + "integrity": "sha512-rNjApaLzuwaOTjCiT8lSDdGN1APCiqkChLMJxJPWLunPAt5fy8xgU9/jNOchV84wfIxrA0lRQB7oCT8jrn/wrQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6.0" + } + }, + "node_modules/commander": { + "version": "2.20.3", + "resolved": "https://registry.npmjs.org/commander/-/commander-2.20.3.tgz", + "integrity": "sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ==", + "dev": true, + "license": "MIT" + }, + "node_modules/dedent": { + "version": "1.7.2", + "resolved": "https://registry.npmjs.org/dedent/-/dedent-1.7.2.tgz", + "integrity": "sha512-WzMx3mW98SN+zn3hgemf4OzdmyNhhhKz5Ay0pUfQiMQ3e1g+xmTJWp/pKdwKVXhdSkAEGIIzqeuWrL3mV/AXbA==", + "dev": true, + "license": "MIT", + "peerDependencies": { + "babel-plugin-macros": "^3.1.0" + }, + "peerDependenciesMeta": { + "babel-plugin-macros": { + "optional": true + } + } + }, + "node_modules/electron-to-chromium": { + "version": "1.5.307", + "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.307.tgz", + "integrity": "sha512-5z3uFKBWjiNR44nFcYdkcXjKMbg5KXNdciu7mhTPo9tB7NbqSNP2sSnGR+fqknZSCwKkBN+oxiiajWs4dT6ORg==", + "dev": true, + "license": "ISC" + }, + "node_modules/enhanced-resolve": { + "version": "5.20.0", + "resolved": "https://registry.npmjs.org/enhanced-resolve/-/enhanced-resolve-5.20.0.tgz", + "integrity": "sha512-/ce7+jQ1PQ6rVXwe+jKEg5hW5ciicHwIQUagZkp6IufBoY3YDgdTTY1azVs0qoRgVmvsNB+rbjLJxDAeHHtwsQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "graceful-fs": "^4.2.4", + "tapable": "^2.3.0" + }, + "engines": { + "node": ">=10.13.0" + } + }, + "node_modules/entities": { + "version": "4.5.0", + "resolved": "https://registry.npmjs.org/entities/-/entities-4.5.0.tgz", + "integrity": "sha512-V0hjH4dGPh9Ao5p0MoRY6BVqtwCjhz6vI5LT8AJ55H+4g9/4vbHx1I54fS0XuclLhDHArPQCiMjDxjaL8fPxhw==", + "dev": true, + "license": "BSD-2-Clause", + "engines": { + "node": ">=0.12" + }, + "funding": { + "url": "https://github.com/fb55/entities?sponsor=1" + } + }, + "node_modules/es-module-lexer": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/es-module-lexer/-/es-module-lexer-2.0.0.tgz", + "integrity": "sha512-5POEcUuZybH7IdmGsD8wlf0AI55wMecM9rVBTI/qEAy2c1kTOm3DjFYjrBdI2K3BaJjJYfYFeRtM0t9ssnRuxw==", + "dev": true, + "license": "MIT" + }, + "node_modules/escalade": { + "version": "3.2.0", + "resolved": "https://registry.npmjs.org/escalade/-/escalade-3.2.0.tgz", + "integrity": "sha512-WUj2qlxaQtO4g6Pq5c29GTcWGDyd8itL8zTlipgECz3JesAiiOKotd8JU6otB3PACgG6xkJUyVhboMS+bje/jA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/eslint-scope": { + "version": "5.1.1", + "resolved": "https://registry.npmjs.org/eslint-scope/-/eslint-scope-5.1.1.tgz", + "integrity": "sha512-2NxwbF/hZ0KpepYN0cNbo+FN6XoK7GaHlQhgx/hIZl6Va0bF45RQOOwhLIy8lQDbuCiadSLCBnH2CFYquit5bw==", + "dev": true, + "license": "BSD-2-Clause", + "dependencies": { + "esrecurse": "^4.3.0", + "estraverse": "^4.1.1" + }, + "engines": { + "node": ">=8.0.0" + } + }, + "node_modules/esrecurse": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/esrecurse/-/esrecurse-4.3.0.tgz", + "integrity": "sha512-KmfKL3b6G+RXvP8N1vr3Tq1kL/oCFgn2NYXEtqP8/L3pKapUA4G8cFVaoF3SU323CD4XypR/ffioHmkti6/Tag==", + "dev": true, + "license": "BSD-2-Clause", + "dependencies": { + "estraverse": "^5.2.0" + }, + "engines": { + "node": ">=4.0" + } + }, + "node_modules/esrecurse/node_modules/estraverse": { + "version": "5.3.0", + "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-5.3.0.tgz", + "integrity": "sha512-MMdARuVEQziNTeJD8DgMqmhwR11BRQ/cBP+pLtYdSTnf3MIO8fFeiINEbX36ZdNlfU/7A9f3gUw49B3oQsvwBA==", + "dev": true, + "license": "BSD-2-Clause", + "engines": { + "node": ">=4.0" + } + }, + "node_modules/estraverse": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-4.3.0.tgz", + "integrity": "sha512-39nnKffWz8xN1BU/2c79n9nB9HDzo0niYUqx6xyqUnyoAnQyyWpOTdZEeiCch8BBu515t4wp9ZmgVfVhn9EBpw==", + "dev": true, + "license": "BSD-2-Clause", + "engines": { + "node": ">=4.0" + } + }, + "node_modules/events": { + "version": "3.3.0", + "resolved": "https://registry.npmjs.org/events/-/events-3.3.0.tgz", + "integrity": "sha512-mQw+2fkQbALzQ7V0MY0IqdnXNOeTtP4r0lN9z7AAawCXgqea7bDii20AYrIBrFd/Hx0M2Ocz6S111CaFkUcb0Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.8.x" + } + }, + "node_modules/fast-deep-equal": { + "version": "3.1.3", + "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz", + "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==", + "dev": true, + "license": "MIT" + }, + "node_modules/fast-uri": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/fast-uri/-/fast-uri-3.1.0.tgz", + "integrity": "sha512-iPeeDKJSWf4IEOasVVrknXpaBV0IApz/gp7S2bb7Z4Lljbl2MGJRqInZiUrQwV16cpzw/D3S5j5Julj/gT52AA==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/fastify" + }, + { + "type": "opencollective", + "url": "https://opencollective.com/fastify" + } + ], + "license": "BSD-3-Clause" + }, + "node_modules/glob-to-regexp": { + "version": "0.4.1", + "resolved": "https://registry.npmjs.org/glob-to-regexp/-/glob-to-regexp-0.4.1.tgz", + "integrity": "sha512-lkX1HJXwyMcprw/5YUZc2s7DrpAiHB21/V+E1rHUrVNokkvB6bqMzT0VfV6/86ZNabt1k14YOIaT7nDvOX3Iiw==", + "dev": true, + "license": "BSD-2-Clause" + }, + "node_modules/graceful-fs": { + "version": "4.2.11", + "resolved": "https://registry.npmjs.org/graceful-fs/-/graceful-fs-4.2.11.tgz", + "integrity": "sha512-RbJ5/jmFcNNCcDV5o9eTnBLJ/HszWV0P73bc+Ff4nS/rJj+YaS6IGyiOL0VoBYX+l1Wrl3k63h/KrH+nhJ0XvQ==", + "dev": true, + "license": "ISC" + }, + "node_modules/has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/jest-worker": { + "version": "27.5.1", + "resolved": "https://registry.npmjs.org/jest-worker/-/jest-worker-27.5.1.tgz", + "integrity": "sha512-7vuh85V5cdDofPyxn58nrPjBktZo0u9x1g8WtjQol+jZDaE+fhN+cIvTj11GndBnMnyfrUOG1sZQxCdjKh+DKg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/node": "*", + "merge-stream": "^2.0.0", + "supports-color": "^8.0.0" + }, + "engines": { + "node": ">= 10.13.0" + } + }, + "node_modules/json-parse-even-better-errors": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/json-parse-even-better-errors/-/json-parse-even-better-errors-2.3.1.tgz", + "integrity": "sha512-xyFwyhro/JEof6Ghe2iz2NcXoj2sloNsWr/XsERDK/oiPCfaNhl5ONfp+jQdAZRQQ0IJWNzH9zIZF7li91kh2w==", + "dev": true, + "license": "MIT" + }, + "node_modules/json-schema-traverse": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz", + "integrity": "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug==", + "dev": true, + "license": "MIT" + }, + "node_modules/linkify-it": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/linkify-it/-/linkify-it-5.0.0.tgz", + "integrity": "sha512-5aHCbzQRADcdP+ATqnDuhhJ/MRIqDkZX5pyjFHRRysS8vZ5AbqGEoFIb6pYHPZ+L/OC2Lc+xT8uHVVR5CAK/wQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "uc.micro": "^2.0.0" + } + }, + "node_modules/loader-runner": { + "version": "4.3.1", + "resolved": "https://registry.npmjs.org/loader-runner/-/loader-runner-4.3.1.tgz", + "integrity": "sha512-IWqP2SCPhyVFTBtRcgMHdzlf9ul25NwaFx4wCEH/KjAXuuHY4yNjvPXsBokp8jCB936PyWRaPKUNh8NvylLp2Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6.11.5" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + } + }, + "node_modules/lunr": { + "version": "2.3.9", + "resolved": "https://registry.npmjs.org/lunr/-/lunr-2.3.9.tgz", + "integrity": "sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==", + "dev": true, + "license": "MIT" + }, + "node_modules/markdown-it": { + "version": "14.1.1", + "resolved": "https://registry.npmjs.org/markdown-it/-/markdown-it-14.1.1.tgz", + "integrity": "sha512-BuU2qnTti9YKgK5N+IeMubp14ZUKUUw7yeJbkjtosvHiP0AZ5c8IAgEMk79D0eC8F23r4Ac/q8cAIFdm2FtyoA==", + "dev": true, + "license": "MIT", + "dependencies": { + "argparse": "^2.0.1", + "entities": "^4.4.0", + "linkify-it": "^5.0.0", + "mdurl": "^2.0.0", + "punycode.js": "^2.3.1", + "uc.micro": "^2.1.0" + }, + "bin": { + "markdown-it": "bin/markdown-it.mjs" + } + }, + "node_modules/mdurl": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/mdurl/-/mdurl-2.0.0.tgz", + "integrity": "sha512-Lf+9+2r+Tdp5wXDXC4PcIBjTDtq4UKjCPMQhKIuzpJNW0b96kVqSwW0bT7FhRSfmAiFYgP+SCRvdrDozfh0U5w==", + "dev": true, + "license": "MIT" + }, + "node_modules/merge-stream": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/merge-stream/-/merge-stream-2.0.0.tgz", + "integrity": "sha512-abv/qOcuPfk3URPfDzmZU1LKmuw8kT+0nIHvKrKgFrwifol/doWcdA4ZqsWQ8ENrFKkd67Mfpo/LovbIUsbt3w==", + "dev": true, + "license": "MIT" + }, + "node_modules/mime-db": { + "version": "1.52.0", + "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.52.0.tgz", + "integrity": "sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/mime-types": { + "version": "2.1.35", + "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.35.tgz", + "integrity": "sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw==", + "dev": true, + "license": "MIT", + "dependencies": { + "mime-db": "1.52.0" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/minimatch": { + "version": "9.0.9", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.9.tgz", + "integrity": "sha512-OBwBN9AL4dqmETlpS2zasx+vTeWclWzkblfZk7KTA5j3jeOONz/tRCnZomUyvNg83wL5Zv9Ss6HMJXAgL8R2Yg==", + "dev": true, + "license": "ISC", + "dependencies": { + "brace-expansion": "^2.0.2" + }, + "engines": { + "node": ">=16 || 14 >=14.17" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/neo-async": { + "version": "2.6.2", + "resolved": "https://registry.npmjs.org/neo-async/-/neo-async-2.6.2.tgz", + "integrity": "sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw==", + "dev": true, + "license": "MIT" + }, + "node_modules/node-releases": { + "version": "2.0.36", + "resolved": "https://registry.npmjs.org/node-releases/-/node-releases-2.0.36.tgz", + "integrity": "sha512-TdC8FSgHz8Mwtw9g5L4gR/Sh9XhSP/0DEkQxfEFXOpiul5IiHgHan2VhYYb6agDSfp4KuvltmGApc8HMgUrIkA==", + "dev": true, + "license": "MIT" + }, + "node_modules/picocolors": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.1.1.tgz", + "integrity": "sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA==", + "dev": true, + "license": "ISC" + }, + "node_modules/punycode.js": { + "version": "2.3.1", + "resolved": "https://registry.npmjs.org/punycode.js/-/punycode.js-2.3.1.tgz", + "integrity": "sha512-uxFIHU0YlHYhDQtV4R9J6a52SLx28BCjT+4ieh7IGbgwVJWO+km431c4yRlREUAsAmt/uMjQUyQHNEPf0M39CA==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/require-from-string": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/require-from-string/-/require-from-string-2.0.2.tgz", + "integrity": "sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/schema-utils": { + "version": "4.3.3", + "resolved": "https://registry.npmjs.org/schema-utils/-/schema-utils-4.3.3.tgz", + "integrity": "sha512-eflK8wEtyOE6+hsaRVPxvUKYCpRgzLqDTb8krvAsRIwOGlHoSgYLgBXoubGgLd2fT41/OUYdb48v4k4WWHQurA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/json-schema": "^7.0.9", + "ajv": "^8.9.0", + "ajv-formats": "^2.1.1", + "ajv-keywords": "^5.1.0" + }, + "engines": { + "node": ">= 10.13.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + } + }, + "node_modules/source-map": { + "version": "0.6.1", + "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", + "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", + "dev": true, + "license": "BSD-3-Clause", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/source-map-support": { + "version": "0.5.21", + "resolved": "https://registry.npmjs.org/source-map-support/-/source-map-support-0.5.21.tgz", + "integrity": "sha512-uBHU3L3czsIyYXKX88fdrGovxdSCoTGDRZ6SYXtSRxLZUzHg5P/66Ht6uoUlHu9EZod+inXhKo3qQgwXUT/y1w==", + "dev": true, + "license": "MIT", + "dependencies": { + "buffer-from": "^1.0.0", + "source-map": "^0.6.0" + } + }, + "node_modules/supports-color": { + "version": "8.1.1", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-8.1.1.tgz", + "integrity": "sha512-MpUEN2OodtUzxvKQl72cUF7RQ5EiHsGvSsVG0ia9c5RbWGL2CI4C7EpPS8UTBIplnlzZiNuV56w+FuNxy3ty2Q==", + "dev": true, + "license": "MIT", + "dependencies": { + "has-flag": "^4.0.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/supports-color?sponsor=1" + } + }, + "node_modules/tapable": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/tapable/-/tapable-2.3.0.tgz", + "integrity": "sha512-g9ljZiwki/LfxmQADO3dEY1CbpmXT5Hm2fJ+QaGKwSXUylMybePR7/67YW7jOrrvjEgL1Fmz5kzyAjWVWLlucg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + } + }, + "node_modules/terser": { + "version": "5.46.0", + "resolved": "https://registry.npmjs.org/terser/-/terser-5.46.0.tgz", + "integrity": "sha512-jTwoImyr/QbOWFFso3YoU3ik0jBBDJ6JTOQiy/J2YxVJdZCc+5u7skhNwiOR3FQIygFqVUPHl7qbbxtjW2K3Qg==", + "dev": true, + "license": "BSD-2-Clause", + "dependencies": { + "@jridgewell/source-map": "^0.3.3", + "acorn": "^8.15.0", + "commander": "^2.20.0", + "source-map-support": "~0.5.20" + }, + "bin": { + "terser": "bin/terser" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/terser-webpack-plugin": { + "version": "5.3.17", + "resolved": "https://registry.npmjs.org/terser-webpack-plugin/-/terser-webpack-plugin-5.3.17.tgz", + "integrity": "sha512-YR7PtUp6GMU91BgSJmlaX/rS2lGDbAF7D+Wtq7hRO+MiljNmodYvqslzCFiYVAgW+Qoaaia/QUIP4lGXufjdZw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jridgewell/trace-mapping": "^0.3.25", + "jest-worker": "^27.4.5", + "schema-utils": "^4.3.0", + "terser": "^5.31.1" + }, + "engines": { + "node": ">= 10.13.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + }, + "peerDependencies": { + "webpack": "^5.1.0" + }, + "peerDependenciesMeta": { + "@swc/core": { + "optional": true + }, + "esbuild": { + "optional": true + }, + "uglify-js": { + "optional": true + } + } + }, + "node_modules/typedoc": { + "version": "0.28.17", + "resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.28.17.tgz", + "integrity": "sha512-ZkJ2G7mZrbxrKxinTQMjFqsCoYY6a5Luwv2GKbTnBCEgV2ihYm5CflA9JnJAwH0pZWavqfYxmDkFHPt4yx2oDQ==", + "dev": true, + "license": "Apache-2.0", + "dependencies": { + "@gerrit0/mini-shiki": "^3.17.0", + "lunr": "^2.3.9", + "markdown-it": "^14.1.0", + "minimatch": "^9.0.5", + "yaml": "^2.8.1" + }, + "bin": { + "typedoc": "bin/typedoc" + }, + "engines": { + "node": ">= 18", + "pnpm": ">= 10" + }, + "peerDependencies": { + "typescript": "5.0.x || 5.1.x || 5.2.x || 5.3.x || 5.4.x || 5.5.x || 5.6.x || 5.7.x || 5.8.x || 5.9.x" + } + }, + "node_modules/typedoc-plugin-frontmatter": { + "version": "1.3.1", + "resolved": "https://registry.npmjs.org/typedoc-plugin-frontmatter/-/typedoc-plugin-frontmatter-1.3.1.tgz", + "integrity": "sha512-wXKnhpiOuG3lY9GGKiKcXNrhKbPYm/jA5wbzGE/kKdwlSu8++ZbEuKA0K2dvIna3F+5EQrv+3AeObHkS1QP7JA==", + "dev": true, + "license": "MIT", + "dependencies": { + "yaml": "^2.8.1" + }, + "peerDependencies": { + "typedoc-plugin-markdown": ">=4.9.0" + } + }, + "node_modules/typedoc-plugin-markdown": { + "version": "4.10.0", + "resolved": "https://registry.npmjs.org/typedoc-plugin-markdown/-/typedoc-plugin-markdown-4.10.0.tgz", + "integrity": "sha512-psrg8Rtnv4HPWCsoxId+MzEN8TVK5jeKCnTbnGAbTBqcDapR9hM41bJT/9eAyKn9C2MDG9Qjh3MkltAYuLDoXg==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 18" + }, + "peerDependencies": { + "typedoc": "0.28.x" + } + }, + "node_modules/typescript": { + "version": "5.9.3", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.9.3.tgz", + "integrity": "sha512-jl1vZzPDinLr9eUt3J/t7V6FgNEw9QjvBPdysz9KfQDD41fQrC2Y4vKQdiaUpFT4bXlb1RHhLpp8wtm6M5TgSw==", + "dev": true, + "license": "Apache-2.0", + "peer": true, + "bin": { + "tsc": "bin/tsc", + "tsserver": "bin/tsserver" + }, + "engines": { + "node": ">=14.17" + } + }, + "node_modules/uc.micro": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/uc.micro/-/uc.micro-2.1.0.tgz", + "integrity": "sha512-ARDJmphmdvUk6Glw7y9DQ2bFkKBHwQHLi2lsaH6PPmz/Ka9sFOBsBluozhDltWmnv9u/cF6Rt87znRTPV+yp/A==", + "dev": true, + "license": "MIT" + }, + "node_modules/undici-types": { + "version": "7.18.2", + "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-7.18.2.tgz", + "integrity": "sha512-AsuCzffGHJybSaRrmr5eHr81mwJU3kjw6M+uprWvCXiNeN9SOGwQ3Jn8jb8m3Z6izVgknn1R0FTCEAP2QrLY/w==", + "dev": true, + "license": "MIT" + }, + "node_modules/update-browserslist-db": { + "version": "1.2.3", + "resolved": "https://registry.npmjs.org/update-browserslist-db/-/update-browserslist-db-1.2.3.tgz", + "integrity": "sha512-Js0m9cx+qOgDxo0eMiFGEueWztz+d4+M3rGlmKPT+T4IS/jP4ylw3Nwpu6cpTTP8R1MAC1kF4VbdLt3ARf209w==", + "dev": true, + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/browserslist" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/browserslist" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "MIT", + "dependencies": { + "escalade": "^3.2.0", + "picocolors": "^1.1.1" + }, + "bin": { + "update-browserslist-db": "cli.js" + }, + "peerDependencies": { + "browserslist": ">= 4.21.0" + } + }, + "node_modules/watchpack": { + "version": "2.5.1", + "resolved": "https://registry.npmjs.org/watchpack/-/watchpack-2.5.1.tgz", + "integrity": "sha512-Zn5uXdcFNIA1+1Ei5McRd+iRzfhENPCe7LeABkJtNulSxjma+l7ltNx55BWZkRlwRnpOgHqxnjyaDgJnNXnqzg==", + "dev": true, + "license": "MIT", + "dependencies": { + "glob-to-regexp": "^0.4.1", + "graceful-fs": "^4.1.2" + }, + "engines": { + "node": ">=10.13.0" + } + }, + "node_modules/webpack": { + "version": "5.105.4", + "resolved": "https://registry.npmjs.org/webpack/-/webpack-5.105.4.tgz", + "integrity": "sha512-jTywjboN9aHxFlToqb0K0Zs9SbBoW4zRUlGzI2tYNxVYcEi/IPpn+Xi4ye5jTLvX2YeLuic/IvxNot+Q1jMoOw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@types/eslint-scope": "^3.7.7", + "@types/estree": "^1.0.8", + "@types/json-schema": "^7.0.15", + "@webassemblyjs/ast": "^1.14.1", + "@webassemblyjs/wasm-edit": "^1.14.1", + "@webassemblyjs/wasm-parser": "^1.14.1", + "acorn": "^8.16.0", + "acorn-import-phases": "^1.0.3", + "browserslist": "^4.28.1", + "chrome-trace-event": "^1.0.2", + "enhanced-resolve": "^5.20.0", + "es-module-lexer": "^2.0.0", + "eslint-scope": "5.1.1", + "events": "^3.2.0", + "glob-to-regexp": "^0.4.1", + "graceful-fs": "^4.2.11", + "json-parse-even-better-errors": "^2.3.1", + "loader-runner": "^4.3.1", + "mime-types": "^2.1.27", + "neo-async": "^2.6.2", + "schema-utils": "^4.3.3", + "tapable": "^2.3.0", + "terser-webpack-plugin": "^5.3.17", + "watchpack": "^2.5.1", + "webpack-sources": "^3.3.4" + }, + "bin": { + "webpack": "bin/webpack.js" + }, + "engines": { + "node": ">=10.13.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/webpack" + }, + "peerDependenciesMeta": { + "webpack-cli": { + "optional": true + } + } + }, + "node_modules/webpack-sources": { + "version": "3.3.4", + "resolved": "https://registry.npmjs.org/webpack-sources/-/webpack-sources-3.3.4.tgz", + "integrity": "sha512-7tP1PdV4vF+lYPnkMR0jMY5/la2ub5Fc/8VQrrU+lXkiM6C4TjVfGw7iKfyhnTQOsD+6Q/iKw0eFciziRgD58Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=10.13.0" + } + }, + "node_modules/yaml": { + "version": "2.8.2", + "resolved": "https://registry.npmjs.org/yaml/-/yaml-2.8.2.tgz", + "integrity": "sha512-mplynKqc1C2hTVYxd0PU2xQAc22TI1vShAYGksCCfxbn/dFwnHTNi1bvYsBTkhdUNtGIf5xNOg938rrSSYvS9A==", + "dev": true, + "license": "ISC", + "bin": { + "yaml": "bin.mjs" + }, + "engines": { + "node": ">= 14.6" + }, + "funding": { + "url": "https://github.com/sponsors/eemeli" + } + } + } +} diff --git a/package.json b/package.json new file mode 100644 index 0000000..cf32b61 --- /dev/null +++ b/package.json @@ -0,0 +1,9 @@ +{ + "devDependencies": { + "dedent": "^1.7.2", + "typedoc": "^0.28.17", + "typedoc-plugin-frontmatter": "^1.3.1", + "typedoc-plugin-markdown": "^4.10.0", + "webpack": "^5.105.4" + } +} diff --git a/scripts/typedoc/generate-markdown.mjs b/scripts/typedoc/generate-markdown.mjs new file mode 100644 index 0000000..e67a0d8 --- /dev/null +++ b/scripts/typedoc/generate-markdown.mjs @@ -0,0 +1,21 @@ +import { Application } from "typedoc"; +import { fileURLToPath } from "node:url"; + +const app = await Application.bootstrapWithPlugins({ + entryPoints: ["../webpack/lib/index.js"], + out: "api", + + // Plugins + plugin: [ + "typedoc-plugin-markdown", + "typedoc-plugin-frontmatter", + fileURLToPath(import.meta.resolve("./postprocessor.mjs")), + ], + + // TypeScript configuration + tsconfig: fileURLToPath(import.meta.resolve("./tsconfig.json")), +}); + +const project = await app.convert(); + +await app.generateOutputs(project); diff --git a/scripts/typedoc/postprocessor.mjs b/scripts/typedoc/postprocessor.mjs new file mode 100644 index 0000000..b190e65 --- /dev/null +++ b/scripts/typedoc/postprocessor.mjs @@ -0,0 +1,17 @@ +import { MarkdownPageEvent } from 'typedoc-plugin-markdown'; + +/** + * @param {import('typedoc-plugin-markdown').MarkdownApplication} app + */ +export function load(app) { + app.renderer.on( + MarkdownPageEvent.BEGIN, + /** @param {import('typedoc-plugin-markdown').MarkdownPageEvent} page */ + (page) => { + page.frontmatter = { + title: page.model.name, + + } + }, + ); +} \ No newline at end of file diff --git a/scripts/typedoc/tsconfig.json b/scripts/typedoc/tsconfig.json new file mode 100644 index 0000000..7619e80 --- /dev/null +++ b/scripts/typedoc/tsconfig.json @@ -0,0 +1,10 @@ +{ + "include": ["../../../webpack/lib/*"], + "compilerOptions": { + "allowJs": true, + "esModuleInterop": true, + "paths": { + "webpack": ["../../node_modules/webpack"] + } + }, +} \ No newline at end of file From c9a7333c5ce5c98dac40726e39150da0b4d42559 Mon Sep 17 00:00:00 2001 From: avivkeller Date: Fri, 6 Mar 2026 10:16:38 -0500 Subject: [PATCH 2/5] [WIP] API generation --- .gitignore | 3 +- api/README.md | 94 - api/_media/GOVERNANCE.md | 3 + api/_media/WORKING_GROUP.md | 48 + api/classes/AsyncDependenciesBlock.md | 306 ++ api/classes/AutomaticPrefetchPlugin.md | 41 + api/classes/BannerPlugin.md | 83 + api/classes/Cache.md | 225 ++ api/classes/Chunk.md | 843 +++++ api/classes/ChunkGraph.md | 1859 ++++++++++ api/classes/ChunkGroup.md | 759 ++++ api/classes/CleanPlugin.md | 73 + api/classes/CodeGenerationResults.md | 193 ++ api/classes/Compilation.md | 1980 +++++++++++ api/classes/Compiler.md | 685 ++++ api/classes/ConcatenationScope.md | 237 ++ api/classes/ContextExclusionPlugin.md | 55 + api/classes/ContextReplacementPlugin.md | 131 + api/classes/DefinePlugin.md | 97 + api/classes/DelegatedPlugin.md | 55 + api/classes/Dependency.md | 442 +++ api/classes/DllPlugin.md | 55 + api/classes/DllReferencePlugin.md | 55 + api/classes/DotenvPlugin.md | 53 + api/classes/DynamicEntryPlugin.md | 71 + api/classes/EntryOptionPlugin.md | 91 + api/classes/EntryPlugin.md | 103 + api/classes/Entrypoint.md | 1052 ++++++ api/classes/EnvironmentPlugin.md | 63 + api/classes/EvalDevToolModulePlugin.md | 71 + api/classes/EvalSourceMapDevToolPlugin.md | 79 + api/classes/ExternalModule.md | 1781 ++++++++++ api/classes/ExternalsPlugin.md | 67 + api/classes/Generator.md | 143 + api/classes/HotModuleReplacementPlugin.md | 59 + api/classes/HotUpdateChunk.md | 1069 ++++++ api/classes/IgnorePlugin.md | 75 + api/classes/InitFragment.md | 249 ++ api/classes/JavascriptModulesPlugin.md | 261 ++ api/classes/LibManifestPlugin.md | 55 + api/classes/LibraryTemplatePlugin.md | 91 + api/classes/LoaderOptionsPlugin.md | 55 + api/classes/LoaderTargetPlugin.md | 55 + api/classes/ManifestPlugin.md | 55 + api/classes/Module.md | 1393 ++++++++ api/classes/ModuleFactory.md | 43 + api/classes/ModuleGraph.md | 1257 +++++++ api/classes/ModuleGraphConnection.md | 291 ++ api/classes/MultiCompiler.md | 281 ++ api/classes/MultiStats.md | 101 + api/classes/NoEmitOnErrorsPlugin.md | 41 + api/classes/NormalModule.md | 2019 +++++++++++ api/classes/NormalModuleReplacementPlugin.md | 69 + api/classes/Parser.md | 47 + api/classes/PlatformPlugin.md | 55 + api/classes/PrefetchPlugin.md | 67 + api/classes/ProgressPlugin.md | 223 ++ api/classes/ProvidePlugin.md | 55 + api/classes/Resolver.md | 285 ++ api/classes/RuntimeModule.md | 1856 ++++++++++ api/classes/SourceMapDevToolPlugin.md | 95 + api/classes/Stats.md | 137 + api/classes/Template.md | 313 ++ api/classes/WatchIgnorePlugin.md | 55 + api/classes/Watching.md | 223 ++ api/classes/WebpackError.md | 278 ++ api/classes/WebpackOptionsApply.md | 59 + api/classes/WebpackOptionsDefaulter.md | 39 + api/functions/export=.md | 79 + api/globals.md | 185 + api/index.md | 665 ++++ api/interfaces/Argument.md | 20 +- api/interfaces/Asset.md | 16 +- api/interfaces/AssetEmittedInfo.md | 24 +- api/interfaces/Colors.md | 747 ++++ api/interfaces/ColorsOptions.md | 10 +- api/interfaces/Configuration.md | 132 +- api/interfaces/EntryObject.md | 12 +- api/interfaces/ExternalItemFunctionData.md | 32 +- api/interfaces/ExternalItemObjectKnown.md | 12 +- api/interfaces/ExternalItemObjectUnknown.md | 10 +- api/interfaces/FileCacheOptions.md | 52 +- .../GeneratorOptionsByModuleTypeKnown.md | 36 +- api/interfaces/InputFileSystem.md | 102 +- api/interfaces/LibraryOptions.md | 26 +- api/interfaces/LoaderDefinitionFunction.md | 45 + api/interfaces/LoaderModule.md | 43 + api/interfaces/MemoryCacheOptions.md | 14 +- api/interfaces/ModuleOptions.md | 54 +- api/interfaces/MultiCompilerOptions.md | 10 +- api/interfaces/ObjectDeserializerContext.md | 18 +- api/interfaces/ObjectSerializerContext.md | 38 +- api/interfaces/OutputFileSystem.md | 94 +- .../ParserOptionsByModuleTypeKnown.md | 36 +- api/interfaces/PathData.md | 86 +- .../PitchLoaderDefinitionFunction.md | 45 + api/interfaces/Problem.md | 22 +- api/interfaces/RawLoaderDefinitionFunction.md | 45 + api/interfaces/RenderManifestOptions.md | 36 +- api/interfaces/ResolveData.md | 52 +- api/interfaces/ResolveOptions.md | 104 +- api/interfaces/RuleSetRule.md | 138 +- api/interfaces/StatsOptions.md | 178 +- api/interfaces/WebpackOptionsNormalized.md | 122 +- api/interfaces/WebpackPluginInstance.md | 26 +- api/type-aliases/AssetInfo.md | 12 +- api/type-aliases/ChunkGroup.md | 17 - api/type-aliases/CodeGenerationResults.md | 17 - api/type-aliases/Colors.md | 183 - api/type-aliases/Entry.md | 12 +- api/type-aliases/EntryNormalized.md | 12 +- api/type-aliases/EntryOptions.md | 12 +- api/type-aliases/Entrypoint.md | 17 - api/type-aliases/ExternalItem.md | 12 +- api/type-aliases/ExternalItemFunction.md | 12 +- .../ExternalItemFunctionCallback.md | 12 +- .../ExternalItemFunctionDataGetResolve.md | 16 +- ...temFunctionDataGetResolveCallbackResult.md | 12 +- ...xternalItemFunctionDataGetResolveResult.md | 12 +- .../ExternalItemFunctionPromise.md | 14 +- api/type-aliases/ExternalItemValue.md | 12 +- api/type-aliases/Externals.md | 12 +- api/type-aliases/LoaderContext.md | 17 + api/type-aliases/LoaderDefinition.md | 31 + api/type-aliases/MultiConfiguration.md | 12 +- api/type-aliases/MultiStats.md | 17 - api/type-aliases/MultiStatsOptions.md | 17 - api/type-aliases/ParserState.md | 12 +- api/type-aliases/RawLoaderDefinition.md | 31 + api/type-aliases/RenderManifestEntry.md | 12 +- api/type-aliases/ResolvePluginInstance.md | 22 +- api/type-aliases/Resolver.md | 17 - api/type-aliases/RuleSetCondition.md | 12 +- api/type-aliases/RuleSetConditionAbsolute.md | 12 +- api/type-aliases/RuleSetUse.md | 36 +- api/type-aliases/RuleSetUseFunction.md | 42 +- api/type-aliases/RuleSetUseItem.md | 26 +- api/type-aliases/StatsAsset.md | 12 +- api/type-aliases/StatsChunk.md | 12 +- api/type-aliases/StatsChunkGroup.md | 12 +- api/type-aliases/StatsChunkOrigin.md | 12 +- api/type-aliases/StatsCompilation.md | 12 +- api/type-aliases/StatsError.md | 12 +- api/type-aliases/StatsLogging.md | 12 +- api/type-aliases/StatsLoggingEntry.md | 12 +- api/type-aliases/StatsModule.md | 12 +- api/type-aliases/StatsModuleIssuer.md | 12 +- api/type-aliases/StatsModuleReason.md | 12 +- .../StatsModuleTraceDependency.md | 12 +- api/type-aliases/StatsModuleTraceItem.md | 12 +- api/type-aliases/StatsProfile.md | 12 +- api/type-aliases/TemplatePath.md | 12 +- api/type-aliases/Watching.md | 17 - api/type-aliases/WebpackPluginFunction.md | 22 +- api/variables/export=.md | 2154 ------------ .../classes/WebpackOptionsValidationError.md | 409 +++ api/webpack/namespaces/export=/index.md | 900 +++++ .../namespaces/ModuleFilenameHelpers/index.md | 36 + .../variables/ABSOLUTE_RESOURCE_PATH.md | 11 + .../variables/ALL_LOADERS.md | 11 + .../variables/ALL_LOADERS_RESOURCE.md | 11 + .../ModuleFilenameHelpers/variables/HASH.md | 11 + .../ModuleFilenameHelpers/variables/ID.md | 11 + .../variables/LOADERS.md | 11 + .../variables/LOADERS_RESOURCE.md | 11 + .../variables/NAMESPACE.md | 11 + .../ModuleFilenameHelpers/variables/QUERY.md | 11 + .../REGEXP_ABSOLUTE_RESOURCE_PATH.md | 11 + .../variables/REGEXP_ALL_LOADERS.md | 11 + .../variables/REGEXP_ALL_LOADERS_RESOURCE.md | 11 + .../variables/REGEXP_HASH.md | 11 + .../variables/REGEXP_ID.md | 11 + .../variables/REGEXP_LOADERS.md | 11 + .../variables/REGEXP_LOADERS_RESOURCE.md | 11 + .../variables/REGEXP_NAMESPACE.md | 11 + .../variables/REGEXP_QUERY.md | 11 + .../variables/REGEXP_RESOURCE.md | 11 + .../variables/REGEXP_RESOURCE_PATH.md | 11 + .../variables/RESOURCE.md | 11 + .../variables/RESOURCE_PATH.md | 11 + .../variables/createFilename.md | 45 + .../variables/matchObject.md | 25 + .../variables/matchPart.md | 25 + .../variables/replaceDuplicates.md | 35 + .../namespaces/OptimizationStages/index.md | 13 + .../variables/STAGE_ADVANCED.md | 11 + .../variables/STAGE_BASIC.md | 11 + .../variables/STAGE_DEFAULT.md | 11 + .../namespaces/RuntimeGlobals/index.md | 92 + .../RuntimeGlobals/variables/amdDefine.md | 11 + .../RuntimeGlobals/variables/amdOptions.md | 11 + .../RuntimeGlobals/variables/asyncModule.md | 11 + .../variables/asyncModuleDoneSymbol.md | 11 + .../variables/asyncModuleExportSymbol.md | 11 + .../RuntimeGlobals/variables/baseURI.md | 11 + .../RuntimeGlobals/variables/chunkCallback.md | 11 + .../RuntimeGlobals/variables/chunkName.md | 11 + .../variables/compatGetDefaultExport.md | 11 + .../variables/createFakeNamespaceObject.md | 11 + .../RuntimeGlobals/variables/createScript.md | 11 + .../variables/createScriptUrl.md | 11 + .../variables/cssMergeStyleSheets.md | 11 + .../variables/currentRemoteGetScope.md | 11 + ...ferredModuleAsyncTransitiveDependencies.md | 11 + ...ModuleAsyncTransitiveDependenciesSymbol.md | 11 + .../variables/definePropertyGetters.md | 11 + .../RuntimeGlobals/variables/ensureChunk.md | 11 + .../variables/ensureChunkHandlers.md | 11 + .../variables/ensureChunkIncludeEntries.md | 11 + .../RuntimeGlobals/variables/entryModuleId.md | 11 + .../RuntimeGlobals/variables/esmId.md | 11 + .../RuntimeGlobals/variables/esmIds.md | 11 + .../RuntimeGlobals/variables/esmModules.md | 11 + .../RuntimeGlobals/variables/esmRuntime.md | 11 + .../RuntimeGlobals/variables/exports.md | 11 + .../variables/externalInstallChunk.md | 11 + .../variables/getChunkCssFilename.md | 11 + .../variables/getChunkScriptFilename.md | 11 + .../variables/getChunkUpdateCssFilename.md | 11 + .../variables/getChunkUpdateScriptFilename.md | 11 + .../RuntimeGlobals/variables/getFullHash.md | 11 + .../variables/getTrustedTypesPolicy.md | 11 + .../variables/getUpdateManifestFilename.md | 11 + .../RuntimeGlobals/variables/global.md | 11 + .../variables/harmonyModuleDecorator.md | 11 + .../RuntimeGlobals/variables/hasCssModules.md | 11 + .../variables/hasFetchPriority.md | 11 + .../variables/hasOwnProperty.md | 11 + .../variables/hmrDownloadManifest.md | 11 + .../variables/hmrDownloadUpdateHandlers.md | 11 + .../variables/hmrInvalidateModuleHandlers.md | 11 + .../RuntimeGlobals/variables/hmrModuleData.md | 11 + .../variables/hmrRuntimeStatePrefix.md | 11 + .../variables/initializeSharing.md | 11 + .../variables/instantiateWasm.md | 11 + .../variables/interceptModuleExecution.md | 11 + .../RuntimeGlobals/variables/loadScript.md | 11 + .../variables/makeDeferredNamespaceObject.md | 11 + .../variables/makeNamespaceObject.md | 11 + .../makeOptimizedDeferredNamespaceObject.md | 11 + .../RuntimeGlobals/variables/module.md | 11 + .../RuntimeGlobals/variables/moduleCache.md | 11 + .../variables/moduleFactories.md | 11 + .../variables/moduleFactoriesAddOnly.md | 11 + .../RuntimeGlobals/variables/moduleId.md | 11 + .../RuntimeGlobals/variables/moduleLoaded.md | 11 + .../variables/nodeModuleDecorator.md | 11 + .../variables/onChunksLoaded.md | 11 + .../RuntimeGlobals/variables/prefetchChunk.md | 11 + .../variables/prefetchChunkHandlers.md | 11 + .../RuntimeGlobals/variables/preloadChunk.md | 11 + .../variables/preloadChunkHandlers.md | 11 + .../RuntimeGlobals/variables/publicPath.md | 11 + .../RuntimeGlobals/variables/relativeUrl.md | 11 + .../RuntimeGlobals/variables/require.md | 11 + .../RuntimeGlobals/variables/requireScope.md | 11 + .../variables/returnExportsFromRuntime.md | 11 + .../RuntimeGlobals/variables/runtimeId.md | 11 + .../RuntimeGlobals/variables/scriptNonce.md | 11 + .../RuntimeGlobals/variables/shareScopeMap.md | 11 + .../RuntimeGlobals/variables/startup.md | 11 + .../variables/startupEntrypoint.md | 11 + .../variables/startupNoDefault.md | 11 + .../variables/startupOnlyAfter.md | 11 + .../variables/startupOnlyBefore.md | 11 + .../RuntimeGlobals/variables/system.md | 11 + .../RuntimeGlobals/variables/systemContext.md | 11 + .../RuntimeGlobals/variables/thisAsExports.md | 11 + .../RuntimeGlobals/variables/toBinary.md | 11 + .../variables/uncaughtErrorHandler.md | 11 + .../RuntimeGlobals/variables/wasmInstances.md | 11 + .../cache/classes/MemoryCachePlugin.md | 41 + .../export=/namespaces/cache/index.md | 11 + .../export=/namespaces/cli/index.md | 14 + .../namespaces/cli/variables/createColors.md | 21 + .../namespaces/cli/variables/getArguments.md | 21 + .../cli/variables/isColorSupported.md | 15 + .../cli/variables/processArguments.md | 29 + .../export=/namespaces/config/index.md | 12 + .../variables/applyWebpackOptionsDefaults.md | 25 + .../variables/getNormalizedWebpackOptions.md | 21 + .../container/classes/ContainerPlugin.md | 55 + .../classes/ContainerReferencePlugin.md | 55 + .../classes/ModuleFederationPlugin.md | 75 + .../export=/namespaces/container/index.md | 17 + .../namespaces/container/variables/scope.md | 31 + .../css/classes/CssModulesPlugin.md | 203 ++ .../export=/namespaces/css/index.md | 11 + .../debug/classes/ProfilingPlugin.md | 63 + .../export=/namespaces/debug/index.md | 11 + .../dependencies/classes/ConstDependency.md | 603 ++++ .../classes/HarmonyImportDependency.md | 811 +++++ .../dependencies/classes/ModuleDependency.md | 607 ++++ .../dependencies/classes/NullDependency.md | 565 +++ .../export=/namespaces/dependencies/index.md | 14 + .../electron/classes/ElectronTargetPlugin.md | 47 + .../export=/namespaces/electron/index.md | 11 + .../ModuleChunkLoadingRuntimeModule.md | 1923 +++++++++++ .../export=/namespaces/esm/index.md | 11 + .../export=/namespaces/experiments/index.md | 12 + .../ids/classes/SyncModuleIdsPlugin.md | 55 + .../experiments/namespaces/ids/index.md | 11 + .../schemes/classes/HttpUriPlugin.md | 55 + .../schemes/classes/VirtualUrlPlugin.md | 113 + .../experiments/namespaces/schemes/index.md | 12 + .../ids/classes/ChunkModuleIdRangePlugin.md | 55 + .../classes/DeterministicChunkIdsPlugin.md | 55 + .../classes/DeterministicModuleIdsPlugin.md | 55 + .../ids/classes/HashedModuleIdsPlugin.md | 55 + .../ids/classes/NamedChunkIdsPlugin.md | 55 + .../ids/classes/NamedModuleIdsPlugin.md | 55 + .../ids/classes/NaturalModuleIdsPlugin.md | 41 + .../ids/classes/OccurrenceChunkIdsPlugin.md | 55 + .../ids/classes/OccurrenceModuleIdsPlugin.md | 55 + .../export=/namespaces/ids/index.md | 19 + .../classes/EnableChunkLoadingPlugin.md | 99 + .../javascript/classes/JavascriptParser.md | 3037 +++++++++++++++++ .../export=/namespaces/javascript/index.md | 18 + .../library/classes/AbstractLibraryPlugin.md | 295 ++ .../library/classes/EnableLibraryPlugin.md | 111 + .../export=/namespaces/library/index.md | 12 + .../node/classes/NodeEnvironmentPlugin.md | 55 + .../node/classes/NodeSourcePlugin.md | 41 + .../node/classes/NodeTargetPlugin.md | 55 + .../node/classes/NodeTemplatePlugin.md | 47 + .../classes/ReadFileCompileAsyncWasmPlugin.md | 47 + .../node/classes/ReadFileCompileWasmPlugin.md | 55 + .../export=/namespaces/node/index.md | 16 + .../classes/AggressiveMergingPlugin.md | 55 + .../classes/AggressiveSplittingPlugin.md | 73 + .../optimize/classes/LimitChunkCountPlugin.md | 53 + .../classes/MergeDuplicateChunksPlugin.md | 53 + .../optimize/classes/MinChunkSizePlugin.md | 55 + .../classes/ModuleConcatenationPlugin.md | 41 + .../optimize/classes/RealContentHashPlugin.md | 65 + .../optimize/classes/RuntimeChunkPlugin.md | 63 + .../optimize/classes/SideEffectsFlagPlugin.md | 73 + .../optimize/classes/SplitChunksPlugin.md | 55 + .../export=/namespaces/optimize/index.md | 24 + .../InnerGraph/classes/TopLevelSymbol.md | 35 + .../optimize/namespaces/InnerGraph/index.md | 27 + .../InnerGraph/variables/addUsage.md | 29 + .../InnerGraph/variables/addVariableUsage.md | 29 + .../InnerGraph/variables/bailout.md | 21 + .../namespaces/InnerGraph/variables/enable.md | 21 + .../getDependencyUsedByExportsCondition.md | 29 + .../InnerGraph/variables/getTopLevelSymbol.md | 21 + .../variables/inferDependencyUsage.md | 21 + .../variables/isDependencyUsedByExports.md | 33 + .../InnerGraph/variables/isEnabled.md | 21 + .../InnerGraph/variables/onUsage.md | 25 + .../InnerGraph/variables/setTopLevelSymbol.md | 25 + .../InnerGraph/variables/tagTopLevelSymbol.md | 25 + .../InnerGraph/variables/topLevelSymbolTag.md | 11 + .../classes/ChunkPrefetchPreloadPlugin.md | 39 + .../export=/namespaces/prefetch/index.md | 11 + .../classes/GetChunkFilenameRuntimeModule.md | 1963 +++++++++++ .../classes/LoadScriptRuntimeModule.md | 1927 +++++++++++ .../export=/namespaces/runtime/index.md | 12 + .../sharing/classes/ConsumeSharedPlugin.md | 55 + .../sharing/classes/ProvideSharedPlugin.md | 55 + .../namespaces/sharing/classes/SharePlugin.md | 47 + .../export=/namespaces/sharing/index.md | 17 + .../namespaces/sharing/variables/scope.md | 31 + .../sources/classes/CachedSource.md | 219 ++ .../sources/classes/CompatSource.md | 167 + .../sources/classes/ConcatSource.md | 227 ++ .../sources/classes/OriginalSource.md | 195 ++ .../sources/classes/PrefixSource.md | 207 ++ .../namespaces/sources/classes/RawSource.md | 195 ++ .../sources/classes/ReplaceSource.md | 283 ++ .../sources/classes/SizeOnlySource.md | 149 + .../namespaces/sources/classes/Source.md | 123 + .../sources/classes/SourceMapSource.md | 211 ++ .../export=/namespaces/sources/index.md | 20 + .../namespaces/util/classes/LazySet.md | 249 ++ .../util/functions/compileBooleanMatcher.md | 21 + .../export=/namespaces/util/index.md | 27 + .../util/namespaces/comparators/index.md | 30 + .../variables/compareChunkGroupsByIndex.md | 25 + .../comparators/variables/compareChunks.md | 11 + .../variables/compareChunksById.md | 25 + .../variables/compareChunksNatural.md | 21 + .../comparators/variables/compareIds.md | 25 + .../comparators/variables/compareIterables.md | 27 + .../comparators/variables/compareLocations.md | 25 + .../variables/compareModulesByFullName.md | 11 + .../variables/compareModulesById.md | 11 + .../compareModulesByIdOrIdentifier.md | 11 + .../variables/compareModulesByIdentifier.md | 25 + ...pareModulesByPostOrderIndexOrIdentifier.md | 11 + ...mpareModulesByPreOrderIndexOrIdentifier.md | 11 + .../comparators/variables/compareNumbers.md | 25 + .../comparators/variables/compareSelect.md | 35 + .../comparators/variables/compareStrings.md | 25 + .../variables/compareStringsNumeric.md | 25 + .../variables/concatComparators.md | 35 + .../variables/keepOriginalOrder.md | 27 + .../variables/sortWithSourceOrder.md | 29 + .../namespaces/compileBooleanMatcher/index.md | 12 + .../variables/fromLists.md | 35 + .../variables/itemsToRegexp.md | 21 + .../runtime/classes/RuntimeSpecMap.md | 195 ++ .../runtime/classes/RuntimeSpecSet.md | 89 + .../util/namespaces/runtime/index.md | 31 + .../runtime/variables/compareRuntime.md | 25 + .../runtime/variables/filterRuntime.md | 25 + .../runtime/variables/forEachRuntime.md | 29 + .../runtime/variables/getEntryRuntime.md | 29 + .../runtime/variables/getRuntimeKey.md | 21 + .../runtime/variables/intersectRuntime.md | 25 + .../runtime/variables/keyToRuntime.md | 21 + .../runtime/variables/mergeRuntime.md | 25 + .../variables/mergeRuntimeCondition.md | 29 + .../mergeRuntimeConditionNonFalse.md | 29 + .../runtime/variables/mergeRuntimeOwned.md | 25 + .../variables/runtimeConditionToString.md | 21 + .../runtime/variables/runtimeEqual.md | 25 + .../runtime/variables/runtimeToString.md | 21 + .../runtime/variables/subtractRuntime.md | 25 + .../variables/subtractRuntimeCondition.md | 29 + .../util/namespaces/serialization/index.md | 18 + .../variables/MEASURE_END_OPERATION.md | 11 + .../variables/MEASURE_START_OPERATION.md | 11 + .../variables/NOT_SERIALIZABLE.md | 11 + .../variables/buffersSerializer.md | 11 + .../variables/createFileSerializer.md | 39 + .../serialization/variables/register.md | 33 + .../serialization/variables/registerLoader.md | 25 + .../variables/registerNotSerializable.md | 21 + .../namespaces/util/variables/cleverMerge.md | 35 + .../namespaces/util/variables/createHash.md | 21 + .../classes/AsyncWebAssemblyModulesPlugin.md | 99 + .../wasm/classes/EnableWasmLoadingPlugin.md | 99 + .../export=/namespaces/wasm/index.md | 12 + .../web/classes/CssLoadingRuntimeModule.md | 1923 +++++++++++ .../classes/FetchCompileAsyncWasmPlugin.md | 41 + .../web/classes/FetchCompileWasmPlugin.md | 55 + .../classes/JsonpChunkLoadingRuntimeModule.md | 1923 +++++++++++ .../web/classes/JsonpTemplatePlugin.md | 63 + .../export=/namespaces/web/index.md | 15 + .../classes/WebWorkerTemplatePlugin.md | 41 + .../export=/namespaces/webworker/index.md | 11 + .../export=/variables/UsageState.md | 11 + .../namespaces/export=/variables/validate.md | 21 + .../export=/variables/validateSchema.md | 29 + .../namespaces/export=/variables/version.md | 11 + .../namespaces/export=/variables/webpack.md | 11 + docs.json | 869 ++++- scripts/typedoc/generate-markdown.mjs | 44 +- scripts/typedoc/postprocessor.mjs | 4 +- scripts/typedoc/tsconfig.json | 22 +- 452 files changed, 52914 insertions(+), 3695 deletions(-) delete mode 100644 api/README.md create mode 100644 api/_media/GOVERNANCE.md create mode 100644 api/_media/WORKING_GROUP.md create mode 100644 api/classes/AsyncDependenciesBlock.md create mode 100644 api/classes/AutomaticPrefetchPlugin.md create mode 100644 api/classes/BannerPlugin.md create mode 100644 api/classes/Cache.md create mode 100644 api/classes/Chunk.md create mode 100644 api/classes/ChunkGraph.md create mode 100644 api/classes/ChunkGroup.md create mode 100644 api/classes/CleanPlugin.md create mode 100644 api/classes/CodeGenerationResults.md create mode 100644 api/classes/Compilation.md create mode 100644 api/classes/Compiler.md create mode 100644 api/classes/ConcatenationScope.md create mode 100644 api/classes/ContextExclusionPlugin.md create mode 100644 api/classes/ContextReplacementPlugin.md create mode 100644 api/classes/DefinePlugin.md create mode 100644 api/classes/DelegatedPlugin.md create mode 100644 api/classes/Dependency.md create mode 100644 api/classes/DllPlugin.md create mode 100644 api/classes/DllReferencePlugin.md create mode 100644 api/classes/DotenvPlugin.md create mode 100644 api/classes/DynamicEntryPlugin.md create mode 100644 api/classes/EntryOptionPlugin.md create mode 100644 api/classes/EntryPlugin.md create mode 100644 api/classes/Entrypoint.md create mode 100644 api/classes/EnvironmentPlugin.md create mode 100644 api/classes/EvalDevToolModulePlugin.md create mode 100644 api/classes/EvalSourceMapDevToolPlugin.md create mode 100644 api/classes/ExternalModule.md create mode 100644 api/classes/ExternalsPlugin.md create mode 100644 api/classes/Generator.md create mode 100644 api/classes/HotModuleReplacementPlugin.md create mode 100644 api/classes/HotUpdateChunk.md create mode 100644 api/classes/IgnorePlugin.md create mode 100644 api/classes/InitFragment.md create mode 100644 api/classes/JavascriptModulesPlugin.md create mode 100644 api/classes/LibManifestPlugin.md create mode 100644 api/classes/LibraryTemplatePlugin.md create mode 100644 api/classes/LoaderOptionsPlugin.md create mode 100644 api/classes/LoaderTargetPlugin.md create mode 100644 api/classes/ManifestPlugin.md create mode 100644 api/classes/Module.md create mode 100644 api/classes/ModuleFactory.md create mode 100644 api/classes/ModuleGraph.md create mode 100644 api/classes/ModuleGraphConnection.md create mode 100644 api/classes/MultiCompiler.md create mode 100644 api/classes/MultiStats.md create mode 100644 api/classes/NoEmitOnErrorsPlugin.md create mode 100644 api/classes/NormalModule.md create mode 100644 api/classes/NormalModuleReplacementPlugin.md create mode 100644 api/classes/Parser.md create mode 100644 api/classes/PlatformPlugin.md create mode 100644 api/classes/PrefetchPlugin.md create mode 100644 api/classes/ProgressPlugin.md create mode 100644 api/classes/ProvidePlugin.md create mode 100644 api/classes/Resolver.md create mode 100644 api/classes/RuntimeModule.md create mode 100644 api/classes/SourceMapDevToolPlugin.md create mode 100644 api/classes/Stats.md create mode 100644 api/classes/Template.md create mode 100644 api/classes/WatchIgnorePlugin.md create mode 100644 api/classes/Watching.md create mode 100644 api/classes/WebpackError.md create mode 100644 api/classes/WebpackOptionsApply.md create mode 100644 api/classes/WebpackOptionsDefaulter.md create mode 100644 api/functions/export=.md create mode 100644 api/globals.md create mode 100644 api/index.md create mode 100644 api/interfaces/Colors.md create mode 100644 api/interfaces/LoaderDefinitionFunction.md create mode 100644 api/interfaces/LoaderModule.md create mode 100644 api/interfaces/PitchLoaderDefinitionFunction.md create mode 100644 api/interfaces/RawLoaderDefinitionFunction.md delete mode 100644 api/type-aliases/ChunkGroup.md delete mode 100644 api/type-aliases/CodeGenerationResults.md delete mode 100644 api/type-aliases/Colors.md delete mode 100644 api/type-aliases/Entrypoint.md create mode 100644 api/type-aliases/LoaderContext.md create mode 100644 api/type-aliases/LoaderDefinition.md delete mode 100644 api/type-aliases/MultiStats.md delete mode 100644 api/type-aliases/MultiStatsOptions.md create mode 100644 api/type-aliases/RawLoaderDefinition.md delete mode 100644 api/type-aliases/Resolver.md delete mode 100644 api/type-aliases/Watching.md delete mode 100644 api/variables/export=.md create mode 100644 api/webpack/namespaces/export=/classes/WebpackOptionsValidationError.md create mode 100644 api/webpack/namespaces/export=/index.md create mode 100644 api/webpack/namespaces/export=/namespaces/ModuleFilenameHelpers/index.md create mode 100644 api/webpack/namespaces/export=/namespaces/ModuleFilenameHelpers/variables/ABSOLUTE_RESOURCE_PATH.md create mode 100644 api/webpack/namespaces/export=/namespaces/ModuleFilenameHelpers/variables/ALL_LOADERS.md create mode 100644 api/webpack/namespaces/export=/namespaces/ModuleFilenameHelpers/variables/ALL_LOADERS_RESOURCE.md create mode 100644 api/webpack/namespaces/export=/namespaces/ModuleFilenameHelpers/variables/HASH.md create mode 100644 api/webpack/namespaces/export=/namespaces/ModuleFilenameHelpers/variables/ID.md create mode 100644 api/webpack/namespaces/export=/namespaces/ModuleFilenameHelpers/variables/LOADERS.md create mode 100644 api/webpack/namespaces/export=/namespaces/ModuleFilenameHelpers/variables/LOADERS_RESOURCE.md create mode 100644 api/webpack/namespaces/export=/namespaces/ModuleFilenameHelpers/variables/NAMESPACE.md create mode 100644 api/webpack/namespaces/export=/namespaces/ModuleFilenameHelpers/variables/QUERY.md create mode 100644 api/webpack/namespaces/export=/namespaces/ModuleFilenameHelpers/variables/REGEXP_ABSOLUTE_RESOURCE_PATH.md create mode 100644 api/webpack/namespaces/export=/namespaces/ModuleFilenameHelpers/variables/REGEXP_ALL_LOADERS.md create mode 100644 api/webpack/namespaces/export=/namespaces/ModuleFilenameHelpers/variables/REGEXP_ALL_LOADERS_RESOURCE.md create mode 100644 api/webpack/namespaces/export=/namespaces/ModuleFilenameHelpers/variables/REGEXP_HASH.md create mode 100644 api/webpack/namespaces/export=/namespaces/ModuleFilenameHelpers/variables/REGEXP_ID.md create mode 100644 api/webpack/namespaces/export=/namespaces/ModuleFilenameHelpers/variables/REGEXP_LOADERS.md create mode 100644 api/webpack/namespaces/export=/namespaces/ModuleFilenameHelpers/variables/REGEXP_LOADERS_RESOURCE.md create mode 100644 api/webpack/namespaces/export=/namespaces/ModuleFilenameHelpers/variables/REGEXP_NAMESPACE.md create mode 100644 api/webpack/namespaces/export=/namespaces/ModuleFilenameHelpers/variables/REGEXP_QUERY.md create mode 100644 api/webpack/namespaces/export=/namespaces/ModuleFilenameHelpers/variables/REGEXP_RESOURCE.md create mode 100644 api/webpack/namespaces/export=/namespaces/ModuleFilenameHelpers/variables/REGEXP_RESOURCE_PATH.md create mode 100644 api/webpack/namespaces/export=/namespaces/ModuleFilenameHelpers/variables/RESOURCE.md create mode 100644 api/webpack/namespaces/export=/namespaces/ModuleFilenameHelpers/variables/RESOURCE_PATH.md create mode 100644 api/webpack/namespaces/export=/namespaces/ModuleFilenameHelpers/variables/createFilename.md create mode 100644 api/webpack/namespaces/export=/namespaces/ModuleFilenameHelpers/variables/matchObject.md create mode 100644 api/webpack/namespaces/export=/namespaces/ModuleFilenameHelpers/variables/matchPart.md create mode 100644 api/webpack/namespaces/export=/namespaces/ModuleFilenameHelpers/variables/replaceDuplicates.md create mode 100644 api/webpack/namespaces/export=/namespaces/OptimizationStages/index.md create mode 100644 api/webpack/namespaces/export=/namespaces/OptimizationStages/variables/STAGE_ADVANCED.md create mode 100644 api/webpack/namespaces/export=/namespaces/OptimizationStages/variables/STAGE_BASIC.md create mode 100644 api/webpack/namespaces/export=/namespaces/OptimizationStages/variables/STAGE_DEFAULT.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/index.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/amdDefine.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/amdOptions.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/asyncModule.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/asyncModuleDoneSymbol.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/asyncModuleExportSymbol.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/baseURI.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/chunkCallback.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/chunkName.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/compatGetDefaultExport.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/createFakeNamespaceObject.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/createScript.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/createScriptUrl.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/cssMergeStyleSheets.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/currentRemoteGetScope.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/deferredModuleAsyncTransitiveDependencies.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/deferredModuleAsyncTransitiveDependenciesSymbol.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/definePropertyGetters.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/ensureChunk.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/ensureChunkHandlers.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/ensureChunkIncludeEntries.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/entryModuleId.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/esmId.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/esmIds.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/esmModules.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/esmRuntime.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/exports.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/externalInstallChunk.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/getChunkCssFilename.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/getChunkScriptFilename.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/getChunkUpdateCssFilename.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/getChunkUpdateScriptFilename.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/getFullHash.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/getTrustedTypesPolicy.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/getUpdateManifestFilename.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/global.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/harmonyModuleDecorator.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/hasCssModules.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/hasFetchPriority.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/hasOwnProperty.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/hmrDownloadManifest.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/hmrDownloadUpdateHandlers.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/hmrInvalidateModuleHandlers.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/hmrModuleData.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/hmrRuntimeStatePrefix.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/initializeSharing.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/instantiateWasm.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/interceptModuleExecution.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/loadScript.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/makeDeferredNamespaceObject.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/makeNamespaceObject.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/makeOptimizedDeferredNamespaceObject.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/module.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/moduleCache.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/moduleFactories.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/moduleFactoriesAddOnly.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/moduleId.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/moduleLoaded.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/nodeModuleDecorator.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/onChunksLoaded.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/prefetchChunk.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/prefetchChunkHandlers.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/preloadChunk.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/preloadChunkHandlers.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/publicPath.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/relativeUrl.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/require.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/requireScope.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/returnExportsFromRuntime.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/runtimeId.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/scriptNonce.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/shareScopeMap.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/startup.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/startupEntrypoint.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/startupNoDefault.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/startupOnlyAfter.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/startupOnlyBefore.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/system.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/systemContext.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/thisAsExports.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/toBinary.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/uncaughtErrorHandler.md create mode 100644 api/webpack/namespaces/export=/namespaces/RuntimeGlobals/variables/wasmInstances.md create mode 100644 api/webpack/namespaces/export=/namespaces/cache/classes/MemoryCachePlugin.md create mode 100644 api/webpack/namespaces/export=/namespaces/cache/index.md create mode 100644 api/webpack/namespaces/export=/namespaces/cli/index.md create mode 100644 api/webpack/namespaces/export=/namespaces/cli/variables/createColors.md create mode 100644 api/webpack/namespaces/export=/namespaces/cli/variables/getArguments.md create mode 100644 api/webpack/namespaces/export=/namespaces/cli/variables/isColorSupported.md create mode 100644 api/webpack/namespaces/export=/namespaces/cli/variables/processArguments.md create mode 100644 api/webpack/namespaces/export=/namespaces/config/index.md create mode 100644 api/webpack/namespaces/export=/namespaces/config/variables/applyWebpackOptionsDefaults.md create mode 100644 api/webpack/namespaces/export=/namespaces/config/variables/getNormalizedWebpackOptions.md create mode 100644 api/webpack/namespaces/export=/namespaces/container/classes/ContainerPlugin.md create mode 100644 api/webpack/namespaces/export=/namespaces/container/classes/ContainerReferencePlugin.md create mode 100644 api/webpack/namespaces/export=/namespaces/container/classes/ModuleFederationPlugin.md create mode 100644 api/webpack/namespaces/export=/namespaces/container/index.md create mode 100644 api/webpack/namespaces/export=/namespaces/container/variables/scope.md create mode 100644 api/webpack/namespaces/export=/namespaces/css/classes/CssModulesPlugin.md create mode 100644 api/webpack/namespaces/export=/namespaces/css/index.md create mode 100644 api/webpack/namespaces/export=/namespaces/debug/classes/ProfilingPlugin.md create mode 100644 api/webpack/namespaces/export=/namespaces/debug/index.md create mode 100644 api/webpack/namespaces/export=/namespaces/dependencies/classes/ConstDependency.md create mode 100644 api/webpack/namespaces/export=/namespaces/dependencies/classes/HarmonyImportDependency.md create mode 100644 api/webpack/namespaces/export=/namespaces/dependencies/classes/ModuleDependency.md create mode 100644 api/webpack/namespaces/export=/namespaces/dependencies/classes/NullDependency.md create mode 100644 api/webpack/namespaces/export=/namespaces/dependencies/index.md create mode 100644 api/webpack/namespaces/export=/namespaces/electron/classes/ElectronTargetPlugin.md create mode 100644 api/webpack/namespaces/export=/namespaces/electron/index.md create mode 100644 api/webpack/namespaces/export=/namespaces/esm/classes/ModuleChunkLoadingRuntimeModule.md create mode 100644 api/webpack/namespaces/export=/namespaces/esm/index.md create mode 100644 api/webpack/namespaces/export=/namespaces/experiments/index.md create mode 100644 api/webpack/namespaces/export=/namespaces/experiments/namespaces/ids/classes/SyncModuleIdsPlugin.md create mode 100644 api/webpack/namespaces/export=/namespaces/experiments/namespaces/ids/index.md create mode 100644 api/webpack/namespaces/export=/namespaces/experiments/namespaces/schemes/classes/HttpUriPlugin.md create mode 100644 api/webpack/namespaces/export=/namespaces/experiments/namespaces/schemes/classes/VirtualUrlPlugin.md create mode 100644 api/webpack/namespaces/export=/namespaces/experiments/namespaces/schemes/index.md create mode 100644 api/webpack/namespaces/export=/namespaces/ids/classes/ChunkModuleIdRangePlugin.md create mode 100644 api/webpack/namespaces/export=/namespaces/ids/classes/DeterministicChunkIdsPlugin.md create mode 100644 api/webpack/namespaces/export=/namespaces/ids/classes/DeterministicModuleIdsPlugin.md create mode 100644 api/webpack/namespaces/export=/namespaces/ids/classes/HashedModuleIdsPlugin.md create mode 100644 api/webpack/namespaces/export=/namespaces/ids/classes/NamedChunkIdsPlugin.md create mode 100644 api/webpack/namespaces/export=/namespaces/ids/classes/NamedModuleIdsPlugin.md create mode 100644 api/webpack/namespaces/export=/namespaces/ids/classes/NaturalModuleIdsPlugin.md create mode 100644 api/webpack/namespaces/export=/namespaces/ids/classes/OccurrenceChunkIdsPlugin.md create mode 100644 api/webpack/namespaces/export=/namespaces/ids/classes/OccurrenceModuleIdsPlugin.md create mode 100644 api/webpack/namespaces/export=/namespaces/ids/index.md create mode 100644 api/webpack/namespaces/export=/namespaces/javascript/classes/EnableChunkLoadingPlugin.md create mode 100644 api/webpack/namespaces/export=/namespaces/javascript/classes/JavascriptParser.md create mode 100644 api/webpack/namespaces/export=/namespaces/javascript/index.md create mode 100644 api/webpack/namespaces/export=/namespaces/library/classes/AbstractLibraryPlugin.md create mode 100644 api/webpack/namespaces/export=/namespaces/library/classes/EnableLibraryPlugin.md create mode 100644 api/webpack/namespaces/export=/namespaces/library/index.md create mode 100644 api/webpack/namespaces/export=/namespaces/node/classes/NodeEnvironmentPlugin.md create mode 100644 api/webpack/namespaces/export=/namespaces/node/classes/NodeSourcePlugin.md create mode 100644 api/webpack/namespaces/export=/namespaces/node/classes/NodeTargetPlugin.md create mode 100644 api/webpack/namespaces/export=/namespaces/node/classes/NodeTemplatePlugin.md create mode 100644 api/webpack/namespaces/export=/namespaces/node/classes/ReadFileCompileAsyncWasmPlugin.md create mode 100644 api/webpack/namespaces/export=/namespaces/node/classes/ReadFileCompileWasmPlugin.md create mode 100644 api/webpack/namespaces/export=/namespaces/node/index.md create mode 100644 api/webpack/namespaces/export=/namespaces/optimize/classes/AggressiveMergingPlugin.md create mode 100644 api/webpack/namespaces/export=/namespaces/optimize/classes/AggressiveSplittingPlugin.md create mode 100644 api/webpack/namespaces/export=/namespaces/optimize/classes/LimitChunkCountPlugin.md create mode 100644 api/webpack/namespaces/export=/namespaces/optimize/classes/MergeDuplicateChunksPlugin.md create mode 100644 api/webpack/namespaces/export=/namespaces/optimize/classes/MinChunkSizePlugin.md create mode 100644 api/webpack/namespaces/export=/namespaces/optimize/classes/ModuleConcatenationPlugin.md create mode 100644 api/webpack/namespaces/export=/namespaces/optimize/classes/RealContentHashPlugin.md create mode 100644 api/webpack/namespaces/export=/namespaces/optimize/classes/RuntimeChunkPlugin.md create mode 100644 api/webpack/namespaces/export=/namespaces/optimize/classes/SideEffectsFlagPlugin.md create mode 100644 api/webpack/namespaces/export=/namespaces/optimize/classes/SplitChunksPlugin.md create mode 100644 api/webpack/namespaces/export=/namespaces/optimize/index.md create mode 100644 api/webpack/namespaces/export=/namespaces/optimize/namespaces/InnerGraph/classes/TopLevelSymbol.md create mode 100644 api/webpack/namespaces/export=/namespaces/optimize/namespaces/InnerGraph/index.md create mode 100644 api/webpack/namespaces/export=/namespaces/optimize/namespaces/InnerGraph/variables/addUsage.md create mode 100644 api/webpack/namespaces/export=/namespaces/optimize/namespaces/InnerGraph/variables/addVariableUsage.md create mode 100644 api/webpack/namespaces/export=/namespaces/optimize/namespaces/InnerGraph/variables/bailout.md create mode 100644 api/webpack/namespaces/export=/namespaces/optimize/namespaces/InnerGraph/variables/enable.md create mode 100644 api/webpack/namespaces/export=/namespaces/optimize/namespaces/InnerGraph/variables/getDependencyUsedByExportsCondition.md create mode 100644 api/webpack/namespaces/export=/namespaces/optimize/namespaces/InnerGraph/variables/getTopLevelSymbol.md create mode 100644 api/webpack/namespaces/export=/namespaces/optimize/namespaces/InnerGraph/variables/inferDependencyUsage.md create mode 100644 api/webpack/namespaces/export=/namespaces/optimize/namespaces/InnerGraph/variables/isDependencyUsedByExports.md create mode 100644 api/webpack/namespaces/export=/namespaces/optimize/namespaces/InnerGraph/variables/isEnabled.md create mode 100644 api/webpack/namespaces/export=/namespaces/optimize/namespaces/InnerGraph/variables/onUsage.md create mode 100644 api/webpack/namespaces/export=/namespaces/optimize/namespaces/InnerGraph/variables/setTopLevelSymbol.md create mode 100644 api/webpack/namespaces/export=/namespaces/optimize/namespaces/InnerGraph/variables/tagTopLevelSymbol.md create mode 100644 api/webpack/namespaces/export=/namespaces/optimize/namespaces/InnerGraph/variables/topLevelSymbolTag.md create mode 100644 api/webpack/namespaces/export=/namespaces/prefetch/classes/ChunkPrefetchPreloadPlugin.md create mode 100644 api/webpack/namespaces/export=/namespaces/prefetch/index.md create mode 100644 api/webpack/namespaces/export=/namespaces/runtime/classes/GetChunkFilenameRuntimeModule.md create mode 100644 api/webpack/namespaces/export=/namespaces/runtime/classes/LoadScriptRuntimeModule.md create mode 100644 api/webpack/namespaces/export=/namespaces/runtime/index.md create mode 100644 api/webpack/namespaces/export=/namespaces/sharing/classes/ConsumeSharedPlugin.md create mode 100644 api/webpack/namespaces/export=/namespaces/sharing/classes/ProvideSharedPlugin.md create mode 100644 api/webpack/namespaces/export=/namespaces/sharing/classes/SharePlugin.md create mode 100644 api/webpack/namespaces/export=/namespaces/sharing/index.md create mode 100644 api/webpack/namespaces/export=/namespaces/sharing/variables/scope.md create mode 100644 api/webpack/namespaces/export=/namespaces/sources/classes/CachedSource.md create mode 100644 api/webpack/namespaces/export=/namespaces/sources/classes/CompatSource.md create mode 100644 api/webpack/namespaces/export=/namespaces/sources/classes/ConcatSource.md create mode 100644 api/webpack/namespaces/export=/namespaces/sources/classes/OriginalSource.md create mode 100644 api/webpack/namespaces/export=/namespaces/sources/classes/PrefixSource.md create mode 100644 api/webpack/namespaces/export=/namespaces/sources/classes/RawSource.md create mode 100644 api/webpack/namespaces/export=/namespaces/sources/classes/ReplaceSource.md create mode 100644 api/webpack/namespaces/export=/namespaces/sources/classes/SizeOnlySource.md create mode 100644 api/webpack/namespaces/export=/namespaces/sources/classes/Source.md create mode 100644 api/webpack/namespaces/export=/namespaces/sources/classes/SourceMapSource.md create mode 100644 api/webpack/namespaces/export=/namespaces/sources/index.md create mode 100644 api/webpack/namespaces/export=/namespaces/util/classes/LazySet.md create mode 100644 api/webpack/namespaces/export=/namespaces/util/functions/compileBooleanMatcher.md create mode 100644 api/webpack/namespaces/export=/namespaces/util/index.md create mode 100644 api/webpack/namespaces/export=/namespaces/util/namespaces/comparators/index.md create mode 100644 api/webpack/namespaces/export=/namespaces/util/namespaces/comparators/variables/compareChunkGroupsByIndex.md create mode 100644 api/webpack/namespaces/export=/namespaces/util/namespaces/comparators/variables/compareChunks.md create mode 100644 api/webpack/namespaces/export=/namespaces/util/namespaces/comparators/variables/compareChunksById.md create mode 100644 api/webpack/namespaces/export=/namespaces/util/namespaces/comparators/variables/compareChunksNatural.md create mode 100644 api/webpack/namespaces/export=/namespaces/util/namespaces/comparators/variables/compareIds.md create mode 100644 api/webpack/namespaces/export=/namespaces/util/namespaces/comparators/variables/compareIterables.md create mode 100644 api/webpack/namespaces/export=/namespaces/util/namespaces/comparators/variables/compareLocations.md create mode 100644 api/webpack/namespaces/export=/namespaces/util/namespaces/comparators/variables/compareModulesByFullName.md create mode 100644 api/webpack/namespaces/export=/namespaces/util/namespaces/comparators/variables/compareModulesById.md create mode 100644 api/webpack/namespaces/export=/namespaces/util/namespaces/comparators/variables/compareModulesByIdOrIdentifier.md create mode 100644 api/webpack/namespaces/export=/namespaces/util/namespaces/comparators/variables/compareModulesByIdentifier.md create mode 100644 api/webpack/namespaces/export=/namespaces/util/namespaces/comparators/variables/compareModulesByPostOrderIndexOrIdentifier.md create mode 100644 api/webpack/namespaces/export=/namespaces/util/namespaces/comparators/variables/compareModulesByPreOrderIndexOrIdentifier.md create mode 100644 api/webpack/namespaces/export=/namespaces/util/namespaces/comparators/variables/compareNumbers.md create mode 100644 api/webpack/namespaces/export=/namespaces/util/namespaces/comparators/variables/compareSelect.md create mode 100644 api/webpack/namespaces/export=/namespaces/util/namespaces/comparators/variables/compareStrings.md create mode 100644 api/webpack/namespaces/export=/namespaces/util/namespaces/comparators/variables/compareStringsNumeric.md create mode 100644 api/webpack/namespaces/export=/namespaces/util/namespaces/comparators/variables/concatComparators.md create mode 100644 api/webpack/namespaces/export=/namespaces/util/namespaces/comparators/variables/keepOriginalOrder.md create mode 100644 api/webpack/namespaces/export=/namespaces/util/namespaces/comparators/variables/sortWithSourceOrder.md create mode 100644 api/webpack/namespaces/export=/namespaces/util/namespaces/compileBooleanMatcher/index.md create mode 100644 api/webpack/namespaces/export=/namespaces/util/namespaces/compileBooleanMatcher/variables/fromLists.md create mode 100644 api/webpack/namespaces/export=/namespaces/util/namespaces/compileBooleanMatcher/variables/itemsToRegexp.md create mode 100644 api/webpack/namespaces/export=/namespaces/util/namespaces/runtime/classes/RuntimeSpecMap.md create mode 100644 api/webpack/namespaces/export=/namespaces/util/namespaces/runtime/classes/RuntimeSpecSet.md create mode 100644 api/webpack/namespaces/export=/namespaces/util/namespaces/runtime/index.md create mode 100644 api/webpack/namespaces/export=/namespaces/util/namespaces/runtime/variables/compareRuntime.md create mode 100644 api/webpack/namespaces/export=/namespaces/util/namespaces/runtime/variables/filterRuntime.md create mode 100644 api/webpack/namespaces/export=/namespaces/util/namespaces/runtime/variables/forEachRuntime.md create mode 100644 api/webpack/namespaces/export=/namespaces/util/namespaces/runtime/variables/getEntryRuntime.md create mode 100644 api/webpack/namespaces/export=/namespaces/util/namespaces/runtime/variables/getRuntimeKey.md create mode 100644 api/webpack/namespaces/export=/namespaces/util/namespaces/runtime/variables/intersectRuntime.md create mode 100644 api/webpack/namespaces/export=/namespaces/util/namespaces/runtime/variables/keyToRuntime.md create mode 100644 api/webpack/namespaces/export=/namespaces/util/namespaces/runtime/variables/mergeRuntime.md create mode 100644 api/webpack/namespaces/export=/namespaces/util/namespaces/runtime/variables/mergeRuntimeCondition.md create mode 100644 api/webpack/namespaces/export=/namespaces/util/namespaces/runtime/variables/mergeRuntimeConditionNonFalse.md create mode 100644 api/webpack/namespaces/export=/namespaces/util/namespaces/runtime/variables/mergeRuntimeOwned.md create mode 100644 api/webpack/namespaces/export=/namespaces/util/namespaces/runtime/variables/runtimeConditionToString.md create mode 100644 api/webpack/namespaces/export=/namespaces/util/namespaces/runtime/variables/runtimeEqual.md create mode 100644 api/webpack/namespaces/export=/namespaces/util/namespaces/runtime/variables/runtimeToString.md create mode 100644 api/webpack/namespaces/export=/namespaces/util/namespaces/runtime/variables/subtractRuntime.md create mode 100644 api/webpack/namespaces/export=/namespaces/util/namespaces/runtime/variables/subtractRuntimeCondition.md create mode 100644 api/webpack/namespaces/export=/namespaces/util/namespaces/serialization/index.md create mode 100644 api/webpack/namespaces/export=/namespaces/util/namespaces/serialization/variables/MEASURE_END_OPERATION.md create mode 100644 api/webpack/namespaces/export=/namespaces/util/namespaces/serialization/variables/MEASURE_START_OPERATION.md create mode 100644 api/webpack/namespaces/export=/namespaces/util/namespaces/serialization/variables/NOT_SERIALIZABLE.md create mode 100644 api/webpack/namespaces/export=/namespaces/util/namespaces/serialization/variables/buffersSerializer.md create mode 100644 api/webpack/namespaces/export=/namespaces/util/namespaces/serialization/variables/createFileSerializer.md create mode 100644 api/webpack/namespaces/export=/namespaces/util/namespaces/serialization/variables/register.md create mode 100644 api/webpack/namespaces/export=/namespaces/util/namespaces/serialization/variables/registerLoader.md create mode 100644 api/webpack/namespaces/export=/namespaces/util/namespaces/serialization/variables/registerNotSerializable.md create mode 100644 api/webpack/namespaces/export=/namespaces/util/variables/cleverMerge.md create mode 100644 api/webpack/namespaces/export=/namespaces/util/variables/createHash.md create mode 100644 api/webpack/namespaces/export=/namespaces/wasm/classes/AsyncWebAssemblyModulesPlugin.md create mode 100644 api/webpack/namespaces/export=/namespaces/wasm/classes/EnableWasmLoadingPlugin.md create mode 100644 api/webpack/namespaces/export=/namespaces/wasm/index.md create mode 100644 api/webpack/namespaces/export=/namespaces/web/classes/CssLoadingRuntimeModule.md create mode 100644 api/webpack/namespaces/export=/namespaces/web/classes/FetchCompileAsyncWasmPlugin.md create mode 100644 api/webpack/namespaces/export=/namespaces/web/classes/FetchCompileWasmPlugin.md create mode 100644 api/webpack/namespaces/export=/namespaces/web/classes/JsonpChunkLoadingRuntimeModule.md create mode 100644 api/webpack/namespaces/export=/namespaces/web/classes/JsonpTemplatePlugin.md create mode 100644 api/webpack/namespaces/export=/namespaces/web/index.md create mode 100644 api/webpack/namespaces/export=/namespaces/webworker/classes/WebWorkerTemplatePlugin.md create mode 100644 api/webpack/namespaces/export=/namespaces/webworker/index.md create mode 100644 api/webpack/namespaces/export=/variables/UsageState.md create mode 100644 api/webpack/namespaces/export=/variables/validate.md create mode 100644 api/webpack/namespaces/export=/variables/validateSchema.md create mode 100644 api/webpack/namespaces/export=/variables/version.md create mode 100644 api/webpack/namespaces/export=/variables/webpack.md diff --git a/.gitignore b/.gitignore index b512c09..d101bc4 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ -node_modules \ No newline at end of file +node_modules +*.generated.json \ No newline at end of file diff --git a/api/README.md b/api/README.md deleted file mode 100644 index 7cc1db8..0000000 --- a/api/README.md +++ /dev/null @@ -1,94 +0,0 @@ ---- -title: webpack ---- - -**webpack** - -*** - -# webpack - -## Interfaces - -- [Argument](interfaces/Argument.md) -- [Asset](interfaces/Asset.md) -- [AssetEmittedInfo](interfaces/AssetEmittedInfo.md) -- [ColorsOptions](interfaces/ColorsOptions.md) -- [Configuration](interfaces/Configuration.md) -- [EntryObject](interfaces/EntryObject.md) -- [ExternalItemFunctionData](interfaces/ExternalItemFunctionData.md) -- [ExternalItemObjectKnown](interfaces/ExternalItemObjectKnown.md) -- [ExternalItemObjectUnknown](interfaces/ExternalItemObjectUnknown.md) -- [FileCacheOptions](interfaces/FileCacheOptions.md) -- [GeneratorOptionsByModuleTypeKnown](interfaces/GeneratorOptionsByModuleTypeKnown.md) -- [InputFileSystem](interfaces/InputFileSystem.md) -- [LibraryOptions](interfaces/LibraryOptions.md) -- [MemoryCacheOptions](interfaces/MemoryCacheOptions.md) -- [ModuleOptions](interfaces/ModuleOptions.md) -- [MultiCompilerOptions](interfaces/MultiCompilerOptions.md) -- [ObjectDeserializerContext](interfaces/ObjectDeserializerContext.md) -- [ObjectSerializerContext](interfaces/ObjectSerializerContext.md) -- [OutputFileSystem](interfaces/OutputFileSystem.md) -- [ParserOptionsByModuleTypeKnown](interfaces/ParserOptionsByModuleTypeKnown.md) -- [PathData](interfaces/PathData.md) -- [Problem](interfaces/Problem.md) -- [RenderManifestOptions](interfaces/RenderManifestOptions.md) -- [ResolveData](interfaces/ResolveData.md) -- [ResolveOptions](interfaces/ResolveOptions.md) -- [RuleSetRule](interfaces/RuleSetRule.md) -- [StatsOptions](interfaces/StatsOptions.md) -- [WebpackOptionsNormalized](interfaces/WebpackOptionsNormalized.md) -- [WebpackPluginInstance](interfaces/WebpackPluginInstance.md) - -## Type Aliases - -- [AssetInfo](type-aliases/AssetInfo.md) -- [ChunkGroup](type-aliases/ChunkGroup.md) -- [CodeGenerationResults](type-aliases/CodeGenerationResults.md) -- [Colors](type-aliases/Colors.md) -- [Entry](type-aliases/Entry.md) -- [EntryNormalized](type-aliases/EntryNormalized.md) -- [EntryOptions](type-aliases/EntryOptions.md) -- [Entrypoint](type-aliases/Entrypoint.md) -- [ExternalItem](type-aliases/ExternalItem.md) -- [ExternalItemFunction](type-aliases/ExternalItemFunction.md) -- [ExternalItemFunctionCallback](type-aliases/ExternalItemFunctionCallback.md) -- [ExternalItemFunctionDataGetResolve](type-aliases/ExternalItemFunctionDataGetResolve.md) -- [ExternalItemFunctionDataGetResolveCallbackResult](type-aliases/ExternalItemFunctionDataGetResolveCallbackResult.md) -- [ExternalItemFunctionDataGetResolveResult](type-aliases/ExternalItemFunctionDataGetResolveResult.md) -- [ExternalItemFunctionPromise](type-aliases/ExternalItemFunctionPromise.md) -- [ExternalItemValue](type-aliases/ExternalItemValue.md) -- [Externals](type-aliases/Externals.md) -- [MultiConfiguration](type-aliases/MultiConfiguration.md) -- [MultiStats](type-aliases/MultiStats.md) -- [MultiStatsOptions](type-aliases/MultiStatsOptions.md) -- [ParserState](type-aliases/ParserState.md) -- [RenderManifestEntry](type-aliases/RenderManifestEntry.md) -- [ResolvePluginInstance](type-aliases/ResolvePluginInstance.md) -- [Resolver](type-aliases/Resolver.md) -- [RuleSetCondition](type-aliases/RuleSetCondition.md) -- [RuleSetConditionAbsolute](type-aliases/RuleSetConditionAbsolute.md) -- [RuleSetUse](type-aliases/RuleSetUse.md) -- [RuleSetUseFunction](type-aliases/RuleSetUseFunction.md) -- [RuleSetUseItem](type-aliases/RuleSetUseItem.md) -- [StatsAsset](type-aliases/StatsAsset.md) -- [StatsChunk](type-aliases/StatsChunk.md) -- [StatsChunkGroup](type-aliases/StatsChunkGroup.md) -- [StatsChunkOrigin](type-aliases/StatsChunkOrigin.md) -- [StatsCompilation](type-aliases/StatsCompilation.md) -- [StatsError](type-aliases/StatsError.md) -- [StatsLogging](type-aliases/StatsLogging.md) -- [StatsLoggingEntry](type-aliases/StatsLoggingEntry.md) -- [StatsModule](type-aliases/StatsModule.md) -- [StatsModuleIssuer](type-aliases/StatsModuleIssuer.md) -- [StatsModuleReason](type-aliases/StatsModuleReason.md) -- [StatsModuleTraceDependency](type-aliases/StatsModuleTraceDependency.md) -- [StatsModuleTraceItem](type-aliases/StatsModuleTraceItem.md) -- [StatsProfile](type-aliases/StatsProfile.md) -- [TemplatePath](type-aliases/TemplatePath.md) -- [Watching](type-aliases/Watching.md) -- [WebpackPluginFunction](type-aliases/WebpackPluginFunction.md) - -## Variables - -- [export=](variables/export=.md) diff --git a/api/_media/GOVERNANCE.md b/api/_media/GOVERNANCE.md new file mode 100644 index 0000000..6d004f5 --- /dev/null +++ b/api/_media/GOVERNANCE.md @@ -0,0 +1,3 @@ +# webpack Project Governance + +The webpack project (and organization) follows the webpack's governance model defined within [the webpack governance repository](https://github.com/webpack/governance/blob/main/README.md). diff --git a/api/_media/WORKING_GROUP.md b/api/_media/WORKING_GROUP.md new file mode 100644 index 0000000..3578afb --- /dev/null +++ b/api/_media/WORKING_GROUP.md @@ -0,0 +1,48 @@ +# Webpack Core Working Group + +This document outlines the webpack core working group. + +--- + +## Working Group Name + +Webpack Core Working Group + +## Purpose and Responsibilities + +The purpose of this working group is to facilitate, implement and fix problems and features within the core of webpack. This core includes tasking such as bugfixes, feature implementation and in general maintaining the main logic of webpack. + +Each member of the working group is required to adhere to the [governance model of webpack](https://github.com/webpack/governance). In addition to having responsibility of the main part of webpack, the working group will manage other parts of the webpack organization repositories in such way they see fit. + +## Goals & Objectives + +- Develop features within the webpack organization and core areas. +- Fix bugs within webpack organization and core areas. +- Maintain and steer webpack in general together with the Technical Steering Committee. +- Ensure performance and code coverage is sustained and top-notch. + +## Members + +- [snitin315](https://github.com/snitin315) - + **Nitin Kumar** <> (he/him) +- [thelarkinn](https://github.com/thelarkinn) - + **Sean Larkin** <> (he/him) +- [jhnns](https://github.com/jhnns) - + **Johannes Ewald** <> +- [sokra](https://github.com/sokra) - + **Tobias Koppers** <> +- [spacek33z](https://github.com/spacek33z) - + **Kees Kluskens** <> + +## Communication + +Meetings are hosted on an as-needed basis and private discussions are held in the #core-wg channel. For public feedback and communication, please use an appropriate channel within the webpack discord (e.g `#development-general`). + +## Resources + +- https://github.com/webpack +- https://github.com/webpack/governance + +## Reporting & Updates + +- The working group can choose to involve the webpack TSC for feedback and updates, but has full autonomy of making changes to any codebase within webpack. diff --git a/api/classes/AsyncDependenciesBlock.md b/api/classes/AsyncDependenciesBlock.md new file mode 100644 index 0000000..be76c07 --- /dev/null +++ b/api/classes/AsyncDependenciesBlock.md @@ -0,0 +1,306 @@ +--- +title: AsyncDependenciesBlock +--- + +[webpack](../globals.md) / AsyncDependenciesBlock + +# Class: AsyncDependenciesBlock + +Defined in: [webpack/types.d.ts:498](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L498) + +## Extends + +- `DependenciesBlock` + +## Constructors + +### Constructor + +> **new AsyncDependenciesBlock**(`groupOptions`, `loc?`, `request?`): `AsyncDependenciesBlock` + +Defined in: [webpack/types.d.ts:499](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L499) + +#### Parameters + +##### groupOptions + +`string` | `GroupOptionsAsyncDependenciesBlock` + +##### loc? + +`SyntheticDependencyLocation` | `RealDependencyLocation` + +##### request? + +`string` + +#### Returns + +`AsyncDependenciesBlock` + +#### Overrides + +`DependenciesBlock.constructor` + +## Properties + +### blocks + +> **blocks**: `AsyncDependenciesBlock`[] + +Defined in: [webpack/types.d.ts:4110](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4110) + +#### Inherited from + +`DependenciesBlock.blocks` + +*** + +### chunkName? + +> `optional` **chunkName**: `string` + +Defined in: [webpack/types.d.ts:507](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L507) + +*** + +### dependencies + +> **dependencies**: [`Dependency`](Dependency.md)[] + +Defined in: [webpack/types.d.ts:4109](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4109) + +#### Inherited from + +`DependenciesBlock.dependencies` + +*** + +### groupOptions + +> **groupOptions**: `GroupOptionsAsyncDependenciesBlock` + +Defined in: [webpack/types.d.ts:504](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L504) + +*** + +### loc? + +> `optional` **loc**: `SyntheticDependencyLocation` \| `RealDependencyLocation` + +Defined in: [webpack/types.d.ts:505](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L505) + +*** + +### module + +> **module**: `any` + +Defined in: [webpack/types.d.ts:509](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L509) + +*** + +### parent? + +> `optional` **parent**: `DependenciesBlock` + +Defined in: [webpack/types.d.ts:4111](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4111) + +#### Inherited from + +`DependenciesBlock.parent` + +*** + +### request? + +> `optional` **request**: `string` + +Defined in: [webpack/types.d.ts:506](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L506) + +## Accessors + +### circular + +#### Get Signature + +> **get** **circular**(): `boolean` + +Defined in: [webpack/types.d.ts:508](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L508) + +##### Returns + +`boolean` + +## Methods + +### addBlock() + +> **addBlock**(`block`): `void` + +Defined in: [webpack/types.d.ts:4118](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4118) + +Adds a DependencyBlock to DependencyBlock relationship. +This is used for when a Module has a AsyncDependencyBlock tie (for code-splitting) + +#### Parameters + +##### block + +`AsyncDependenciesBlock` + +#### Returns + +`void` + +#### Inherited from + +`DependenciesBlock.addBlock` + +*** + +### addDependency() + +> **addDependency**(`dependency`): `void` + +Defined in: [webpack/types.d.ts:4119](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4119) + +#### Parameters + +##### dependency + +[`Dependency`](Dependency.md) + +#### Returns + +`void` + +#### Inherited from + +`DependenciesBlock.addDependency` + +*** + +### clearDependenciesAndBlocks() + +> **clearDependenciesAndBlocks**(): `void` + +Defined in: [webpack/types.d.ts:4125](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4125) + +Removes all dependencies and blocks + +#### Returns + +`void` + +#### Inherited from + +`DependenciesBlock.clearDependenciesAndBlocks` + +*** + +### deserialize() + +> **deserialize**(`__namedParameters`): `void` + +Defined in: [webpack/types.d.ts:4128](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4128) + +#### Parameters + +##### \_\_namedParameters + +[`ObjectDeserializerContext`](../interfaces/ObjectDeserializerContext.md) + +#### Returns + +`void` + +#### Inherited from + +`DependenciesBlock.deserialize` + +*** + +### getRootBlock() + +> **getRootBlock**(): `DependenciesBlock` + +Defined in: [webpack/types.d.ts:4112](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4112) + +#### Returns + +`DependenciesBlock` + +#### Inherited from + +`DependenciesBlock.getRootBlock` + +*** + +### removeDependency() + +> **removeDependency**(`dependency`): `void` + +Defined in: [webpack/types.d.ts:4120](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4120) + +#### Parameters + +##### dependency + +[`Dependency`](Dependency.md) + +#### Returns + +`void` + +#### Inherited from + +`DependenciesBlock.removeDependency` + +*** + +### serialize() + +> **serialize**(`__namedParameters`): `void` + +Defined in: [webpack/types.d.ts:4127](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4127) + +#### Parameters + +##### \_\_namedParameters + +[`ObjectSerializerContext`](../interfaces/ObjectSerializerContext.md) + +#### Returns + +`void` + +#### Inherited from + +`DependenciesBlock.serialize` + +*** + +### updateHash() + +> **updateHash**(`hash`, `context`): `void` + +Defined in: [webpack/types.d.ts:4126](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4126) + +#### Parameters + +##### hash + +`Hash` + +##### context + +`UpdateHashContextDependency` + +#### Returns + +`void` + +#### Inherited from + +`DependenciesBlock.updateHash` diff --git a/api/classes/AutomaticPrefetchPlugin.md b/api/classes/AutomaticPrefetchPlugin.md new file mode 100644 index 0000000..6d9d4a2 --- /dev/null +++ b/api/classes/AutomaticPrefetchPlugin.md @@ -0,0 +1,41 @@ +--- +title: AutomaticPrefetchPlugin +--- + +[webpack](../globals.md) / AutomaticPrefetchPlugin + +# Class: AutomaticPrefetchPlugin + +Defined in: [webpack/types.d.ts:562](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L562) + +## Constructors + +### Constructor + +> **new AutomaticPrefetchPlugin**(): `AutomaticPrefetchPlugin` + +Defined in: [webpack/types.d.ts:563](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L563) + +#### Returns + +`AutomaticPrefetchPlugin` + +## Methods + +### apply() + +> **apply**(`compiler`): `void` + +Defined in: [webpack/types.d.ts:568](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L568) + +Apply the plugin + +#### Parameters + +##### compiler + +[`Compiler`](Compiler.md) + +#### Returns + +`void` diff --git a/api/classes/BannerPlugin.md b/api/classes/BannerPlugin.md new file mode 100644 index 0000000..9decbca --- /dev/null +++ b/api/classes/BannerPlugin.md @@ -0,0 +1,83 @@ +--- +title: BannerPlugin +--- + +[webpack](../globals.md) / BannerPlugin + +# Class: BannerPlugin + +Defined in: [webpack/types.d.ts:575](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L575) + +## Constructors + +### Constructor + +> **new BannerPlugin**(`options`): `BannerPlugin` + +Defined in: [webpack/types.d.ts:576](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L576) + +#### Parameters + +##### options + +`BannerPluginArgument` + +#### Returns + +`BannerPlugin` + +## Properties + +### banner() + +> **banner**: (`data`) => `string` + +Defined in: [webpack/types.d.ts:578](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L578) + +#### Parameters + +##### data + +###### chunk + +[`Chunk`](Chunk.md) + +###### filename + +`string` + +###### hash? + +`string` + +#### Returns + +`string` + +*** + +### options + +> **options**: `BannerPluginOptions` + +Defined in: [webpack/types.d.ts:577](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L577) + +## Methods + +### apply() + +> **apply**(`compiler`): `void` + +Defined in: [webpack/types.d.ts:583](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L583) + +Apply the plugin + +#### Parameters + +##### compiler + +[`Compiler`](Compiler.md) + +#### Returns + +`void` diff --git a/api/classes/Cache.md b/api/classes/Cache.md new file mode 100644 index 0000000..3670139 --- /dev/null +++ b/api/classes/Cache.md @@ -0,0 +1,225 @@ +--- +title: Cache +--- + +[webpack](../globals.md) / Cache + +# Class: Cache + +Defined in: [webpack/types.d.ts:1099](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1099) + +## Constructors + +### Constructor + +> **new Cache**(): `CacheClass` + +Defined in: [webpack/types.d.ts:1100](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1100) + +#### Returns + +`CacheClass` + +## Properties + +### hooks + +> **hooks**: `object` + +Defined in: [webpack/types.d.ts:1101](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1101) + +#### beginIdle + +> **beginIdle**: `SyncHook`\<\[\]\> + +#### endIdle + +> **endIdle**: `AsyncParallelHook`\<\[\]\> + +#### get + +> **get**: `AsyncSeriesBailHook`\<\[`string`, `Etag`, `GotHandler`\<`any`\>[]\], `any`\> + +#### shutdown + +> **shutdown**: `AsyncParallelHook`\<\[\]\> + +#### store + +> **store**: `AsyncParallelHook`\<\[`string`, `Etag`, `any`\]\> + +#### storeBuildDependencies + +> **storeBuildDependencies**: `AsyncParallelHook`\<\[`Iterable`\<`string`, `any`, `any`\>\]\> + +*** + +### STAGE\_DEFAULT + +> `static` **STAGE\_DEFAULT**: `number` + +Defined in: [webpack/types.d.ts:1132](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1132) + +*** + +### STAGE\_DISK + +> `static` **STAGE\_DISK**: `number` + +Defined in: [webpack/types.d.ts:1133](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1133) + +*** + +### STAGE\_MEMORY + +> `static` **STAGE\_MEMORY**: `number` + +Defined in: [webpack/types.d.ts:1131](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1131) + +*** + +### STAGE\_NETWORK + +> `static` **STAGE\_NETWORK**: `number` + +Defined in: [webpack/types.d.ts:1134](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1134) + +## Methods + +### beginIdle() + +> **beginIdle**(): `void` + +Defined in: [webpack/types.d.ts:1128](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1128) + +#### Returns + +`void` + +*** + +### endIdle() + +> **endIdle**(`callback`): `void` + +Defined in: [webpack/types.d.ts:1129](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1129) + +#### Parameters + +##### callback + +`CallbackCacheCache`\<`void`\> + +#### Returns + +`void` + +*** + +### get() + +> **get**\<`T`\>(`identifier`, `etag`, `callback`): `void` + +Defined in: [webpack/types.d.ts:1109](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1109) + +#### Type Parameters + +##### T + +`T` + +#### Parameters + +##### identifier + +`string` + +##### etag + +`Etag` + +##### callback + +`CallbackCacheCache`\<`T`\> + +#### Returns + +`void` + +*** + +### shutdown() + +> **shutdown**(`callback`): `void` + +Defined in: [webpack/types.d.ts:1130](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1130) + +#### Parameters + +##### callback + +`CallbackCacheCache`\<`void`\> + +#### Returns + +`void` + +*** + +### store() + +> **store**\<`T`\>(`identifier`, `etag`, `data`, `callback`): `void` + +Defined in: [webpack/types.d.ts:1114](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1114) + +#### Type Parameters + +##### T + +`T` + +#### Parameters + +##### identifier + +`string` + +##### etag + +`Etag` + +##### data + +`T` + +##### callback + +`CallbackCacheCache`\<`void`\> + +#### Returns + +`void` + +*** + +### storeBuildDependencies() + +> **storeBuildDependencies**(`dependencies`, `callback`): `void` + +Defined in: [webpack/types.d.ts:1124](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1124) + +After this method has succeeded the cache can only be restored when build dependencies are + +#### Parameters + +##### dependencies + +`Iterable`\<`string`\> + +##### callback + +`CallbackCacheCache`\<`void`\> + +#### Returns + +`void` diff --git a/api/classes/Chunk.md b/api/classes/Chunk.md new file mode 100644 index 0000000..eac074b --- /dev/null +++ b/api/classes/Chunk.md @@ -0,0 +1,843 @@ +--- +title: Chunk +--- + +[webpack](../globals.md) / Chunk + +# Class: Chunk + +Defined in: [webpack/types.d.ts:1290](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1290) + +## Extended by + +- [`HotUpdateChunk`](HotUpdateChunk.md) + +## Constructors + +### Constructor + +> **new Chunk**(`name?`, `backCompat?`): `Chunk` + +Defined in: [webpack/types.d.ts:1291](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1291) + +#### Parameters + +##### name? + +`string` + +##### backCompat? + +`boolean` + +#### Returns + +`Chunk` + +## Properties + +### auxiliaryFiles + +> **auxiliaryFiles**: `Set`\<`string`\> + +Defined in: [webpack/types.d.ts:1306](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1306) + +*** + +### chunkReason? + +> `optional` **chunkReason**: `string` + +Defined in: [webpack/types.d.ts:1311](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1311) + +*** + +### contentHash + +> **contentHash**: `Record`\<`string`, `string`\> + +Defined in: [webpack/types.d.ts:1309](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1309) + +*** + +### cssFilenameTemplate? + +> `optional` **cssFilenameTemplate**: `string` \| (`pathData`, `assetInfo?`) => `string` + +Defined in: [webpack/types.d.ts:1301](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1301) + +*** + +### debugId + +> **debugId**: `number` + +Defined in: [webpack/types.d.ts:1294](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1294) + +*** + +### extraAsync + +> **extraAsync**: `boolean` + +Defined in: [webpack/types.d.ts:1312](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1312) + +*** + +### filenameTemplate? + +> `optional` **filenameTemplate**: `string` \| (`pathData`, `assetInfo?`) => `string` + +Defined in: [webpack/types.d.ts:1298](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1298) + +*** + +### files + +> **files**: `Set`\<`string`\> + +Defined in: [webpack/types.d.ts:1305](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1305) + +*** + +### hash? + +> `optional` **hash**: `string` + +Defined in: [webpack/types.d.ts:1308](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1308) + +*** + +### id + +> **id**: `string` \| `number` + +Defined in: [webpack/types.d.ts:1292](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1292) + +*** + +### idNameHints + +> **idNameHints**: `SortableSet`\<`string`\> + +Defined in: [webpack/types.d.ts:1296](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1296) + +*** + +### ids + +> **ids**: `ChunkId`[] + +Defined in: [webpack/types.d.ts:1293](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1293) + +*** + +### name? + +> `optional` **name**: `string` + +Defined in: [webpack/types.d.ts:1295](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1295) + +*** + +### preventIntegration + +> **preventIntegration**: `boolean` + +Defined in: [webpack/types.d.ts:1297](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1297) + +*** + +### rendered + +> **rendered**: `boolean` + +Defined in: [webpack/types.d.ts:1307](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1307) + +*** + +### renderedHash? + +> `optional` **renderedHash**: `string` + +Defined in: [webpack/types.d.ts:1310](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1310) + +*** + +### runtime + +> **runtime**: `RuntimeSpec` + +Defined in: [webpack/types.d.ts:1304](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1304) + +## Accessors + +### entryModule + +#### Get Signature + +> **get** **entryModule**(): [`Module`](Module.md) + +Defined in: [webpack/types.d.ts:1317](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1317) + +##### Deprecated + +##### Returns + +[`Module`](Module.md) + +*** + +### groupsIterable + +#### Get Signature + +> **get** **groupsIterable**(): `SortableSet`\<[`ChunkGroup`](ChunkGroup.md)\> + +Defined in: [webpack/types.d.ts:1352](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1352) + +##### Returns + +`SortableSet`\<[`ChunkGroup`](ChunkGroup.md)\> + +*** + +### modulesIterable + +#### Get Signature + +> **get** **modulesIterable**(): `Iterable`\<[`Module`](Module.md)\> + +Defined in: [webpack/types.d.ts:1322](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1322) + +##### Returns + +`Iterable`\<[`Module`](Module.md)\> + +## Methods + +### addGroup() + +> **addGroup**(`chunkGroup`): `void` + +Defined in: [webpack/types.d.ts:1348](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1348) + +#### Parameters + +##### chunkGroup + +[`ChunkGroup`](ChunkGroup.md) + +#### Returns + +`void` + +*** + +### addModule() + +> **addModule**(`module`): `boolean` + +Defined in: [webpack/types.d.ts:1319](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1319) + +#### Parameters + +##### module + +[`Module`](Module.md) + +#### Returns + +`boolean` + +*** + +### canBeInitial() + +> **canBeInitial**(): `boolean` + +Defined in: [webpack/types.d.ts:1345](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1345) + +#### Returns + +`boolean` + +*** + +### canBeIntegrated() + +> **canBeIntegrated**(`otherChunk`): `boolean` + +Defined in: [webpack/types.d.ts:1329](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1329) + +#### Parameters + +##### otherChunk + +`Chunk` + +#### Returns + +`boolean` + +*** + +### compareTo() + +> **compareTo**(`otherChunk`): `-1` \| `0` \| `1` + +Defined in: [webpack/types.d.ts:1323](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1323) + +#### Parameters + +##### otherChunk + +`Chunk` + +#### Returns + +`-1` \| `0` \| `1` + +*** + +### containsModule() + +> **containsModule**(`module`): `boolean` + +Defined in: [webpack/types.d.ts:1324](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1324) + +#### Parameters + +##### module + +[`Module`](Module.md) + +#### Returns + +`boolean` + +*** + +### disconnectFromGroups() + +> **disconnectFromGroups**(): `void` + +Defined in: [webpack/types.d.ts:1353](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1353) + +#### Returns + +`void` + +*** + +### getAllAsyncChunks() + +> **getAllAsyncChunks**(): `Set`\<`Chunk`\> + +Defined in: [webpack/types.d.ts:1356](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1356) + +#### Returns + +`Set`\<`Chunk`\> + +*** + +### getAllInitialChunks() + +> **getAllInitialChunks**(): `Set`\<`Chunk`\> + +Defined in: [webpack/types.d.ts:1357](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1357) + +#### Returns + +`Set`\<`Chunk`\> + +*** + +### getAllReferencedAsyncEntrypoints() + +> **getAllReferencedAsyncEntrypoints**(): `Set`\<[`Entrypoint`](Entrypoint.md)\> + +Defined in: [webpack/types.d.ts:1359](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1359) + +#### Returns + +`Set`\<[`Entrypoint`](Entrypoint.md)\> + +*** + +### getAllReferencedChunks() + +> **getAllReferencedChunks**(): `Set`\<`Chunk`\> + +Defined in: [webpack/types.d.ts:1358](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1358) + +#### Returns + +`Set`\<`Chunk`\> + +*** + +### getChildIdsByOrders() + +> **getChildIdsByOrders**(`chunkGraph`, `filterFn?`): `Record`\<`string`, `ChunkId`[]\> + +Defined in: [webpack/types.d.ts:1361](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1361) + +#### Parameters + +##### chunkGraph + +[`ChunkGraph`](ChunkGraph.md) + +##### filterFn? + +(`c`, `chunkGraph`) => `boolean` + +#### Returns + +`Record`\<`string`, `ChunkId`[]\> + +*** + +### getChildIdsByOrdersMap() + +> **getChildIdsByOrdersMap**(`chunkGraph`, `includeDirectChildren?`, `filterFn?`): `ChunkChildIdsByOrdersMapByData` + +Defined in: [webpack/types.d.ts:1369](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1369) + +#### Parameters + +##### chunkGraph + +[`ChunkGraph`](ChunkGraph.md) + +##### includeDirectChildren? + +`boolean` + +##### filterFn? + +(`c`, `chunkGraph`) => `boolean` + +#### Returns + +`ChunkChildIdsByOrdersMapByData` + +*** + +### getChildrenOfTypeInOrder() + +> **getChildrenOfTypeInOrder**(`chunkGraph`, `type`): `ChunkChildOfTypeInOrder`[] + +Defined in: [webpack/types.d.ts:1365](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1365) + +#### Parameters + +##### chunkGraph + +[`ChunkGraph`](ChunkGraph.md) + +##### type + +`string` + +#### Returns + +`ChunkChildOfTypeInOrder`[] + +*** + +### ~~getChunkMaps()~~ + +> **getChunkMaps**(`realHash`): `ChunkMaps` + +Defined in: [webpack/types.d.ts:1343](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1343) + +#### Parameters + +##### realHash + +`boolean` + +#### Returns + +`ChunkMaps` + +#### Deprecated + +*** + +### getChunkModuleMaps() + +> **getChunkModuleMaps**(`filterFn`): `ChunkModuleMaps` + +Defined in: [webpack/types.d.ts:1334](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1334) + +#### Parameters + +##### filterFn + +(`m`) => `boolean` + +#### Returns + +`ChunkModuleMaps` + +*** + +### getEntryOptions() + +> **getEntryOptions**(): [`EntryOptions`](../type-aliases/EntryOptions.md) + +Defined in: [webpack/types.d.ts:1347](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1347) + +#### Returns + +[`EntryOptions`](../type-aliases/EntryOptions.md) + +*** + +### getModules() + +> **getModules**(): [`Module`](Module.md)[] + +Defined in: [webpack/types.d.ts:1325](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1325) + +#### Returns + +[`Module`](Module.md)[] + +*** + +### getNumberOfGroups() + +> **getNumberOfGroups**(): `number` + +Defined in: [webpack/types.d.ts:1351](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1351) + +#### Returns + +`number` + +*** + +### getNumberOfModules() + +> **getNumberOfModules**(): `number` + +Defined in: [webpack/types.d.ts:1321](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1321) + +#### Returns + +`number` + +*** + +### hasAsyncChunks() + +> **hasAsyncChunks**(): `boolean` + +Defined in: [webpack/types.d.ts:1360](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1360) + +#### Returns + +`boolean` + +*** + +### hasChildByOrder() + +> **hasChildByOrder**(`chunkGraph`, `type`, `includeDirectChildren?`, `filterFn?`): `boolean` + +Defined in: [webpack/types.d.ts:1374](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1374) + +#### Parameters + +##### chunkGraph + +[`ChunkGraph`](ChunkGraph.md) + +##### type + +`string` + +##### includeDirectChildren? + +`boolean` + +##### filterFn? + +(`c`, `chunkGraph`) => `boolean` + +#### Returns + +`boolean` + +*** + +### hasEntryModule() + +> **hasEntryModule**(): `boolean` + +Defined in: [webpack/types.d.ts:1318](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1318) + +#### Returns + +`boolean` + +*** + +### hasModuleInGraph() + +> **hasModuleInGraph**(`filterFn`, `filterChunkFn?`): `boolean` + +Defined in: [webpack/types.d.ts:1335](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1335) + +#### Parameters + +##### filterFn + +(`m`) => `boolean` + +##### filterChunkFn? + +(`c`, `chunkGraph`) => `boolean` + +#### Returns + +`boolean` + +*** + +### hasRuntime() + +> **hasRuntime**(): `boolean` + +Defined in: [webpack/types.d.ts:1344](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1344) + +#### Returns + +`boolean` + +*** + +### integrate() + +> **integrate**(`otherChunk`): `boolean` + +Defined in: [webpack/types.d.ts:1328](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1328) + +#### Parameters + +##### otherChunk + +`Chunk` + +#### Returns + +`boolean` + +*** + +### integratedSize() + +> **integratedSize**(`otherChunk`, `options`): `number` + +Defined in: [webpack/types.d.ts:1333](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1333) + +#### Parameters + +##### otherChunk + +`Chunk` + +##### options + +`ChunkSizeOptions` + +#### Returns + +`number` + +*** + +### isEmpty() + +> **isEmpty**(): `boolean` + +Defined in: [webpack/types.d.ts:1330](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1330) + +#### Returns + +`boolean` + +*** + +### isInGroup() + +> **isInGroup**(`chunkGroup`): `boolean` + +Defined in: [webpack/types.d.ts:1350](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1350) + +#### Parameters + +##### chunkGroup + +[`ChunkGroup`](ChunkGroup.md) + +#### Returns + +`boolean` + +*** + +### isOnlyInitial() + +> **isOnlyInitial**(): `boolean` + +Defined in: [webpack/types.d.ts:1346](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1346) + +#### Returns + +`boolean` + +*** + +### modulesSize() + +> **modulesSize**(): `number` + +Defined in: [webpack/types.d.ts:1331](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1331) + +#### Returns + +`number` + +*** + +### moveModule() + +> **moveModule**(`module`, `otherChunk`): `void` + +Defined in: [webpack/types.d.ts:1327](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1327) + +#### Parameters + +##### module + +[`Module`](Module.md) + +##### otherChunk + +`Chunk` + +#### Returns + +`void` + +*** + +### remove() + +> **remove**(): `void` + +Defined in: [webpack/types.d.ts:1326](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1326) + +#### Returns + +`void` + +*** + +### removeGroup() + +> **removeGroup**(`chunkGroup`): `void` + +Defined in: [webpack/types.d.ts:1349](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1349) + +#### Parameters + +##### chunkGroup + +[`ChunkGroup`](ChunkGroup.md) + +#### Returns + +`void` + +*** + +### removeModule() + +> **removeModule**(`module`): `void` + +Defined in: [webpack/types.d.ts:1320](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1320) + +#### Parameters + +##### module + +[`Module`](Module.md) + +#### Returns + +`void` + +*** + +### size() + +> **size**(`options?`): `number` + +Defined in: [webpack/types.d.ts:1332](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1332) + +#### Parameters + +##### options? + +`ChunkSizeOptions` + +#### Returns + +`number` + +*** + +### split() + +> **split**(`newChunk`): `void` + +Defined in: [webpack/types.d.ts:1354](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1354) + +#### Parameters + +##### newChunk + +`Chunk` + +#### Returns + +`void` + +*** + +### updateHash() + +> **updateHash**(`hash`, `chunkGraph`): `void` + +Defined in: [webpack/types.d.ts:1355](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1355) + +#### Parameters + +##### hash + +`Hash` + +##### chunkGraph + +[`ChunkGraph`](ChunkGraph.md) + +#### Returns + +`void` diff --git a/api/classes/ChunkGraph.md b/api/classes/ChunkGraph.md new file mode 100644 index 0000000..59574f3 --- /dev/null +++ b/api/classes/ChunkGraph.md @@ -0,0 +1,1859 @@ +--- +title: ChunkGraph +--- + +[webpack](../globals.md) / ChunkGraph + +# Class: ChunkGraph + +Defined in: [webpack/types.d.ts:1395](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1395) + +## Constructors + +### Constructor + +> **new ChunkGraph**(`moduleGraph`, `hashFunction?`): `ChunkGraph` + +Defined in: [webpack/types.d.ts:1396](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1396) + +#### Parameters + +##### moduleGraph + +[`ModuleGraph`](ModuleGraph.md) + +##### hashFunction? + +`HashFunction` + +#### Returns + +`ChunkGraph` + +## Properties + +### moduleGraph + +> **moduleGraph**: [`ModuleGraph`](ModuleGraph.md) + +Defined in: [webpack/types.d.ts:1397](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1397) + +## Methods + +### addChunkRuntimeRequirements() + +> **addChunkRuntimeRequirements**(`chunk`, `items`): `void` + +Defined in: [webpack/types.d.ts:1539](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1539) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +##### items + +`Set`\<`string`\> + +#### Returns + +`void` + +*** + +### addDependentHashModuleToChunk() + +> **addDependentHashModuleToChunk**(`chunk`, `module`): `void` + +Defined in: [webpack/types.d.ts:1489](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1489) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +##### module + +[`RuntimeModule`](RuntimeModule.md) + +#### Returns + +`void` + +*** + +### addFullHashModuleToChunk() + +> **addFullHashModuleToChunk**(`chunk`, `module`): `void` + +Defined in: [webpack/types.d.ts:1488](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1488) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +##### module + +[`RuntimeModule`](RuntimeModule.md) + +#### Returns + +`void` + +*** + +### addModuleRuntimeRequirements() + +> **addModuleRuntimeRequirements**(`module`, `runtime`, `items`, `transferOwnership?`): `void` + +Defined in: [webpack/types.d.ts:1533](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1533) + +#### Parameters + +##### module + +[`Module`](Module.md) + +##### runtime + +`RuntimeSpec` + +##### items + +`Set`\<`string`\> + +##### transferOwnership? + +`boolean` + +#### Returns + +`void` + +*** + +### addTreeRuntimeRequirements() + +> **addTreeRuntimeRequirements**(`chunk`, `items`): `void` + +Defined in: [webpack/types.d.ts:1540](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1540) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +##### items + +`Iterable`\<`string`\> + +#### Returns + +`void` + +*** + +### attachDependentHashModules() + +> **attachDependentHashModules**(`chunk`, `modules`): `void` + +Defined in: [webpack/types.d.ts:1404](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1404) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +##### modules + +`Iterable`\<[`RuntimeModule`](RuntimeModule.md)\> + +#### Returns + +`void` + +*** + +### attachFullHashModules() + +> **attachFullHashModules**(`chunk`, `modules`): `void` + +Defined in: [webpack/types.d.ts:1403](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1403) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +##### modules + +`Iterable`\<[`RuntimeModule`](RuntimeModule.md)\> + +#### Returns + +`void` + +*** + +### attachModules() + +> **attachModules**(`chunk`, `modules`): `void` + +Defined in: [webpack/types.d.ts:1401](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1401) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +##### modules + +`Iterable`\<[`Module`](Module.md)\> + +#### Returns + +`void` + +*** + +### attachRuntimeModules() + +> **attachRuntimeModules**(`chunk`, `modules`): `void` + +Defined in: [webpack/types.d.ts:1402](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1402) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +##### modules + +`Iterable`\<[`RuntimeModule`](RuntimeModule.md)\> + +#### Returns + +`void` + +*** + +### canChunksBeIntegrated() + +> **canChunksBeIntegrated**(`chunkA`, `chunkB`): `boolean` + +Defined in: [webpack/types.d.ts:1478](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1478) + +#### Parameters + +##### chunkA + +[`Chunk`](Chunk.md) + +##### chunkB + +[`Chunk`](Chunk.md) + +#### Returns + +`boolean` + +*** + +### compareChunks() + +> **compareChunks**(`chunkA`, `chunkB`): `-1` \| `0` \| `1` + +Defined in: [webpack/types.d.ts:1468](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1468) + +#### Parameters + +##### chunkA + +[`Chunk`](Chunk.md) + +##### chunkB + +[`Chunk`](Chunk.md) + +#### Returns + +`-1` \| `0` \| `1` + +*** + +### connectBlockAndChunkGroup() + +> **connectBlockAndChunkGroup**(`depBlock`, `chunkGroup`): `void` + +Defined in: [webpack/types.d.ts:1515](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1515) + +#### Parameters + +##### depBlock + +[`AsyncDependenciesBlock`](AsyncDependenciesBlock.md) + +##### chunkGroup + +[`ChunkGroup`](ChunkGroup.md) + +#### Returns + +`void` + +*** + +### connectChunkAndEntryModule() + +> **connectChunkAndEntryModule**(`chunk`, `module`, `entrypoint`): `void` + +Defined in: [webpack/types.d.ts:1482](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1482) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +##### module + +[`Module`](Module.md) + +##### entrypoint + +[`Entrypoint`](Entrypoint.md) + +#### Returns + +`void` + +*** + +### connectChunkAndModule() + +> **connectChunkAndModule**(`chunk`, `module`): `void` + +Defined in: [webpack/types.d.ts:1398](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1398) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +##### module + +[`Module`](Module.md) + +#### Returns + +`void` + +*** + +### connectChunkAndRuntimeModule() + +> **connectChunkAndRuntimeModule**(`chunk`, `module`): `void` + +Defined in: [webpack/types.d.ts:1487](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1487) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +##### module + +[`RuntimeModule`](RuntimeModule.md) + +#### Returns + +`void` + +*** + +### disconnectChunk() + +> **disconnectChunk**(`chunk`): `void` + +Defined in: [webpack/types.d.ts:1400](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1400) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +#### Returns + +`void` + +*** + +### disconnectChunkAndEntryModule() + +> **disconnectChunkAndEntryModule**(`chunk`, `module`): `void` + +Defined in: [webpack/types.d.ts:1490](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1490) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +##### module + +[`Module`](Module.md) + +#### Returns + +`void` + +*** + +### disconnectChunkAndModule() + +> **disconnectChunkAndModule**(`chunk`, `module`): `void` + +Defined in: [webpack/types.d.ts:1399](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1399) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +##### module + +[`Module`](Module.md) + +#### Returns + +`void` + +*** + +### disconnectChunkAndRuntimeModule() + +> **disconnectChunkAndRuntimeModule**(`chunk`, `module`): `void` + +Defined in: [webpack/types.d.ts:1491](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1491) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +##### module + +[`RuntimeModule`](RuntimeModule.md) + +#### Returns + +`void` + +*** + +### disconnectChunkGroup() + +> **disconnectChunkGroup**(`chunkGroup`): `void` + +Defined in: [webpack/types.d.ts:1519](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1519) + +#### Parameters + +##### chunkGroup + +[`ChunkGroup`](ChunkGroup.md) + +#### Returns + +`void` + +*** + +### disconnectEntries() + +> **disconnectEntries**(`chunk`): `void` + +Defined in: [webpack/types.d.ts:1493](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1493) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +#### Returns + +`void` + +*** + +### disconnectEntryModule() + +> **disconnectEntryModule**(`module`): `void` + +Defined in: [webpack/types.d.ts:1492](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1492) + +#### Parameters + +##### module + +[`Module`](Module.md) + +#### Returns + +`void` + +*** + +### getBlockChunkGroup() + +> **getBlockChunkGroup**(`depBlock`): [`ChunkGroup`](ChunkGroup.md) + +Defined in: [webpack/types.d.ts:1514](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1514) + +#### Parameters + +##### depBlock + +[`AsyncDependenciesBlock`](AsyncDependenciesBlock.md) + +#### Returns + +[`ChunkGroup`](ChunkGroup.md) + +*** + +### getChunkConditionMap() + +> **getChunkConditionMap**(`chunk`, `filterFn`): `ChunkConditionMap` + +Defined in: [webpack/types.d.ts:1459](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1459) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +##### filterFn + +(`c`, `chunkGraph`) => `boolean` + +#### Returns + +`ChunkConditionMap` + +*** + +### getChunkDependentHashModulesIterable() + +> **getChunkDependentHashModulesIterable**(`chunk`): `Iterable`\<[`RuntimeModule`](RuntimeModule.md), `any`, `any`\> + +Defined in: [webpack/types.d.ts:1508](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1508) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +#### Returns + +`Iterable`\<[`RuntimeModule`](RuntimeModule.md), `any`, `any`\> + +*** + +### getChunkEntryDependentChunksIterable() + +> **getChunkEntryDependentChunksIterable**(`chunk`): `Iterable`\<[`Chunk`](Chunk.md)\> + +Defined in: [webpack/types.d.ts:1497](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1497) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +#### Returns + +`Iterable`\<[`Chunk`](Chunk.md)\> + +*** + +### getChunkEntryModulesIterable() + +> **getChunkEntryModulesIterable**(`chunk`): `Iterable`\<[`Module`](Module.md)\> + +Defined in: [webpack/types.d.ts:1496](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1496) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +#### Returns + +`Iterable`\<[`Module`](Module.md)\> + +*** + +### getChunkEntryModulesWithChunkGroupIterable() + +> **getChunkEntryModulesWithChunkGroupIterable**(`chunk`): `Iterable`\<\[[`Module`](Module.md), [`Entrypoint`](Entrypoint.md)\]\> + +Defined in: [webpack/types.d.ts:1511](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1511) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +#### Returns + +`Iterable`\<\[[`Module`](Module.md), [`Entrypoint`](Entrypoint.md)\]\> + +*** + +### getChunkFullHashModulesIterable() + +> **getChunkFullHashModulesIterable**(`chunk`): `Iterable`\<[`RuntimeModule`](RuntimeModule.md), `any`, `any`\> + +Defined in: [webpack/types.d.ts:1502](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1502) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +#### Returns + +`Iterable`\<[`RuntimeModule`](RuntimeModule.md), `any`, `any`\> + +*** + +### getChunkFullHashModulesSet() + +> **getChunkFullHashModulesSet**(`chunk`): `ReadonlySet`\<[`RuntimeModule`](RuntimeModule.md)\> + +Defined in: [webpack/types.d.ts:1505](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1505) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +#### Returns + +`ReadonlySet`\<[`RuntimeModule`](RuntimeModule.md)\> + +*** + +### getChunkModuleIdMap() + +> **getChunkModuleIdMap**(`chunk`, `filterFn`, `includeAllChunks?`): `ChunkModuleIdMapEs5Alias_2` + +Defined in: [webpack/types.d.ts:1448](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1448) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +##### filterFn + +(`m`) => `boolean` + +##### includeAllChunks? + +`boolean` + +#### Returns + +`ChunkModuleIdMapEs5Alias_2` + +*** + +### getChunkModuleRenderedHashMap() + +> **getChunkModuleRenderedHashMap**(`chunk`, `filterFn`, `hashLength?`, `includeAllChunks?`): `ChunkModuleHashMap` + +Defined in: [webpack/types.d.ts:1453](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1453) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +##### filterFn + +(`m`) => `boolean` + +##### hashLength? + +`number` + +##### includeAllChunks? + +`boolean` + +#### Returns + +`ChunkModuleHashMap` + +*** + +### getChunkModules() + +> **getChunkModules**(`chunk`): [`Module`](Module.md)[] + +Defined in: [webpack/types.d.ts:1443](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1443) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +#### Returns + +[`Module`](Module.md)[] + +*** + +### getChunkModulesIterable() + +> **getChunkModulesIterable**(`chunk`): `Iterable`\<[`Module`](Module.md)\> + +Defined in: [webpack/types.d.ts:1422](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1422) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +#### Returns + +`Iterable`\<[`Module`](Module.md)\> + +*** + +### getChunkModulesIterableBySourceType() + +> **getChunkModulesIterableBySourceType**(`chunk`, `sourceType`): `Iterable`\<[`Module`](Module.md), `any`, `any`\> + +Defined in: [webpack/types.d.ts:1423](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1423) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +##### sourceType + +`string` + +#### Returns + +`Iterable`\<[`Module`](Module.md), `any`, `any`\> + +*** + +### getChunkModuleSourceTypes() + +> **getChunkModuleSourceTypes**(`chunk`, `module`): `ReadonlySet`\<`string`\> + +Defined in: [webpack/types.d.ts:1432](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1432) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +##### module + +[`Module`](Module.md) + +#### Returns + +`ReadonlySet`\<`string`\> + +*** + +### getChunkModulesSize() + +> **getChunkModulesSize**(`chunk`): `number` + +Defined in: [webpack/types.d.ts:1469](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1469) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +#### Returns + +`number` + +*** + +### getChunkModulesSizes() + +> **getChunkModulesSizes**(`chunk`): `Record`\<`string`, `number`\> + +Defined in: [webpack/types.d.ts:1470](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1470) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +#### Returns + +`Record`\<`string`, `number`\> + +*** + +### getChunkRootModules() + +> **getChunkRootModules**(`chunk`): [`Module`](Module.md)[] + +Defined in: [webpack/types.d.ts:1471](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1471) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +#### Returns + +[`Module`](Module.md)[] + +*** + +### getChunkRuntimeModulesInOrder() + +> **getChunkRuntimeModulesInOrder**(`chunk`): [`RuntimeModule`](RuntimeModule.md)[] + +Defined in: [webpack/types.d.ts:1501](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1501) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +#### Returns + +[`RuntimeModule`](RuntimeModule.md)[] + +*** + +### getChunkRuntimeModulesIterable() + +> **getChunkRuntimeModulesIterable**(`chunk`): `Iterable`\<[`RuntimeModule`](RuntimeModule.md)\> + +Defined in: [webpack/types.d.ts:1500](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1500) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +#### Returns + +`Iterable`\<[`RuntimeModule`](RuntimeModule.md)\> + +*** + +### getChunkRuntimeRequirements() + +> **getChunkRuntimeRequirements**(`chunk`): `ReadonlySet`\<`string`\> + +Defined in: [webpack/types.d.ts:1545](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1545) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +#### Returns + +`ReadonlySet`\<`string`\> + +*** + +### getChunkSize() + +> **getChunkSize**(`chunk`, `options?`): `number` + +Defined in: [webpack/types.d.ts:1472](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1472) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +##### options? + +`ChunkSizeOptions` + +#### Returns + +`number` + +*** + +### getIntegratedChunksSize() + +> **getIntegratedChunksSize**(`chunkA`, `chunkB`, `options?`): `number` + +Defined in: [webpack/types.d.ts:1473](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1473) + +#### Parameters + +##### chunkA + +[`Chunk`](Chunk.md) + +##### chunkB + +[`Chunk`](Chunk.md) + +##### options? + +`ChunkSizeOptions` + +#### Returns + +`number` + +*** + +### getModuleChunks() + +> **getModuleChunks**(`module`): [`Chunk`](Chunk.md)[] + +Defined in: [webpack/types.d.ts:1417](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1417) + +#### Parameters + +##### module + +[`Module`](Module.md) + +#### Returns + +[`Chunk`](Chunk.md)[] + +*** + +### getModuleChunksIterable() + +> **getModuleChunksIterable**(`module`): `Iterable`\<[`Chunk`](Chunk.md)\> + +Defined in: [webpack/types.d.ts:1412](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1412) + +#### Parameters + +##### module + +[`Module`](Module.md) + +#### Returns + +`Iterable`\<[`Chunk`](Chunk.md)\> + +*** + +### getModuleGraphHash() + +> **getModuleGraphHash**(`module`, `runtime`, `withConnections?`): `string` + +Defined in: [webpack/types.d.ts:1546](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1546) + +#### Parameters + +##### module + +[`Module`](Module.md) + +##### runtime + +`RuntimeSpec` + +##### withConnections? + +`boolean` + +#### Returns + +`string` + +*** + +### getModuleGraphHashBigInt() + +> **getModuleGraphHashBigInt**(`module`, `runtime`, `withConnections?`): `bigint` + +Defined in: [webpack/types.d.ts:1551](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1551) + +#### Parameters + +##### module + +[`Module`](Module.md) + +##### runtime + +`RuntimeSpec` + +##### withConnections? + +`boolean` + +#### Returns + +`bigint` + +*** + +### getModuleHash() + +> **getModuleHash**(`module`, `runtime`): `string` + +Defined in: [webpack/types.d.ts:1525](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1525) + +#### Parameters + +##### module + +[`Module`](Module.md) + +##### runtime + +`RuntimeSpec` + +#### Returns + +`string` + +*** + +### getModuleId() + +> **getModuleId**(`module`): `string` \| `number` + +Defined in: [webpack/types.d.ts:1520](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1520) + +#### Parameters + +##### module + +[`Module`](Module.md) + +#### Returns + +`string` \| `number` + +*** + +### getModuleRuntimeRequirements() + +> **getModuleRuntimeRequirements**(`module`, `runtime`): `ReadonlySet`\<`string`\> + +Defined in: [webpack/types.d.ts:1541](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1541) + +#### Parameters + +##### module + +[`Module`](Module.md) + +##### runtime + +`RuntimeSpec` + +#### Returns + +`ReadonlySet`\<`string`\> + +*** + +### getModuleRuntimes() + +> **getModuleRuntimes**(`module`): [`RuntimeSpecSet`](../webpack/namespaces/export=/namespaces/util/namespaces/runtime/classes/RuntimeSpecSet.md) + +Defined in: [webpack/types.d.ts:1419](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1419) + +#### Parameters + +##### module + +[`Module`](Module.md) + +#### Returns + +[`RuntimeSpecSet`](../webpack/namespaces/export=/namespaces/util/namespaces/runtime/classes/RuntimeSpecSet.md) + +*** + +### getModuleSourceTypes() + +> **getModuleSourceTypes**(`module`): `ReadonlySet`\<`string`\> + +Defined in: [webpack/types.d.ts:1433](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1433) + +#### Parameters + +##### module + +[`Module`](Module.md) + +#### Returns + +`ReadonlySet`\<`string`\> + +*** + +### getNumberOfChunkFullHashModules() + +> **getNumberOfChunkFullHashModules**(`chunk`): `number` + +Defined in: [webpack/types.d.ts:1421](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1421) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +#### Returns + +`number` + +*** + +### getNumberOfChunkModules() + +> **getNumberOfChunkModules**(`chunk`): `number` + +Defined in: [webpack/types.d.ts:1420](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1420) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +#### Returns + +`number` + +*** + +### getNumberOfEntryModules() + +> **getNumberOfEntryModules**(`chunk`): `number` + +Defined in: [webpack/types.d.ts:1494](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1494) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +#### Returns + +`number` + +*** + +### getNumberOfModuleChunks() + +> **getNumberOfModuleChunks**(`module`): `number` + +Defined in: [webpack/types.d.ts:1418](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1418) + +#### Parameters + +##### module + +[`Module`](Module.md) + +#### Returns + +`number` + +*** + +### getNumberOfRuntimeModules() + +> **getNumberOfRuntimeModules**(`chunk`): `number` + +Defined in: [webpack/types.d.ts:1495](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1495) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +#### Returns + +`number` + +*** + +### getOrderedChunkModules() + +> **getOrderedChunkModules**(`chunk`, `comparator`): [`Module`](Module.md)[] + +Defined in: [webpack/types.d.ts:1444](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1444) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +##### comparator + +(`a`, `b`) => `-1` \| `0` \| `1` + +#### Returns + +[`Module`](Module.md)[] + +*** + +### getOrderedChunkModulesIterable() + +> **getOrderedChunkModulesIterable**(`chunk`, `comparator`): `Iterable`\<[`Module`](Module.md)\> + +Defined in: [webpack/types.d.ts:1434](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1434) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +##### comparator + +(`a`, `b`) => `-1` \| `0` \| `1` + +#### Returns + +`Iterable`\<[`Module`](Module.md)\> + +*** + +### getOrderedChunkModulesIterableBySourceType() + +> **getOrderedChunkModulesIterableBySourceType**(`chunk`, `sourceType`, `comparator`): `Iterable`\<[`Module`](Module.md), `any`, `any`\> + +Defined in: [webpack/types.d.ts:1438](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1438) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +##### sourceType + +`string` + +##### comparator + +(`a`, `b`) => `-1` \| `0` \| `1` + +#### Returns + +`Iterable`\<[`Module`](Module.md), `any`, `any`\> + +*** + +### getOrderedModuleChunksIterable() + +> **getOrderedModuleChunksIterable**(`module`, `sortFn`): `Iterable`\<[`Chunk`](Chunk.md)\> + +Defined in: [webpack/types.d.ts:1413](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1413) + +#### Parameters + +##### module + +[`Module`](Module.md) + +##### sortFn + +(`a`, `b`) => `-1` \| `0` \| `1` + +#### Returns + +`Iterable`\<[`Chunk`](Chunk.md)\> + +*** + +### getRenderedModuleHash() + +> **getRenderedModuleHash**(`module`, `runtime`): `string` + +Defined in: [webpack/types.d.ts:1526](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1526) + +#### Parameters + +##### module + +[`Module`](Module.md) + +##### runtime + +`RuntimeSpec` + +#### Returns + +`string` + +*** + +### getRuntimeChunkDependentChunksIterable() + +> **getRuntimeChunkDependentChunksIterable**(`chunk`): `Iterable`\<[`Chunk`](Chunk.md)\> + +Defined in: [webpack/types.d.ts:1498](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1498) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +#### Returns + +`Iterable`\<[`Chunk`](Chunk.md)\> + +*** + +### getRuntimeId() + +> **getRuntimeId**(`runtime`): `RuntimeId` + +Defined in: [webpack/types.d.ts:1522](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1522) + +#### Parameters + +##### runtime + +`string` + +#### Returns + +`RuntimeId` + +*** + +### getTreeRuntimeRequirements() + +> **getTreeRuntimeRequirements**(`chunk`): `ReadonlySet`\<`string`\> + +Defined in: [webpack/types.d.ts:1556](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1556) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +#### Returns + +`ReadonlySet`\<`string`\> + +*** + +### hasChunkEntryDependentChunks() + +> **hasChunkEntryDependentChunks**(`chunk`): `boolean` + +Defined in: [webpack/types.d.ts:1499](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1499) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +#### Returns + +`boolean` + +*** + +### hasModuleHashes() + +> **hasModuleHashes**(`module`, `runtime`): `boolean` + +Defined in: [webpack/types.d.ts:1524](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1524) + +#### Parameters + +##### module + +[`Module`](Module.md) + +##### runtime + +`RuntimeSpec` + +#### Returns + +`boolean` + +*** + +### hasModuleInGraph() + +> **hasModuleInGraph**(`chunk`, `filterFn`, `filterChunkFn?`): `boolean` + +Defined in: [webpack/types.d.ts:1463](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1463) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +##### filterFn + +(`m`) => `boolean` + +##### filterChunkFn? + +(`c`, `chunkGraph`) => `boolean` + +#### Returns + +`boolean` + +*** + +### integrateChunks() + +> **integrateChunks**(`chunkA`, `chunkB`): `void` + +Defined in: [webpack/types.d.ts:1479](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1479) + +#### Parameters + +##### chunkA + +[`Chunk`](Chunk.md) + +##### chunkB + +[`Chunk`](Chunk.md) + +#### Returns + +`void` + +*** + +### isEntryModule() + +> **isEntryModule**(`module`): `boolean` + +Defined in: [webpack/types.d.ts:1411](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1411) + +#### Parameters + +##### module + +[`Module`](Module.md) + +#### Returns + +`boolean` + +*** + +### isEntryModuleInChunk() + +> **isEntryModuleInChunk**(`module`, `chunk`): `boolean` + +Defined in: [webpack/types.d.ts:1481](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1481) + +#### Parameters + +##### module + +[`Module`](Module.md) + +##### chunk + +[`Chunk`](Chunk.md) + +#### Returns + +`boolean` + +*** + +### isModuleInChunk() + +> **isModuleInChunk**(`module`, `chunk`): `boolean` + +Defined in: [webpack/types.d.ts:1409](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1409) + +#### Parameters + +##### module + +[`Module`](Module.md) + +##### chunk + +[`Chunk`](Chunk.md) + +#### Returns + +`boolean` + +*** + +### isModuleInChunkGroup() + +> **isModuleInChunkGroup**(`module`, `chunkGroup`): `boolean` + +Defined in: [webpack/types.d.ts:1410](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1410) + +#### Parameters + +##### module + +[`Module`](Module.md) + +##### chunkGroup + +[`ChunkGroup`](ChunkGroup.md) + +#### Returns + +`boolean` + +*** + +### replaceModule() + +> **replaceModule**(`oldModule`, `newModule`): `void` + +Defined in: [webpack/types.d.ts:1408](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1408) + +#### Parameters + +##### oldModule + +[`Module`](Module.md) + +##### newModule + +[`Module`](Module.md) + +#### Returns + +`void` + +*** + +### setChunkModuleSourceTypes() + +> **setChunkModuleSourceTypes**(`chunk`, `module`, `sourceTypes`): `void` + +Defined in: [webpack/types.d.ts:1427](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1427) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +##### module + +[`Module`](Module.md) + +##### sourceTypes + +`ReadonlySet`\<`string`\> + +#### Returns + +`void` + +*** + +### setModuleHashes() + +> **setModuleHashes**(`module`, `runtime`, `hash`, `renderedHash`): `void` + +Defined in: [webpack/types.d.ts:1527](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1527) + +#### Parameters + +##### module + +[`Module`](Module.md) + +##### runtime + +`RuntimeSpec` + +##### hash + +`string` + +##### renderedHash + +`string` + +#### Returns + +`void` + +*** + +### setModuleId() + +> **setModuleId**(`module`, `id`): `void` + +Defined in: [webpack/types.d.ts:1521](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1521) + +#### Parameters + +##### module + +[`Module`](Module.md) + +##### id + +`ModuleId` + +#### Returns + +`void` + +*** + +### setRuntimeId() + +> **setRuntimeId**(`runtime`, `id`): `void` + +Defined in: [webpack/types.d.ts:1523](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1523) + +#### Parameters + +##### runtime + +`string` + +##### id + +`RuntimeId` + +#### Returns + +`void` + +*** + +### upgradeDependentToFullHashModules() + +> **upgradeDependentToFullHashModules**(`chunk`): `void` + +Defined in: [webpack/types.d.ts:1480](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1480) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +#### Returns + +`void` + +*** + +### ~~clearChunkGraphForChunk()~~ + +> `static` **clearChunkGraphForChunk**(`chunk`): `void` + +Defined in: [webpack/types.d.ts:1594](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1594) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +#### Returns + +`void` + +#### Deprecated + +*** + +### ~~clearChunkGraphForModule()~~ + +> `static` **clearChunkGraphForModule**(`module`): `void` + +Defined in: [webpack/types.d.ts:1575](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1575) + +#### Parameters + +##### module + +[`Module`](Module.md) + +#### Returns + +`void` + +#### Deprecated + +*** + +### ~~getChunkGraphForChunk()~~ + +> `static` **getChunkGraphForChunk**(`chunk`, `deprecateMessage`, `deprecationCode`): `ChunkGraph` + +Defined in: [webpack/types.d.ts:1580](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1580) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +##### deprecateMessage + +`string` + +##### deprecationCode + +`string` + +#### Returns + +`ChunkGraph` + +#### Deprecated + +*** + +### ~~getChunkGraphForModule()~~ + +> `static` **getChunkGraphForModule**(`module`, `deprecateMessage`, `deprecationCode`): `ChunkGraph` + +Defined in: [webpack/types.d.ts:1561](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1561) + +#### Parameters + +##### module + +[`Module`](Module.md) + +##### deprecateMessage + +`string` + +##### deprecationCode + +`string` + +#### Returns + +`ChunkGraph` + +#### Deprecated + +*** + +### ~~setChunkGraphForChunk()~~ + +> `static` **setChunkGraphForChunk**(`chunk`, `chunkGraph`): `void` + +Defined in: [webpack/types.d.ts:1589](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1589) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +##### chunkGraph + +`ChunkGraph` + +#### Returns + +`void` + +#### Deprecated + +*** + +### ~~setChunkGraphForModule()~~ + +> `static` **setChunkGraphForModule**(`module`, `chunkGraph`): `void` + +Defined in: [webpack/types.d.ts:1570](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1570) + +#### Parameters + +##### module + +[`Module`](Module.md) + +##### chunkGraph + +`ChunkGraph` + +#### Returns + +`void` + +#### Deprecated diff --git a/api/classes/ChunkGroup.md b/api/classes/ChunkGroup.md new file mode 100644 index 0000000..cd17747 --- /dev/null +++ b/api/classes/ChunkGroup.md @@ -0,0 +1,759 @@ +--- +title: ChunkGroup +--- + +[webpack](../globals.md) / ChunkGroup + +# Abstract Class: ChunkGroup + +Defined in: [webpack/types.d.ts:1596](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1596) + +## Extended by + +- [`Entrypoint`](Entrypoint.md) + +## Constructors + +### Constructor + +> **new ChunkGroup**(): `ChunkGroup` + +#### Returns + +`ChunkGroup` + +## Properties + +### chunks + +> **chunks**: [`Chunk`](Chunk.md)[] + +Defined in: [webpack/types.d.ts:1599](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1599) + +*** + +### getModuleIndex() + +> **getModuleIndex**: (`module`) => `number` + +Defined in: [webpack/types.d.ts:1698](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1698) + +#### Parameters + +##### module + +[`Module`](Module.md) + +#### Returns + +`number` + +*** + +### getModuleIndex2() + +> **getModuleIndex2**: (`module`) => `number` + +Defined in: [webpack/types.d.ts:1699](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1699) + +#### Parameters + +##### module + +[`Module`](Module.md) + +#### Returns + +`number` + +*** + +### groupDebugId + +> **groupDebugId**: `number` + +Defined in: [webpack/types.d.ts:1597](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1597) + +*** + +### index? + +> `optional` **index**: `number` + +Defined in: [webpack/types.d.ts:1601](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1601) + +*** + +### name? + +> `optional` **name**: `string` + +Defined in: [webpack/types.d.ts:1612](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1612) + +returns the name of current ChunkGroup +sets a new name for current ChunkGroup + +*** + +### options + +> **options**: `ChunkGroupOptions` + +Defined in: [webpack/types.d.ts:1598](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1598) + +*** + +### origins + +> **origins**: `OriginRecord`[] + +Defined in: [webpack/types.d.ts:1600](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1600) + +## Accessors + +### asyncEntrypointsIterable + +#### Get Signature + +> **get** **asyncEntrypointsIterable**(): `SortableSet`\<`ChunkGroup`\> + +Defined in: [webpack/types.d.ts:1653](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1653) + +##### Returns + +`SortableSet`\<`ChunkGroup`\> + +*** + +### blocksIterable + +#### Get Signature + +> **get** **blocksIterable**(): `Iterable`\<[`AsyncDependenciesBlock`](AsyncDependenciesBlock.md)\> + +Defined in: [webpack/types.d.ts:1657](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1657) + +##### Returns + +`Iterable`\<[`AsyncDependenciesBlock`](AsyncDependenciesBlock.md)\> + +*** + +### childrenIterable + +#### Get Signature + +> **get** **childrenIterable**(): `SortableSet`\<`ChunkGroup`\> + +Defined in: [webpack/types.d.ts:1644](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1644) + +##### Returns + +`SortableSet`\<`ChunkGroup`\> + +*** + +### debugId + +#### Get Signature + +> **get** **debugId**(): `string` + +Defined in: [webpack/types.d.ts:1617](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1617) + +get a uniqueId for ChunkGroup, made up of its member Chunk debugId's + +##### Returns + +`string` + +*** + +### id + +#### Get Signature + +> **get** **id**(): `string` + +Defined in: [webpack/types.d.ts:1622](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1622) + +get a unique id for ChunkGroup, made up of its member Chunk id's + +##### Returns + +`string` + +*** + +### parentsIterable + +#### Get Signature + +> **get** **parentsIterable**(): `SortableSet`\<`ChunkGroup`\> + +Defined in: [webpack/types.d.ts:1650](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1650) + +##### Returns + +`SortableSet`\<`ChunkGroup`\> + +## Methods + +### addAsyncEntrypoint() + +> **addAsyncEntrypoint**(`entrypoint`): `boolean` + +Defined in: [webpack/types.d.ts:1652](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1652) + +#### Parameters + +##### entrypoint + +[`Entrypoint`](Entrypoint.md) + +#### Returns + +`boolean` + +*** + +### addBlock() + +> **addBlock**(`block`): `boolean` + +Defined in: [webpack/types.d.ts:1658](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1658) + +#### Parameters + +##### block + +[`AsyncDependenciesBlock`](AsyncDependenciesBlock.md) + +#### Returns + +`boolean` + +*** + +### addChild() + +> **addChild**(`group`): `boolean` + +Defined in: [webpack/types.d.ts:1641](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1641) + +#### Parameters + +##### group + +`ChunkGroup` + +#### Returns + +`boolean` + +*** + +### addOptions() + +> **addOptions**(`options`): `void` + +Defined in: [webpack/types.d.ts:1606](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1606) + +when a new chunk is added to a chunkGroup, addingOptions will occur. + +#### Parameters + +##### options + +`ChunkGroupOptions` + +#### Returns + +`void` + +*** + +### addOrigin() + +> **addOrigin**(`module`, `loc`, `request`): `void` + +Defined in: [webpack/types.d.ts:1659](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1659) + +#### Parameters + +##### module + +[`Module`](Module.md) + +##### loc + +`DependencyLocation` + +##### request + +`string` + +#### Returns + +`void` + +*** + +### addParent() + +> **addParent**(`parentChunk`): `boolean` + +Defined in: [webpack/types.d.ts:1646](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1646) + +#### Parameters + +##### parentChunk + +`ChunkGroup` + +#### Returns + +`boolean` + +*** + +### checkConstraints() + +> **checkConstraints**(): `void` + +Defined in: [webpack/types.d.ts:1697](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1697) + +#### Returns + +`void` + +*** + +### compareTo() + +> **compareTo**(`chunkGraph`, `otherGroup`): `-1` \| `0` \| `1` + +Defined in: [webpack/types.d.ts:1672](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1672) + +Sorting predicate which allows current ChunkGroup to be compared against another. +Sorting values are based off of number of chunks in ChunkGroup. + +#### Parameters + +##### chunkGraph + +[`ChunkGraph`](ChunkGraph.md) + +##### otherGroup + +`ChunkGroup` + +#### Returns + +`-1` \| `0` \| `1` + +*** + +### getBlocks() + +> **getBlocks**(): [`AsyncDependenciesBlock`](AsyncDependenciesBlock.md)[] + +Defined in: [webpack/types.d.ts:1654](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1654) + +#### Returns + +[`AsyncDependenciesBlock`](AsyncDependenciesBlock.md)[] + +*** + +### getChildren() + +> **getChildren**(): `ChunkGroup`[] + +Defined in: [webpack/types.d.ts:1642](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1642) + +#### Returns + +`ChunkGroup`[] + +*** + +### getChildrenByOrders() + +> **getChildrenByOrders**(`moduleGraph`, `chunkGraph`): `Record`\<`string`, `ChunkGroup`[]\> + +Defined in: [webpack/types.d.ts:1673](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1673) + +#### Parameters + +##### moduleGraph + +[`ModuleGraph`](ModuleGraph.md) + +##### chunkGraph + +[`ChunkGraph`](ChunkGraph.md) + +#### Returns + +`Record`\<`string`, `ChunkGroup`[]\> + +*** + +### getFiles() + +> **getFiles**(): `string`[] + +Defined in: [webpack/types.d.ts:1664](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1664) + +#### Returns + +`string`[] + +*** + +### getModulePostOrderIndex() + +> **getModulePostOrderIndex**(`module`): `number` + +Defined in: [webpack/types.d.ts:1696](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1696) + +Gets the bottom-up index of a module in this ChunkGroup + +#### Parameters + +##### module + +[`Module`](Module.md) + +#### Returns + +`number` + +*** + +### getModulePreOrderIndex() + +> **getModulePreOrderIndex**(`module`): `number` + +Defined in: [webpack/types.d.ts:1686](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1686) + +Gets the top-down index of a module in this ChunkGroup + +#### Parameters + +##### module + +[`Module`](Module.md) + +#### Returns + +`number` + +*** + +### getNumberOfBlocks() + +> **getNumberOfBlocks**(): `number` + +Defined in: [webpack/types.d.ts:1655](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1655) + +#### Returns + +`number` + +*** + +### getNumberOfChildren() + +> **getNumberOfChildren**(): `number` + +Defined in: [webpack/types.d.ts:1643](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1643) + +#### Returns + +`number` + +*** + +### getNumberOfParents() + +> **getNumberOfParents**(): `number` + +Defined in: [webpack/types.d.ts:1648](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1648) + +#### Returns + +`number` + +*** + +### getParents() + +> **getParents**(): `ChunkGroup`[] + +Defined in: [webpack/types.d.ts:1647](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1647) + +#### Returns + +`ChunkGroup`[] + +*** + +### hasBlock() + +> **hasBlock**(`block`): `boolean` + +Defined in: [webpack/types.d.ts:1656](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1656) + +#### Parameters + +##### block + +[`AsyncDependenciesBlock`](AsyncDependenciesBlock.md) + +#### Returns + +`boolean` + +*** + +### hasParent() + +> **hasParent**(`parent`): `boolean` + +Defined in: [webpack/types.d.ts:1649](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1649) + +#### Parameters + +##### parent + +`ChunkGroup` + +#### Returns + +`boolean` + +*** + +### insertChunk() + +> **insertChunk**(`chunk`, `before`): `boolean` + +Defined in: [webpack/types.d.ts:1632](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1632) + +inserts a chunk before another existing chunk in group + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +##### before + +[`Chunk`](Chunk.md) + +#### Returns + +`boolean` + +*** + +### isInitial() + +> **isInitial**(): `boolean` + +Defined in: [webpack/types.d.ts:1640](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1640) + +#### Returns + +`boolean` + +*** + +### pushChunk() + +> **pushChunk**(`chunk`): `boolean` + +Defined in: [webpack/types.d.ts:1637](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1637) + +add a chunk into ChunkGroup. Is pushed on or prepended + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +#### Returns + +`boolean` + +*** + +### remove() + +> **remove**(): `void` + +Defined in: [webpack/types.d.ts:1665](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1665) + +#### Returns + +`void` + +*** + +### removeChild() + +> **removeChild**(`group`): `boolean` + +Defined in: [webpack/types.d.ts:1645](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1645) + +#### Parameters + +##### group + +`ChunkGroup` + +#### Returns + +`boolean` + +*** + +### removeChunk() + +> **removeChunk**(`chunk`): `boolean` + +Defined in: [webpack/types.d.ts:1639](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1639) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +#### Returns + +`boolean` + +*** + +### removeParent() + +> **removeParent**(`chunkGroup`): `boolean` + +Defined in: [webpack/types.d.ts:1651](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1651) + +#### Parameters + +##### chunkGroup + +`ChunkGroup` + +#### Returns + +`boolean` + +*** + +### replaceChunk() + +> **replaceChunk**(`oldChunk`, `newChunk`): `boolean` + +Defined in: [webpack/types.d.ts:1638](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1638) + +#### Parameters + +##### oldChunk + +[`Chunk`](Chunk.md) + +##### newChunk + +[`Chunk`](Chunk.md) + +#### Returns + +`boolean` + +*** + +### setModulePostOrderIndex() + +> **setModulePostOrderIndex**(`module`, `index`): `void` + +Defined in: [webpack/types.d.ts:1691](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1691) + +Sets the bottom-up index of a module in this ChunkGroup + +#### Parameters + +##### module + +[`Module`](Module.md) + +##### index + +`number` + +#### Returns + +`void` + +*** + +### setModulePreOrderIndex() + +> **setModulePreOrderIndex**(`module`, `index`): `void` + +Defined in: [webpack/types.d.ts:1681](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1681) + +Sets the top-down index of a module in this ChunkGroup + +#### Parameters + +##### module + +[`Module`](Module.md) + +##### index + +`number` + +#### Returns + +`void` + +*** + +### sortItems() + +> **sortItems**(): `void` + +Defined in: [webpack/types.d.ts:1666](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1666) + +#### Returns + +`void` + +*** + +### unshiftChunk() + +> **unshiftChunk**(`chunk`): `boolean` + +Defined in: [webpack/types.d.ts:1627](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1627) + +Performs an unshift of a specific chunk + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +#### Returns + +`boolean` diff --git a/api/classes/CleanPlugin.md b/api/classes/CleanPlugin.md new file mode 100644 index 0000000..e5d381a --- /dev/null +++ b/api/classes/CleanPlugin.md @@ -0,0 +1,73 @@ +--- +title: CleanPlugin +--- + +[webpack](../globals.md) / CleanPlugin + +# Class: CleanPlugin + +Defined in: [webpack/types.d.ts:1978](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1978) + +## Constructors + +### Constructor + +> **new CleanPlugin**(`options?`): `CleanPlugin` + +Defined in: [webpack/types.d.ts:1979](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1979) + +#### Parameters + +##### options? + +`CleanOptions` + +#### Returns + +`CleanPlugin` + +## Properties + +### options + +> **options**: `CleanOptions` + +Defined in: [webpack/types.d.ts:1980](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1980) + +## Methods + +### apply() + +> **apply**(`compiler`): `void` + +Defined in: [webpack/types.d.ts:1985](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1985) + +Apply the plugin + +#### Parameters + +##### compiler + +[`Compiler`](Compiler.md) + +#### Returns + +`void` + +*** + +### getCompilationHooks() + +> `static` **getCompilationHooks**(`compilation`): `CleanPluginCompilationHooks` + +Defined in: [webpack/types.d.ts:1986](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1986) + +#### Parameters + +##### compilation + +[`Compilation`](Compilation.md) + +#### Returns + +`CleanPluginCompilationHooks` diff --git a/api/classes/CodeGenerationResults.md b/api/classes/CodeGenerationResults.md new file mode 100644 index 0000000..b57f61d --- /dev/null +++ b/api/classes/CodeGenerationResults.md @@ -0,0 +1,193 @@ +--- +title: CodeGenerationResults +--- + +[webpack](../globals.md) / CodeGenerationResults + +# Abstract Class: CodeGenerationResults + +Defined in: [webpack/types.d.ts:2098](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2098) + +## Constructors + +### Constructor + +> **new CodeGenerationResults**(): `CodeGenerationResults` + +#### Returns + +`CodeGenerationResults` + +## Properties + +### map + +> **map**: `Map`\<[`Module`](Module.md), [`RuntimeSpecMap`](../webpack/namespaces/export=/namespaces/util/namespaces/runtime/classes/RuntimeSpecMap.md)\<`CodeGenerationResult`, `CodeGenerationResult`\>\> + +Defined in: [webpack/types.d.ts:2099](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2099) + +## Methods + +### add() + +> **add**(`module`, `runtime`, `result`): `void` + +Defined in: [webpack/types.d.ts:2109](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2109) + +#### Parameters + +##### module + +[`Module`](Module.md) + +##### runtime + +`RuntimeSpec` + +##### result + +`CodeGenerationResult` + +#### Returns + +`void` + +*** + +### get() + +> **get**(`module`, `runtime`): `CodeGenerationResult` + +Defined in: [webpack/types.d.ts:2100](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2100) + +#### Parameters + +##### module + +[`Module`](Module.md) + +##### runtime + +`RuntimeSpec` + +#### Returns + +`CodeGenerationResult` + +*** + +### getData() + +> **getData**(`module`, `runtime`, `key`): `any` + +Defined in: [webpack/types.d.ts:2107](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2107) + +#### Parameters + +##### module + +[`Module`](Module.md) + +##### runtime + +`RuntimeSpec` + +##### key + +`string` + +#### Returns + +`any` + +*** + +### getHash() + +> **getHash**(`module`, `runtime`): `string` + +Defined in: [webpack/types.d.ts:2108](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2108) + +#### Parameters + +##### module + +[`Module`](Module.md) + +##### runtime + +`RuntimeSpec` + +#### Returns + +`string` + +*** + +### getRuntimeRequirements() + +> **getRuntimeRequirements**(`module`, `runtime`): `ReadonlySet`\<`string`\> + +Defined in: [webpack/types.d.ts:2103](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2103) + +#### Parameters + +##### module + +[`Module`](Module.md) + +##### runtime + +`RuntimeSpec` + +#### Returns + +`ReadonlySet`\<`string`\> + +*** + +### getSource() + +> **getSource**(`module`, `runtime`, `sourceType`): [`Source`](../webpack/namespaces/export=/namespaces/sources/classes/Source.md) + +Defined in: [webpack/types.d.ts:2102](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2102) + +#### Parameters + +##### module + +[`Module`](Module.md) + +##### runtime + +`RuntimeSpec` + +##### sourceType + +`string` + +#### Returns + +[`Source`](../webpack/namespaces/export=/namespaces/sources/classes/Source.md) + +*** + +### has() + +> **has**(`module`, `runtime`): `boolean` + +Defined in: [webpack/types.d.ts:2101](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2101) + +#### Parameters + +##### module + +[`Module`](Module.md) + +##### runtime + +`RuntimeSpec` + +#### Returns + +`boolean` diff --git a/api/classes/Compilation.md b/api/classes/Compilation.md new file mode 100644 index 0000000..4ba20d7 --- /dev/null +++ b/api/classes/Compilation.md @@ -0,0 +1,1980 @@ +--- +title: Compilation +--- + +[webpack](../globals.md) / Compilation + +# Class: Compilation + +Defined in: [webpack/types.d.ts:2233](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2233) + +## Constructors + +### Constructor + +> **new Compilation**(`compiler`, `params`): `Compilation` + +Defined in: [webpack/types.d.ts:2237](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2237) + +Creates an instance of Compilation. + +#### Parameters + +##### compiler + +[`Compiler`](Compiler.md) + +##### params + +`CompilationParams` + +#### Returns + +`Compilation` + +## Properties + +### additionalChunkAssets + +> **additionalChunkAssets**: `string`[] + +Defined in: [webpack/types.d.ts:2463](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2463) + +*** + +### addModuleQueue + +> **addModuleQueue**: `AsyncQueue`\<[`Module`](Module.md), `string`, [`Module`](Module.md)\> + +Defined in: [webpack/types.d.ts:2438](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2438) + +*** + +### assets + +> **assets**: `CompilationAssets` + +Defined in: [webpack/types.d.ts:2464](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2464) + +*** + +### assetsInfo + +> **assetsInfo**: `Map`\<`string`, [`AssetInfo`](../type-aliases/AssetInfo.md)\> + +Defined in: [webpack/types.d.ts:2465](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2465) + +*** + +### asyncEntrypoints + +> **asyncEntrypoints**: [`Entrypoint`](Entrypoint.md)[] + +Defined in: [webpack/types.d.ts:2456](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2456) + +*** + +### bail + +> **bail**: `boolean` + +Defined in: [webpack/types.d.ts:2425](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2425) + +*** + +### buildDependencies + +> **buildDependencies**: [`LazySet`](../webpack/namespaces/export=/namespaces/util/classes/LazySet.md)\<`string`\> + +Defined in: [webpack/types.d.ts:2484](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2484) + +*** + +### buildQueue + +> **buildQueue**: `AsyncQueue`\<[`Module`](Module.md), [`Module`](Module.md), [`Module`](Module.md)\> + +Defined in: [webpack/types.d.ts:2444](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2444) + +*** + +### buildTimeExecutedModules + +> **buildTimeExecutedModules**: `WeakSet`\<[`Module`](Module.md)\> + +Defined in: [webpack/types.d.ts:2478](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2478) + +*** + +### builtModules + +> **builtModules**: `WeakSet`\<[`Module`](Module.md)\> + +Defined in: [webpack/types.d.ts:2476](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2476) + +*** + +### children + +> **children**: `Compilation`[] + +Defined in: [webpack/types.d.ts:2468](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2468) + +*** + +### childrenCounters + +> **childrenCounters**: `Record`\<`string`, `number`\> + +Defined in: [webpack/types.d.ts:2472](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2472) + +*** + +### chunkGraph + +> **chunkGraph**: [`ChunkGraph`](ChunkGraph.md) + +Defined in: [webpack/types.d.ts:2435](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2435) + +*** + +### chunkGroups + +> **chunkGroups**: [`ChunkGroup`](ChunkGroup.md)[] + +Defined in: [webpack/types.d.ts:2458](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2458) + +*** + +### chunks + +> **chunks**: `Set`\<[`Chunk`](Chunk.md)\> + +Defined in: [webpack/types.d.ts:2457](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2457) + +*** + +### chunkTemplate + +> **chunkTemplate**: `ChunkTemplate` + +Defined in: [webpack/types.d.ts:2429](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2429) + +*** + +### codeGeneratedModules + +> **codeGeneratedModules**: `WeakSet`\<[`Module`](Module.md)\> + +Defined in: [webpack/types.d.ts:2477](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2477) + +*** + +### codeGenerationResults? + +> `optional` **codeGenerationResults**: [`CodeGenerationResults`](CodeGenerationResults.md) + +Defined in: [webpack/types.d.ts:2436](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2436) + +*** + +### comparedForEmitAssets + +> **comparedForEmitAssets**: `Set`\<`string`\> + +Defined in: [webpack/types.d.ts:2480](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2480) + +*** + +### ~~compilationDependencies~~ + +> **compilationDependencies**: `object` + +Defined in: [webpack/types.d.ts:2489](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2489) + +#### ~~add()~~ + +> **add**: (`item`) => [`LazySet`](../webpack/namespaces/export=/namespaces/util/classes/LazySet.md)\<`string`\> + +##### Parameters + +###### item + +`string` + +##### Returns + +[`LazySet`](../webpack/namespaces/export=/namespaces/util/classes/LazySet.md)\<`string`\> + +#### Deprecated + +*** + +### compiler + +> **compiler**: [`Compiler`](Compiler.md) + +Defined in: [webpack/types.d.ts:2415](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2415) + +*** + +### compilerPath + +> **compilerPath**: `string` + +Defined in: [webpack/types.d.ts:2421](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2421) + +*** + +### contextDependencies + +> **contextDependencies**: [`LazySet`](../webpack/namespaces/export=/namespaces/util/classes/LazySet.md)\<`string`\> + +Defined in: [webpack/types.d.ts:2482](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2482) + +*** + +### creatingModuleDuringBuild + +> **creatingModuleDuringBuild**: `WeakMap`\<[`Module`](Module.md), `Set`\<[`Module`](Module.md)\>\> + +Defined in: [webpack/types.d.ts:2452](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2452) + +Modules in value are building during the build of Module in key. +Means value blocking key from finishing. +Needed to detect build cycles. + +*** + +### dependencyFactories + +> **dependencyFactories**: `Map`\<`DependencyConstructor`, [`ModuleFactory`](ModuleFactory.md)\> + +Defined in: [webpack/types.d.ts:2470](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2470) + +*** + +### dependencyTemplates + +> **dependencyTemplates**: `DependencyTemplates` + +Defined in: [webpack/types.d.ts:2471](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2471) + +*** + +### emittedAssets + +> **emittedAssets**: `Set`\<`string`\> + +Defined in: [webpack/types.d.ts:2479](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2479) + +*** + +### endTime? + +> `optional` **endTime**: `number` + +Defined in: [webpack/types.d.ts:2414](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2414) + +*** + +### entries + +> **entries**: `Map`\<`string`, `EntryData`\> + +Defined in: [webpack/types.d.ts:2453](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2453) + +*** + +### entrypoints + +> **entrypoints**: `Map`\<`string`, [`Entrypoint`](Entrypoint.md)\> + +Defined in: [webpack/types.d.ts:2455](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2455) + +*** + +### errors + +> **errors**: `Error`[] + +Defined in: [webpack/types.d.ts:2466](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2466) + +*** + +### factorizeQueue + +> **factorizeQueue**: `AsyncQueue`\<`FactorizeModuleOptions`, `string`, [`Module`](Module.md) \| `ModuleFactoryResult`\> + +Defined in: [webpack/types.d.ts:2439](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2439) + +*** + +### fileDependencies + +> **fileDependencies**: [`LazySet`](../webpack/namespaces/export=/namespaces/util/classes/LazySet.md)\<`string`\> + +Defined in: [webpack/types.d.ts:2481](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2481) + +*** + +### fileSystemInfo + +> **fileSystemInfo**: `FileSystemInfo` + +Defined in: [webpack/types.d.ts:2418](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2418) + +*** + +### fullHash? + +> `optional` **fullHash**: `string` + +Defined in: [webpack/types.d.ts:2657](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2657) + +*** + +### globalEntry + +> **globalEntry**: `EntryData` + +Defined in: [webpack/types.d.ts:2454](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2454) + +*** + +### hash? + +> `optional` **hash**: `string` + +Defined in: [webpack/types.d.ts:2658](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2658) + +*** + +### hooks + +> **hooks**: `Readonly`\<\{ `addEntry`: `SyncHook`\<\[[`Dependency`](Dependency.md), [`EntryOptions`](../type-aliases/EntryOptions.md)\]\>; `additionalAssets`: `FakeHook`\<`Pick`\<`AsyncSeriesHook`\<\[\]\>, `"name"` \| `"tap"` \| `"tapAsync"` \| `"tapPromise"`\>\>; `additionalChunkAssets`: `FakeHook`\<`Pick`\<`AsyncSeriesHook`\<\[`Set`\<[`Chunk`](Chunk.md)\>\]\>, `"name"` \| `"tap"` \| `"tapAsync"` \| `"tapPromise"`\>\>; `additionalChunkRuntimeRequirements`: `SyncHook`\<\[[`Chunk`](Chunk.md), `Set`\<`string`\>, `RuntimeRequirementsContext`\]\>; `additionalModuleRuntimeRequirements`: `SyncHook`\<\[[`Module`](Module.md), `Set`\<`string`\>, `RuntimeRequirementsContext`\]\>; `additionalTreeRuntimeRequirements`: `SyncHook`\<\[[`Chunk`](Chunk.md), `Set`\<`string`\>, `RuntimeRequirementsContext`\]\>; `afterChunks`: `SyncHook`\<\[`Iterable`\<[`Chunk`](Chunk.md)\>\]\>; `afterCodeGeneration`: `SyncHook`\<\[\]\>; `afterHash`: `SyncHook`\<\[\]\>; `afterModuleHash`: `SyncHook`\<\[\]\>; `afterOptimizeAssets`: `SyncHook`\<\[`CompilationAssets`\]\>; `afterOptimizeChunkAssets`: `FakeHook`\<`Pick`\<`AsyncSeriesHook`\<\[`Set`\<[`Chunk`](Chunk.md)\>\]\>, `"name"` \| `"tap"` \| `"tapAsync"` \| `"tapPromise"`\>\>; `afterOptimizeChunkIds`: `SyncHook`\<\[`Iterable`\<[`Chunk`](Chunk.md)\>\]\>; `afterOptimizeChunkModules`: `SyncHook`\<\[`Iterable`\<[`Chunk`](Chunk.md)\>, `Iterable`\<[`Module`](Module.md)\>\]\>; `afterOptimizeChunks`: `SyncHook`\<\[`Iterable`\<[`Chunk`](Chunk.md)\>, [`ChunkGroup`](ChunkGroup.md)[]\]\>; `afterOptimizeDependencies`: `SyncHook`\<\[`Iterable`\<[`Module`](Module.md)\>\]\>; `afterOptimizeModuleIds`: `SyncHook`\<\[`Iterable`\<[`Module`](Module.md)\>\]\>; `afterOptimizeModules`: `SyncHook`\<\[`Iterable`\<[`Module`](Module.md)\>\]\>; `afterOptimizeTree`: `SyncHook`\<\[`Iterable`\<[`Chunk`](Chunk.md)\>, `Iterable`\<[`Module`](Module.md)\>\]\>; `afterProcessAssets`: `SyncHook`\<\[`CompilationAssets`\]\>; `afterRuntimeRequirements`: `SyncHook`\<\[\]\>; `afterSeal`: `AsyncSeriesHook`\<\[\]\>; `assetPath`: `SyncWaterfallHook`\<\[`string`, [`PathData`](../interfaces/PathData.md), `undefined` \| [`AssetInfo`](../type-aliases/AssetInfo.md)\], `string`\>; `beforeChunkAssets`: `SyncHook`\<\[\]\>; `beforeChunkIds`: `SyncHook`\<\[`Iterable`\<[`Chunk`](Chunk.md)\>\]\>; `beforeChunks`: `SyncHook`\<\[\]\>; `beforeCodeGeneration`: `SyncHook`\<\[\]\>; `beforeHash`: `SyncHook`\<\[\]\>; `beforeModuleAssets`: `SyncHook`\<\[\]\>; `beforeModuleHash`: `SyncHook`\<\[\]\>; `beforeModuleIds`: `SyncHook`\<\[`Iterable`\<[`Module`](Module.md)\>\]\>; `beforeRuntimeRequirements`: `SyncHook`\<\[\]\>; `buildModule`: `SyncHook`\<\[[`Module`](Module.md)\]\>; `childCompiler`: `SyncHook`\<\[[`Compiler`](Compiler.md), `string`, `number`\]\>; `chunkAsset`: `SyncHook`\<\[[`Chunk`](Chunk.md), `string`\]\>; `chunkHash`: `SyncHook`\<\[[`Chunk`](Chunk.md), `Hash`, `ChunkHashContext`\]\>; `chunkIds`: `SyncHook`\<\[`Iterable`\<[`Chunk`](Chunk.md)\>\]\>; `contentHash`: `SyncHook`\<\[[`Chunk`](Chunk.md)\]\>; `dependencyReferencedExports`: `SyncWaterfallHook`\<\[(`string`[] \| `ReferencedExport`)[], [`Dependency`](Dependency.md), `RuntimeSpec`\], (`string`[] \| `ReferencedExport`)[]\>; `executeModule`: `SyncHook`\<\[`ExecuteModuleArgument`, `ExecuteModuleContext`\]\>; `failedEntry`: `SyncHook`\<\[[`Dependency`](Dependency.md), [`EntryOptions`](../type-aliases/EntryOptions.md), `Error`\]\>; `failedModule`: `SyncHook`\<\[[`Module`](Module.md), [`WebpackError`](WebpackError.md)\]\>; `finishModules`: `AsyncSeriesHook`\<\[`Iterable`\<[`Module`](Module.md)\>\]\>; `finishRebuildingModule`: `AsyncSeriesHook`\<\[[`Module`](Module.md)\]\>; `fullHash`: `SyncHook`\<\[`Hash`\]\>; `log`: `SyncBailHook`\<\[`string`, `LogEntry`\], `boolean` \| `void`\>; `moduleAsset`: `SyncHook`\<\[[`Module`](Module.md), `string`\]\>; `moduleIds`: `SyncHook`\<\[`Iterable`\<[`Module`](Module.md)\>\]\>; `needAdditionalPass`: `SyncBailHook`\<\[\], `boolean` \| `void`\>; `needAdditionalSeal`: `SyncBailHook`\<\[\], `boolean` \| `void`\>; `optimize`: `SyncHook`\<\[\]\>; `optimizeAssets`: `AsyncSeriesHook`\<\[`CompilationAssets`\], `ProcessAssetsAdditionalOptions`\>; `optimizeChunkAssets`: `FakeHook`\<`Pick`\<`AsyncSeriesHook`\<\[`Set`\<[`Chunk`](Chunk.md)\>\]\>, `"name"` \| `"tap"` \| `"tapAsync"` \| `"tapPromise"`\>\>; `optimizeChunkIds`: `SyncHook`\<\[`Iterable`\<[`Chunk`](Chunk.md)\>\]\>; `optimizeChunkModules`: `AsyncSeriesBailHook`\<\[`Iterable`\<[`Chunk`](Chunk.md)\>, `Iterable`\<[`Module`](Module.md)\>\], `void`\>; `optimizeChunks`: `SyncBailHook`\<\[`Iterable`\<[`Chunk`](Chunk.md)\>, [`ChunkGroup`](ChunkGroup.md)[]\], `boolean` \| `void`\>; `optimizeCodeGeneration`: `SyncHook`\<\[`Iterable`\<[`Module`](Module.md)\>\]\>; `optimizeDependencies`: `SyncBailHook`\<\[`Iterable`\<[`Module`](Module.md)\>\], `boolean` \| `void`\>; `optimizeModuleIds`: `SyncHook`\<\[`Iterable`\<[`Module`](Module.md)\>\]\>; `optimizeModules`: `SyncBailHook`\<\[`Iterable`\<[`Module`](Module.md)\>\], `boolean` \| `void`\>; `optimizeTree`: `AsyncSeriesHook`\<\[`Iterable`\<[`Chunk`](Chunk.md)\>, `Iterable`\<[`Module`](Module.md)\>\]\>; `prepareModuleExecution`: `AsyncParallelHook`\<\[`ExecuteModuleArgument`, `ExecuteModuleContext`\]\>; `processAdditionalAssets`: `AsyncSeriesHook`\<\[`CompilationAssets`\]\>; `processAssets`: `AsyncSeriesHook`\<\[`CompilationAssets`\], `ProcessAssetsAdditionalOptions`\>; `processErrors`: `SyncWaterfallHook`\<\[`Error`[]\], `Error`[]\>; `processWarnings`: `SyncWaterfallHook`\<\[`Error`[]\], `Error`[]\>; `rebuildModule`: `SyncHook`\<\[[`Module`](Module.md)\]\>; `record`: `SyncHook`\<\[`Compilation`, `Records`\]\>; `recordChunks`: `SyncHook`\<\[`Iterable`\<[`Chunk`](Chunk.md)\>, `Records`\]\>; `recordHash`: `SyncHook`\<\[`Records`\]\>; `recordModules`: `SyncHook`\<\[`Iterable`\<[`Module`](Module.md)\>, `Records`\]\>; `renderManifest`: `SyncWaterfallHook`\<\[[`RenderManifestEntry`](../type-aliases/RenderManifestEntry.md)[], [`RenderManifestOptions`](../interfaces/RenderManifestOptions.md)\], [`RenderManifestEntry`](../type-aliases/RenderManifestEntry.md)[]\>; `reviveChunks`: `SyncHook`\<\[`Iterable`\<[`Chunk`](Chunk.md)\>, `Records`\]\>; `reviveModules`: `SyncHook`\<\[`Iterable`\<[`Module`](Module.md)\>, `Records`\]\>; `runtimeModule`: `SyncHook`\<\[[`RuntimeModule`](RuntimeModule.md), [`Chunk`](Chunk.md)\]\>; `runtimeRequirementInChunk`: `HookMap`\<`SyncBailHook`\<\[[`Chunk`](Chunk.md), `Set`\<`string`\>, `RuntimeRequirementsContext`\], `void`\>\>; `runtimeRequirementInModule`: `HookMap`\<`SyncBailHook`\<\[[`Module`](Module.md), `Set`\<`string`\>, `RuntimeRequirementsContext`\], `void`\>\>; `runtimeRequirementInTree`: `HookMap`\<`SyncBailHook`\<\[[`Chunk`](Chunk.md), `Set`\<`string`\>, `RuntimeRequirementsContext`\], `void`\>\>; `seal`: `SyncHook`\<\[\]\>; `shouldGenerateChunkAssets`: `SyncBailHook`\<\[\], `boolean` \| `void`\>; `shouldRecord`: `SyncBailHook`\<\[\], `boolean` \| `void`\>; `statsFactory`: `SyncHook`\<\[`StatsFactory`, `NormalizedStatsOptions`\]\>; `statsNormalize`: `SyncHook`\<\[`Partial`\<`NormalizedStatsOptions`\>, `CreateStatsOptionsContext`\]\>; `statsPreset`: `HookMap`\<`SyncHook`\<\[`Partial`\<`NormalizedStatsOptions`\>, `CreateStatsOptionsContext`\]\>\>; `statsPrinter`: `SyncHook`\<\[`StatsPrinter`, `NormalizedStatsOptions`\]\>; `stillValidModule`: `SyncHook`\<\[[`Module`](Module.md)\]\>; `succeedEntry`: `SyncHook`\<\[[`Dependency`](Dependency.md), [`EntryOptions`](../type-aliases/EntryOptions.md), [`Module`](Module.md)\]\>; `succeedModule`: `SyncHook`\<\[[`Module`](Module.md)\]\>; `unseal`: `SyncHook`\<\[\]\>; get `normalModuleLoader`(): `SyncHook`\<\[`AnyLoaderContext`, [`NormalModule`](NormalModule.md)\]\>; \}\> + +Defined in: [webpack/types.d.ts:2238](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2238) + +*** + +### inputFileSystem + +> **inputFileSystem**: [`InputFileSystem`](../interfaces/InputFileSystem.md) + +Defined in: [webpack/types.d.ts:2417](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2417) + +*** + +### logger + +> **logger**: `WebpackLogger` + +Defined in: [webpack/types.d.ts:2422](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2422) + +*** + +### logging + +> **logging**: `Map`\<`string`, `LogEntry`[]\> + +Defined in: [webpack/types.d.ts:2469](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2469) + +*** + +### mainTemplate + +> **mainTemplate**: `MainTemplate` + +Defined in: [webpack/types.d.ts:2428](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2428) + +*** + +### missingDependencies + +> **missingDependencies**: [`LazySet`](../webpack/namespaces/export=/namespaces/util/classes/LazySet.md)\<`string`\> + +Defined in: [webpack/types.d.ts:2483](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2483) + +*** + +### moduleGraph + +> **moduleGraph**: [`ModuleGraph`](ModuleGraph.md) + +Defined in: [webpack/types.d.ts:2434](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2434) + +*** + +### moduleMemCaches? + +> `optional` **moduleMemCaches**: `Map`\<[`Module`](Module.md), `WeakTupleMap`\<`any`[], `any`\>\> + +Defined in: [webpack/types.d.ts:2432](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2432) + +*** + +### moduleMemCaches2? + +> `optional` **moduleMemCaches2**: `Map`\<[`Module`](Module.md), `WeakTupleMap`\<`any`[], `any`\>\> + +Defined in: [webpack/types.d.ts:2433](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2433) + +*** + +### modules + +> **modules**: `Set`\<[`Module`](Module.md)\> + +Defined in: [webpack/types.d.ts:2461](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2461) + +*** + +### moduleTemplates + +> **moduleTemplates**: `ModuleTemplates` + +Defined in: [webpack/types.d.ts:2431](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2431) + +*** + +### name? + +> `optional` **name**: `string` + +Defined in: [webpack/types.d.ts:2412](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2412) + +*** + +### namedChunkGroups + +> **namedChunkGroups**: `Map`\<`string`, [`ChunkGroup`](ChunkGroup.md)\> + +Defined in: [webpack/types.d.ts:2459](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2459) + +*** + +### namedChunks + +> **namedChunks**: `Map`\<`string`, [`Chunk`](Chunk.md)\> + +Defined in: [webpack/types.d.ts:2460](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2460) + +*** + +### needAdditionalPass + +> **needAdditionalPass**: `boolean` + +Defined in: [webpack/types.d.ts:2475](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2475) + +*** + +### options + +> **options**: `WebpackOptionsNormalizedWithDefaults` + +Defined in: [webpack/types.d.ts:2423](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2423) + +*** + +### outputOptions + +> **outputOptions**: `OutputNormalizedWithDefaults` + +Defined in: [webpack/types.d.ts:2424](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2424) + +*** + +### params + +> **params**: `CompilationParams` + +Defined in: [webpack/types.d.ts:2427](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2427) + +*** + +### processDependenciesQueue + +> **processDependenciesQueue**: `AsyncQueue`\<[`Module`](Module.md), [`Module`](Module.md), [`Module`](Module.md)\> + +Defined in: [webpack/types.d.ts:2437](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2437) + +*** + +### profile + +> **profile**: `boolean` + +Defined in: [webpack/types.d.ts:2426](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2426) + +*** + +### rebuildQueue + +> **rebuildQueue**: `AsyncQueue`\<[`Module`](Module.md), [`Module`](Module.md), [`Module`](Module.md)\> + +Defined in: [webpack/types.d.ts:2445](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2445) + +*** + +### records + +> **records**: `Records` + +Defined in: [webpack/types.d.ts:2462](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2462) + +*** + +### requestShortener + +> **requestShortener**: `RequestShortener` + +Defined in: [webpack/types.d.ts:2420](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2420) + +*** + +### resolverFactory + +> **resolverFactory**: `ResolverFactory` + +Defined in: [webpack/types.d.ts:2416](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2416) + +*** + +### runtimeTemplate + +> **runtimeTemplate**: `RuntimeTemplate` + +Defined in: [webpack/types.d.ts:2430](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2430) + +*** + +### startTime? + +> `optional` **startTime**: `number` + +Defined in: [webpack/types.d.ts:2413](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2413) + +*** + +### usedChunkIds + +> **usedChunkIds**: `Set`\<`number`\> + +Defined in: [webpack/types.d.ts:2473](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2473) + +*** + +### usedModuleIds + +> **usedModuleIds**: `Set`\<`number`\> + +Defined in: [webpack/types.d.ts:2474](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2474) + +*** + +### valueCacheVersions + +> **valueCacheVersions**: `Map`\<`string`, `ValueCacheVersion`\> + +Defined in: [webpack/types.d.ts:2419](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2419) + +*** + +### warnings + +> **warnings**: `Error`[] + +Defined in: [webpack/types.d.ts:2467](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2467) + +*** + +### PROCESS\_ASSETS\_STAGE\_ADDITIONAL + +> `static` **PROCESS\_ASSETS\_STAGE\_ADDITIONAL**: `number` + +Defined in: [webpack/types.d.ts:2719](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2719) + +Add additional assets to the compilation. + +*** + +### PROCESS\_ASSETS\_STAGE\_ADDITIONS + +> `static` **PROCESS\_ASSETS\_STAGE\_ADDITIONS**: `number` + +Defined in: [webpack/types.d.ts:2735](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2735) + +Add additional sections to existing assets, like a banner or initialization code. + +*** + +### PROCESS\_ASSETS\_STAGE\_ANALYSE + +> `static` **PROCESS\_ASSETS\_STAGE\_ANALYSE**: `number` + +Defined in: [webpack/types.d.ts:2790](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2790) + +Analyse existing assets. + +*** + +### PROCESS\_ASSETS\_STAGE\_DERIVED + +> `static` **PROCESS\_ASSETS\_STAGE\_DERIVED**: `number` + +Defined in: [webpack/types.d.ts:2730](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2730) + +Derive new assets from existing assets. +Existing assets should not be treated as complete. + +*** + +### PROCESS\_ASSETS\_STAGE\_DEV\_TOOLING + +> `static` **PROCESS\_ASSETS\_STAGE\_DEV\_TOOLING**: `number` + +Defined in: [webpack/types.d.ts:2762](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2762) + +Add development tooling to assets, e. g. by extracting a SourceMap. + +*** + +### PROCESS\_ASSETS\_STAGE\_OPTIMIZE + +> `static` **PROCESS\_ASSETS\_STAGE\_OPTIMIZE**: `number` + +Defined in: [webpack/types.d.ts:2740](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2740) + +Optimize existing assets in a general way. + +*** + +### PROCESS\_ASSETS\_STAGE\_OPTIMIZE\_COMPATIBILITY + +> `static` **PROCESS\_ASSETS\_STAGE\_OPTIMIZE\_COMPATIBILITY**: `number` + +Defined in: [webpack/types.d.ts:2752](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2752) + +Optimize the compatibility of existing assets, e. g. add polyfills or vendor-prefixes. + +*** + +### PROCESS\_ASSETS\_STAGE\_OPTIMIZE\_COUNT + +> `static` **PROCESS\_ASSETS\_STAGE\_OPTIMIZE\_COUNT**: `number` + +Defined in: [webpack/types.d.ts:2747](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2747) + +Optimize the count of existing assets, e. g. by merging them. +Only assets of the same type should be merged. +For assets of different types see PROCESS_ASSETS_STAGE_OPTIMIZE_INLINE. + +*** + +### PROCESS\_ASSETS\_STAGE\_OPTIMIZE\_HASH + +> `static` **PROCESS\_ASSETS\_STAGE\_OPTIMIZE\_HASH**: `number` + +Defined in: [webpack/types.d.ts:2780](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2780) + +Optimize the hashes of the assets, e. g. by generating real hashes of the asset content. + +*** + +### PROCESS\_ASSETS\_STAGE\_OPTIMIZE\_INLINE + +> `static` **PROCESS\_ASSETS\_STAGE\_OPTIMIZE\_INLINE**: `number` + +Defined in: [webpack/types.d.ts:2769](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2769) + +Optimize the count of existing assets, e. g. by inlining assets of into other assets. +Only assets of different types should be inlined. +For assets of the same type see PROCESS_ASSETS_STAGE_OPTIMIZE_COUNT. + +*** + +### PROCESS\_ASSETS\_STAGE\_OPTIMIZE\_SIZE + +> `static` **PROCESS\_ASSETS\_STAGE\_OPTIMIZE\_SIZE**: `number` + +Defined in: [webpack/types.d.ts:2757](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2757) + +Optimize the size of existing assets, e. g. by minimizing or omitting whitespace. + +*** + +### PROCESS\_ASSETS\_STAGE\_OPTIMIZE\_TRANSFER + +> `static` **PROCESS\_ASSETS\_STAGE\_OPTIMIZE\_TRANSFER**: `number` + +Defined in: [webpack/types.d.ts:2785](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2785) + +Optimize the transfer of existing assets, e. g. by preparing a compressed (gzip) file as separate asset. + +*** + +### PROCESS\_ASSETS\_STAGE\_PRE\_PROCESS + +> `static` **PROCESS\_ASSETS\_STAGE\_PRE\_PROCESS**: `number` + +Defined in: [webpack/types.d.ts:2724](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2724) + +Basic preprocessing of assets. + +*** + +### PROCESS\_ASSETS\_STAGE\_REPORT + +> `static` **PROCESS\_ASSETS\_STAGE\_REPORT**: `number` + +Defined in: [webpack/types.d.ts:2795](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2795) + +Creating assets for reporting purposes. + +*** + +### PROCESS\_ASSETS\_STAGE\_SUMMARIZE + +> `static` **PROCESS\_ASSETS\_STAGE\_SUMMARIZE**: `number` + +Defined in: [webpack/types.d.ts:2775](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2775) + +Summarize the list of existing assets +e. g. creating an assets manifest of Service Workers. + +## Methods + +### addAsyncEntrypoint() + +> **addAsyncEntrypoint**(`options`, `module`, `loc`, `request`): [`Entrypoint`](Entrypoint.md) + +Defined in: [webpack/types.d.ts:2624](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2624) + +#### Parameters + +##### options + +[`EntryOptions`](../type-aliases/EntryOptions.md) + +##### module + +[`Module`](Module.md) + +##### loc + +`DependencyLocation` + +##### request + +`string` + +#### Returns + +[`Entrypoint`](Entrypoint.md) + +*** + +### addChunk() + +> **addChunk**(`name?`): [`Chunk`](Chunk.md) + +Defined in: [webpack/types.d.ts:2635](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2635) + +This method first looks to see if a name is provided for a new chunk, +and first looks to see if any named chunks already exist and reuse that chunk instead. + +#### Parameters + +##### name? + +`string` + +#### Returns + +[`Chunk`](Chunk.md) + +*** + +### addChunkInGroup() + +> **addChunkInGroup**(`groupOptions`, `module?`, `loc?`, `request?`): [`ChunkGroup`](ChunkGroup.md) + +Defined in: [webpack/types.d.ts:2618](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2618) + +If `module` is passed, `loc` and `request` must also be passed. + +#### Parameters + +##### groupOptions + +`string` | `ChunkGroupOptions` + +##### module? + +[`Module`](Module.md) + +##### loc? + +`SyntheticDependencyLocation` | `RealDependencyLocation` + +##### request? + +`string` + +#### Returns + +[`ChunkGroup`](ChunkGroup.md) + +*** + +### addEntry() + +> **addEntry**(`context`, `entry`, `optionsOrName`, `callback`): `void` + +Defined in: [webpack/types.d.ts:2563](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2563) + +#### Parameters + +##### context + +`string` + +##### entry + +[`Dependency`](Dependency.md) + +##### optionsOrName + +`string` | [`EntryOptions`](../type-aliases/EntryOptions.md) + +##### callback + +(`err?`, `result?`) => `void` + +#### Returns + +`void` + +*** + +### addInclude() + +> **addInclude**(`context`, `dependency`, `options`, `callback`): `void` + +Defined in: [webpack/types.d.ts:2569](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2569) + +#### Parameters + +##### context + +`string` + +##### dependency + +[`Dependency`](Dependency.md) + +##### options + +[`EntryOptions`](../type-aliases/EntryOptions.md) + +##### callback + +(`err?`, `result?`) => `void` + +#### Returns + +`void` + +*** + +### addModule() + +> **addModule**(`module`, `callback`): `void` + +Defined in: [webpack/types.d.ts:2499](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2499) + +#### Parameters + +##### module + +[`Module`](Module.md) + +##### callback + +(`err?`, `result?`) => `void` + +#### Returns + +`void` + +*** + +### addModuleChain() + +> **addModuleChain**(`context`, `dependency`, `callback`): `void` + +Defined in: [webpack/types.d.ts:2541](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2541) + +#### Parameters + +##### context + +`string` + +##### dependency + +[`Dependency`](Dependency.md) + +##### callback + +(`err?`, `result?`) => `void` + +#### Returns + +`void` + +*** + +### addModuleTree() + +> **addModuleTree**(`__namedParameters`, `callback`): `void` + +Defined in: [webpack/types.d.ts:2546](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2546) + +#### Parameters + +##### \_\_namedParameters + +###### context + +`string` + +context string path + +###### contextInfo? + +`Partial`\<`ModuleFactoryCreateDataContextInfo`\> + +additional context info for the root module + +###### dependency + +[`Dependency`](Dependency.md) + +dependency used to create Module chain + +##### callback + +(`err?`, `result?`) => `void` + +#### Returns + +`void` + +*** + +### addRuntimeModule() + +> **addRuntimeModule**(`chunk`, `module`, `chunkGraph?`): `void` + +Defined in: [webpack/types.d.ts:2609](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2609) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +##### module + +[`RuntimeModule`](RuntimeModule.md) + +##### chunkGraph? + +[`ChunkGraph`](ChunkGraph.md) + +#### Returns + +`void` + +*** + +### ~~assignDepth()~~ + +> **assignDepth**(`module`): `void` + +Defined in: [webpack/types.d.ts:2640](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2640) + +#### Parameters + +##### module + +[`Module`](Module.md) + +#### Returns + +`void` + +#### Deprecated + +*** + +### assignDepths() + +> **assignDepths**(`modules`): `void` + +Defined in: [webpack/types.d.ts:2641](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2641) + +#### Parameters + +##### modules + +`Set`\<[`Module`](Module.md)\> + +#### Returns + +`void` + +*** + +### assignRuntimeIds() + +> **assignRuntimeIds**(): `void` + +Defined in: [webpack/types.d.ts:2652](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2652) + +#### Returns + +`void` + +*** + +### buildModule() + +> **buildModule**(`module`, `callback`): `void` + +Defined in: [webpack/types.d.ts:2517](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2517) + +Schedules a build of the module object + +#### Parameters + +##### module + +[`Module`](Module.md) + +##### callback + +(`err?`, `result?`) => `void` + +#### Returns + +`void` + +*** + +### checkConstraints() + +> **checkConstraints**(): `void` + +Defined in: [webpack/types.d.ts:2714](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2714) + +#### Returns + +`void` + +*** + +### clearAssets() + +> **clearAssets**(): `void` + +Defined in: [webpack/types.d.ts:2671](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2671) + +#### Returns + +`void` + +*** + +### codeGeneration() + +> **codeGeneration**(`callback`): `void` + +Defined in: [webpack/types.d.ts:2586](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2586) + +#### Parameters + +##### callback + +(`err?`) => `void` + +#### Returns + +`void` + +*** + +### createChildCompiler() + +> **createChildCompiler**(`name`, `outputOptions?`, `plugins?`): [`Compiler`](Compiler.md) + +Defined in: [webpack/types.d.ts:2693](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2693) + +This function allows you to run another instance of webpack inside of webpack however as +a child with different settings and configurations (if desired) applied. It copies all hooks, plugins +from parent (or top level compiler) and creates a child Compilation + +#### Parameters + +##### name + +`string` + +##### outputOptions? + +`Partial`\<`OutputNormalized`\> + +##### plugins? + +(`false` \| `""` \| `0` \| [`WebpackPluginInstance`](../interfaces/WebpackPluginInstance.md) \| (`this`, `compiler`) => `void`)[] + +#### Returns + +[`Compiler`](Compiler.md) + +*** + +### createChunkAssets() + +> **createChunkAssets**(`callback`): `void` + +Defined in: [webpack/types.d.ts:2674](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2674) + +#### Parameters + +##### callback + +(`err?`) => `void` + +#### Returns + +`void` + +*** + +### createHash() + +> **createHash**(): `CodeGenerationJob`[] + +Defined in: [webpack/types.d.ts:2656](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2656) + +#### Returns + +`CodeGenerationJob`[] + +*** + +### createModuleAssets() + +> **createModuleAssets**(): `void` + +Defined in: [webpack/types.d.ts:2672](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2672) + +#### Returns + +`void` + +*** + +### createModuleHashes() + +> **createModuleHashes**(): `void` + +Defined in: [webpack/types.d.ts:2655](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2655) + +#### Returns + +`void` + +*** + +### createStatsFactory() + +> **createStatsFactory**(`options`): `StatsFactory` + +Defined in: [webpack/types.d.ts:2495](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2495) + +#### Parameters + +##### options + +`NormalizedStatsOptions` + +#### Returns + +`StatsFactory` + +*** + +### createStatsOptions() + +> **createStatsOptions**(`optionsOrPreset?`, `context?`): `NormalizedStatsOptions` + +Defined in: [webpack/types.d.ts:2491](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2491) + +#### Parameters + +##### optionsOrPreset? + +`string` | `boolean` | [`StatsOptions`](../interfaces/StatsOptions.md) + +##### context? + +`CreateStatsOptionsContext` + +#### Returns + +`NormalizedStatsOptions` + +*** + +### createStatsPrinter() + +> **createStatsPrinter**(`options`): `StatsPrinter` + +Defined in: [webpack/types.d.ts:2496](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2496) + +#### Parameters + +##### options + +`NormalizedStatsOptions` + +#### Returns + +`StatsPrinter` + +*** + +### deleteAsset() + +> **deleteAsset**(`file`): `void` + +Defined in: [webpack/types.d.ts:2668](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2668) + +#### Parameters + +##### file + +`string` + +#### Returns + +`void` + +*** + +### emitAsset() + +> **emitAsset**(`file`, `source`, `assetInfo?`): `void` + +Defined in: [webpack/types.d.ts:2659](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2659) + +#### Parameters + +##### file + +`string` + +##### source + +[`Source`](../webpack/namespaces/export=/namespaces/sources/classes/Source.md) + +##### assetInfo? + +[`AssetInfo`](../type-aliases/AssetInfo.md) + +#### Returns + +`void` + +*** + +### executeModule() + +> **executeModule**(`module`, `options`, `callback`): `void` + +Defined in: [webpack/types.d.ts:2706](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2706) + +#### Parameters + +##### module + +[`Module`](Module.md) + +##### options + +`ExecuteModuleOptions` + +##### callback + +(`err?`, `result?`) => `void` + +#### Returns + +`void` + +*** + +### factorizeModule() + +#### Call Signature + +> **factorizeModule**(`options`, `callback`): `void` + +Defined in: [webpack/types.d.ts:2526](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2526) + +##### Parameters + +###### options + +`FactorizeModuleOptions` & `object` + +###### callback + +(`err?`, `result?`) => `void` + +##### Returns + +`void` + +#### Call Signature + +> **factorizeModule**(`options`, `callback`): `void` + +Defined in: [webpack/types.d.ts:2530](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2530) + +##### Parameters + +###### options + +`FactorizeModuleOptions` & `object` + +###### callback + +(`err?`, `result?`) => `void` + +##### Returns + +`void` + +*** + +### findModule() + +> **findModule**(`identifier`): [`Module`](Module.md) + +Defined in: [webpack/types.d.ts:2512](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2512) + +Attempts to search for a module by its identifier + +#### Parameters + +##### identifier + +`string` + +#### Returns + +[`Module`](Module.md) + +*** + +### finish() + +> **finish**(`callback`): `void` + +Defined in: [webpack/types.d.ts:2579](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2579) + +#### Parameters + +##### callback + +(`err?`) => `void` + +#### Returns + +`void` + +*** + +### getAsset() + +> **getAsset**(`name`): `Readonly`\<[`Asset`](../interfaces/Asset.md)\> + +Defined in: [webpack/types.d.ts:2670](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2670) + +#### Parameters + +##### name + +`string` + +#### Returns + +`Readonly`\<[`Asset`](../interfaces/Asset.md)\> + +*** + +### getAssetPath() + +> **getAssetPath**(`filename`, `data`): `string` + +Defined in: [webpack/types.d.ts:2680](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2680) + +#### Parameters + +##### filename + +[`TemplatePath`](../type-aliases/TemplatePath.md) + +##### data + +[`PathData`](../interfaces/PathData.md) + +#### Returns + +`string` + +*** + +### getAssetPathWithInfo() + +> **getAssetPathWithInfo**(`filename`, `data`): `InterpolatedPathAndAssetInfo` + +Defined in: [webpack/types.d.ts:2681](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2681) + +#### Parameters + +##### filename + +[`TemplatePath`](../type-aliases/TemplatePath.md) + +##### data + +[`PathData`](../interfaces/PathData.md) + +#### Returns + +`InterpolatedPathAndAssetInfo` + +*** + +### getAssets() + +> **getAssets**(): `Readonly`\<[`Asset`](../interfaces/Asset.md)\>[] + +Defined in: [webpack/types.d.ts:2669](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2669) + +#### Returns + +`Readonly`\<[`Asset`](../interfaces/Asset.md)\>[] + +*** + +### getCache() + +> **getCache**(`name`): `CacheFacade` + +Defined in: [webpack/types.d.ts:2497](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2497) + +#### Parameters + +##### name + +`string` + +#### Returns + +`CacheFacade` + +*** + +### getDependencyReferencedExports() + +> **getDependencyReferencedExports**(`dependency`, `runtime`): (`string`[] \| `ReferencedExport`)[] + +Defined in: [webpack/types.d.ts:2642](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2642) + +#### Parameters + +##### dependency + +[`Dependency`](Dependency.md) + +##### runtime + +`RuntimeSpec` + +#### Returns + +(`string`[] \| `ReferencedExport`)[] + +*** + +### getErrors() + +> **getErrors**(): `Error`[] + +Defined in: [webpack/types.d.ts:2686](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2686) + +#### Returns + +`Error`[] + +*** + +### getLogger() + +> **getLogger**(`name`): `WebpackLogger` + +Defined in: [webpack/types.d.ts:2498](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2498) + +#### Parameters + +##### name + +`string` | () => `string` + +#### Returns + +`WebpackLogger` + +*** + +### getModule() + +> **getModule**(`module`): [`Module`](Module.md) + +Defined in: [webpack/types.d.ts:2507](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2507) + +Fetches a module from a compilation by its identifier + +#### Parameters + +##### module + +[`Module`](Module.md) + +#### Returns + +[`Module`](Module.md) + +*** + +### getPath() + +> **getPath**(`filename`, `data?`): `string` + +Defined in: [webpack/types.d.ts:2675](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2675) + +#### Parameters + +##### filename + +[`TemplatePath`](../type-aliases/TemplatePath.md) + +##### data? + +[`PathData`](../interfaces/PathData.md) + +#### Returns + +`string` + +*** + +### getPathWithInfo() + +> **getPathWithInfo**(`filename`, `data?`): `InterpolatedPathAndAssetInfo` + +Defined in: [webpack/types.d.ts:2676](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2676) + +#### Parameters + +##### filename + +[`TemplatePath`](../type-aliases/TemplatePath.md) + +##### data? + +[`PathData`](../interfaces/PathData.md) + +#### Returns + +`InterpolatedPathAndAssetInfo` + +*** + +### getRenderManifest() + +> **getRenderManifest**(`options`): [`RenderManifestEntry`](../type-aliases/RenderManifestEntry.md)[] + +Defined in: [webpack/types.d.ts:2673](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2673) + +#### Parameters + +##### options + +[`RenderManifestOptions`](../interfaces/RenderManifestOptions.md) + +#### Returns + +[`RenderManifestEntry`](../type-aliases/RenderManifestEntry.md)[] + +*** + +### getStats() + +> **getStats**(): [`Stats`](Stats.md) + +Defined in: [webpack/types.d.ts:2490](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2490) + +#### Returns + +[`Stats`](Stats.md) + +*** + +### getWarnings() + +> **getWarnings**(): `Error`[] + +Defined in: [webpack/types.d.ts:2685](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2685) + +#### Returns + +`Error`[] + +*** + +### handleModuleCreation() + +> **handleModuleCreation**(`__namedParameters`, `callback`): `void` + +Defined in: [webpack/types.d.ts:2537](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2537) + +#### Parameters + +##### \_\_namedParameters + +`HandleModuleCreationOptions` + +##### callback + +(`err?`, `result?`) => `void` + +#### Returns + +`void` + +*** + +### patchChunksAfterReasonRemoval() + +> **patchChunksAfterReasonRemoval**(`module`, `chunk`): `void` + +Defined in: [webpack/types.d.ts:2650](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2650) + +#### Parameters + +##### module + +[`Module`](Module.md) + +##### chunk + +[`Chunk`](Chunk.md) + +#### Returns + +`void` + +*** + +### processModuleDependencies() + +> **processModuleDependencies**(`module`, `callback`): `void` + +Defined in: [webpack/types.d.ts:2521](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2521) + +#### Parameters + +##### module + +[`Module`](Module.md) + +##### callback + +(`err?`, `result?`) => `void` + +#### Returns + +`void` + +*** + +### processModuleDependenciesNonRecursive() + +> **processModuleDependenciesNonRecursive**(`module`): `void` + +Defined in: [webpack/types.d.ts:2525](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2525) + +#### Parameters + +##### module + +[`Module`](Module.md) + +#### Returns + +`void` + +*** + +### processRuntimeRequirements() + +> **processRuntimeRequirements**(`__namedParameters?`): `void` + +Defined in: [webpack/types.d.ts:2587](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2587) + +#### Parameters + +##### \_\_namedParameters? + +###### chunkGraph? + +[`ChunkGraph`](ChunkGraph.md) + +the chunk graph + +###### chunkGraphEntries? + +`Iterable`\<[`Chunk`](Chunk.md)\> + +chunkGraphEntries + +###### chunks? + +`Iterable`\<[`Chunk`](Chunk.md)\> + +chunks + +###### codeGenerationResults? + +[`CodeGenerationResults`](CodeGenerationResults.md) + +codeGenerationResults + +###### modules? + +`Iterable`\<[`Module`](Module.md)\> + +modules + +#### Returns + +`void` + +*** + +### rebuildModule() + +> **rebuildModule**(`module`, `callback`): `void` + +Defined in: [webpack/types.d.ts:2575](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2575) + +#### Parameters + +##### module + +[`Module`](Module.md) + +##### callback + +(`err?`, `result?`) => `void` + +#### Returns + +`void` + +*** + +### removeChunkFromDependencies() + +> **removeChunkFromDependencies**(`block`, `chunk`): `void` + +Defined in: [webpack/types.d.ts:2651](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2651) + +#### Parameters + +##### block + +`DependenciesBlock` + +##### chunk + +[`Chunk`](Chunk.md) + +#### Returns + +`void` + +*** + +### removeReasonsOfDependencyBlock() + +> **removeReasonsOfDependencyBlock**(`module`, `block`): `void` + +Defined in: [webpack/types.d.ts:2646](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2646) + +#### Parameters + +##### module + +[`Module`](Module.md) + +##### block + +`DependenciesBlockLike` + +#### Returns + +`void` + +*** + +### renameAsset() + +> **renameAsset**(`file`, `newFile`): `void` + +Defined in: [webpack/types.d.ts:2667](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2667) + +#### Parameters + +##### file + +`string` + +##### newFile + +`string` + +#### Returns + +`void` + +*** + +### reportDependencyErrorsAndWarnings() + +> **reportDependencyErrorsAndWarnings**(`module`, `blocks`): `boolean` + +Defined in: [webpack/types.d.ts:2582](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2582) + +#### Parameters + +##### module + +[`Module`](Module.md) + +##### blocks + +`DependenciesBlock`[] + +#### Returns + +`boolean` + +*** + +### seal() + +> **seal**(`callback`): `void` + +Defined in: [webpack/types.d.ts:2581](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2581) + +#### Parameters + +##### callback + +(`err?`) => `void` + +#### Returns + +`void` + +*** + +### sortItemsWithChunkIds() + +> **sortItemsWithChunkIds**(): `void` + +Defined in: [webpack/types.d.ts:2653](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2653) + +#### Returns + +`void` + +*** + +### summarizeDependencies() + +> **summarizeDependencies**(): `void` + +Defined in: [webpack/types.d.ts:2654](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2654) + +#### Returns + +`void` + +*** + +### unseal() + +> **unseal**(): `void` + +Defined in: [webpack/types.d.ts:2580](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2580) + +#### Returns + +`void` + +*** + +### updateAsset() + +> **updateAsset**(`file`, `newSourceOrFunction`, `assetInfoUpdateOrFunction?`): `void` + +Defined in: [webpack/types.d.ts:2660](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2660) + +#### Parameters + +##### file + +`string` + +##### newSourceOrFunction + +[`Source`](../webpack/namespaces/export=/namespaces/sources/classes/Source.md) | (`source`) => [`Source`](../webpack/namespaces/export=/namespaces/sources/classes/Source.md) + +##### assetInfoUpdateOrFunction? + +[`AssetInfo`](../type-aliases/AssetInfo.md) | (`assetInfo?`) => [`AssetInfo`](../type-aliases/AssetInfo.md) + +#### Returns + +`void` diff --git a/api/classes/Compiler.md b/api/classes/Compiler.md new file mode 100644 index 0000000..331226a --- /dev/null +++ b/api/classes/Compiler.md @@ -0,0 +1,685 @@ +--- +title: Compiler +--- + +[webpack](../globals.md) / Compiler + +# Class: Compiler + +Defined in: [webpack/types.d.ts:2876](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2876) + +## Constructors + +### Constructor + +> **new Compiler**(`context`, `options?`): `Compiler` + +Defined in: [webpack/types.d.ts:2877](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2877) + +#### Parameters + +##### context + +`string` + +##### options? + +[`WebpackOptionsNormalized`](../interfaces/WebpackOptionsNormalized.md) + +#### Returns + +`Compiler` + +## Properties + +### cache + +> **cache**: [`Cache`](Cache.md) + +Defined in: [webpack/types.d.ts:2961](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2961) + +*** + +### compilerPath + +> **compilerPath**: `string` + +Defined in: [webpack/types.d.ts:2963](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2963) + +*** + +### context + +> **context**: `string` + +Defined in: [webpack/types.d.ts:2959](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2959) + +*** + +### contextTimestamps? + +> `optional` **contextTimestamps**: `Map`\<`string`, `"ignore"` \| `EntryTypesIndex` \| `OnlySafeTimeEntry` \| `ExistenceOnlyTimeEntryTypesIndex`\> + +Defined in: [webpack/types.d.ts:2942](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2942) + +*** + +### fileTimestamps? + +> `optional` **fileTimestamps**: `Map`\<`string`, `"ignore"` \| `EntryTypesIndex` \| `OnlySafeTimeEntry` \| `ExistenceOnlyTimeEntryTypesIndex`\> + +Defined in: [webpack/types.d.ts:2934](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2934) + +*** + +### fsStartTime? + +> `optional` **fsStartTime**: `number` + +Defined in: [webpack/types.d.ts:2950](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2950) + +*** + +### hooks + +> **hooks**: `Readonly`\<\{ `additionalPass`: `AsyncSeriesHook`\<\[\]\>; `afterCompile`: `AsyncSeriesHook`\<\[[`Compilation`](Compilation.md)\]\>; `afterDone`: `SyncHook`\<\[[`Stats`](Stats.md)\]\>; `afterEmit`: `AsyncSeriesHook`\<\[[`Compilation`](Compilation.md)\]\>; `afterEnvironment`: `SyncHook`\<\[\]\>; `afterPlugins`: `SyncHook`\<\[`Compiler`\]\>; `afterResolvers`: `SyncHook`\<\[`Compiler`\]\>; `assetEmitted`: `AsyncSeriesHook`\<\[`string`, [`AssetEmittedInfo`](../interfaces/AssetEmittedInfo.md)\]\>; `beforeCompile`: `AsyncSeriesHook`\<\[`CompilationParams`\]\>; `beforeRun`: `AsyncSeriesHook`\<\[`Compiler`\]\>; `compilation`: `SyncHook`\<\[[`Compilation`](Compilation.md), `CompilationParams`\]\>; `compile`: `SyncHook`\<\[`CompilationParams`\]\>; `contextModuleFactory`: `SyncHook`\<\[`ContextModuleFactory`\]\>; `done`: `AsyncSeriesHook`\<\[[`Stats`](Stats.md)\]\>; `emit`: `AsyncSeriesHook`\<\[[`Compilation`](Compilation.md)\]\>; `emitRecords`: `AsyncSeriesHook`\<\[\]\>; `entryOption`: `SyncBailHook`\<\[`string`, [`EntryNormalized`](../type-aliases/EntryNormalized.md)\], `boolean` \| `void`\>; `environment`: `SyncHook`\<\[\]\>; `failed`: `SyncHook`\<\[`Error`\]\>; `finishMake`: `AsyncParallelHook`\<\[[`Compilation`](Compilation.md)\]\>; `infrastructureLog`: `SyncBailHook`\<\[`string`, `string`, `undefined` \| `any`[]\], `true` \| `void`\>; `initialize`: `SyncHook`\<\[\]\>; `invalid`: `SyncHook`\<\[`null` \| `string`, `number`\]\>; `make`: `AsyncParallelHook`\<\[[`Compilation`](Compilation.md)\]\>; `normalModuleFactory`: `SyncHook`\<\[`NormalModuleFactory`\]\>; `readRecords`: `AsyncSeriesHook`\<\[\]\>; `run`: `AsyncSeriesHook`\<\[`Compiler`\]\>; `shouldEmit`: `SyncBailHook`\<\[[`Compilation`](Compilation.md)\], `boolean` \| `void`\>; `shutdown`: `AsyncSeriesHook`\<\[\]\>; `thisCompilation`: `SyncHook`\<\[[`Compilation`](Compilation.md), `CompilationParams`\]\>; `validate`: `SyncHook`\<\[\]\>; `watchClose`: `SyncHook`\<\[\]\>; `watchRun`: `AsyncSeriesHook`\<\[`Compiler`\]\>; \}\> + +Defined in: [webpack/types.d.ts:2878](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2878) + +*** + +### idle + +> **idle**: `boolean` + +Defined in: [webpack/types.d.ts:2965](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2965) + +*** + +### immutablePaths + +> **immutablePaths**: `Set`\<`string` \| `RegExp`\> + +Defined in: [webpack/types.d.ts:2931](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2931) + +*** + +### infrastructureLogger()? + +> `optional` **infrastructureLogger**: (`value`, `type`, `args?`) => `void` + +Defined in: [webpack/types.d.ts:2952](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2952) + +#### Parameters + +##### value + +`string` + +##### type + +`LogTypeEnum` + +##### args? + +`any`[] + +#### Returns + +`void` + +*** + +### inputFileSystem + +> **inputFileSystem**: [`InputFileSystem`](../interfaces/InputFileSystem.md) + +Defined in: [webpack/types.d.ts:2924](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2924) + +*** + +### intermediateFileSystem + +> **intermediateFileSystem**: `IntermediateFileSystem` + +Defined in: [webpack/types.d.ts:2923](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2923) + +*** + +### managedPaths + +> **managedPaths**: `Set`\<`string` \| `RegExp`\> + +Defined in: [webpack/types.d.ts:2929](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2929) + +*** + +### modifiedFiles? + +> `optional` **modifiedFiles**: `ReadonlySet`\<`string`\> + +Defined in: [webpack/types.d.ts:2932](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2932) + +*** + +### moduleMemCaches? + +> `optional` **moduleMemCaches**: `Map`\<[`Module`](Module.md), `ModuleMemCachesItem`\> + +Defined in: [webpack/types.d.ts:2962](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2962) + +*** + +### name? + +> `optional` **name**: `string` + +Defined in: [webpack/types.d.ts:2917](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2917) + +*** + +### options + +> **options**: [`WebpackOptionsNormalized`](../interfaces/WebpackOptionsNormalized.md) + +Defined in: [webpack/types.d.ts:2958](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2958) + +*** + +### outputFileSystem + +> **outputFileSystem**: [`OutputFileSystem`](../interfaces/OutputFileSystem.md) + +Defined in: [webpack/types.d.ts:2922](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2922) + +*** + +### outputPath + +> **outputPath**: `string` + +Defined in: [webpack/types.d.ts:2920](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2920) + +*** + +### parentCompilation? + +> `optional` **parentCompilation**: [`Compilation`](Compilation.md) + +Defined in: [webpack/types.d.ts:2918](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2918) + +*** + +### platform + +> **platform**: `Readonly`\<`PlatformTargetProperties`\> + +Defined in: [webpack/types.d.ts:2957](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2957) + +*** + +### records + +> **records**: `Records` + +Defined in: [webpack/types.d.ts:2928](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2928) + +*** + +### recordsInputPath + +> **recordsInputPath**: `string` + +Defined in: [webpack/types.d.ts:2926](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2926) + +*** + +### recordsOutputPath + +> **recordsOutputPath**: `string` + +Defined in: [webpack/types.d.ts:2927](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2927) + +*** + +### removedFiles? + +> `optional` **removedFiles**: `ReadonlySet`\<`string`\> + +Defined in: [webpack/types.d.ts:2933](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2933) + +*** + +### requestShortener + +> **requestShortener**: `RequestShortener` + +Defined in: [webpack/types.d.ts:2960](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2960) + +*** + +### resolverFactory + +> **resolverFactory**: `ResolverFactory` + +Defined in: [webpack/types.d.ts:2951](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2951) + +*** + +### root + +> **root**: `Compiler` + +Defined in: [webpack/types.d.ts:2919](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2919) + +*** + +### running + +> **running**: `boolean` + +Defined in: [webpack/types.d.ts:2964](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2964) + +*** + +### unmanagedPaths + +> **unmanagedPaths**: `Set`\<`string` \| `RegExp`\> + +Defined in: [webpack/types.d.ts:2930](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2930) + +*** + +### watchFileSystem + +> **watchFileSystem**: `WatchFileSystem` + +Defined in: [webpack/types.d.ts:2925](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2925) + +*** + +### watching? + +> `optional` **watching**: [`Watching`](Watching.md) + +Defined in: [webpack/types.d.ts:2921](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2921) + +*** + +### watchMode + +> **watchMode**: `boolean` + +Defined in: [webpack/types.d.ts:2966](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2966) + +*** + +### webpack + +> **webpack**: *typeof* [`export=`](../functions/export=.md) + +Defined in: [webpack/types.d.ts:2916](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2916) + +## Methods + +### close() + +> **close**(`callback`): `void` + +Defined in: [webpack/types.d.ts:3013](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L3013) + +#### Parameters + +##### callback + +(`err`, `result?`) => `void` + +#### Returns + +`void` + +*** + +### compile() + +> **compile**(`callback`): `void` + +Defined in: [webpack/types.d.ts:3012](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L3012) + +#### Parameters + +##### callback + +`CallbackWebpackFunction_2`\<[`Compilation`](Compilation.md), `void`\> + +#### Returns + +`void` + +*** + +### createChildCompiler() + +> **createChildCompiler**(`compilation`, `compilerName`, `compilerIndex`, `outputOptions?`, `plugins?`): `Compiler` + +Defined in: [webpack/types.d.ts:2988](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2988) + +#### Parameters + +##### compilation + +[`Compilation`](Compilation.md) + +##### compilerName + +`string` + +##### compilerIndex + +`number` + +##### outputOptions? + +`Partial`\<`OutputNormalized`\> + +##### plugins? + +(`false` \| `""` \| `0` \| [`WebpackPluginInstance`](../interfaces/WebpackPluginInstance.md) \| (`this`, `compiler`) => `void`)[] + +#### Returns + +`Compiler` + +*** + +### createCompilation() + +> **createCompilation**(`params`): [`Compilation`](Compilation.md) + +Defined in: [webpack/types.d.ts:3004](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L3004) + +#### Parameters + +##### params + +`CompilationParams` + +#### Returns + +[`Compilation`](Compilation.md) + +*** + +### createContextModuleFactory() + +> **createContextModuleFactory**(): `ContextModuleFactory` + +Defined in: [webpack/types.d.ts:3007](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L3007) + +#### Returns + +`ContextModuleFactory` + +*** + +### createNormalModuleFactory() + +> **createNormalModuleFactory**(): `NormalModuleFactory` + +Defined in: [webpack/types.d.ts:3006](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L3006) + +#### Returns + +`NormalModuleFactory` + +*** + +### emitAssets() + +> **emitAssets**(`compilation`, `callback`): `void` + +Defined in: [webpack/types.d.ts:2982](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2982) + +#### Parameters + +##### compilation + +[`Compilation`](Compilation.md) + +##### callback + +(`err`, `result?`) => `void` + +#### Returns + +`void` + +*** + +### emitRecords() + +> **emitRecords**(`callback`): `void` + +Defined in: [webpack/types.d.ts:2986](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2986) + +#### Parameters + +##### callback + +(`err`, `result?`) => `void` + +#### Returns + +`void` + +*** + +### getCache() + +> **getCache**(`name`): `CacheFacade` + +Defined in: [webpack/types.d.ts:2967](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2967) + +#### Parameters + +##### name + +`string` + +#### Returns + +`CacheFacade` + +*** + +### getInfrastructureLogger() + +> **getInfrastructureLogger**(`name`): `WebpackLogger` + +Defined in: [webpack/types.d.ts:2968](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2968) + +#### Parameters + +##### name + +`string` | () => `string` + +#### Returns + +`WebpackLogger` + +*** + +### isChild() + +> **isChild**(): `boolean` + +Defined in: [webpack/types.d.ts:3003](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L3003) + +#### Returns + +`boolean` + +*** + +### newCompilation() + +> **newCompilation**(`params`): [`Compilation`](Compilation.md) + +Defined in: [webpack/types.d.ts:3005](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L3005) + +#### Parameters + +##### params + +`CompilationParams` + +#### Returns + +[`Compilation`](Compilation.md) + +*** + +### newCompilationParams() + +> **newCompilationParams**(): `object` + +Defined in: [webpack/types.d.ts:3008](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L3008) + +#### Returns + +`object` + +##### contextModuleFactory + +> **contextModuleFactory**: `ContextModuleFactory` + +##### normalModuleFactory + +> **normalModuleFactory**: `NormalModuleFactory` + +*** + +### purgeInputFileSystem() + +> **purgeInputFileSystem**(): `void` + +Defined in: [webpack/types.d.ts:2981](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2981) + +#### Returns + +`void` + +*** + +### readRecords() + +> **readRecords**(`callback`): `void` + +Defined in: [webpack/types.d.ts:2987](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2987) + +#### Parameters + +##### callback + +(`err`, `result?`) => `void` + +#### Returns + +`void` + +*** + +### run() + +> **run**(`callback`): `void` + +Defined in: [webpack/types.d.ts:2973](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2973) + +#### Parameters + +##### callback + +`CallbackWebpackFunction_2`\<[`Stats`](Stats.md), `void`\> + +#### Returns + +`void` + +*** + +### runAsChild() + +> **runAsChild**(`callback`): `void` + +Defined in: [webpack/types.d.ts:2974](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2974) + +#### Parameters + +##### callback + +(`err`, `entries?`, `compilation?`) => `void` + +#### Returns + +`void` + +*** + +### validate() + +> **validate**\<`T`\>(`schema`, `value`, `options?`, `check?`): `void` + +Defined in: [webpack/types.d.ts:3018](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L3018) + +Schema validation function with optional pre-compiled check + +#### Type Parameters + +##### T + +`T` *extends* `object` \| `object`[] = `object` + +#### Parameters + +##### schema + +`JSONSchema4` & `ExtendedSchema` | `JSONSchema6` & `ExtendedSchema` | `JSONSchema7` & `ExtendedSchema` | () => `Schema` + +##### value + +`T` + +##### options? + +`ValidationErrorConfiguration` + +##### check? + +(`value`) => `boolean` + +#### Returns + +`void` + +*** + +### watch() + +> **watch**(`watchOptions`, `handler`): [`Watching`](Watching.md) + +Defined in: [webpack/types.d.ts:2969](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2969) + +#### Parameters + +##### watchOptions + +`WatchOptions` + +##### handler + +`CallbackWebpackFunction_2`\<[`Stats`](Stats.md), `void`\> + +#### Returns + +[`Watching`](Watching.md) diff --git a/api/classes/ConcatenationScope.md b/api/classes/ConcatenationScope.md new file mode 100644 index 0000000..2bbccaf --- /dev/null +++ b/api/classes/ConcatenationScope.md @@ -0,0 +1,237 @@ +--- +title: ConcatenationScope +--- + +[webpack](../globals.md) / ConcatenationScope + +# Class: ConcatenationScope + +Defined in: [webpack/types.d.ts:3113](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L3113) + +## Constructors + +### Constructor + +> **new ConcatenationScope**(`modulesMap`, `currentModule`, `usedNames`): `ConcatenationScope` + +Defined in: [webpack/types.d.ts:3114](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L3114) + +#### Parameters + +##### modulesMap + +`Map`\<[`Module`](Module.md), `ModuleInfo`\> | `ModuleInfo`[] + +##### currentModule + +`ConcatenatedModuleInfo` + +##### usedNames + +`Set`\<`string`\> + +#### Returns + +`ConcatenationScope` + +## Properties + +### usedNames + +> **usedNames**: `Set`\<`string`\> + +Defined in: [webpack/types.d.ts:3119](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L3119) + +*** + +### DEFAULT\_EXPORT + +> `static` **DEFAULT\_EXPORT**: `string` + +Defined in: [webpack/types.d.ts:3134](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L3134) + +*** + +### NAMESPACE\_OBJECT\_EXPORT + +> `static` **NAMESPACE\_OBJECT\_EXPORT**: `string` + +Defined in: [webpack/types.d.ts:3135](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L3135) + +## Methods + +### createModuleReference() + +> **createModuleReference**(`module`, `__namedParameters`): `string` + +Defined in: [webpack/types.d.ts:3126](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L3126) + +#### Parameters + +##### module + +[`Module`](Module.md) + +##### \_\_namedParameters + +`Partial`\<`ModuleReferenceOptions`\> + +#### Returns + +`string` + +*** + +### getRawExport() + +> **getRawExport**(`exportName`): `string` + +Defined in: [webpack/types.d.ts:3123](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L3123) + +#### Parameters + +##### exportName + +`string` + +#### Returns + +`string` + +*** + +### isModuleInScope() + +> **isModuleInScope**(`module`): `boolean` + +Defined in: [webpack/types.d.ts:3120](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L3120) + +#### Parameters + +##### module + +[`Module`](Module.md) + +#### Returns + +`boolean` + +*** + +### registerExport() + +> **registerExport**(`exportName`, `symbol`): `void` + +Defined in: [webpack/types.d.ts:3121](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L3121) + +#### Parameters + +##### exportName + +`string` + +##### symbol + +`string` + +#### Returns + +`void` + +*** + +### registerNamespaceExport() + +> **registerNamespaceExport**(`symbol`): `void` + +Defined in: [webpack/types.d.ts:3125](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L3125) + +#### Parameters + +##### symbol + +`string` + +#### Returns + +`void` + +*** + +### registerRawExport() + +> **registerRawExport**(`exportName`, `expression`): `void` + +Defined in: [webpack/types.d.ts:3122](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L3122) + +#### Parameters + +##### exportName + +`string` + +##### expression + +`string` + +#### Returns + +`void` + +*** + +### setRawExportMap() + +> **setRawExportMap**(`exportName`, `expression`): `void` + +Defined in: [webpack/types.d.ts:3124](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L3124) + +#### Parameters + +##### exportName + +`string` + +##### expression + +`string` + +#### Returns + +`void` + +*** + +### isModuleReference() + +> `static` **isModuleReference**(`name`): `boolean` + +Defined in: [webpack/types.d.ts:3130](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L3130) + +#### Parameters + +##### name + +`string` + +#### Returns + +`boolean` + +*** + +### matchModuleReference() + +> `static` **matchModuleReference**(`name`): `ModuleReferenceOptions` & `object` + +Defined in: [webpack/types.d.ts:3131](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L3131) + +#### Parameters + +##### name + +`string` + +#### Returns + +`ModuleReferenceOptions` & `object` diff --git a/api/classes/ContextExclusionPlugin.md b/api/classes/ContextExclusionPlugin.md new file mode 100644 index 0000000..81d9846 --- /dev/null +++ b/api/classes/ContextExclusionPlugin.md @@ -0,0 +1,55 @@ +--- +title: ContextExclusionPlugin +--- + +[webpack](../globals.md) / ContextExclusionPlugin + +# Class: ContextExclusionPlugin + +Defined in: [webpack/types.d.ts:3603](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L3603) + +## Constructors + +### Constructor + +> **new ContextExclusionPlugin**(`negativeMatcher`): `ContextExclusionPlugin` + +Defined in: [webpack/types.d.ts:3604](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L3604) + +#### Parameters + +##### negativeMatcher + +`RegExp` + +#### Returns + +`ContextExclusionPlugin` + +## Properties + +### negativeMatcher + +> **negativeMatcher**: `RegExp` + +Defined in: [webpack/types.d.ts:3605](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L3605) + +## Methods + +### apply() + +> **apply**(`compiler`): `void` + +Defined in: [webpack/types.d.ts:3610](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L3610) + +Apply the plugin + +#### Parameters + +##### compiler + +[`Compiler`](Compiler.md) + +#### Returns + +`void` diff --git a/api/classes/ContextReplacementPlugin.md b/api/classes/ContextReplacementPlugin.md new file mode 100644 index 0000000..c0351e5 --- /dev/null +++ b/api/classes/ContextReplacementPlugin.md @@ -0,0 +1,131 @@ +--- +title: ContextReplacementPlugin +--- + +[webpack](../globals.md) / ContextReplacementPlugin + +# Class: ContextReplacementPlugin + +Defined in: [webpack/types.d.ts:3693](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L3693) + +## Constructors + +### Constructor + +> **new ContextReplacementPlugin**(`resourceRegExp`, `newContentResource?`, `newContentRecursive?`, `newContentRegExp?`): `ContextReplacementPlugin` + +Defined in: [webpack/types.d.ts:3694](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L3694) + +#### Parameters + +##### resourceRegExp + +`RegExp` + +##### newContentResource? + +`string` | `boolean` | `RegExp` | (`context`) => `void` + +##### newContentRecursive? + +`boolean` | `RegExp` | `NewContentCreateContextMap` + +##### newContentRegExp? + +`RegExp` + +#### Returns + +`ContextReplacementPlugin` + +## Properties + +### newContentCallback()? + +> `optional` **newContentCallback**: (`context`) => `void` + +Defined in: [webpack/types.d.ts:3705](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L3705) + +#### Parameters + +##### context + +`AfterContextResolveData` | `BeforeContextResolveData` + +#### Returns + +`void` + +*** + +### newContentCreateContextMap()? + +> `optional` **newContentCreateContextMap**: (`fs`, `callback`) => `void` + +Defined in: [webpack/types.d.ts:3709](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L3709) + +#### Parameters + +##### fs + +[`InputFileSystem`](../interfaces/InputFileSystem.md) + +##### callback + +(`err`, `newContentRecursive`) => `void` + +#### Returns + +`void` + +*** + +### newContentRecursive? + +> `optional` **newContentRecursive**: `boolean` + +Defined in: [webpack/types.d.ts:3716](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L3716) + +*** + +### newContentRegExp? + +> `optional` **newContentRegExp**: `RegExp` + +Defined in: [webpack/types.d.ts:3717](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L3717) + +*** + +### newContentResource? + +> `optional` **newContentResource**: `string` + +Defined in: [webpack/types.d.ts:3708](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L3708) + +*** + +### resourceRegExp + +> **resourceRegExp**: `RegExp` + +Defined in: [webpack/types.d.ts:3704](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L3704) + +## Methods + +### apply() + +> **apply**(`compiler`): `void` + +Defined in: [webpack/types.d.ts:3722](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L3722) + +Apply the plugin + +#### Parameters + +##### compiler + +[`Compiler`](Compiler.md) + +#### Returns + +`void` diff --git a/api/classes/DefinePlugin.md b/api/classes/DefinePlugin.md new file mode 100644 index 0000000..2fd2a7f --- /dev/null +++ b/api/classes/DefinePlugin.md @@ -0,0 +1,97 @@ +--- +title: DefinePlugin +--- + +[webpack](../globals.md) / DefinePlugin + +# Class: DefinePlugin + +Defined in: [webpack/types.d.ts:4069](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4069) + +## Constructors + +### Constructor + +> **new DefinePlugin**(`definitions`): `DefinePlugin` + +Defined in: [webpack/types.d.ts:4073](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4073) + +Create a new define plugin + +#### Parameters + +##### definitions + +`Definitions` + +#### Returns + +`DefinePlugin` + +## Properties + +### definitions + +> **definitions**: `Definitions` + +Defined in: [webpack/types.d.ts:4074](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4074) + +## Methods + +### apply() + +> **apply**(`compiler`): `void` + +Defined in: [webpack/types.d.ts:4079](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4079) + +Apply the plugin + +#### Parameters + +##### compiler + +[`Compiler`](Compiler.md) + +#### Returns + +`void` + +*** + +### getCompilationHooks() + +> `static` **getCompilationHooks**(`compilation`): `DefinePluginHooks` + +Defined in: [webpack/types.d.ts:4080](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4080) + +#### Parameters + +##### compilation + +[`Compilation`](Compilation.md) + +#### Returns + +`DefinePluginHooks` + +*** + +### runtimeValue() + +> `static` **runtimeValue**(`fn`, `options?`): `RuntimeValue` + +Defined in: [webpack/types.d.ts:4081](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4081) + +#### Parameters + +##### fn + +(`value`) => `CodeValuePrimitive` + +##### options? + +`true` | `string`[] | `RuntimeValueOptions` + +#### Returns + +`RuntimeValue` diff --git a/api/classes/DelegatedPlugin.md b/api/classes/DelegatedPlugin.md new file mode 100644 index 0000000..c4c9877 --- /dev/null +++ b/api/classes/DelegatedPlugin.md @@ -0,0 +1,55 @@ +--- +title: DelegatedPlugin +--- + +[webpack](../globals.md) / DelegatedPlugin + +# Class: DelegatedPlugin + +Defined in: [webpack/types.d.ts:4099](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4099) + +## Constructors + +### Constructor + +> **new DelegatedPlugin**(`options`): `DelegatedPlugin` + +Defined in: [webpack/types.d.ts:4100](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4100) + +#### Parameters + +##### options + +`Options` + +#### Returns + +`DelegatedPlugin` + +## Properties + +### options + +> **options**: `Options` + +Defined in: [webpack/types.d.ts:4101](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4101) + +## Methods + +### apply() + +> **apply**(`compiler`): `void` + +Defined in: [webpack/types.d.ts:4106](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4106) + +Apply the plugin + +#### Parameters + +##### compiler + +[`Compiler`](Compiler.md) + +#### Returns + +`void` diff --git a/api/classes/Dependency.md b/api/classes/Dependency.md new file mode 100644 index 0000000..83b091b --- /dev/null +++ b/api/classes/Dependency.md @@ -0,0 +1,442 @@ +--- +title: Dependency +--- + +[webpack](../globals.md) / Dependency + +# Class: Dependency + +Defined in: [webpack/types.d.ts:4134](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4134) + +## Extended by + +- [`ModuleDependency`](../webpack/namespaces/export=/namespaces/dependencies/classes/ModuleDependency.md) +- [`NullDependency`](../webpack/namespaces/export=/namespaces/dependencies/classes/NullDependency.md) + +## Constructors + +### Constructor + +> **new Dependency**(): `Dependency` + +Defined in: [webpack/types.d.ts:4135](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4135) + +#### Returns + +`Dependency` + +## Properties + +### loc + +> **loc**: `DependencyLocation` + +Defined in: [webpack/types.d.ts:4140](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4140) + +*** + +### module + +> **module**: `any` + +Defined in: [webpack/types.d.ts:4204](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4204) + +*** + +### optional? + +> `optional` **optional**: `boolean` + +Defined in: [webpack/types.d.ts:4137](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4137) + +*** + +### weak + +> **weak**: `boolean` + +Defined in: [webpack/types.d.ts:4136](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4136) + +*** + +### EXPORTS\_OBJECT\_REFERENCED + +> `static` **EXPORTS\_OBJECT\_REFERENCED**: `string`[][] + +Defined in: [webpack/types.d.ts:4207](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4207) + +*** + +### NO\_EXPORTS\_REFERENCED + +> `static` **NO\_EXPORTS\_REFERENCED**: `string`[][] + +Defined in: [webpack/types.d.ts:4206](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4206) + +*** + +### TRANSITIVE + +> `static` **TRANSITIVE**: *typeof* `TRANSITIVE` + +Defined in: [webpack/types.d.ts:4209](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4209) + +## Accessors + +### category + +#### Get Signature + +> **get** **category**(): `string` + +Defined in: [webpack/types.d.ts:4139](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4139) + +##### Returns + +`string` + +*** + +### disconnect + +#### Get Signature + +> **get** **disconnect**(): `any` + +Defined in: [webpack/types.d.ts:4205](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4205) + +##### Returns + +`any` + +*** + +### type + +#### Get Signature + +> **get** **type**(): `string` + +Defined in: [webpack/types.d.ts:4138](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4138) + +##### Returns + +`string` + +## Methods + +### couldAffectReferencingModule() + +> **couldAffectReferencingModule**(): `boolean` \| *typeof* `TRANSITIVE` + +Defined in: [webpack/types.d.ts:4149](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4149) + +#### Returns + +`boolean` \| *typeof* `TRANSITIVE` + +*** + +### createIgnoredModule() + +> **createIgnoredModule**(`context`): [`Module`](Module.md) + +Defined in: [webpack/types.d.ts:4201](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4201) + +#### Parameters + +##### context + +`string` + +#### Returns + +[`Module`](Module.md) + +*** + +### deserialize() + +> **deserialize**(`__namedParameters`): `void` + +Defined in: [webpack/types.d.ts:4203](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4203) + +#### Parameters + +##### \_\_namedParameters + +[`ObjectDeserializerContext`](../interfaces/ObjectDeserializerContext.md) + +#### Returns + +`void` + +*** + +### getCondition() + +> **getCondition**(`moduleGraph`): `false` \| (`moduleGraphConnection`, `runtime`) => `ConnectionState` + +Defined in: [webpack/types.d.ts:4164](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4164) + +#### Parameters + +##### moduleGraph + +[`ModuleGraph`](ModuleGraph.md) + +#### Returns + +`false` \| (`moduleGraphConnection`, `runtime`) => `ConnectionState` + +*** + +### getContext() + +> **getContext**(): `string` + +Defined in: [webpack/types.d.ts:4147](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4147) + +#### Returns + +`string` + +*** + +### getErrors() + +> **getErrors**(`moduleGraph`): [`WebpackError`](WebpackError.md)[] + +Defined in: [webpack/types.d.ts:4187](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4187) + +Returns errors + +#### Parameters + +##### moduleGraph + +[`ModuleGraph`](ModuleGraph.md) + +#### Returns + +[`WebpackError`](WebpackError.md)[] + +*** + +### getExports() + +> **getExports**(`moduleGraph`): `ExportsSpec` + +Defined in: [webpack/types.d.ts:4177](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4177) + +Returns the exported names + +#### Parameters + +##### moduleGraph + +[`ModuleGraph`](ModuleGraph.md) + +#### Returns + +`ExportsSpec` + +*** + +### getModuleEvaluationSideEffectsState() + +> **getModuleEvaluationSideEffectsState**(`moduleGraph`): `ConnectionState` + +Defined in: [webpack/types.d.ts:4198](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4198) + +#### Parameters + +##### moduleGraph + +[`ModuleGraph`](ModuleGraph.md) + +#### Returns + +`ConnectionState` + +*** + +### getNumberOfIdOccurrences() + +> **getNumberOfIdOccurrences**(): `number` + +Defined in: [webpack/types.d.ts:4197](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4197) + +implement this method to allow the occurrence order plugin to count correctly + +#### Returns + +`number` + +*** + +### ~~getReference()~~ + +> **getReference**(`moduleGraph`): `never` + +Defined in: [webpack/types.d.ts:4155](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4155) + +Returns the referenced module and export + +#### Parameters + +##### moduleGraph + +[`ModuleGraph`](ModuleGraph.md) + +#### Returns + +`never` + +#### Deprecated + +*** + +### getReferencedExports() + +> **getReferencedExports**(`moduleGraph`, `runtime`): (`string`[] \| `ReferencedExport`)[] + +Defined in: [webpack/types.d.ts:4160](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4160) + +Returns list of exports referenced by this dependency + +#### Parameters + +##### moduleGraph + +[`ModuleGraph`](ModuleGraph.md) + +##### runtime + +`RuntimeSpec` + +#### Returns + +(`string`[] \| `ReferencedExport`)[] + +*** + +### getResourceIdentifier() + +> **getResourceIdentifier**(): `string` + +Defined in: [webpack/types.d.ts:4148](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4148) + +#### Returns + +`string` + +*** + +### getWarnings() + +> **getWarnings**(`moduleGraph`): [`WebpackError`](WebpackError.md)[] + +Defined in: [webpack/types.d.ts:4182](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4182) + +Returns warnings + +#### Parameters + +##### moduleGraph + +[`ModuleGraph`](ModuleGraph.md) + +#### Returns + +[`WebpackError`](WebpackError.md)[] + +*** + +### serialize() + +> **serialize**(`__namedParameters`): `void` + +Defined in: [webpack/types.d.ts:4202](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4202) + +#### Parameters + +##### \_\_namedParameters + +[`ObjectSerializerContext`](../interfaces/ObjectSerializerContext.md) + +#### Returns + +`void` + +*** + +### setLoc() + +> **setLoc**(`startLine`, `startColumn`, `endLine`, `endColumn`): `void` + +Defined in: [webpack/types.d.ts:4141](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4141) + +#### Parameters + +##### startLine + +`number` + +##### startColumn + +`number` + +##### endLine + +`number` + +##### endColumn + +`number` + +#### Returns + +`void` + +*** + +### updateHash() + +> **updateHash**(`hash`, `context`): `void` + +Defined in: [webpack/types.d.ts:4192](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4192) + +Update the hash + +#### Parameters + +##### hash + +`Hash` + +##### context + +`UpdateHashContextDependency` + +#### Returns + +`void` + +*** + +### isLowPriorityDependency() + +> `static` **isLowPriorityDependency**(`dependency`): `boolean` + +Defined in: [webpack/types.d.ts:4208](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4208) + +#### Parameters + +##### dependency + +`Dependency` + +#### Returns + +`boolean` diff --git a/api/classes/DllPlugin.md b/api/classes/DllPlugin.md new file mode 100644 index 0000000..f70a03a --- /dev/null +++ b/api/classes/DllPlugin.md @@ -0,0 +1,55 @@ +--- +title: DllPlugin +--- + +[webpack](../globals.md) / DllPlugin + +# Class: DllPlugin + +Defined in: [webpack/types.d.ts:4433](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4433) + +## Constructors + +### Constructor + +> **new DllPlugin**(`options`): `DllPlugin` + +Defined in: [webpack/types.d.ts:4434](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4434) + +#### Parameters + +##### options + +`DllPluginOptions` + +#### Returns + +`DllPlugin` + +## Properties + +### options + +> **options**: `DllPluginOptions` + +Defined in: [webpack/types.d.ts:4435](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4435) + +## Methods + +### apply() + +> **apply**(`compiler`): `void` + +Defined in: [webpack/types.d.ts:4440](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4440) + +Apply the plugin + +#### Parameters + +##### compiler + +[`Compiler`](Compiler.md) + +#### Returns + +`void` diff --git a/api/classes/DllReferencePlugin.md b/api/classes/DllReferencePlugin.md new file mode 100644 index 0000000..2f3a5c4 --- /dev/null +++ b/api/classes/DllReferencePlugin.md @@ -0,0 +1,55 @@ +--- +title: DllReferencePlugin +--- + +[webpack](../globals.md) / DllReferencePlugin + +# Class: DllReferencePlugin + +Defined in: [webpack/types.d.ts:4473](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4473) + +## Constructors + +### Constructor + +> **new DllReferencePlugin**(`options`): `DllReferencePlugin` + +Defined in: [webpack/types.d.ts:4474](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4474) + +#### Parameters + +##### options + +`DllReferencePluginOptions` + +#### Returns + +`DllReferencePlugin` + +## Properties + +### options + +> **options**: `DllReferencePluginOptions` + +Defined in: [webpack/types.d.ts:4475](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4475) + +## Methods + +### apply() + +> **apply**(`compiler`): `void` + +Defined in: [webpack/types.d.ts:4480](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4480) + +Apply the plugin + +#### Parameters + +##### compiler + +[`Compiler`](Compiler.md) + +#### Returns + +`void` diff --git a/api/classes/DotenvPlugin.md b/api/classes/DotenvPlugin.md new file mode 100644 index 0000000..684e16f --- /dev/null +++ b/api/classes/DotenvPlugin.md @@ -0,0 +1,53 @@ +--- +title: DotenvPlugin +--- + +[webpack](../globals.md) / DotenvPlugin + +# Class: DotenvPlugin + +Defined in: [webpack/types.d.ts:4625](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4625) + +## Constructors + +### Constructor + +> **new DotenvPlugin**(`options?`): `DotenvPlugin` + +Defined in: [webpack/types.d.ts:4626](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4626) + +#### Parameters + +##### options? + +`DotenvPluginOptions` + +#### Returns + +`DotenvPlugin` + +## Properties + +### options + +> **options**: `DotenvPluginOptions` + +Defined in: [webpack/types.d.ts:4627](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4627) + +## Methods + +### apply() + +> **apply**(`compiler`): `void` + +Defined in: [webpack/types.d.ts:4628](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4628) + +#### Parameters + +##### compiler + +[`Compiler`](Compiler.md) + +#### Returns + +`void` diff --git a/api/classes/DynamicEntryPlugin.md b/api/classes/DynamicEntryPlugin.md new file mode 100644 index 0000000..7d78f25 --- /dev/null +++ b/api/classes/DynamicEntryPlugin.md @@ -0,0 +1,71 @@ +--- +title: DynamicEntryPlugin +--- + +[webpack](../globals.md) / DynamicEntryPlugin + +# Class: DynamicEntryPlugin + +Defined in: [webpack/types.d.ts:4650](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4650) + +## Constructors + +### Constructor + +> **new DynamicEntryPlugin**(`context`, `entry`): `DynamicEntryPlugin` + +Defined in: [webpack/types.d.ts:4651](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4651) + +#### Parameters + +##### context + +`string` + +##### entry + +() => `Promise`\<`EntryStaticNormalized`\> + +#### Returns + +`DynamicEntryPlugin` + +## Properties + +### context + +> **context**: `string` + +Defined in: [webpack/types.d.ts:4652](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4652) + +*** + +### entry() + +> **entry**: () => `Promise`\<`EntryStaticNormalized`\> + +Defined in: [webpack/types.d.ts:4653](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4653) + +#### Returns + +`Promise`\<`EntryStaticNormalized`\> + +## Methods + +### apply() + +> **apply**(`compiler`): `void` + +Defined in: [webpack/types.d.ts:4658](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4658) + +Apply the plugin + +#### Parameters + +##### compiler + +[`Compiler`](Compiler.md) + +#### Returns + +`void` diff --git a/api/classes/EntryOptionPlugin.md b/api/classes/EntryOptionPlugin.md new file mode 100644 index 0000000..0aa39b7 --- /dev/null +++ b/api/classes/EntryOptionPlugin.md @@ -0,0 +1,91 @@ +--- +title: EntryOptionPlugin +--- + +[webpack](../globals.md) / EntryOptionPlugin + +# Class: EntryOptionPlugin + +Defined in: [webpack/types.d.ts:4915](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4915) + +## Constructors + +### Constructor + +> **new EntryOptionPlugin**(): `EntryOptionPlugin` + +Defined in: [webpack/types.d.ts:4916](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4916) + +#### Returns + +`EntryOptionPlugin` + +## Methods + +### apply() + +> **apply**(`compiler`): `void` + +Defined in: [webpack/types.d.ts:4917](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4917) + +#### Parameters + +##### compiler + +[`Compiler`](Compiler.md) + +#### Returns + +`void` + +*** + +### applyEntryOption() + +> `static` **applyEntryOption**(`compiler`, `context`, `entry`): `void` + +Defined in: [webpack/types.d.ts:4918](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4918) + +#### Parameters + +##### compiler + +[`Compiler`](Compiler.md) + +##### context + +`string` + +##### entry + +[`EntryNormalized`](../type-aliases/EntryNormalized.md) + +#### Returns + +`void` + +*** + +### entryDescriptionToOptions() + +> `static` **entryDescriptionToOptions**(`compiler`, `name`, `desc`): [`EntryOptions`](../type-aliases/EntryOptions.md) + +Defined in: [webpack/types.d.ts:4923](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4923) + +#### Parameters + +##### compiler + +[`Compiler`](Compiler.md) + +##### name + +`string` + +##### desc + +`EntryDescriptionNormalized` + +#### Returns + +[`EntryOptions`](../type-aliases/EntryOptions.md) diff --git a/api/classes/EntryPlugin.md b/api/classes/EntryPlugin.md new file mode 100644 index 0000000..f206588 --- /dev/null +++ b/api/classes/EntryPlugin.md @@ -0,0 +1,103 @@ +--- +title: EntryPlugin +--- + +[webpack](../globals.md) / EntryPlugin + +# Class: EntryPlugin + +Defined in: [webpack/types.d.ts:4933](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4933) + +## Constructors + +### Constructor + +> **new EntryPlugin**(`context`, `entry`, `options?`): `EntryPlugin` + +Defined in: [webpack/types.d.ts:4937](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4937) + +An entry plugin which will handle creation of the EntryDependency + +#### Parameters + +##### context + +`string` + +##### entry + +`string` + +##### options? + +`string` | [`EntryOptions`](../type-aliases/EntryOptions.md) + +#### Returns + +`EntryPlugin` + +## Properties + +### context + +> **context**: `string` + +Defined in: [webpack/types.d.ts:4938](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4938) + +*** + +### entry + +> **entry**: `string` + +Defined in: [webpack/types.d.ts:4939](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4939) + +*** + +### options + +> **options**: `string` \| [`EntryOptions`](../type-aliases/EntryOptions.md) + +Defined in: [webpack/types.d.ts:4940](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4940) + +## Methods + +### apply() + +> **apply**(`compiler`): `void` + +Defined in: [webpack/types.d.ts:4945](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4945) + +Apply the plugin + +#### Parameters + +##### compiler + +[`Compiler`](Compiler.md) + +#### Returns + +`void` + +*** + +### createDependency() + +> `static` **createDependency**(`entry`, `options`): `EntryDependency` + +Defined in: [webpack/types.d.ts:4946](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4946) + +#### Parameters + +##### entry + +`string` + +##### options + +`string` | [`EntryOptions`](../type-aliases/EntryOptions.md) + +#### Returns + +`EntryDependency` diff --git a/api/classes/Entrypoint.md b/api/classes/Entrypoint.md new file mode 100644 index 0000000..df53d26 --- /dev/null +++ b/api/classes/Entrypoint.md @@ -0,0 +1,1052 @@ +--- +title: Entrypoint +--- + +[webpack](../globals.md) / Entrypoint + +# Abstract Class: Entrypoint + +Defined in: [webpack/types.d.ts:4964](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4964) + +## Extends + +- [`ChunkGroup`](ChunkGroup.md) + +## Constructors + +### Constructor + +> **new Entrypoint**(): `Entrypoint` + +#### Returns + +`Entrypoint` + +#### Inherited from + +[`ChunkGroup`](ChunkGroup.md).[`constructor`](ChunkGroup.md#constructor) + +## Properties + +### chunks + +> **chunks**: [`Chunk`](Chunk.md)[] + +Defined in: [webpack/types.d.ts:1599](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1599) + +#### Inherited from + +[`ChunkGroup`](ChunkGroup.md).[`chunks`](ChunkGroup.md#chunks) + +*** + +### getModuleIndex() + +> **getModuleIndex**: (`module`) => `number` + +Defined in: [webpack/types.d.ts:1698](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1698) + +#### Parameters + +##### module + +[`Module`](Module.md) + +#### Returns + +`number` + +#### Inherited from + +[`ChunkGroup`](ChunkGroup.md).[`getModuleIndex`](ChunkGroup.md#getmoduleindex) + +*** + +### getModuleIndex2() + +> **getModuleIndex2**: (`module`) => `number` + +Defined in: [webpack/types.d.ts:1699](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1699) + +#### Parameters + +##### module + +[`Module`](Module.md) + +#### Returns + +`number` + +#### Inherited from + +[`ChunkGroup`](ChunkGroup.md).[`getModuleIndex2`](ChunkGroup.md#getmoduleindex2) + +*** + +### groupDebugId + +> **groupDebugId**: `number` + +Defined in: [webpack/types.d.ts:1597](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1597) + +#### Inherited from + +[`ChunkGroup`](ChunkGroup.md).[`groupDebugId`](ChunkGroup.md#groupdebugid) + +*** + +### index? + +> `optional` **index**: `number` + +Defined in: [webpack/types.d.ts:1601](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1601) + +#### Inherited from + +[`ChunkGroup`](ChunkGroup.md).[`index`](ChunkGroup.md#index) + +*** + +### name? + +> `optional` **name**: `string` + +Defined in: [webpack/types.d.ts:1612](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1612) + +returns the name of current ChunkGroup +sets a new name for current ChunkGroup + +#### Inherited from + +[`ChunkGroup`](ChunkGroup.md).[`name`](ChunkGroup.md#name) + +*** + +### options + +> **options**: `ChunkGroupOptions` + +Defined in: [webpack/types.d.ts:1598](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1598) + +#### Inherited from + +[`ChunkGroup`](ChunkGroup.md).[`options`](ChunkGroup.md#options) + +*** + +### origins + +> **origins**: `OriginRecord`[] + +Defined in: [webpack/types.d.ts:1600](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1600) + +#### Inherited from + +[`ChunkGroup`](ChunkGroup.md).[`origins`](ChunkGroup.md#origins) + +## Accessors + +### asyncEntrypointsIterable + +#### Get Signature + +> **get** **asyncEntrypointsIterable**(): `SortableSet`\<[`ChunkGroup`](ChunkGroup.md)\> + +Defined in: [webpack/types.d.ts:1653](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1653) + +##### Returns + +`SortableSet`\<[`ChunkGroup`](ChunkGroup.md)\> + +#### Inherited from + +[`ChunkGroup`](ChunkGroup.md).[`asyncEntrypointsIterable`](ChunkGroup.md#asyncentrypointsiterable) + +*** + +### blocksIterable + +#### Get Signature + +> **get** **blocksIterable**(): `Iterable`\<[`AsyncDependenciesBlock`](AsyncDependenciesBlock.md)\> + +Defined in: [webpack/types.d.ts:1657](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1657) + +##### Returns + +`Iterable`\<[`AsyncDependenciesBlock`](AsyncDependenciesBlock.md)\> + +#### Inherited from + +[`ChunkGroup`](ChunkGroup.md).[`blocksIterable`](ChunkGroup.md#blocksiterable) + +*** + +### childrenIterable + +#### Get Signature + +> **get** **childrenIterable**(): `SortableSet`\<[`ChunkGroup`](ChunkGroup.md)\> + +Defined in: [webpack/types.d.ts:1644](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1644) + +##### Returns + +`SortableSet`\<[`ChunkGroup`](ChunkGroup.md)\> + +#### Inherited from + +[`ChunkGroup`](ChunkGroup.md).[`childrenIterable`](ChunkGroup.md#childreniterable) + +*** + +### debugId + +#### Get Signature + +> **get** **debugId**(): `string` + +Defined in: [webpack/types.d.ts:1617](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1617) + +get a uniqueId for ChunkGroup, made up of its member Chunk debugId's + +##### Returns + +`string` + +#### Inherited from + +[`ChunkGroup`](ChunkGroup.md).[`debugId`](ChunkGroup.md#debugid) + +*** + +### id + +#### Get Signature + +> **get** **id**(): `string` + +Defined in: [webpack/types.d.ts:1622](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1622) + +get a unique id for ChunkGroup, made up of its member Chunk id's + +##### Returns + +`string` + +#### Inherited from + +[`ChunkGroup`](ChunkGroup.md).[`id`](ChunkGroup.md#id) + +*** + +### parentsIterable + +#### Get Signature + +> **get** **parentsIterable**(): `SortableSet`\<[`ChunkGroup`](ChunkGroup.md)\> + +Defined in: [webpack/types.d.ts:1650](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1650) + +##### Returns + +`SortableSet`\<[`ChunkGroup`](ChunkGroup.md)\> + +#### Inherited from + +[`ChunkGroup`](ChunkGroup.md).[`parentsIterable`](ChunkGroup.md#parentsiterable) + +## Methods + +### addAsyncEntrypoint() + +> **addAsyncEntrypoint**(`entrypoint`): `boolean` + +Defined in: [webpack/types.d.ts:1652](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1652) + +#### Parameters + +##### entrypoint + +`Entrypoint` + +#### Returns + +`boolean` + +#### Inherited from + +[`ChunkGroup`](ChunkGroup.md).[`addAsyncEntrypoint`](ChunkGroup.md#addasyncentrypoint) + +*** + +### addBlock() + +> **addBlock**(`block`): `boolean` + +Defined in: [webpack/types.d.ts:1658](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1658) + +#### Parameters + +##### block + +[`AsyncDependenciesBlock`](AsyncDependenciesBlock.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`ChunkGroup`](ChunkGroup.md).[`addBlock`](ChunkGroup.md#addblock) + +*** + +### addChild() + +> **addChild**(`group`): `boolean` + +Defined in: [webpack/types.d.ts:1641](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1641) + +#### Parameters + +##### group + +[`ChunkGroup`](ChunkGroup.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`ChunkGroup`](ChunkGroup.md).[`addChild`](ChunkGroup.md#addchild) + +*** + +### addDependOn() + +> **addDependOn**(`entrypoint`): `void` + +Defined in: [webpack/types.d.ts:4985](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4985) + +#### Parameters + +##### entrypoint + +`Entrypoint` + +#### Returns + +`void` + +*** + +### addOptions() + +> **addOptions**(`options`): `void` + +Defined in: [webpack/types.d.ts:1606](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1606) + +when a new chunk is added to a chunkGroup, addingOptions will occur. + +#### Parameters + +##### options + +`ChunkGroupOptions` + +#### Returns + +`void` + +#### Inherited from + +[`ChunkGroup`](ChunkGroup.md).[`addOptions`](ChunkGroup.md#addoptions) + +*** + +### addOrigin() + +> **addOrigin**(`module`, `loc`, `request`): `void` + +Defined in: [webpack/types.d.ts:1659](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1659) + +#### Parameters + +##### module + +[`Module`](Module.md) + +##### loc + +`DependencyLocation` + +##### request + +`string` + +#### Returns + +`void` + +#### Inherited from + +[`ChunkGroup`](ChunkGroup.md).[`addOrigin`](ChunkGroup.md#addorigin) + +*** + +### addParent() + +> **addParent**(`parentChunk`): `boolean` + +Defined in: [webpack/types.d.ts:1646](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1646) + +#### Parameters + +##### parentChunk + +[`ChunkGroup`](ChunkGroup.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`ChunkGroup`](ChunkGroup.md).[`addParent`](ChunkGroup.md#addparent) + +*** + +### checkConstraints() + +> **checkConstraints**(): `void` + +Defined in: [webpack/types.d.ts:1697](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1697) + +#### Returns + +`void` + +#### Inherited from + +[`ChunkGroup`](ChunkGroup.md).[`checkConstraints`](ChunkGroup.md#checkconstraints) + +*** + +### compareTo() + +> **compareTo**(`chunkGraph`, `otherGroup`): `-1` \| `0` \| `1` + +Defined in: [webpack/types.d.ts:1672](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1672) + +Sorting predicate which allows current ChunkGroup to be compared against another. +Sorting values are based off of number of chunks in ChunkGroup. + +#### Parameters + +##### chunkGraph + +[`ChunkGraph`](ChunkGraph.md) + +##### otherGroup + +[`ChunkGroup`](ChunkGroup.md) + +#### Returns + +`-1` \| `0` \| `1` + +#### Inherited from + +[`ChunkGroup`](ChunkGroup.md).[`compareTo`](ChunkGroup.md#compareto) + +*** + +### dependOn() + +> **dependOn**(`entrypoint`): `boolean` + +Defined in: [webpack/types.d.ts:4986](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4986) + +#### Parameters + +##### entrypoint + +`Entrypoint` + +#### Returns + +`boolean` + +*** + +### getBlocks() + +> **getBlocks**(): [`AsyncDependenciesBlock`](AsyncDependenciesBlock.md)[] + +Defined in: [webpack/types.d.ts:1654](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1654) + +#### Returns + +[`AsyncDependenciesBlock`](AsyncDependenciesBlock.md)[] + +#### Inherited from + +[`ChunkGroup`](ChunkGroup.md).[`getBlocks`](ChunkGroup.md#getblocks) + +*** + +### getChildren() + +> **getChildren**(): [`ChunkGroup`](ChunkGroup.md)[] + +Defined in: [webpack/types.d.ts:1642](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1642) + +#### Returns + +[`ChunkGroup`](ChunkGroup.md)[] + +#### Inherited from + +[`ChunkGroup`](ChunkGroup.md).[`getChildren`](ChunkGroup.md#getchildren) + +*** + +### getChildrenByOrders() + +> **getChildrenByOrders**(`moduleGraph`, `chunkGraph`): `Record`\<`string`, [`ChunkGroup`](ChunkGroup.md)[]\> + +Defined in: [webpack/types.d.ts:1673](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1673) + +#### Parameters + +##### moduleGraph + +[`ModuleGraph`](ModuleGraph.md) + +##### chunkGraph + +[`ChunkGraph`](ChunkGraph.md) + +#### Returns + +`Record`\<`string`, [`ChunkGroup`](ChunkGroup.md)[]\> + +#### Inherited from + +[`ChunkGroup`](ChunkGroup.md).[`getChildrenByOrders`](ChunkGroup.md#getchildrenbyorders) + +*** + +### getEntrypointChunk() + +> **getEntrypointChunk**(): [`Chunk`](Chunk.md) + +Defined in: [webpack/types.d.ts:4984](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4984) + +Returns the chunk which contains the entrypoint modules +(or at least the execution of them) + +#### Returns + +[`Chunk`](Chunk.md) + +*** + +### getFiles() + +> **getFiles**(): `string`[] + +Defined in: [webpack/types.d.ts:1664](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1664) + +#### Returns + +`string`[] + +#### Inherited from + +[`ChunkGroup`](ChunkGroup.md).[`getFiles`](ChunkGroup.md#getfiles) + +*** + +### getModulePostOrderIndex() + +> **getModulePostOrderIndex**(`module`): `number` + +Defined in: [webpack/types.d.ts:1696](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1696) + +Gets the bottom-up index of a module in this ChunkGroup + +#### Parameters + +##### module + +[`Module`](Module.md) + +#### Returns + +`number` + +#### Inherited from + +[`ChunkGroup`](ChunkGroup.md).[`getModulePostOrderIndex`](ChunkGroup.md#getmodulepostorderindex) + +*** + +### getModulePreOrderIndex() + +> **getModulePreOrderIndex**(`module`): `number` + +Defined in: [webpack/types.d.ts:1686](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1686) + +Gets the top-down index of a module in this ChunkGroup + +#### Parameters + +##### module + +[`Module`](Module.md) + +#### Returns + +`number` + +#### Inherited from + +[`ChunkGroup`](ChunkGroup.md).[`getModulePreOrderIndex`](ChunkGroup.md#getmodulepreorderindex) + +*** + +### getNumberOfBlocks() + +> **getNumberOfBlocks**(): `number` + +Defined in: [webpack/types.d.ts:1655](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1655) + +#### Returns + +`number` + +#### Inherited from + +[`ChunkGroup`](ChunkGroup.md).[`getNumberOfBlocks`](ChunkGroup.md#getnumberofblocks) + +*** + +### getNumberOfChildren() + +> **getNumberOfChildren**(): `number` + +Defined in: [webpack/types.d.ts:1643](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1643) + +#### Returns + +`number` + +#### Inherited from + +[`ChunkGroup`](ChunkGroup.md).[`getNumberOfChildren`](ChunkGroup.md#getnumberofchildren) + +*** + +### getNumberOfParents() + +> **getNumberOfParents**(): `number` + +Defined in: [webpack/types.d.ts:1648](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1648) + +#### Returns + +`number` + +#### Inherited from + +[`ChunkGroup`](ChunkGroup.md).[`getNumberOfParents`](ChunkGroup.md#getnumberofparents) + +*** + +### getParents() + +> **getParents**(): [`ChunkGroup`](ChunkGroup.md)[] + +Defined in: [webpack/types.d.ts:1647](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1647) + +#### Returns + +[`ChunkGroup`](ChunkGroup.md)[] + +#### Inherited from + +[`ChunkGroup`](ChunkGroup.md).[`getParents`](ChunkGroup.md#getparents) + +*** + +### getRuntimeChunk() + +> **getRuntimeChunk**(): [`Chunk`](Chunk.md) + +Defined in: [webpack/types.d.ts:4973](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4973) + +Fetches the chunk reference containing the webpack bootstrap code + +#### Returns + +[`Chunk`](Chunk.md) + +*** + +### hasBlock() + +> **hasBlock**(`block`): `boolean` + +Defined in: [webpack/types.d.ts:1656](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1656) + +#### Parameters + +##### block + +[`AsyncDependenciesBlock`](AsyncDependenciesBlock.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`ChunkGroup`](ChunkGroup.md).[`hasBlock`](ChunkGroup.md#hasblock) + +*** + +### hasParent() + +> **hasParent**(`parent`): `boolean` + +Defined in: [webpack/types.d.ts:1649](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1649) + +#### Parameters + +##### parent + +[`ChunkGroup`](ChunkGroup.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`ChunkGroup`](ChunkGroup.md).[`hasParent`](ChunkGroup.md#hasparent) + +*** + +### insertChunk() + +> **insertChunk**(`chunk`, `before`): `boolean` + +Defined in: [webpack/types.d.ts:1632](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1632) + +inserts a chunk before another existing chunk in group + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +##### before + +[`Chunk`](Chunk.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`ChunkGroup`](ChunkGroup.md).[`insertChunk`](ChunkGroup.md#insertchunk) + +*** + +### isInitial() + +> **isInitial**(): `boolean` + +Defined in: [webpack/types.d.ts:1640](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1640) + +#### Returns + +`boolean` + +#### Inherited from + +[`ChunkGroup`](ChunkGroup.md).[`isInitial`](ChunkGroup.md#isinitial) + +*** + +### pushChunk() + +> **pushChunk**(`chunk`): `boolean` + +Defined in: [webpack/types.d.ts:1637](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1637) + +add a chunk into ChunkGroup. Is pushed on or prepended + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`ChunkGroup`](ChunkGroup.md).[`pushChunk`](ChunkGroup.md#pushchunk) + +*** + +### remove() + +> **remove**(): `void` + +Defined in: [webpack/types.d.ts:1665](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1665) + +#### Returns + +`void` + +#### Inherited from + +[`ChunkGroup`](ChunkGroup.md).[`remove`](ChunkGroup.md#remove) + +*** + +### removeChild() + +> **removeChild**(`group`): `boolean` + +Defined in: [webpack/types.d.ts:1645](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1645) + +#### Parameters + +##### group + +[`ChunkGroup`](ChunkGroup.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`ChunkGroup`](ChunkGroup.md).[`removeChild`](ChunkGroup.md#removechild) + +*** + +### removeChunk() + +> **removeChunk**(`chunk`): `boolean` + +Defined in: [webpack/types.d.ts:1639](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1639) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`ChunkGroup`](ChunkGroup.md).[`removeChunk`](ChunkGroup.md#removechunk) + +*** + +### removeParent() + +> **removeParent**(`chunkGroup`): `boolean` + +Defined in: [webpack/types.d.ts:1651](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1651) + +#### Parameters + +##### chunkGroup + +[`ChunkGroup`](ChunkGroup.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`ChunkGroup`](ChunkGroup.md).[`removeParent`](ChunkGroup.md#removeparent) + +*** + +### replaceChunk() + +> **replaceChunk**(`oldChunk`, `newChunk`): `boolean` + +Defined in: [webpack/types.d.ts:1638](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1638) + +#### Parameters + +##### oldChunk + +[`Chunk`](Chunk.md) + +##### newChunk + +[`Chunk`](Chunk.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`ChunkGroup`](ChunkGroup.md).[`replaceChunk`](ChunkGroup.md#replacechunk) + +*** + +### setEntrypointChunk() + +> **setEntrypointChunk**(`chunk`): `void` + +Defined in: [webpack/types.d.ts:4978](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4978) + +Sets the chunk with the entrypoint modules for an entrypoint. + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +#### Returns + +`void` + +*** + +### setModulePostOrderIndex() + +> **setModulePostOrderIndex**(`module`, `index`): `void` + +Defined in: [webpack/types.d.ts:1691](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1691) + +Sets the bottom-up index of a module in this ChunkGroup + +#### Parameters + +##### module + +[`Module`](Module.md) + +##### index + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`ChunkGroup`](ChunkGroup.md).[`setModulePostOrderIndex`](ChunkGroup.md#setmodulepostorderindex) + +*** + +### setModulePreOrderIndex() + +> **setModulePreOrderIndex**(`module`, `index`): `void` + +Defined in: [webpack/types.d.ts:1681](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1681) + +Sets the top-down index of a module in this ChunkGroup + +#### Parameters + +##### module + +[`Module`](Module.md) + +##### index + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`ChunkGroup`](ChunkGroup.md).[`setModulePreOrderIndex`](ChunkGroup.md#setmodulepreorderindex) + +*** + +### setRuntimeChunk() + +> **setRuntimeChunk**(`chunk`): `void` + +Defined in: [webpack/types.d.ts:4968](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4968) + +Sets the runtimeChunk for an entrypoint. + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +#### Returns + +`void` + +*** + +### sortItems() + +> **sortItems**(): `void` + +Defined in: [webpack/types.d.ts:1666](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1666) + +#### Returns + +`void` + +#### Inherited from + +[`ChunkGroup`](ChunkGroup.md).[`sortItems`](ChunkGroup.md#sortitems) + +*** + +### unshiftChunk() + +> **unshiftChunk**(`chunk`): `boolean` + +Defined in: [webpack/types.d.ts:1627](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1627) + +Performs an unshift of a specific chunk + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`ChunkGroup`](ChunkGroup.md).[`unshiftChunk`](ChunkGroup.md#unshiftchunk) diff --git a/api/classes/EnvironmentPlugin.md b/api/classes/EnvironmentPlugin.md new file mode 100644 index 0000000..68db27b --- /dev/null +++ b/api/classes/EnvironmentPlugin.md @@ -0,0 +1,63 @@ +--- +title: EnvironmentPlugin +--- + +[webpack](../globals.md) / EnvironmentPlugin + +# Class: EnvironmentPlugin + +Defined in: [webpack/types.d.ts:5083](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L5083) + +## Constructors + +### Constructor + +> **new EnvironmentPlugin**(...`keys`): `EnvironmentPlugin` + +Defined in: [webpack/types.d.ts:5084](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L5084) + +#### Parameters + +##### keys + +...(`string` \| `string`[] \| `Record`\<`string`, `any`\>)[] + +#### Returns + +`EnvironmentPlugin` + +## Properties + +### defaultValues + +> **defaultValues**: `Record`\<`string`, `any`\> + +Defined in: [webpack/types.d.ts:5086](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L5086) + +*** + +### keys + +> **keys**: `string`[] + +Defined in: [webpack/types.d.ts:5085](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L5085) + +## Methods + +### apply() + +> **apply**(`compiler`): `void` + +Defined in: [webpack/types.d.ts:5091](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L5091) + +Apply the plugin + +#### Parameters + +##### compiler + +[`Compiler`](Compiler.md) + +#### Returns + +`void` diff --git a/api/classes/EvalDevToolModulePlugin.md b/api/classes/EvalDevToolModulePlugin.md new file mode 100644 index 0000000..e8d5d69 --- /dev/null +++ b/api/classes/EvalDevToolModulePlugin.md @@ -0,0 +1,71 @@ +--- +title: EvalDevToolModulePlugin +--- + +[webpack](../globals.md) / EvalDevToolModulePlugin + +# Class: EvalDevToolModulePlugin + +Defined in: [webpack/types.d.ts:5097](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L5097) + +## Constructors + +### Constructor + +> **new EvalDevToolModulePlugin**(`options?`): `EvalDevToolModulePlugin` + +Defined in: [webpack/types.d.ts:5098](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L5098) + +#### Parameters + +##### options? + +`EvalDevToolModulePluginOptions` + +#### Returns + +`EvalDevToolModulePlugin` + +## Properties + +### moduleFilenameTemplate + +> **moduleFilenameTemplate**: `DevtoolModuleFilenameTemplate` + +Defined in: [webpack/types.d.ts:5101](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L5101) + +*** + +### namespace + +> **namespace**: `string` + +Defined in: [webpack/types.d.ts:5099](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L5099) + +*** + +### sourceUrlComment + +> **sourceUrlComment**: `string` + +Defined in: [webpack/types.d.ts:5100](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L5100) + +## Methods + +### apply() + +> **apply**(`compiler`): `void` + +Defined in: [webpack/types.d.ts:5106](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L5106) + +Apply the plugin + +#### Parameters + +##### compiler + +[`Compiler`](Compiler.md) + +#### Returns + +`void` diff --git a/api/classes/EvalSourceMapDevToolPlugin.md b/api/classes/EvalSourceMapDevToolPlugin.md new file mode 100644 index 0000000..08bc5ae --- /dev/null +++ b/api/classes/EvalSourceMapDevToolPlugin.md @@ -0,0 +1,79 @@ +--- +title: EvalSourceMapDevToolPlugin +--- + +[webpack](../globals.md) / EvalSourceMapDevToolPlugin + +# Class: EvalSourceMapDevToolPlugin + +Defined in: [webpack/types.d.ts:5126](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L5126) + +## Constructors + +### Constructor + +> **new EvalSourceMapDevToolPlugin**(`inputOptions?`): `EvalSourceMapDevToolPlugin` + +Defined in: [webpack/types.d.ts:5127](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L5127) + +#### Parameters + +##### inputOptions? + +`string` | `SourceMapDevToolPluginOptions` + +#### Returns + +`EvalSourceMapDevToolPlugin` + +## Properties + +### moduleFilenameTemplate + +> **moduleFilenameTemplate**: `DevtoolModuleFilenameTemplate` + +Defined in: [webpack/types.d.ts:5129](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L5129) + +*** + +### namespace + +> **namespace**: `string` + +Defined in: [webpack/types.d.ts:5130](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L5130) + +*** + +### options + +> **options**: `SourceMapDevToolPluginOptions` + +Defined in: [webpack/types.d.ts:5131](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L5131) + +*** + +### sourceMapComment + +> **sourceMapComment**: `string` + +Defined in: [webpack/types.d.ts:5128](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L5128) + +## Methods + +### apply() + +> **apply**(`compiler`): `void` + +Defined in: [webpack/types.d.ts:5136](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L5136) + +Apply the plugin + +#### Parameters + +##### compiler + +[`Compiler`](Compiler.md) + +#### Returns + +`void` diff --git a/api/classes/ExternalModule.md b/api/classes/ExternalModule.md new file mode 100644 index 0000000..f0c6188 --- /dev/null +++ b/api/classes/ExternalModule.md @@ -0,0 +1,1781 @@ +--- +title: ExternalModule +--- + +[webpack](../globals.md) / ExternalModule + +# Class: ExternalModule + +Defined in: [webpack/types.d.ts:5683](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L5683) + +## Extends + +- [`Module`](Module.md) + +## Constructors + +### Constructor + +> **new ExternalModule**(`request`, `type`, `userRequest`, `dependencyMeta?`): `ExternalModule` + +Defined in: [webpack/types.d.ts:5684](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L5684) + +#### Parameters + +##### request + +`ExternalModuleRequest` + +##### type + +`ExternalsType` + +##### userRequest + +`string` + +##### dependencyMeta? + +`AssetDependencyMeta` | `CssImportDependencyMeta` | `ImportDependencyMeta` + +#### Returns + +`ExternalModule` + +#### Overrides + +[`Module`](Module.md).[`constructor`](Module.md#constructor) + +## Properties + +### blocks + +> **blocks**: [`AsyncDependenciesBlock`](AsyncDependenciesBlock.md)[] + +Defined in: [webpack/types.d.ts:4110](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4110) + +#### Inherited from + +[`Module`](Module.md).[`blocks`](Module.md#blocks) + +*** + +### buildInfo? + +> `optional` **buildInfo**: `BuildInfo` + +Defined in: [webpack/types.d.ts:10642](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10642) + +#### Inherited from + +[`Module`](Module.md).[`buildInfo`](Module.md#buildinfo) + +*** + +### buildMeta? + +> `optional` **buildMeta**: `BuildMeta` + +Defined in: [webpack/types.d.ts:10641](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10641) + +#### Inherited from + +[`Module`](Module.md).[`buildMeta`](Module.md#buildmeta) + +*** + +### codeGenerationDependencies? + +> `optional` **codeGenerationDependencies**: [`Dependency`](Dependency.md)[] + +Defined in: [webpack/types.d.ts:10644](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10644) + +#### Inherited from + +[`Module`](Module.md).[`codeGenerationDependencies`](Module.md#codegenerationdependencies) + +*** + +### context + +> **context**: `string` + +Defined in: [webpack/types.d.ts:10632](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10632) + +#### Inherited from + +[`ModuleChunkLoadingRuntimeModule`](../webpack/namespaces/export=/namespaces/esm/classes/ModuleChunkLoadingRuntimeModule.md).[`context`](../webpack/namespaces/export=/namespaces/esm/classes/ModuleChunkLoadingRuntimeModule.md#context) + +*** + +### debugId + +> **debugId**: `number` + +Defined in: [webpack/types.d.ts:10635](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10635) + +#### Inherited from + +[`Module`](Module.md).[`debugId`](Module.md#debugid) + +*** + +### dependencies + +> **dependencies**: [`Dependency`](Dependency.md)[] + +Defined in: [webpack/types.d.ts:4109](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4109) + +#### Inherited from + +[`Module`](Module.md).[`dependencies`](Module.md#dependencies) + +*** + +### dependencyMeta? + +> `optional` **dependencyMeta**: `AssetDependencyMeta` \| `CssImportDependencyMeta` \| `ImportDependencyMeta` + +Defined in: [webpack/types.d.ts:5696](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L5696) + +*** + +### depth + +> **depth**: `number` + +Defined in: [webpack/types.d.ts:10655](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10655) + +#### Inherited from + +[`ModuleChunkLoadingRuntimeModule`](../webpack/namespaces/export=/namespaces/esm/classes/ModuleChunkLoadingRuntimeModule.md).[`depth`](../webpack/namespaces/export=/namespaces/esm/classes/ModuleChunkLoadingRuntimeModule.md#depth) + +*** + +### externalType + +> **externalType**: `ExternalsType` + +Defined in: [webpack/types.d.ts:5694](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L5694) + +*** + +### factoryMeta? + +> `optional` **factoryMeta**: `FactoryMeta` + +Defined in: [webpack/types.d.ts:10637](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10637) + +#### Inherited from + +[`Module`](Module.md).[`factoryMeta`](Module.md#factorymeta) + +*** + +### hot + +> **hot**: `boolean` + +Defined in: [webpack/types.d.ts:10640](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10640) + +#### Inherited from + +[`Module`](Module.md).[`hot`](Module.md#hot) + +*** + +### ~~id~~ + +> **id**: `string` \| `number` + +Defined in: [webpack/types.d.ts:10649](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10649) + +#### Deprecated + +#### Inherited from + +[`ModuleChunkLoadingRuntimeModule`](../webpack/namespaces/export=/namespaces/esm/classes/ModuleChunkLoadingRuntimeModule.md).[`id`](../webpack/namespaces/export=/namespaces/esm/classes/ModuleChunkLoadingRuntimeModule.md#id) + +*** + +### index + +> **index**: `number` + +Defined in: [webpack/types.d.ts:10653](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10653) + +#### Inherited from + +[`ModuleChunkLoadingRuntimeModule`](../webpack/namespaces/export=/namespaces/esm/classes/ModuleChunkLoadingRuntimeModule.md).[`index`](../webpack/namespaces/export=/namespaces/esm/classes/ModuleChunkLoadingRuntimeModule.md#index) + +*** + +### index2 + +> **index2**: `number` + +Defined in: [webpack/types.d.ts:10654](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10654) + +#### Inherited from + +[`ModuleChunkLoadingRuntimeModule`](../webpack/namespaces/export=/namespaces/esm/classes/ModuleChunkLoadingRuntimeModule.md).[`index2`](../webpack/namespaces/export=/namespaces/esm/classes/ModuleChunkLoadingRuntimeModule.md#index2) + +*** + +### issuer? + +> `optional` **issuer**: [`Module`](Module.md) + +Defined in: [webpack/types.d.ts:10656](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10656) + +#### Inherited from + +[`ModuleChunkLoadingRuntimeModule`](../webpack/namespaces/export=/namespaces/esm/classes/ModuleChunkLoadingRuntimeModule.md).[`issuer`](../webpack/namespaces/export=/namespaces/esm/classes/ModuleChunkLoadingRuntimeModule.md#issuer) + +*** + +### layer + +> **layer**: `string` + +Defined in: [webpack/types.d.ts:10633](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10633) + +#### Inherited from + +[`ModuleChunkLoadingRuntimeModule`](../webpack/namespaces/export=/namespaces/esm/classes/ModuleChunkLoadingRuntimeModule.md).[`layer`](../webpack/namespaces/export=/namespaces/esm/classes/ModuleChunkLoadingRuntimeModule.md#layer) + +*** + +### needId + +> **needId**: `boolean` + +Defined in: [webpack/types.d.ts:10634](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10634) + +#### Inherited from + +[`Module`](Module.md).[`needId`](Module.md#needid) + +*** + +### parent? + +> `optional` **parent**: `DependenciesBlock` + +Defined in: [webpack/types.d.ts:4111](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4111) + +#### Inherited from + +[`Module`](Module.md).[`parent`](Module.md#parent) + +*** + +### presentationalDependencies? + +> `optional` **presentationalDependencies**: [`Dependency`](Dependency.md)[] + +Defined in: [webpack/types.d.ts:10643](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10643) + +#### Inherited from + +[`Module`](Module.md).[`presentationalDependencies`](Module.md#presentationaldependencies) + +*** + +### profile? + +> `optional` **profile**: `ModuleProfile` + +Defined in: [webpack/types.d.ts:10652](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10652) + +#### Inherited from + +[`Module`](Module.md).[`profile`](Module.md#profile) + +*** + +### request + +> **request**: `ExternalModuleRequest` + +Defined in: [webpack/types.d.ts:5693](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L5693) + +*** + +### resolveOptions? + +> `optional` **resolveOptions**: [`ResolveOptions`](../interfaces/ResolveOptions.md) + +Defined in: [webpack/types.d.ts:10636](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10636) + +#### Inherited from + +[`Module`](Module.md).[`resolveOptions`](Module.md#resolveoptions) + +*** + +### type + +> **type**: `string` + +Defined in: [webpack/types.d.ts:10631](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10631) + +#### Inherited from + +[`Module`](Module.md).[`type`](Module.md#type) + +*** + +### used + +> **used**: `any` + +Defined in: [webpack/types.d.ts:10790](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10790) + +#### Inherited from + +[`Module`](Module.md).[`used`](Module.md#used) + +*** + +### userRequest + +> **userRequest**: `string` + +Defined in: [webpack/types.d.ts:5695](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L5695) + +*** + +### useSimpleSourceMap + +> **useSimpleSourceMap**: `boolean` + +Defined in: [webpack/types.d.ts:10639](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10639) + +#### Inherited from + +[`Module`](Module.md).[`useSimpleSourceMap`](Module.md#usesimplesourcemap) + +*** + +### useSourceMap + +> **useSourceMap**: `boolean` + +Defined in: [webpack/types.d.ts:10638](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10638) + +#### Inherited from + +[`Module`](Module.md).[`useSourceMap`](Module.md#usesourcemap) + +*** + +### getExternalModuleNodeCommonjsInitFragment() + +> `static` **getExternalModuleNodeCommonjsInitFragment**: (`runtimeTemplate`) => [`InitFragment`](InitFragment.md)\<`ChunkRenderContextJavascriptModulesPlugin`\> + +Defined in: [webpack/types.d.ts:5709](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L5709) + +#### Parameters + +##### runtimeTemplate + +`RuntimeTemplate` + +#### Returns + +[`InitFragment`](InitFragment.md)\<`ChunkRenderContextJavascriptModulesPlugin`\> + +*** + +### ModuleExternalInitFragment + +> `static` **ModuleExternalInitFragment**: *typeof* `ModuleExternalInitFragment` + +Defined in: [webpack/types.d.ts:5708](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L5708) + +## Accessors + +### chunksIterable + +#### Get Signature + +> **get** **chunksIterable**(): `Iterable`\<[`Chunk`](Chunk.md)\> + +Defined in: [webpack/types.d.ts:10673](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10673) + +##### Returns + +`Iterable`\<[`Chunk`](Chunk.md)\> + +#### Inherited from + +[`Module`](Module.md).[`chunksIterable`](Module.md#chunksiterable) + +*** + +### errors + +#### Get Signature + +> **get** **errors**(): `any` + +Defined in: [webpack/types.d.ts:10788](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10788) + +##### Returns + +`any` + +#### Inherited from + +[`Module`](Module.md).[`errors`](Module.md#errors) + +*** + +### exportsArgument + +#### Get Signature + +> **get** **exportsArgument**(): `string` + +Defined in: [webpack/types.d.ts:10675](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10675) + +##### Returns + +`string` + +#### Inherited from + +[`Module`](Module.md).[`exportsArgument`](Module.md#exportsargument) + +*** + +### hasEqualsChunks + +#### Get Signature + +> **get** **hasEqualsChunks**(): `any` + +Defined in: [webpack/types.d.ts:10786](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10786) + +##### Returns + +`any` + +#### Inherited from + +[`Module`](Module.md).[`hasEqualsChunks`](Module.md#hasequalschunks) + +*** + +### hash + +#### Get Signature + +> **get** **hash**(): `string` + +Defined in: [webpack/types.d.ts:10650](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10650) + +##### Returns + +`string` + +#### Inherited from + +[`Module`](Module.md).[`hash`](Module.md#hash) + +*** + +### isUsed + +#### Get Signature + +> **get** **isUsed**(): `any` + +Defined in: [webpack/types.d.ts:10787](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10787) + +##### Returns + +`any` + +#### Inherited from + +[`Module`](Module.md).[`isUsed`](Module.md#isused) + +*** + +### moduleArgument + +#### Get Signature + +> **get** **moduleArgument**(): `string` + +Defined in: [webpack/types.d.ts:10676](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10676) + +##### Returns + +`string` + +#### Inherited from + +[`Module`](Module.md).[`moduleArgument`](Module.md#moduleargument) + +*** + +### optimizationBailout + +#### Get Signature + +> **get** **optimizationBailout**(): (`string` \| (`requestShortener`) => `string`)[] + +Defined in: [webpack/types.d.ts:10662](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10662) + +##### Deprecated + +##### Returns + +(`string` \| (`requestShortener`) => `string`)[] + +#### Inherited from + +[`Module`](Module.md).[`optimizationBailout`](Module.md#optimizationbailout) + +*** + +### optional + +#### Get Signature + +> **get** **optional**(): `boolean` + +Defined in: [webpack/types.d.ts:10666](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10666) + +##### Returns + +`boolean` + +#### Inherited from + +[`Module`](Module.md).[`optional`](Module.md#optional) + +*** + +### renderedHash + +#### Get Signature + +> **get** **renderedHash**(): `string` + +Defined in: [webpack/types.d.ts:10651](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10651) + +##### Returns + +`string` + +#### Inherited from + +[`Module`](Module.md).[`renderedHash`](Module.md#renderedhash) + +*** + +### usedExports + +#### Get Signature + +> **get** **usedExports**(): `boolean` \| `SortableSet`\<`string`\> + +Defined in: [webpack/types.d.ts:10657](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10657) + +##### Returns + +`boolean` \| `SortableSet`\<`string`\> + +#### Inherited from + +[`ModuleChunkLoadingRuntimeModule`](../webpack/namespaces/export=/namespaces/esm/classes/ModuleChunkLoadingRuntimeModule.md).[`usedExports`](../webpack/namespaces/export=/namespaces/esm/classes/ModuleChunkLoadingRuntimeModule.md#usedexports) + +*** + +### warnings + +#### Get Signature + +> **get** **warnings**(): `any` + +Defined in: [webpack/types.d.ts:10789](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10789) + +##### Returns + +`any` + +#### Inherited from + +[`Module`](Module.md).[`warnings`](Module.md#warnings) + +## Methods + +### addBlock() + +> **addBlock**(`block`): `void` + +Defined in: [webpack/types.d.ts:4118](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4118) + +Adds a DependencyBlock to DependencyBlock relationship. +This is used for when a Module has a AsyncDependencyBlock tie (for code-splitting) + +#### Parameters + +##### block + +[`AsyncDependenciesBlock`](AsyncDependenciesBlock.md) + +#### Returns + +`void` + +#### Inherited from + +[`Module`](Module.md).[`addBlock`](Module.md#addblock) + +*** + +### addCacheDependencies() + +> **addCacheDependencies**(`fileDependencies`, `contextDependencies`, `missingDependencies`, `buildDependencies`): `void` + +Defined in: [webpack/types.d.ts:10780](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10780) + +#### Parameters + +##### fileDependencies + +[`LazySet`](../webpack/namespaces/export=/namespaces/util/classes/LazySet.md)\<`string`\> + +##### contextDependencies + +[`LazySet`](../webpack/namespaces/export=/namespaces/util/classes/LazySet.md)\<`string`\> + +##### missingDependencies + +[`LazySet`](../webpack/namespaces/export=/namespaces/util/classes/LazySet.md)\<`string`\> + +##### buildDependencies + +[`LazySet`](../webpack/namespaces/export=/namespaces/util/classes/LazySet.md)\<`string`\> + +#### Returns + +`void` + +#### Inherited from + +[`Module`](Module.md).[`addCacheDependencies`](Module.md#addcachedependencies) + +*** + +### addChunk() + +> **addChunk**(`chunk`): `boolean` + +Defined in: [webpack/types.d.ts:10667](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10667) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`Module`](Module.md).[`addChunk`](Module.md#addchunk) + +*** + +### addCodeGenerationDependency() + +> **addCodeGenerationDependency**(`codeGenerationDependency`): `void` + +Defined in: [webpack/types.d.ts:10679](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10679) + +#### Parameters + +##### codeGenerationDependency + +[`Dependency`](Dependency.md) + +#### Returns + +`void` + +#### Inherited from + +[`Module`](Module.md).[`addCodeGenerationDependency`](Module.md#addcodegenerationdependency) + +*** + +### addDependency() + +> **addDependency**(`dependency`): `void` + +Defined in: [webpack/types.d.ts:4119](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4119) + +#### Parameters + +##### dependency + +[`Dependency`](Dependency.md) + +#### Returns + +`void` + +#### Inherited from + +[`Module`](Module.md).[`addDependency`](Module.md#adddependency) + +*** + +### addError() + +> **addError**(`error`): `void` + +Defined in: [webpack/types.d.ts:10683](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10683) + +#### Parameters + +##### error + +[`WebpackError`](WebpackError.md) + +#### Returns + +`void` + +#### Inherited from + +[`Module`](Module.md).[`addError`](Module.md#adderror) + +*** + +### addPresentationalDependency() + +> **addPresentationalDependency**(`presentationalDependency`): `void` + +Defined in: [webpack/types.d.ts:10678](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10678) + +#### Parameters + +##### presentationalDependency + +[`Dependency`](Dependency.md) + +#### Returns + +`void` + +#### Inherited from + +[`Module`](Module.md).[`addPresentationalDependency`](Module.md#addpresentationaldependency) + +*** + +### addWarning() + +> **addWarning**(`warning`): `void` + +Defined in: [webpack/types.d.ts:10680](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10680) + +#### Parameters + +##### warning + +[`WebpackError`](WebpackError.md) + +#### Returns + +`void` + +#### Inherited from + +[`Module`](Module.md).[`addWarning`](Module.md#addwarning) + +*** + +### build() + +> **build**(`options`, `compilation`, `resolver`, `fs`, `callback`): `void` + +Defined in: [webpack/types.d.ts:10724](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10724) + +#### Parameters + +##### options + +`WebpackOptionsNormalizedWithDefaults` + +##### compilation + +[`Compilation`](Compilation.md) + +##### resolver + +`ResolverWithOptions` + +##### fs + +[`InputFileSystem`](../interfaces/InputFileSystem.md) + +##### callback + +(`err?`) => `void` + +#### Returns + +`void` + +#### Inherited from + +[`Module`](Module.md).[`build`](Module.md#build) + +*** + +### chunkCondition() + +> **chunkCondition**(`chunk`, `compilation`): `boolean` + +Defined in: [webpack/types.d.ts:10759](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10759) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +##### compilation + +[`Compilation`](Compilation.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`Module`](Module.md).[`chunkCondition`](Module.md#chunkcondition) + +*** + +### cleanupForCache() + +> **cleanupForCache**(): `void` + +Defined in: [webpack/types.d.ts:10778](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10778) + +Assuming this module is in the cache. Remove internal references to allow freeing some memory. + +#### Returns + +`void` + +#### Inherited from + +[`Module`](Module.md).[`cleanupForCache`](Module.md#cleanupforcache) + +*** + +### clearDependenciesAndBlocks() + +> **clearDependenciesAndBlocks**(): `void` + +Defined in: [webpack/types.d.ts:4125](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4125) + +Removes all dependencies and blocks + +#### Returns + +`void` + +#### Inherited from + +[`Module`](Module.md).[`clearDependenciesAndBlocks`](Module.md#cleardependenciesandblocks) + +*** + +### clearWarningsAndErrors() + +> **clearWarningsAndErrors**(): `void` + +Defined in: [webpack/types.d.ts:10690](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10690) + +removes all warnings and errors + +#### Returns + +`void` + +#### Inherited from + +[`Module`](Module.md).[`clearWarningsAndErrors`](Module.md#clearwarningsanderrors) + +*** + +### codeGeneration() + +> **codeGeneration**(`context`): `CodeGenerationResult` + +Defined in: [webpack/types.d.ts:10758](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10758) + +#### Parameters + +##### context + +`CodeGenerationContext` + +#### Returns + +`CodeGenerationResult` + +#### Inherited from + +[`Module`](Module.md).[`codeGeneration`](Module.md#codegeneration) + +*** + +### deserialize() + +> **deserialize**(`__namedParameters`): `void` + +Defined in: [webpack/types.d.ts:4128](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4128) + +#### Parameters + +##### \_\_namedParameters + +[`ObjectDeserializerContext`](../interfaces/ObjectDeserializerContext.md) + +#### Returns + +`void` + +#### Inherited from + +[`Module`](Module.md).[`deserialize`](Module.md#deserialize) + +*** + +### getChunks() + +> **getChunks**(): [`Chunk`](Chunk.md)[] + +Defined in: [webpack/types.d.ts:10671](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10671) + +#### Returns + +[`Chunk`](Chunk.md)[] + +#### Inherited from + +[`Module`](Module.md).[`getChunks`](Module.md#getchunks) + +*** + +### getConcatenationBailoutReason() + +> **getConcatenationBailoutReason**(`context`): `string` + +Defined in: [webpack/types.d.ts:10754](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10754) + +#### Parameters + +##### context + +`ConcatenationBailoutReasonContext` + +#### Returns + +`string` + +#### Inherited from + +[`Module`](Module.md).[`getConcatenationBailoutReason`](Module.md#getconcatenationbailoutreason) + +*** + +### getErrors() + +> **getErrors**(): `Iterable`\<[`WebpackError`](WebpackError.md), `any`, `any`\> + +Defined in: [webpack/types.d.ts:10684](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10684) + +#### Returns + +`Iterable`\<[`WebpackError`](WebpackError.md), `any`, `any`\> + +#### Inherited from + +[`Module`](Module.md).[`getErrors`](Module.md#geterrors) + +*** + +### getExportsType() + +> **getExportsType**(`moduleGraph`, `strict?`): `ExportsType` + +Defined in: [webpack/types.d.ts:10677](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10677) + +#### Parameters + +##### moduleGraph + +[`ModuleGraph`](ModuleGraph.md) + +##### strict? + +`boolean` + +#### Returns + +`ExportsType` + +#### Inherited from + +[`Module`](Module.md).[`getExportsType`](Module.md#getexportstype) + +*** + +### getNumberOfChunks() + +> **getNumberOfChunks**(): `number` + +Defined in: [webpack/types.d.ts:10672](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10672) + +#### Returns + +`number` + +#### Inherited from + +[`Module`](Module.md).[`getNumberOfChunks`](Module.md#getnumberofchunks) + +*** + +### getNumberOfErrors() + +> **getNumberOfErrors**(): `number` + +Defined in: [webpack/types.d.ts:10685](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10685) + +#### Returns + +`number` + +#### Inherited from + +[`Module`](Module.md).[`getNumberOfErrors`](Module.md#getnumberoferrors) + +*** + +### getNumberOfWarnings() + +> **getNumberOfWarnings**(): `number` + +Defined in: [webpack/types.d.ts:10682](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10682) + +#### Returns + +`number` + +#### Inherited from + +[`Module`](Module.md).[`getNumberOfWarnings`](Module.md#getnumberofwarnings) + +*** + +### getRootBlock() + +> **getRootBlock**(): `DependenciesBlock` + +Defined in: [webpack/types.d.ts:4112](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4112) + +#### Returns + +`DependenciesBlock` + +#### Inherited from + +[`Module`](Module.md).[`getRootBlock`](Module.md#getrootblock) + +*** + +### getSideEffectsConnectionState() + +> **getSideEffectsConnectionState**(`moduleGraph`): `ConnectionState` + +Defined in: [webpack/types.d.ts:10757](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10757) + +#### Parameters + +##### moduleGraph + +[`ModuleGraph`](ModuleGraph.md) + +#### Returns + +`ConnectionState` + +#### Inherited from + +[`Module`](Module.md).[`getSideEffectsConnectionState`](Module.md#getsideeffectsconnectionstate) + +*** + +### getSourceBasicTypes() + +> **getSourceBasicTypes**(): `ReadonlySet`\<`string`\> + +Defined in: [webpack/types.d.ts:10740](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10740) + +Basic source types are high-level categories like javascript, css, webassembly, etc. +We only have built-in knowledge about the javascript basic type here; other basic types may be +added or changed over time by generators and do not need to be handled or detected here. +Some modules, e.g. RemoteModule, may return non-basic source types like "remote" and "share-init" +from getSourceTypes(), but their generated output is still JavaScript, i.e. their basic type is JS. + +#### Returns + +`ReadonlySet`\<`string`\> + +#### Inherited from + +[`Module`](Module.md).[`getSourceBasicTypes`](Module.md#getsourcebasictypes) + +*** + +### getSourceTypes() + +> **getSourceTypes**(): `ReadonlySet`\<`string`\> + +Defined in: [webpack/types.d.ts:10731](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10731) + +#### Returns + +`ReadonlySet`\<`string`\> + +#### Inherited from + +[`Module`](Module.md).[`getSourceTypes`](Module.md#getsourcetypes) + +*** + +### getUnsafeCacheData() + +> **getUnsafeCacheData**(): `UnsafeCacheData` + +Defined in: [webpack/types.d.ts:10773](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10773) + +Module should be unsafe cached. Get data that's needed for that. +This data will be passed to restoreFromUnsafeCache later. + +#### Returns + +`UnsafeCacheData` + +#### Inherited from + +[`Module`](Module.md).[`getUnsafeCacheData`](Module.md#getunsafecachedata) + +*** + +### getWarnings() + +> **getWarnings**(): `Iterable`\<[`WebpackError`](WebpackError.md), `any`, `any`\> + +Defined in: [webpack/types.d.ts:10681](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10681) + +#### Returns + +`Iterable`\<[`WebpackError`](WebpackError.md), `any`, `any`\> + +#### Inherited from + +[`Module`](Module.md).[`getWarnings`](Module.md#getwarnings) + +*** + +### hasChunkCondition() + +> **hasChunkCondition**(): `boolean` + +Defined in: [webpack/types.d.ts:10760](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10760) + +#### Returns + +`boolean` + +#### Inherited from + +[`Module`](Module.md).[`hasChunkCondition`](Module.md#haschunkcondition) + +*** + +### hasReasonForChunk() + +> **hasReasonForChunk**(`chunk`, `moduleGraph`, `chunkGraph`): `boolean` + +Defined in: [webpack/types.d.ts:10702](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10702) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +##### moduleGraph + +[`ModuleGraph`](ModuleGraph.md) + +##### chunkGraph + +[`ChunkGraph`](ChunkGraph.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`Module`](Module.md).[`hasReasonForChunk`](Module.md#hasreasonforchunk) + +*** + +### hasReasons() + +> **hasReasons**(`moduleGraph`, `runtime`): `boolean` + +Defined in: [webpack/types.d.ts:10707](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10707) + +#### Parameters + +##### moduleGraph + +[`ModuleGraph`](ModuleGraph.md) + +##### runtime + +`RuntimeSpec` + +#### Returns + +`boolean` + +#### Inherited from + +[`Module`](Module.md).[`hasReasons`](Module.md#hasreasons) + +*** + +### identifier() + +> **identifier**(): `string` + +Defined in: [webpack/types.d.ts:10722](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10722) + +#### Returns + +`string` + +#### Inherited from + +[`Module`](Module.md).[`identifier`](Module.md#identifier) + +*** + +### invalidateBuild() + +> **invalidateBuild**(): `void` + +Defined in: [webpack/types.d.ts:10721](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10721) + +#### Returns + +`void` + +#### Inherited from + +[`Module`](Module.md).[`invalidateBuild`](Module.md#invalidatebuild) + +*** + +### isAccessibleInChunk() + +> **isAccessibleInChunk**(`chunkGraph`, `chunk`, `ignoreChunk?`): `boolean` + +Defined in: [webpack/types.d.ts:10692](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10692) + +#### Parameters + +##### chunkGraph + +[`ChunkGraph`](ChunkGraph.md) + +##### chunk + +[`Chunk`](Chunk.md) + +##### ignoreChunk? + +[`Chunk`](Chunk.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`Module`](Module.md).[`isAccessibleInChunk`](Module.md#isaccessibleinchunk) + +*** + +### isAccessibleInChunkGroup() + +> **isAccessibleInChunkGroup**(`chunkGraph`, `chunkGroup`, `ignoreChunk?`): `boolean` + +Defined in: [webpack/types.d.ts:10697](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10697) + +#### Parameters + +##### chunkGraph + +[`ChunkGraph`](ChunkGraph.md) + +##### chunkGroup + +[`ChunkGroup`](ChunkGroup.md) + +##### ignoreChunk? + +[`Chunk`](Chunk.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`Module`](Module.md).[`isAccessibleInChunkGroup`](Module.md#isaccessibleinchunkgroup) + +*** + +### isEntryModule() + +> **isEntryModule**(): `boolean` + +Defined in: [webpack/types.d.ts:10670](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10670) + +#### Returns + +`boolean` + +#### Inherited from + +[`Module`](Module.md).[`isEntryModule`](Module.md#isentrymodule) + +*** + +### isInChunk() + +> **isInChunk**(`chunk`): `boolean` + +Defined in: [webpack/types.d.ts:10669](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10669) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`Module`](Module.md).[`isInChunk`](Module.md#isinchunk) + +*** + +### isOptional() + +> **isOptional**(`moduleGraph`): `boolean` + +Defined in: [webpack/types.d.ts:10691](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10691) + +#### Parameters + +##### moduleGraph + +[`ModuleGraph`](ModuleGraph.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`Module`](Module.md).[`isOptional`](Module.md#isoptional) + +*** + +### isProvided() + +> **isProvided**(`exportName`): `boolean` + +Defined in: [webpack/types.d.ts:10674](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10674) + +#### Parameters + +##### exportName + +`string` + +#### Returns + +`boolean` + +#### Inherited from + +[`Module`](Module.md).[`isProvided`](Module.md#isprovided) + +*** + +### libIdent() + +> **libIdent**(`options`): `string` + +Defined in: [webpack/types.d.ts:10752](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10752) + +#### Parameters + +##### options + +`LibIdentOptions` + +#### Returns + +`string` + +#### Inherited from + +[`Module`](Module.md).[`libIdent`](Module.md#libident) + +*** + +### nameForCondition() + +> **nameForCondition**(): `string` + +Defined in: [webpack/types.d.ts:10753](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10753) + +#### Returns + +`string` + +#### Inherited from + +[`Module`](Module.md).[`nameForCondition`](Module.md#nameforcondition) + +*** + +### needBuild() + +> **needBuild**(`context`, `callback`): `void` + +Defined in: [webpack/types.d.ts:10708](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10708) + +#### Parameters + +##### context + +`NeedBuildContext` + +##### callback + +(`err?`, `needBuild?`) => `void` + +#### Returns + +`void` + +#### Inherited from + +[`Module`](Module.md).[`needBuild`](Module.md#needbuild) + +*** + +### ~~needRebuild()~~ + +> **needRebuild**(`fileTimestamps`, `contextTimestamps`): `boolean` + +Defined in: [webpack/types.d.ts:10717](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10717) + +Use needBuild instead + +#### Parameters + +##### fileTimestamps + +`Map`\<`string`, `number`\> + +##### contextTimestamps + +`Map`\<`string`, `number`\> + +#### Returns + +`boolean` + +#### Deprecated + +#### Inherited from + +[`Module`](Module.md).[`needRebuild`](Module.md#needrebuild) + +*** + +### originalSource() + +> **originalSource**(): [`Source`](../webpack/namespaces/export=/namespaces/sources/classes/Source.md) + +Defined in: [webpack/types.d.ts:10779](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10779) + +#### Returns + +[`Source`](../webpack/namespaces/export=/namespaces/sources/classes/Source.md) + +#### Inherited from + +[`Module`](Module.md).[`originalSource`](Module.md#originalsource) + +*** + +### readableIdentifier() + +> **readableIdentifier**(`requestShortener`): `string` + +Defined in: [webpack/types.d.ts:10723](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10723) + +#### Parameters + +##### requestShortener + +`RequestShortener` + +#### Returns + +`string` + +#### Inherited from + +[`Module`](Module.md).[`readableIdentifier`](Module.md#readableidentifier) + +*** + +### removeChunk() + +> **removeChunk**(`chunk`): `void` + +Defined in: [webpack/types.d.ts:10668](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10668) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +#### Returns + +`void` + +#### Inherited from + +[`Module`](Module.md).[`removeChunk`](Module.md#removechunk) + +*** + +### removeDependency() + +> **removeDependency**(`dependency`): `void` + +Defined in: [webpack/types.d.ts:4120](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4120) + +#### Parameters + +##### dependency + +[`Dependency`](Dependency.md) + +#### Returns + +`void` + +#### Inherited from + +[`Module`](Module.md).[`removeDependency`](Module.md#removedependency) + +*** + +### restoreFromUnsafeCache() + +> **restoreFromUnsafeCache**(`unsafeCacheData`, `normalModuleFactory`): `void` + +Defined in: [webpack/types.d.ts:5704](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L5704) + +restore unsafe cache data + +#### Parameters + +##### unsafeCacheData + +`UnsafeCacheData` + +##### normalModuleFactory + +`NormalModuleFactory` + +#### Returns + +`void` + +*** + +### serialize() + +> **serialize**(`__namedParameters`): `void` + +Defined in: [webpack/types.d.ts:4127](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4127) + +#### Parameters + +##### \_\_namedParameters + +[`ObjectSerializerContext`](../interfaces/ObjectSerializerContext.md) + +#### Returns + +`void` + +#### Inherited from + +[`Module`](Module.md).[`serialize`](Module.md#serialize) + +*** + +### size() + +> **size**(`type?`): `number` + +Defined in: [webpack/types.d.ts:10751](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10751) + +#### Parameters + +##### type? + +`string` + +#### Returns + +`number` + +#### Inherited from + +[`Module`](Module.md).[`size`](Module.md#size) + +*** + +### ~~source()~~ + +> **source**(`dependencyTemplates`, `runtimeTemplate`, `type?`): [`Source`](../webpack/namespaces/export=/namespaces/sources/classes/Source.md) + +Defined in: [webpack/types.d.ts:10746](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10746) + +Use codeGeneration() instead + +#### Parameters + +##### dependencyTemplates + +`DependencyTemplates` + +##### runtimeTemplate + +`RuntimeTemplate` + +##### type? + +`string` + +#### Returns + +[`Source`](../webpack/namespaces/export=/namespaces/sources/classes/Source.md) + +#### Deprecated + +#### Inherited from + +[`Module`](Module.md).[`source`](Module.md#source) + +*** + +### updateCacheModule() + +> **updateCacheModule**(`module`): `void` + +Defined in: [webpack/types.d.ts:10767](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10767) + +Assuming this module is in the cache. Update the (cached) module with +the fresh module from the factory. Usually updates internal references +and properties. + +#### Parameters + +##### module + +[`Module`](Module.md) + +#### Returns + +`void` + +#### Inherited from + +[`Module`](Module.md).[`updateCacheModule`](Module.md#updatecachemodule) + +*** + +### updateHash() + +> **updateHash**(`hash`, `context`): `void` + +Defined in: [webpack/types.d.ts:4126](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4126) + +#### Parameters + +##### hash + +`Hash` + +##### context + +`UpdateHashContextDependency` + +#### Returns + +`void` + +#### Inherited from + +[`Module`](Module.md).[`updateHash`](Module.md#updatehash) diff --git a/api/classes/ExternalsPlugin.md b/api/classes/ExternalsPlugin.md new file mode 100644 index 0000000..38e1155 --- /dev/null +++ b/api/classes/ExternalsPlugin.md @@ -0,0 +1,67 @@ +--- +title: ExternalsPlugin +--- + +[webpack](../globals.md) / ExternalsPlugin + +# Class: ExternalsPlugin + +Defined in: [webpack/types.d.ts:5789](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L5789) + +## Constructors + +### Constructor + +> **new ExternalsPlugin**(`type`, `externals`): `ExternalsPlugin` + +Defined in: [webpack/types.d.ts:5790](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L5790) + +#### Parameters + +##### type + +`"window"` | `"promise"` | `"module"` | `"script"` | `"var"` | `"self"` | `"global"` | `"asset"` | `"css-import"` | `"css-url"` | `"commonjs"` | `"import"` | `"jsonp"` | `"this"` | `"assign"` | `"commonjs2"` | `"commonjs-module"` | `"commonjs-static"` | `"amd"` | `"amd-require"` | `"umd"` | `"umd2"` | `"system"` | `"module-import"` | `"node-commonjs"` | (`dependency`) => `ExternalsType` + +##### externals + +[`Externals`](../type-aliases/Externals.md) + +#### Returns + +`ExternalsPlugin` + +## Properties + +### externals + +> **externals**: [`Externals`](../type-aliases/Externals.md) + +Defined in: [webpack/types.d.ts:5847](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L5847) + +*** + +### type + +> **type**: `"window"` \| `"promise"` \| `"module"` \| `"script"` \| `"var"` \| `"self"` \| `"global"` \| `"asset"` \| `"css-import"` \| `"css-url"` \| `"commonjs"` \| `"import"` \| `"jsonp"` \| `"this"` \| `"assign"` \| `"commonjs2"` \| `"commonjs-module"` \| `"commonjs-static"` \| `"amd"` \| `"amd-require"` \| `"umd"` \| `"umd2"` \| `"system"` \| `"module-import"` \| `"node-commonjs"` \| (`dependency`) => `ExternalsType` + +Defined in: [webpack/types.d.ts:5820](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L5820) + +## Methods + +### apply() + +> **apply**(`compiler`): `void` + +Defined in: [webpack/types.d.ts:5852](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L5852) + +Apply the plugin + +#### Parameters + +##### compiler + +[`Compiler`](Compiler.md) + +#### Returns + +`void` diff --git a/api/classes/Generator.md b/api/classes/Generator.md new file mode 100644 index 0000000..a81241a --- /dev/null +++ b/api/classes/Generator.md @@ -0,0 +1,143 @@ +--- +title: Generator +--- + +[webpack](../globals.md) / Generator + +# Class: Generator + +Defined in: [webpack/types.d.ts:6311](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L6311) + +## Constructors + +### Constructor + +> **new Generator**(): `Generator` + +Defined in: [webpack/types.d.ts:6312](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L6312) + +#### Returns + +`Generator` + +## Methods + +### generate() + +> **generate**(`module`, `__namedParameters`): [`Source`](../webpack/namespaces/export=/namespaces/sources/classes/Source.md) + +Defined in: [webpack/types.d.ts:6315](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L6315) + +#### Parameters + +##### module + +[`NormalModule`](NormalModule.md) + +##### \_\_namedParameters + +`GenerateContext` + +#### Returns + +[`Source`](../webpack/namespaces/export=/namespaces/sources/classes/Source.md) + +*** + +### getConcatenationBailoutReason() + +> **getConcatenationBailoutReason**(`module`, `context`): `string` + +Defined in: [webpack/types.d.ts:6316](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L6316) + +#### Parameters + +##### module + +[`NormalModule`](NormalModule.md) + +##### context + +`ConcatenationBailoutReasonContext` + +#### Returns + +`string` + +*** + +### getSize() + +> **getSize**(`module`, `type?`): `number` + +Defined in: [webpack/types.d.ts:6314](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L6314) + +#### Parameters + +##### module + +[`NormalModule`](NormalModule.md) + +##### type? + +`string` + +#### Returns + +`number` + +*** + +### getTypes() + +> **getTypes**(`module`): `ReadonlySet`\<`string`\> + +Defined in: [webpack/types.d.ts:6313](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L6313) + +#### Parameters + +##### module + +[`NormalModule`](NormalModule.md) + +#### Returns + +`ReadonlySet`\<`string`\> + +*** + +### updateHash() + +> **updateHash**(`hash`, `__namedParameters`): `void` + +Defined in: [webpack/types.d.ts:6320](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L6320) + +#### Parameters + +##### hash + +`Hash` + +##### \_\_namedParameters + +`UpdateHashContextGenerator` + +#### Returns + +`void` + +*** + +### byType() + +> `static` **byType**(`map`): `ByTypeGenerator` + +Defined in: [webpack/types.d.ts:6321](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L6321) + +#### Parameters + +##### map + +#### Returns + +`ByTypeGenerator` diff --git a/api/classes/HotModuleReplacementPlugin.md b/api/classes/HotModuleReplacementPlugin.md new file mode 100644 index 0000000..a950d1e --- /dev/null +++ b/api/classes/HotModuleReplacementPlugin.md @@ -0,0 +1,59 @@ +--- +title: HotModuleReplacementPlugin +--- + +[webpack](../globals.md) / HotModuleReplacementPlugin + +# Class: HotModuleReplacementPlugin + +Defined in: [webpack/types.d.ts:6717](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L6717) + +## Constructors + +### Constructor + +> **new HotModuleReplacementPlugin**(): `HotModuleReplacementPlugin` + +Defined in: [webpack/types.d.ts:6718](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L6718) + +#### Returns + +`HotModuleReplacementPlugin` + +## Methods + +### apply() + +> **apply**(`compiler`): `void` + +Defined in: [webpack/types.d.ts:6723](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L6723) + +Apply the plugin + +#### Parameters + +##### compiler + +[`Compiler`](Compiler.md) + +#### Returns + +`void` + +*** + +### getParserHooks() + +> `static` **getParserHooks**(`parser`): `HMRJavascriptParserHooks` + +Defined in: [webpack/types.d.ts:6724](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L6724) + +#### Parameters + +##### parser + +[`JavascriptParser`](../webpack/namespaces/export=/namespaces/javascript/classes/JavascriptParser.md) + +#### Returns + +`HMRJavascriptParserHooks` diff --git a/api/classes/HotUpdateChunk.md b/api/classes/HotUpdateChunk.md new file mode 100644 index 0000000..c96bfdf --- /dev/null +++ b/api/classes/HotUpdateChunk.md @@ -0,0 +1,1069 @@ +--- +title: HotUpdateChunk +--- + +[webpack](../globals.md) / HotUpdateChunk + +# Class: HotUpdateChunk + +Defined in: [webpack/types.d.ts:6733](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L6733) + +## Extends + +- [`Chunk`](Chunk.md) + +## Constructors + +### Constructor + +> **new HotUpdateChunk**(): `HotUpdateChunk` + +Defined in: [webpack/types.d.ts:6734](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L6734) + +#### Returns + +`HotUpdateChunk` + +#### Overrides + +[`Chunk`](Chunk.md).[`constructor`](Chunk.md#constructor) + +## Properties + +### auxiliaryFiles + +> **auxiliaryFiles**: `Set`\<`string`\> + +Defined in: [webpack/types.d.ts:1306](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1306) + +#### Inherited from + +[`Chunk`](Chunk.md).[`auxiliaryFiles`](Chunk.md#auxiliaryfiles) + +*** + +### chunkReason? + +> `optional` **chunkReason**: `string` + +Defined in: [webpack/types.d.ts:1311](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1311) + +#### Inherited from + +[`Chunk`](Chunk.md).[`chunkReason`](Chunk.md#chunkreason) + +*** + +### contentHash + +> **contentHash**: `Record`\<`string`, `string`\> + +Defined in: [webpack/types.d.ts:1309](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1309) + +#### Inherited from + +[`Chunk`](Chunk.md).[`contentHash`](Chunk.md#contenthash) + +*** + +### cssFilenameTemplate? + +> `optional` **cssFilenameTemplate**: `string` \| (`pathData`, `assetInfo?`) => `string` + +Defined in: [webpack/types.d.ts:1301](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1301) + +#### Inherited from + +[`Chunk`](Chunk.md).[`cssFilenameTemplate`](Chunk.md#cssfilenametemplate) + +*** + +### debugId + +> **debugId**: `number` + +Defined in: [webpack/types.d.ts:1294](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1294) + +#### Inherited from + +[`Chunk`](Chunk.md).[`debugId`](Chunk.md#debugid) + +*** + +### extraAsync + +> **extraAsync**: `boolean` + +Defined in: [webpack/types.d.ts:1312](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1312) + +#### Inherited from + +[`Chunk`](Chunk.md).[`extraAsync`](Chunk.md#extraasync) + +*** + +### filenameTemplate? + +> `optional` **filenameTemplate**: `string` \| (`pathData`, `assetInfo?`) => `string` + +Defined in: [webpack/types.d.ts:1298](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1298) + +#### Inherited from + +[`Chunk`](Chunk.md).[`filenameTemplate`](Chunk.md#filenametemplate) + +*** + +### files + +> **files**: `Set`\<`string`\> + +Defined in: [webpack/types.d.ts:1305](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1305) + +#### Inherited from + +[`Chunk`](Chunk.md).[`files`](Chunk.md#files) + +*** + +### hash? + +> `optional` **hash**: `string` + +Defined in: [webpack/types.d.ts:1308](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1308) + +#### Inherited from + +[`Chunk`](Chunk.md).[`hash`](Chunk.md#hash) + +*** + +### id + +> **id**: `string` \| `number` + +Defined in: [webpack/types.d.ts:1292](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1292) + +#### Inherited from + +[`Chunk`](Chunk.md).[`id`](Chunk.md#id) + +*** + +### idNameHints + +> **idNameHints**: `SortableSet`\<`string`\> + +Defined in: [webpack/types.d.ts:1296](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1296) + +#### Inherited from + +[`Chunk`](Chunk.md).[`idNameHints`](Chunk.md#idnamehints) + +*** + +### ids + +> **ids**: `ChunkId`[] + +Defined in: [webpack/types.d.ts:1293](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1293) + +#### Inherited from + +[`Chunk`](Chunk.md).[`ids`](Chunk.md#ids) + +*** + +### name? + +> `optional` **name**: `string` + +Defined in: [webpack/types.d.ts:1295](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1295) + +#### Inherited from + +[`Chunk`](Chunk.md).[`name`](Chunk.md#name) + +*** + +### preventIntegration + +> **preventIntegration**: `boolean` + +Defined in: [webpack/types.d.ts:1297](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1297) + +#### Inherited from + +[`Chunk`](Chunk.md).[`preventIntegration`](Chunk.md#preventintegration) + +*** + +### rendered + +> **rendered**: `boolean` + +Defined in: [webpack/types.d.ts:1307](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1307) + +#### Inherited from + +[`Chunk`](Chunk.md).[`rendered`](Chunk.md#rendered) + +*** + +### renderedHash? + +> `optional` **renderedHash**: `string` + +Defined in: [webpack/types.d.ts:1310](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1310) + +#### Inherited from + +[`Chunk`](Chunk.md).[`renderedHash`](Chunk.md#renderedhash) + +*** + +### runtime + +> **runtime**: `RuntimeSpec` + +Defined in: [webpack/types.d.ts:1304](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1304) + +#### Inherited from + +[`Chunk`](Chunk.md).[`runtime`](Chunk.md#runtime) + +## Accessors + +### entryModule + +#### Get Signature + +> **get** **entryModule**(): [`Module`](Module.md) + +Defined in: [webpack/types.d.ts:1317](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1317) + +##### Deprecated + +##### Returns + +[`Module`](Module.md) + +#### Inherited from + +[`Chunk`](Chunk.md).[`entryModule`](Chunk.md#entrymodule) + +*** + +### groupsIterable + +#### Get Signature + +> **get** **groupsIterable**(): `SortableSet`\<[`ChunkGroup`](ChunkGroup.md)\> + +Defined in: [webpack/types.d.ts:1352](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1352) + +##### Returns + +`SortableSet`\<[`ChunkGroup`](ChunkGroup.md)\> + +#### Inherited from + +[`Chunk`](Chunk.md).[`groupsIterable`](Chunk.md#groupsiterable) + +*** + +### modulesIterable + +#### Get Signature + +> **get** **modulesIterable**(): `Iterable`\<[`Module`](Module.md)\> + +Defined in: [webpack/types.d.ts:1322](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1322) + +##### Returns + +`Iterable`\<[`Module`](Module.md)\> + +#### Inherited from + +[`Chunk`](Chunk.md).[`modulesIterable`](Chunk.md#modulesiterable) + +## Methods + +### addGroup() + +> **addGroup**(`chunkGroup`): `void` + +Defined in: [webpack/types.d.ts:1348](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1348) + +#### Parameters + +##### chunkGroup + +[`ChunkGroup`](ChunkGroup.md) + +#### Returns + +`void` + +#### Inherited from + +[`Chunk`](Chunk.md).[`addGroup`](Chunk.md#addgroup) + +*** + +### addModule() + +> **addModule**(`module`): `boolean` + +Defined in: [webpack/types.d.ts:1319](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1319) + +#### Parameters + +##### module + +[`Module`](Module.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`Chunk`](Chunk.md).[`addModule`](Chunk.md#addmodule) + +*** + +### canBeInitial() + +> **canBeInitial**(): `boolean` + +Defined in: [webpack/types.d.ts:1345](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1345) + +#### Returns + +`boolean` + +#### Inherited from + +[`Chunk`](Chunk.md).[`canBeInitial`](Chunk.md#canbeinitial) + +*** + +### canBeIntegrated() + +> **canBeIntegrated**(`otherChunk`): `boolean` + +Defined in: [webpack/types.d.ts:1329](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1329) + +#### Parameters + +##### otherChunk + +[`Chunk`](Chunk.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`Chunk`](Chunk.md).[`canBeIntegrated`](Chunk.md#canbeintegrated) + +*** + +### compareTo() + +> **compareTo**(`otherChunk`): `-1` \| `0` \| `1` + +Defined in: [webpack/types.d.ts:1323](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1323) + +#### Parameters + +##### otherChunk + +[`Chunk`](Chunk.md) + +#### Returns + +`-1` \| `0` \| `1` + +#### Inherited from + +[`Chunk`](Chunk.md).[`compareTo`](Chunk.md#compareto) + +*** + +### containsModule() + +> **containsModule**(`module`): `boolean` + +Defined in: [webpack/types.d.ts:1324](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1324) + +#### Parameters + +##### module + +[`Module`](Module.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`Chunk`](Chunk.md).[`containsModule`](Chunk.md#containsmodule) + +*** + +### disconnectFromGroups() + +> **disconnectFromGroups**(): `void` + +Defined in: [webpack/types.d.ts:1353](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1353) + +#### Returns + +`void` + +#### Inherited from + +[`Chunk`](Chunk.md).[`disconnectFromGroups`](Chunk.md#disconnectfromgroups) + +*** + +### getAllAsyncChunks() + +> **getAllAsyncChunks**(): `Set`\<[`Chunk`](Chunk.md)\> + +Defined in: [webpack/types.d.ts:1356](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1356) + +#### Returns + +`Set`\<[`Chunk`](Chunk.md)\> + +#### Inherited from + +[`Chunk`](Chunk.md).[`getAllAsyncChunks`](Chunk.md#getallasyncchunks) + +*** + +### getAllInitialChunks() + +> **getAllInitialChunks**(): `Set`\<[`Chunk`](Chunk.md)\> + +Defined in: [webpack/types.d.ts:1357](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1357) + +#### Returns + +`Set`\<[`Chunk`](Chunk.md)\> + +#### Inherited from + +[`Chunk`](Chunk.md).[`getAllInitialChunks`](Chunk.md#getallinitialchunks) + +*** + +### getAllReferencedAsyncEntrypoints() + +> **getAllReferencedAsyncEntrypoints**(): `Set`\<[`Entrypoint`](Entrypoint.md)\> + +Defined in: [webpack/types.d.ts:1359](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1359) + +#### Returns + +`Set`\<[`Entrypoint`](Entrypoint.md)\> + +#### Inherited from + +[`Chunk`](Chunk.md).[`getAllReferencedAsyncEntrypoints`](Chunk.md#getallreferencedasyncentrypoints) + +*** + +### getAllReferencedChunks() + +> **getAllReferencedChunks**(): `Set`\<[`Chunk`](Chunk.md)\> + +Defined in: [webpack/types.d.ts:1358](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1358) + +#### Returns + +`Set`\<[`Chunk`](Chunk.md)\> + +#### Inherited from + +[`Chunk`](Chunk.md).[`getAllReferencedChunks`](Chunk.md#getallreferencedchunks) + +*** + +### getChildIdsByOrders() + +> **getChildIdsByOrders**(`chunkGraph`, `filterFn?`): `Record`\<`string`, `ChunkId`[]\> + +Defined in: [webpack/types.d.ts:1361](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1361) + +#### Parameters + +##### chunkGraph + +[`ChunkGraph`](ChunkGraph.md) + +##### filterFn? + +(`c`, `chunkGraph`) => `boolean` + +#### Returns + +`Record`\<`string`, `ChunkId`[]\> + +#### Inherited from + +[`Chunk`](Chunk.md).[`getChildIdsByOrders`](Chunk.md#getchildidsbyorders) + +*** + +### getChildIdsByOrdersMap() + +> **getChildIdsByOrdersMap**(`chunkGraph`, `includeDirectChildren?`, `filterFn?`): `ChunkChildIdsByOrdersMapByData` + +Defined in: [webpack/types.d.ts:1369](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1369) + +#### Parameters + +##### chunkGraph + +[`ChunkGraph`](ChunkGraph.md) + +##### includeDirectChildren? + +`boolean` + +##### filterFn? + +(`c`, `chunkGraph`) => `boolean` + +#### Returns + +`ChunkChildIdsByOrdersMapByData` + +#### Inherited from + +[`Chunk`](Chunk.md).[`getChildIdsByOrdersMap`](Chunk.md#getchildidsbyordersmap) + +*** + +### getChildrenOfTypeInOrder() + +> **getChildrenOfTypeInOrder**(`chunkGraph`, `type`): `ChunkChildOfTypeInOrder`[] + +Defined in: [webpack/types.d.ts:1365](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1365) + +#### Parameters + +##### chunkGraph + +[`ChunkGraph`](ChunkGraph.md) + +##### type + +`string` + +#### Returns + +`ChunkChildOfTypeInOrder`[] + +#### Inherited from + +[`Chunk`](Chunk.md).[`getChildrenOfTypeInOrder`](Chunk.md#getchildrenoftypeinorder) + +*** + +### ~~getChunkMaps()~~ + +> **getChunkMaps**(`realHash`): `ChunkMaps` + +Defined in: [webpack/types.d.ts:1343](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1343) + +#### Parameters + +##### realHash + +`boolean` + +#### Returns + +`ChunkMaps` + +#### Deprecated + +#### Inherited from + +[`Chunk`](Chunk.md).[`getChunkMaps`](Chunk.md#getchunkmaps) + +*** + +### getChunkModuleMaps() + +> **getChunkModuleMaps**(`filterFn`): `ChunkModuleMaps` + +Defined in: [webpack/types.d.ts:1334](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1334) + +#### Parameters + +##### filterFn + +(`m`) => `boolean` + +#### Returns + +`ChunkModuleMaps` + +#### Inherited from + +[`Chunk`](Chunk.md).[`getChunkModuleMaps`](Chunk.md#getchunkmodulemaps) + +*** + +### getEntryOptions() + +> **getEntryOptions**(): [`EntryOptions`](../type-aliases/EntryOptions.md) + +Defined in: [webpack/types.d.ts:1347](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1347) + +#### Returns + +[`EntryOptions`](../type-aliases/EntryOptions.md) + +#### Inherited from + +[`Chunk`](Chunk.md).[`getEntryOptions`](Chunk.md#getentryoptions) + +*** + +### getModules() + +> **getModules**(): [`Module`](Module.md)[] + +Defined in: [webpack/types.d.ts:1325](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1325) + +#### Returns + +[`Module`](Module.md)[] + +#### Inherited from + +[`Chunk`](Chunk.md).[`getModules`](Chunk.md#getmodules) + +*** + +### getNumberOfGroups() + +> **getNumberOfGroups**(): `number` + +Defined in: [webpack/types.d.ts:1351](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1351) + +#### Returns + +`number` + +#### Inherited from + +[`Chunk`](Chunk.md).[`getNumberOfGroups`](Chunk.md#getnumberofgroups) + +*** + +### getNumberOfModules() + +> **getNumberOfModules**(): `number` + +Defined in: [webpack/types.d.ts:1321](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1321) + +#### Returns + +`number` + +#### Inherited from + +[`Chunk`](Chunk.md).[`getNumberOfModules`](Chunk.md#getnumberofmodules) + +*** + +### hasAsyncChunks() + +> **hasAsyncChunks**(): `boolean` + +Defined in: [webpack/types.d.ts:1360](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1360) + +#### Returns + +`boolean` + +#### Inherited from + +[`Chunk`](Chunk.md).[`hasAsyncChunks`](Chunk.md#hasasyncchunks) + +*** + +### hasChildByOrder() + +> **hasChildByOrder**(`chunkGraph`, `type`, `includeDirectChildren?`, `filterFn?`): `boolean` + +Defined in: [webpack/types.d.ts:1374](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1374) + +#### Parameters + +##### chunkGraph + +[`ChunkGraph`](ChunkGraph.md) + +##### type + +`string` + +##### includeDirectChildren? + +`boolean` + +##### filterFn? + +(`c`, `chunkGraph`) => `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[`Chunk`](Chunk.md).[`hasChildByOrder`](Chunk.md#haschildbyorder) + +*** + +### hasEntryModule() + +> **hasEntryModule**(): `boolean` + +Defined in: [webpack/types.d.ts:1318](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1318) + +#### Returns + +`boolean` + +#### Inherited from + +[`Chunk`](Chunk.md).[`hasEntryModule`](Chunk.md#hasentrymodule) + +*** + +### hasModuleInGraph() + +> **hasModuleInGraph**(`filterFn`, `filterChunkFn?`): `boolean` + +Defined in: [webpack/types.d.ts:1335](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1335) + +#### Parameters + +##### filterFn + +(`m`) => `boolean` + +##### filterChunkFn? + +(`c`, `chunkGraph`) => `boolean` + +#### Returns + +`boolean` + +#### Inherited from + +[`Chunk`](Chunk.md).[`hasModuleInGraph`](Chunk.md#hasmoduleingraph) + +*** + +### hasRuntime() + +> **hasRuntime**(): `boolean` + +Defined in: [webpack/types.d.ts:1344](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1344) + +#### Returns + +`boolean` + +#### Inherited from + +[`Chunk`](Chunk.md).[`hasRuntime`](Chunk.md#hasruntime) + +*** + +### integrate() + +> **integrate**(`otherChunk`): `boolean` + +Defined in: [webpack/types.d.ts:1328](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1328) + +#### Parameters + +##### otherChunk + +[`Chunk`](Chunk.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`Chunk`](Chunk.md).[`integrate`](Chunk.md#integrate) + +*** + +### integratedSize() + +> **integratedSize**(`otherChunk`, `options`): `number` + +Defined in: [webpack/types.d.ts:1333](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1333) + +#### Parameters + +##### otherChunk + +[`Chunk`](Chunk.md) + +##### options + +`ChunkSizeOptions` + +#### Returns + +`number` + +#### Inherited from + +[`Chunk`](Chunk.md).[`integratedSize`](Chunk.md#integratedsize) + +*** + +### isEmpty() + +> **isEmpty**(): `boolean` + +Defined in: [webpack/types.d.ts:1330](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1330) + +#### Returns + +`boolean` + +#### Inherited from + +[`Chunk`](Chunk.md).[`isEmpty`](Chunk.md#isempty) + +*** + +### isInGroup() + +> **isInGroup**(`chunkGroup`): `boolean` + +Defined in: [webpack/types.d.ts:1350](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1350) + +#### Parameters + +##### chunkGroup + +[`ChunkGroup`](ChunkGroup.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`Chunk`](Chunk.md).[`isInGroup`](Chunk.md#isingroup) + +*** + +### isOnlyInitial() + +> **isOnlyInitial**(): `boolean` + +Defined in: [webpack/types.d.ts:1346](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1346) + +#### Returns + +`boolean` + +#### Inherited from + +[`Chunk`](Chunk.md).[`isOnlyInitial`](Chunk.md#isonlyinitial) + +*** + +### modulesSize() + +> **modulesSize**(): `number` + +Defined in: [webpack/types.d.ts:1331](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1331) + +#### Returns + +`number` + +#### Inherited from + +[`Chunk`](Chunk.md).[`modulesSize`](Chunk.md#modulessize) + +*** + +### moveModule() + +> **moveModule**(`module`, `otherChunk`): `void` + +Defined in: [webpack/types.d.ts:1327](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1327) + +#### Parameters + +##### module + +[`Module`](Module.md) + +##### otherChunk + +[`Chunk`](Chunk.md) + +#### Returns + +`void` + +#### Inherited from + +[`Chunk`](Chunk.md).[`moveModule`](Chunk.md#movemodule) + +*** + +### remove() + +> **remove**(): `void` + +Defined in: [webpack/types.d.ts:1326](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1326) + +#### Returns + +`void` + +#### Inherited from + +[`Chunk`](Chunk.md).[`remove`](Chunk.md#remove) + +*** + +### removeGroup() + +> **removeGroup**(`chunkGroup`): `void` + +Defined in: [webpack/types.d.ts:1349](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1349) + +#### Parameters + +##### chunkGroup + +[`ChunkGroup`](ChunkGroup.md) + +#### Returns + +`void` + +#### Inherited from + +[`Chunk`](Chunk.md).[`removeGroup`](Chunk.md#removegroup) + +*** + +### removeModule() + +> **removeModule**(`module`): `void` + +Defined in: [webpack/types.d.ts:1320](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1320) + +#### Parameters + +##### module + +[`Module`](Module.md) + +#### Returns + +`void` + +#### Inherited from + +[`Chunk`](Chunk.md).[`removeModule`](Chunk.md#removemodule) + +*** + +### size() + +> **size**(`options?`): `number` + +Defined in: [webpack/types.d.ts:1332](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1332) + +#### Parameters + +##### options? + +`ChunkSizeOptions` + +#### Returns + +`number` + +#### Inherited from + +[`Chunk`](Chunk.md).[`size`](Chunk.md#size) + +*** + +### split() + +> **split**(`newChunk`): `void` + +Defined in: [webpack/types.d.ts:1354](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1354) + +#### Parameters + +##### newChunk + +[`Chunk`](Chunk.md) + +#### Returns + +`void` + +#### Inherited from + +[`Chunk`](Chunk.md).[`split`](Chunk.md#split) + +*** + +### updateHash() + +> **updateHash**(`hash`, `chunkGraph`): `void` + +Defined in: [webpack/types.d.ts:1355](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1355) + +#### Parameters + +##### hash + +`Hash` + +##### chunkGraph + +[`ChunkGraph`](ChunkGraph.md) + +#### Returns + +`void` + +#### Inherited from + +[`Chunk`](Chunk.md).[`updateHash`](Chunk.md#updatehash) diff --git a/api/classes/IgnorePlugin.md b/api/classes/IgnorePlugin.md new file mode 100644 index 0000000..f0cc38b --- /dev/null +++ b/api/classes/IgnorePlugin.md @@ -0,0 +1,75 @@ +--- +title: IgnorePlugin +--- + +[webpack](../globals.md) / IgnorePlugin + +# Class: IgnorePlugin + +Defined in: [webpack/types.d.ts:6844](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L6844) + +## Constructors + +### Constructor + +> **new IgnorePlugin**(`options`): `IgnorePlugin` + +Defined in: [webpack/types.d.ts:6845](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L6845) + +#### Parameters + +##### options + +`IgnorePluginOptions` + +#### Returns + +`IgnorePlugin` + +## Properties + +### options + +> **options**: `IgnorePluginOptions` + +Defined in: [webpack/types.d.ts:6846](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L6846) + +## Methods + +### apply() + +> **apply**(`compiler`): `void` + +Defined in: [webpack/types.d.ts:6858](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L6858) + +Apply the plugin + +#### Parameters + +##### compiler + +[`Compiler`](Compiler.md) + +#### Returns + +`void` + +*** + +### checkIgnore() + +> **checkIgnore**(`resolveData`): `false` + +Defined in: [webpack/types.d.ts:6851](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L6851) + +Note that if "contextRegExp" is given, both the "resourceRegExp" and "contextRegExp" have to match. + +#### Parameters + +##### resolveData + +`BeforeContextResolveData` | [`ResolveData`](../interfaces/ResolveData.md) + +#### Returns + +`false` diff --git a/api/classes/InitFragment.md b/api/classes/InitFragment.md new file mode 100644 index 0000000..3d23783 --- /dev/null +++ b/api/classes/InitFragment.md @@ -0,0 +1,249 @@ +--- +title: InitFragment +--- + +[webpack](../globals.md) / InitFragment + +# Class: InitFragment\ + +Defined in: [webpack/types.d.ts:6978](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L6978) + +## Type Parameters + +### GenerateContext + +`GenerateContext` + +## Constructors + +### Constructor + +> **new InitFragment**\<`GenerateContext`\>(`content`, `stage`, `position`, `key?`, `endContent?`): `InitFragment`\<`GenerateContext`\> + +Defined in: [webpack/types.d.ts:6979](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L6979) + +#### Parameters + +##### content + +`string` | [`Source`](../webpack/namespaces/export=/namespaces/sources/classes/Source.md) + +##### stage + +`number` + +##### position + +`number` + +##### key? + +`string` + +##### endContent? + +`string` | [`Source`](../webpack/namespaces/export=/namespaces/sources/classes/Source.md) + +#### Returns + +`InitFragment`\<`GenerateContext`\> + +## Properties + +### content? + +> `optional` **content**: `string` \| [`Source`](../webpack/namespaces/export=/namespaces/sources/classes/Source.md) + +Defined in: [webpack/types.d.ts:6986](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L6986) + +*** + +### endContent? + +> `optional` **endContent**: `string` \| [`Source`](../webpack/namespaces/export=/namespaces/sources/classes/Source.md) + +Defined in: [webpack/types.d.ts:6990](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L6990) + +*** + +### key? + +> `optional` **key**: `string` + +Defined in: [webpack/types.d.ts:6989](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L6989) + +*** + +### position + +> **position**: `number` + +Defined in: [webpack/types.d.ts:6988](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L6988) + +*** + +### stage + +> **stage**: `number` + +Defined in: [webpack/types.d.ts:6987](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L6987) + +*** + +### STAGE\_ASYNC\_BOUNDARY + +> `static` **STAGE\_ASYNC\_BOUNDARY**: `number` + +Defined in: [webpack/types.d.ts:7001](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L7001) + +*** + +### STAGE\_ASYNC\_DEPENDENCIES + +> `static` **STAGE\_ASYNC\_DEPENDENCIES**: `number` + +Defined in: [webpack/types.d.ts:7005](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L7005) + +*** + +### STAGE\_ASYNC\_HARMONY\_IMPORTS + +> `static` **STAGE\_ASYNC\_HARMONY\_IMPORTS**: `number` + +Defined in: [webpack/types.d.ts:7006](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L7006) + +*** + +### STAGE\_CONSTANTS + +> `static` **STAGE\_CONSTANTS**: `number` + +Defined in: [webpack/types.d.ts:7000](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L7000) + +*** + +### STAGE\_HARMONY\_EXPORTS + +> `static` **STAGE\_HARMONY\_EXPORTS**: `number` + +Defined in: [webpack/types.d.ts:7002](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L7002) + +*** + +### STAGE\_HARMONY\_IMPORTS + +> `static` **STAGE\_HARMONY\_IMPORTS**: `number` + +Defined in: [webpack/types.d.ts:7003](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L7003) + +*** + +### STAGE\_PROVIDES + +> `static` **STAGE\_PROVIDES**: `number` + +Defined in: [webpack/types.d.ts:7004](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L7004) + +## Methods + +### deserialize() + +> **deserialize**(`context`): `void` + +Defined in: [webpack/types.d.ts:6994](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L6994) + +#### Parameters + +##### context + +[`ObjectDeserializerContext`](../interfaces/ObjectDeserializerContext.md) + +#### Returns + +`void` + +*** + +### getContent() + +> **getContent**(`context`): `string` \| [`Source`](../webpack/namespaces/export=/namespaces/sources/classes/Source.md) + +Defined in: [webpack/types.d.ts:6991](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L6991) + +#### Parameters + +##### context + +`GenerateContext` + +#### Returns + +`string` \| [`Source`](../webpack/namespaces/export=/namespaces/sources/classes/Source.md) + +*** + +### getEndContent() + +> **getEndContent**(`context`): `string` \| [`Source`](../webpack/namespaces/export=/namespaces/sources/classes/Source.md) + +Defined in: [webpack/types.d.ts:6992](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L6992) + +#### Parameters + +##### context + +`GenerateContext` + +#### Returns + +`string` \| [`Source`](../webpack/namespaces/export=/namespaces/sources/classes/Source.md) + +*** + +### serialize() + +> **serialize**(`context`): `void` + +Defined in: [webpack/types.d.ts:6993](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L6993) + +#### Parameters + +##### context + +[`ObjectSerializerContext`](../interfaces/ObjectSerializerContext.md) + +#### Returns + +`void` + +*** + +### addToSource() + +> `static` **addToSource**\<`Context`\>(`source`, `initFragments`, `context`): [`Source`](../webpack/namespaces/export=/namespaces/sources/classes/Source.md) + +Defined in: [webpack/types.d.ts:6995](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L6995) + +#### Type Parameters + +##### Context + +`Context` + +#### Parameters + +##### source + +[`Source`](../webpack/namespaces/export=/namespaces/sources/classes/Source.md) + +##### initFragments + +`MaybeMergeableInitFragment`\<`Context`\>[] + +##### context + +`Context` + +#### Returns + +[`Source`](../webpack/namespaces/export=/namespaces/sources/classes/Source.md) diff --git a/api/classes/JavascriptModulesPlugin.md b/api/classes/JavascriptModulesPlugin.md new file mode 100644 index 0000000..7eae6fa --- /dev/null +++ b/api/classes/JavascriptModulesPlugin.md @@ -0,0 +1,261 @@ +--- +title: JavascriptModulesPlugin +--- + +[webpack](../globals.md) / JavascriptModulesPlugin + +# Class: JavascriptModulesPlugin + +Defined in: [webpack/types.d.ts:7124](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L7124) + +## Constructors + +### Constructor + +> **new JavascriptModulesPlugin**(`options?`): `JavascriptModulesPlugin` + +Defined in: [webpack/types.d.ts:7125](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L7125) + +#### Parameters + +##### options? + +`object` + +#### Returns + +`JavascriptModulesPlugin` + +## Properties + +### options + +> **options**: `object` + +Defined in: [webpack/types.d.ts:7126](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L7126) + +*** + +### chunkHasJs() + +> `static` **chunkHasJs**: (`chunk`, `chunkGraph`) => `boolean` + +Defined in: [webpack/types.d.ts:7166](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L7166) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +##### chunkGraph + +[`ChunkGraph`](ChunkGraph.md) + +#### Returns + +`boolean` + +## Methods + +### apply() + +> **apply**(`compiler`): `void` + +Defined in: [webpack/types.d.ts:7131](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L7131) + +Apply the plugin + +#### Parameters + +##### compiler + +[`Compiler`](Compiler.md) + +#### Returns + +`void` + +*** + +### renderBootstrap() + +> **renderBootstrap**(`renderContext`, `hooks`): `Bootstrap` + +Defined in: [webpack/types.d.ts:7151](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L7151) + +#### Parameters + +##### renderContext + +`RenderBootstrapContext` + +##### hooks + +`CompilationHooksJavascriptModulesPlugin` + +#### Returns + +`Bootstrap` + +*** + +### renderChunk() + +> **renderChunk**(`renderContext`, `hooks`): [`Source`](../webpack/namespaces/export=/namespaces/sources/classes/Source.md) + +Defined in: [webpack/types.d.ts:7137](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L7137) + +#### Parameters + +##### renderContext + +`RenderContextJavascriptModulesPlugin` + +##### hooks + +`CompilationHooksJavascriptModulesPlugin` + +#### Returns + +[`Source`](../webpack/namespaces/export=/namespaces/sources/classes/Source.md) + +*** + +### renderMain() + +> **renderMain**(`renderContext`, `hooks`, `compilation`): [`Source`](../webpack/namespaces/export=/namespaces/sources/classes/Source.md) + +Defined in: [webpack/types.d.ts:7141](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L7141) + +#### Parameters + +##### renderContext + +`MainRenderContext` + +##### hooks + +`CompilationHooksJavascriptModulesPlugin` + +##### compilation + +[`Compilation`](Compilation.md) + +#### Returns + +[`Source`](../webpack/namespaces/export=/namespaces/sources/classes/Source.md) + +*** + +### renderModule() + +> **renderModule**(`module`, `renderContext`, `hooks`): [`Source`](../webpack/namespaces/export=/namespaces/sources/classes/Source.md) + +Defined in: [webpack/types.d.ts:7132](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L7132) + +#### Parameters + +##### module + +[`Module`](Module.md) + +##### renderContext + +`ModuleRenderContext` + +##### hooks + +`CompilationHooksJavascriptModulesPlugin` + +#### Returns + +[`Source`](../webpack/namespaces/export=/namespaces/sources/classes/Source.md) + +*** + +### renderRequire() + +> **renderRequire**(`renderContext`, `hooks`): `string` + +Defined in: [webpack/types.d.ts:7155](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L7155) + +#### Parameters + +##### renderContext + +`RenderBootstrapContext` + +##### hooks + +`CompilationHooksJavascriptModulesPlugin` + +#### Returns + +`string` + +*** + +### updateHashWithBootstrap() + +> **updateHashWithBootstrap**(`hash`, `renderContext`, `hooks`): `void` + +Defined in: [webpack/types.d.ts:7146](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L7146) + +#### Parameters + +##### hash + +`Hash` + +##### renderContext + +`RenderBootstrapContext` + +##### hooks + +`CompilationHooksJavascriptModulesPlugin` + +#### Returns + +`void` + +*** + +### getChunkFilenameTemplate() + +> `static` **getChunkFilenameTemplate**(`chunk`, `outputOptions`): [`TemplatePath`](../type-aliases/TemplatePath.md) + +Defined in: [webpack/types.d.ts:7162](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L7162) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +##### outputOptions + +`OutputNormalizedWithDefaults` + +#### Returns + +[`TemplatePath`](../type-aliases/TemplatePath.md) + +*** + +### getCompilationHooks() + +> `static` **getCompilationHooks**(`compilation`): `CompilationHooksJavascriptModulesPlugin` + +Defined in: [webpack/types.d.ts:7159](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L7159) + +#### Parameters + +##### compilation + +[`Compilation`](Compilation.md) + +#### Returns + +`CompilationHooksJavascriptModulesPlugin` diff --git a/api/classes/LibManifestPlugin.md b/api/classes/LibManifestPlugin.md new file mode 100644 index 0000000..0d5a1b2 --- /dev/null +++ b/api/classes/LibManifestPlugin.md @@ -0,0 +1,55 @@ +--- +title: LibManifestPlugin +--- + +[webpack](../globals.md) / LibManifestPlugin + +# Class: LibManifestPlugin + +Defined in: [webpack/types.d.ts:9725](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L9725) + +## Constructors + +### Constructor + +> **new LibManifestPlugin**(`options`): `LibManifestPlugin` + +Defined in: [webpack/types.d.ts:9726](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L9726) + +#### Parameters + +##### options + +`LibManifestPluginOptions` + +#### Returns + +`LibManifestPlugin` + +## Properties + +### options + +> **options**: `LibManifestPluginOptions` + +Defined in: [webpack/types.d.ts:9727](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L9727) + +## Methods + +### apply() + +> **apply**(`compiler`): `void` + +Defined in: [webpack/types.d.ts:9732](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L9732) + +Apply the plugin + +#### Parameters + +##### compiler + +[`Compiler`](Compiler.md) + +#### Returns + +`void` diff --git a/api/classes/LibraryTemplatePlugin.md b/api/classes/LibraryTemplatePlugin.md new file mode 100644 index 0000000..1201ffd --- /dev/null +++ b/api/classes/LibraryTemplatePlugin.md @@ -0,0 +1,91 @@ +--- +title: LibraryTemplatePlugin +--- + +[webpack](../globals.md) / LibraryTemplatePlugin + +# Class: LibraryTemplatePlugin + +Defined in: [webpack/types.d.ts:9852](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L9852) + +## Constructors + +### Constructor + +> **new LibraryTemplatePlugin**(`name`, `target`, `umdNamedDefine`, `auxiliaryComment`, `exportProperty`): `LibraryTemplatePlugin` + +Defined in: [webpack/types.d.ts:9853](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L9853) + +#### Parameters + +##### name + +`LibraryName` + +##### target + +`string` + +##### umdNamedDefine + +`boolean` + +##### auxiliaryComment + +`AuxiliaryComment` + +##### exportProperty + +`LibraryExport` + +#### Returns + +`LibraryTemplatePlugin` + +## Properties + +### library + +> **library**: `object` + +Defined in: [webpack/types.d.ts:9860](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L9860) + +#### auxiliaryComment + +> **auxiliaryComment**: `AuxiliaryComment` + +#### export + +> **export**: `LibraryExport` + +#### name + +> **name**: `LibraryName` + +#### type + +> **type**: `string` + +#### umdNamedDefine + +> **umdNamedDefine**: `boolean` + +## Methods + +### apply() + +> **apply**(`compiler`): `void` + +Defined in: [webpack/types.d.ts:9871](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L9871) + +Apply the plugin + +#### Parameters + +##### compiler + +[`Compiler`](Compiler.md) + +#### Returns + +`void` diff --git a/api/classes/LoaderOptionsPlugin.md b/api/classes/LoaderOptionsPlugin.md new file mode 100644 index 0000000..240502e --- /dev/null +++ b/api/classes/LoaderOptionsPlugin.md @@ -0,0 +1,55 @@ +--- +title: LoaderOptionsPlugin +--- + +[webpack](../globals.md) / LoaderOptionsPlugin + +# Class: LoaderOptionsPlugin + +Defined in: [webpack/types.d.ts:9974](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L9974) + +## Constructors + +### Constructor + +> **new LoaderOptionsPlugin**(`options?`): `LoaderOptionsPlugin` + +Defined in: [webpack/types.d.ts:9975](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L9975) + +#### Parameters + +##### options? + +`LoaderOptionsPluginOptions` & `MatchObject` + +#### Returns + +`LoaderOptionsPlugin` + +## Properties + +### options + +> **options**: `LoaderOptionsPluginOptions` & `MatchObject` + +Defined in: [webpack/types.d.ts:9976](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L9976) + +## Methods + +### apply() + +> **apply**(`compiler`): `void` + +Defined in: [webpack/types.d.ts:9981](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L9981) + +Apply the plugin + +#### Parameters + +##### compiler + +[`Compiler`](Compiler.md) + +#### Returns + +`void` diff --git a/api/classes/LoaderTargetPlugin.md b/api/classes/LoaderTargetPlugin.md new file mode 100644 index 0000000..0917aa2 --- /dev/null +++ b/api/classes/LoaderTargetPlugin.md @@ -0,0 +1,55 @@ +--- +title: LoaderTargetPlugin +--- + +[webpack](../globals.md) / LoaderTargetPlugin + +# Class: LoaderTargetPlugin + +Defined in: [webpack/types.d.ts:10179](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10179) + +## Constructors + +### Constructor + +> **new LoaderTargetPlugin**(`target`): `LoaderTargetPlugin` + +Defined in: [webpack/types.d.ts:10180](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10180) + +#### Parameters + +##### target + +`string` + +#### Returns + +`LoaderTargetPlugin` + +## Properties + +### target + +> **target**: `string` + +Defined in: [webpack/types.d.ts:10181](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10181) + +## Methods + +### apply() + +> **apply**(`compiler`): `void` + +Defined in: [webpack/types.d.ts:10186](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10186) + +Apply the plugin + +#### Parameters + +##### compiler + +[`Compiler`](Compiler.md) + +#### Returns + +`void` diff --git a/api/classes/ManifestPlugin.md b/api/classes/ManifestPlugin.md new file mode 100644 index 0000000..5bc3933 --- /dev/null +++ b/api/classes/ManifestPlugin.md @@ -0,0 +1,55 @@ +--- +title: ManifestPlugin +--- + +[webpack](../globals.md) / ManifestPlugin + +# Class: ManifestPlugin + +Defined in: [webpack/types.d.ts:10426](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10426) + +## Constructors + +### Constructor + +> **new ManifestPlugin**(`options?`): `ManifestPlugin` + +Defined in: [webpack/types.d.ts:10427](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10427) + +#### Parameters + +##### options? + +`ManifestPluginOptions` + +#### Returns + +`ManifestPlugin` + +## Properties + +### options + +> **options**: `ManifestPluginOptions` + +Defined in: [webpack/types.d.ts:10428](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10428) + +## Methods + +### apply() + +> **apply**(`compiler`): `void` + +Defined in: [webpack/types.d.ts:10433](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10433) + +Apply the plugin + +#### Parameters + +##### compiler + +[`Compiler`](Compiler.md) + +#### Returns + +`void` diff --git a/api/classes/Module.md b/api/classes/Module.md new file mode 100644 index 0000000..1ff9a8e --- /dev/null +++ b/api/classes/Module.md @@ -0,0 +1,1393 @@ +--- +title: Module +--- + +[webpack](../globals.md) / Module + +# Class: Module + +Defined in: [webpack/types.d.ts:10629](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10629) + +## Extends + +- `DependenciesBlock` + +## Extended by + +- [`ExternalModule`](ExternalModule.md) +- [`NormalModule`](NormalModule.md) +- [`RuntimeModule`](RuntimeModule.md) + +## Constructors + +### Constructor + +> **new Module**(`type`, `context?`, `layer?`): `Module` + +Defined in: [webpack/types.d.ts:10630](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10630) + +#### Parameters + +##### type + +`string` + +##### context? + +`string` + +##### layer? + +`string` + +#### Returns + +`Module` + +#### Overrides + +`DependenciesBlock.constructor` + +## Properties + +### blocks + +> **blocks**: [`AsyncDependenciesBlock`](AsyncDependenciesBlock.md)[] + +Defined in: [webpack/types.d.ts:4110](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4110) + +#### Inherited from + +`DependenciesBlock.blocks` + +*** + +### buildInfo? + +> `optional` **buildInfo**: `BuildInfo` + +Defined in: [webpack/types.d.ts:10642](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10642) + +*** + +### buildMeta? + +> `optional` **buildMeta**: `BuildMeta` + +Defined in: [webpack/types.d.ts:10641](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10641) + +*** + +### codeGenerationDependencies? + +> `optional` **codeGenerationDependencies**: [`Dependency`](Dependency.md)[] + +Defined in: [webpack/types.d.ts:10644](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10644) + +*** + +### context + +> **context**: `string` + +Defined in: [webpack/types.d.ts:10632](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10632) + +*** + +### debugId + +> **debugId**: `number` + +Defined in: [webpack/types.d.ts:10635](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10635) + +*** + +### dependencies + +> **dependencies**: [`Dependency`](Dependency.md)[] + +Defined in: [webpack/types.d.ts:4109](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4109) + +#### Inherited from + +`DependenciesBlock.dependencies` + +*** + +### depth + +> **depth**: `number` + +Defined in: [webpack/types.d.ts:10655](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10655) + +*** + +### factoryMeta? + +> `optional` **factoryMeta**: `FactoryMeta` + +Defined in: [webpack/types.d.ts:10637](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10637) + +*** + +### hot + +> **hot**: `boolean` + +Defined in: [webpack/types.d.ts:10640](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10640) + +*** + +### ~~id~~ + +> **id**: `string` \| `number` + +Defined in: [webpack/types.d.ts:10649](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10649) + +#### Deprecated + +*** + +### index + +> **index**: `number` + +Defined in: [webpack/types.d.ts:10653](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10653) + +*** + +### index2 + +> **index2**: `number` + +Defined in: [webpack/types.d.ts:10654](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10654) + +*** + +### issuer? + +> `optional` **issuer**: `Module` + +Defined in: [webpack/types.d.ts:10656](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10656) + +*** + +### layer + +> **layer**: `string` + +Defined in: [webpack/types.d.ts:10633](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10633) + +*** + +### needId + +> **needId**: `boolean` + +Defined in: [webpack/types.d.ts:10634](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10634) + +*** + +### parent? + +> `optional` **parent**: `DependenciesBlock` + +Defined in: [webpack/types.d.ts:4111](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4111) + +#### Inherited from + +`DependenciesBlock.parent` + +*** + +### presentationalDependencies? + +> `optional` **presentationalDependencies**: [`Dependency`](Dependency.md)[] + +Defined in: [webpack/types.d.ts:10643](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10643) + +*** + +### profile? + +> `optional` **profile**: `ModuleProfile` + +Defined in: [webpack/types.d.ts:10652](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10652) + +*** + +### resolveOptions? + +> `optional` **resolveOptions**: [`ResolveOptions`](../interfaces/ResolveOptions.md) + +Defined in: [webpack/types.d.ts:10636](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10636) + +*** + +### type + +> **type**: `string` + +Defined in: [webpack/types.d.ts:10631](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10631) + +*** + +### used + +> **used**: `any` + +Defined in: [webpack/types.d.ts:10790](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10790) + +*** + +### useSimpleSourceMap + +> **useSimpleSourceMap**: `boolean` + +Defined in: [webpack/types.d.ts:10639](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10639) + +*** + +### useSourceMap + +> **useSourceMap**: `boolean` + +Defined in: [webpack/types.d.ts:10638](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10638) + +## Accessors + +### chunksIterable + +#### Get Signature + +> **get** **chunksIterable**(): `Iterable`\<[`Chunk`](Chunk.md)\> + +Defined in: [webpack/types.d.ts:10673](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10673) + +##### Returns + +`Iterable`\<[`Chunk`](Chunk.md)\> + +*** + +### errors + +#### Get Signature + +> **get** **errors**(): `any` + +Defined in: [webpack/types.d.ts:10788](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10788) + +##### Returns + +`any` + +*** + +### exportsArgument + +#### Get Signature + +> **get** **exportsArgument**(): `string` + +Defined in: [webpack/types.d.ts:10675](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10675) + +##### Returns + +`string` + +*** + +### hasEqualsChunks + +#### Get Signature + +> **get** **hasEqualsChunks**(): `any` + +Defined in: [webpack/types.d.ts:10786](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10786) + +##### Returns + +`any` + +*** + +### hash + +#### Get Signature + +> **get** **hash**(): `string` + +Defined in: [webpack/types.d.ts:10650](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10650) + +##### Returns + +`string` + +*** + +### isUsed + +#### Get Signature + +> **get** **isUsed**(): `any` + +Defined in: [webpack/types.d.ts:10787](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10787) + +##### Returns + +`any` + +*** + +### moduleArgument + +#### Get Signature + +> **get** **moduleArgument**(): `string` + +Defined in: [webpack/types.d.ts:10676](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10676) + +##### Returns + +`string` + +*** + +### optimizationBailout + +#### Get Signature + +> **get** **optimizationBailout**(): (`string` \| (`requestShortener`) => `string`)[] + +Defined in: [webpack/types.d.ts:10662](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10662) + +##### Deprecated + +##### Returns + +(`string` \| (`requestShortener`) => `string`)[] + +*** + +### optional + +#### Get Signature + +> **get** **optional**(): `boolean` + +Defined in: [webpack/types.d.ts:10666](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10666) + +##### Returns + +`boolean` + +*** + +### renderedHash + +#### Get Signature + +> **get** **renderedHash**(): `string` + +Defined in: [webpack/types.d.ts:10651](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10651) + +##### Returns + +`string` + +*** + +### usedExports + +#### Get Signature + +> **get** **usedExports**(): `boolean` \| `SortableSet`\<`string`\> + +Defined in: [webpack/types.d.ts:10657](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10657) + +##### Returns + +`boolean` \| `SortableSet`\<`string`\> + +*** + +### warnings + +#### Get Signature + +> **get** **warnings**(): `any` + +Defined in: [webpack/types.d.ts:10789](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10789) + +##### Returns + +`any` + +## Methods + +### addBlock() + +> **addBlock**(`block`): `void` + +Defined in: [webpack/types.d.ts:4118](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4118) + +Adds a DependencyBlock to DependencyBlock relationship. +This is used for when a Module has a AsyncDependencyBlock tie (for code-splitting) + +#### Parameters + +##### block + +[`AsyncDependenciesBlock`](AsyncDependenciesBlock.md) + +#### Returns + +`void` + +#### Inherited from + +`DependenciesBlock.addBlock` + +*** + +### addCacheDependencies() + +> **addCacheDependencies**(`fileDependencies`, `contextDependencies`, `missingDependencies`, `buildDependencies`): `void` + +Defined in: [webpack/types.d.ts:10780](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10780) + +#### Parameters + +##### fileDependencies + +[`LazySet`](../webpack/namespaces/export=/namespaces/util/classes/LazySet.md)\<`string`\> + +##### contextDependencies + +[`LazySet`](../webpack/namespaces/export=/namespaces/util/classes/LazySet.md)\<`string`\> + +##### missingDependencies + +[`LazySet`](../webpack/namespaces/export=/namespaces/util/classes/LazySet.md)\<`string`\> + +##### buildDependencies + +[`LazySet`](../webpack/namespaces/export=/namespaces/util/classes/LazySet.md)\<`string`\> + +#### Returns + +`void` + +*** + +### addChunk() + +> **addChunk**(`chunk`): `boolean` + +Defined in: [webpack/types.d.ts:10667](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10667) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +#### Returns + +`boolean` + +*** + +### addCodeGenerationDependency() + +> **addCodeGenerationDependency**(`codeGenerationDependency`): `void` + +Defined in: [webpack/types.d.ts:10679](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10679) + +#### Parameters + +##### codeGenerationDependency + +[`Dependency`](Dependency.md) + +#### Returns + +`void` + +*** + +### addDependency() + +> **addDependency**(`dependency`): `void` + +Defined in: [webpack/types.d.ts:4119](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4119) + +#### Parameters + +##### dependency + +[`Dependency`](Dependency.md) + +#### Returns + +`void` + +#### Inherited from + +`DependenciesBlock.addDependency` + +*** + +### addError() + +> **addError**(`error`): `void` + +Defined in: [webpack/types.d.ts:10683](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10683) + +#### Parameters + +##### error + +[`WebpackError`](WebpackError.md) + +#### Returns + +`void` + +*** + +### addPresentationalDependency() + +> **addPresentationalDependency**(`presentationalDependency`): `void` + +Defined in: [webpack/types.d.ts:10678](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10678) + +#### Parameters + +##### presentationalDependency + +[`Dependency`](Dependency.md) + +#### Returns + +`void` + +*** + +### addWarning() + +> **addWarning**(`warning`): `void` + +Defined in: [webpack/types.d.ts:10680](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10680) + +#### Parameters + +##### warning + +[`WebpackError`](WebpackError.md) + +#### Returns + +`void` + +*** + +### build() + +> **build**(`options`, `compilation`, `resolver`, `fs`, `callback`): `void` + +Defined in: [webpack/types.d.ts:10724](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10724) + +#### Parameters + +##### options + +`WebpackOptionsNormalizedWithDefaults` + +##### compilation + +[`Compilation`](Compilation.md) + +##### resolver + +`ResolverWithOptions` + +##### fs + +[`InputFileSystem`](../interfaces/InputFileSystem.md) + +##### callback + +(`err?`) => `void` + +#### Returns + +`void` + +*** + +### chunkCondition() + +> **chunkCondition**(`chunk`, `compilation`): `boolean` + +Defined in: [webpack/types.d.ts:10759](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10759) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +##### compilation + +[`Compilation`](Compilation.md) + +#### Returns + +`boolean` + +*** + +### cleanupForCache() + +> **cleanupForCache**(): `void` + +Defined in: [webpack/types.d.ts:10778](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10778) + +Assuming this module is in the cache. Remove internal references to allow freeing some memory. + +#### Returns + +`void` + +*** + +### clearDependenciesAndBlocks() + +> **clearDependenciesAndBlocks**(): `void` + +Defined in: [webpack/types.d.ts:4125](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4125) + +Removes all dependencies and blocks + +#### Returns + +`void` + +#### Inherited from + +`DependenciesBlock.clearDependenciesAndBlocks` + +*** + +### clearWarningsAndErrors() + +> **clearWarningsAndErrors**(): `void` + +Defined in: [webpack/types.d.ts:10690](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10690) + +removes all warnings and errors + +#### Returns + +`void` + +*** + +### codeGeneration() + +> **codeGeneration**(`context`): `CodeGenerationResult` + +Defined in: [webpack/types.d.ts:10758](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10758) + +#### Parameters + +##### context + +`CodeGenerationContext` + +#### Returns + +`CodeGenerationResult` + +*** + +### deserialize() + +> **deserialize**(`__namedParameters`): `void` + +Defined in: [webpack/types.d.ts:4128](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4128) + +#### Parameters + +##### \_\_namedParameters + +[`ObjectDeserializerContext`](../interfaces/ObjectDeserializerContext.md) + +#### Returns + +`void` + +#### Inherited from + +`DependenciesBlock.deserialize` + +*** + +### getChunks() + +> **getChunks**(): [`Chunk`](Chunk.md)[] + +Defined in: [webpack/types.d.ts:10671](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10671) + +#### Returns + +[`Chunk`](Chunk.md)[] + +*** + +### getConcatenationBailoutReason() + +> **getConcatenationBailoutReason**(`context`): `string` + +Defined in: [webpack/types.d.ts:10754](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10754) + +#### Parameters + +##### context + +`ConcatenationBailoutReasonContext` + +#### Returns + +`string` + +*** + +### getErrors() + +> **getErrors**(): `Iterable`\<[`WebpackError`](WebpackError.md), `any`, `any`\> + +Defined in: [webpack/types.d.ts:10684](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10684) + +#### Returns + +`Iterable`\<[`WebpackError`](WebpackError.md), `any`, `any`\> + +*** + +### getExportsType() + +> **getExportsType**(`moduleGraph`, `strict?`): `ExportsType` + +Defined in: [webpack/types.d.ts:10677](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10677) + +#### Parameters + +##### moduleGraph + +[`ModuleGraph`](ModuleGraph.md) + +##### strict? + +`boolean` + +#### Returns + +`ExportsType` + +*** + +### getNumberOfChunks() + +> **getNumberOfChunks**(): `number` + +Defined in: [webpack/types.d.ts:10672](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10672) + +#### Returns + +`number` + +*** + +### getNumberOfErrors() + +> **getNumberOfErrors**(): `number` + +Defined in: [webpack/types.d.ts:10685](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10685) + +#### Returns + +`number` + +*** + +### getNumberOfWarnings() + +> **getNumberOfWarnings**(): `number` + +Defined in: [webpack/types.d.ts:10682](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10682) + +#### Returns + +`number` + +*** + +### getRootBlock() + +> **getRootBlock**(): `DependenciesBlock` + +Defined in: [webpack/types.d.ts:4112](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4112) + +#### Returns + +`DependenciesBlock` + +#### Inherited from + +`DependenciesBlock.getRootBlock` + +*** + +### getSideEffectsConnectionState() + +> **getSideEffectsConnectionState**(`moduleGraph`): `ConnectionState` + +Defined in: [webpack/types.d.ts:10757](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10757) + +#### Parameters + +##### moduleGraph + +[`ModuleGraph`](ModuleGraph.md) + +#### Returns + +`ConnectionState` + +*** + +### getSourceBasicTypes() + +> **getSourceBasicTypes**(): `ReadonlySet`\<`string`\> + +Defined in: [webpack/types.d.ts:10740](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10740) + +Basic source types are high-level categories like javascript, css, webassembly, etc. +We only have built-in knowledge about the javascript basic type here; other basic types may be +added or changed over time by generators and do not need to be handled or detected here. +Some modules, e.g. RemoteModule, may return non-basic source types like "remote" and "share-init" +from getSourceTypes(), but their generated output is still JavaScript, i.e. their basic type is JS. + +#### Returns + +`ReadonlySet`\<`string`\> + +*** + +### getSourceTypes() + +> **getSourceTypes**(): `ReadonlySet`\<`string`\> + +Defined in: [webpack/types.d.ts:10731](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10731) + +#### Returns + +`ReadonlySet`\<`string`\> + +*** + +### getUnsafeCacheData() + +> **getUnsafeCacheData**(): `UnsafeCacheData` + +Defined in: [webpack/types.d.ts:10773](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10773) + +Module should be unsafe cached. Get data that's needed for that. +This data will be passed to restoreFromUnsafeCache later. + +#### Returns + +`UnsafeCacheData` + +*** + +### getWarnings() + +> **getWarnings**(): `Iterable`\<[`WebpackError`](WebpackError.md), `any`, `any`\> + +Defined in: [webpack/types.d.ts:10681](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10681) + +#### Returns + +`Iterable`\<[`WebpackError`](WebpackError.md), `any`, `any`\> + +*** + +### hasChunkCondition() + +> **hasChunkCondition**(): `boolean` + +Defined in: [webpack/types.d.ts:10760](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10760) + +#### Returns + +`boolean` + +*** + +### hasReasonForChunk() + +> **hasReasonForChunk**(`chunk`, `moduleGraph`, `chunkGraph`): `boolean` + +Defined in: [webpack/types.d.ts:10702](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10702) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +##### moduleGraph + +[`ModuleGraph`](ModuleGraph.md) + +##### chunkGraph + +[`ChunkGraph`](ChunkGraph.md) + +#### Returns + +`boolean` + +*** + +### hasReasons() + +> **hasReasons**(`moduleGraph`, `runtime`): `boolean` + +Defined in: [webpack/types.d.ts:10707](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10707) + +#### Parameters + +##### moduleGraph + +[`ModuleGraph`](ModuleGraph.md) + +##### runtime + +`RuntimeSpec` + +#### Returns + +`boolean` + +*** + +### identifier() + +> **identifier**(): `string` + +Defined in: [webpack/types.d.ts:10722](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10722) + +#### Returns + +`string` + +*** + +### invalidateBuild() + +> **invalidateBuild**(): `void` + +Defined in: [webpack/types.d.ts:10721](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10721) + +#### Returns + +`void` + +*** + +### isAccessibleInChunk() + +> **isAccessibleInChunk**(`chunkGraph`, `chunk`, `ignoreChunk?`): `boolean` + +Defined in: [webpack/types.d.ts:10692](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10692) + +#### Parameters + +##### chunkGraph + +[`ChunkGraph`](ChunkGraph.md) + +##### chunk + +[`Chunk`](Chunk.md) + +##### ignoreChunk? + +[`Chunk`](Chunk.md) + +#### Returns + +`boolean` + +*** + +### isAccessibleInChunkGroup() + +> **isAccessibleInChunkGroup**(`chunkGraph`, `chunkGroup`, `ignoreChunk?`): `boolean` + +Defined in: [webpack/types.d.ts:10697](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10697) + +#### Parameters + +##### chunkGraph + +[`ChunkGraph`](ChunkGraph.md) + +##### chunkGroup + +[`ChunkGroup`](ChunkGroup.md) + +##### ignoreChunk? + +[`Chunk`](Chunk.md) + +#### Returns + +`boolean` + +*** + +### isEntryModule() + +> **isEntryModule**(): `boolean` + +Defined in: [webpack/types.d.ts:10670](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10670) + +#### Returns + +`boolean` + +*** + +### isInChunk() + +> **isInChunk**(`chunk`): `boolean` + +Defined in: [webpack/types.d.ts:10669](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10669) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +#### Returns + +`boolean` + +*** + +### isOptional() + +> **isOptional**(`moduleGraph`): `boolean` + +Defined in: [webpack/types.d.ts:10691](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10691) + +#### Parameters + +##### moduleGraph + +[`ModuleGraph`](ModuleGraph.md) + +#### Returns + +`boolean` + +*** + +### isProvided() + +> **isProvided**(`exportName`): `boolean` + +Defined in: [webpack/types.d.ts:10674](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10674) + +#### Parameters + +##### exportName + +`string` + +#### Returns + +`boolean` + +*** + +### libIdent() + +> **libIdent**(`options`): `string` + +Defined in: [webpack/types.d.ts:10752](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10752) + +#### Parameters + +##### options + +`LibIdentOptions` + +#### Returns + +`string` + +*** + +### nameForCondition() + +> **nameForCondition**(): `string` + +Defined in: [webpack/types.d.ts:10753](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10753) + +#### Returns + +`string` + +*** + +### needBuild() + +> **needBuild**(`context`, `callback`): `void` + +Defined in: [webpack/types.d.ts:10708](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10708) + +#### Parameters + +##### context + +`NeedBuildContext` + +##### callback + +(`err?`, `needBuild?`) => `void` + +#### Returns + +`void` + +*** + +### ~~needRebuild()~~ + +> **needRebuild**(`fileTimestamps`, `contextTimestamps`): `boolean` + +Defined in: [webpack/types.d.ts:10717](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10717) + +Use needBuild instead + +#### Parameters + +##### fileTimestamps + +`Map`\<`string`, `number`\> + +##### contextTimestamps + +`Map`\<`string`, `number`\> + +#### Returns + +`boolean` + +#### Deprecated + +*** + +### originalSource() + +> **originalSource**(): [`Source`](../webpack/namespaces/export=/namespaces/sources/classes/Source.md) + +Defined in: [webpack/types.d.ts:10779](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10779) + +#### Returns + +[`Source`](../webpack/namespaces/export=/namespaces/sources/classes/Source.md) + +*** + +### readableIdentifier() + +> **readableIdentifier**(`requestShortener`): `string` + +Defined in: [webpack/types.d.ts:10723](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10723) + +#### Parameters + +##### requestShortener + +`RequestShortener` + +#### Returns + +`string` + +*** + +### removeChunk() + +> **removeChunk**(`chunk`): `void` + +Defined in: [webpack/types.d.ts:10668](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10668) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +#### Returns + +`void` + +*** + +### removeDependency() + +> **removeDependency**(`dependency`): `void` + +Defined in: [webpack/types.d.ts:4120](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4120) + +#### Parameters + +##### dependency + +[`Dependency`](Dependency.md) + +#### Returns + +`void` + +#### Inherited from + +`DependenciesBlock.removeDependency` + +*** + +### serialize() + +> **serialize**(`__namedParameters`): `void` + +Defined in: [webpack/types.d.ts:4127](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4127) + +#### Parameters + +##### \_\_namedParameters + +[`ObjectSerializerContext`](../interfaces/ObjectSerializerContext.md) + +#### Returns + +`void` + +#### Inherited from + +`DependenciesBlock.serialize` + +*** + +### size() + +> **size**(`type?`): `number` + +Defined in: [webpack/types.d.ts:10751](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10751) + +#### Parameters + +##### type? + +`string` + +#### Returns + +`number` + +*** + +### ~~source()~~ + +> **source**(`dependencyTemplates`, `runtimeTemplate`, `type?`): [`Source`](../webpack/namespaces/export=/namespaces/sources/classes/Source.md) + +Defined in: [webpack/types.d.ts:10746](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10746) + +Use codeGeneration() instead + +#### Parameters + +##### dependencyTemplates + +`DependencyTemplates` + +##### runtimeTemplate + +`RuntimeTemplate` + +##### type? + +`string` + +#### Returns + +[`Source`](../webpack/namespaces/export=/namespaces/sources/classes/Source.md) + +#### Deprecated + +*** + +### updateCacheModule() + +> **updateCacheModule**(`module`): `void` + +Defined in: [webpack/types.d.ts:10767](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10767) + +Assuming this module is in the cache. Update the (cached) module with +the fresh module from the factory. Usually updates internal references +and properties. + +#### Parameters + +##### module + +`Module` + +#### Returns + +`void` + +*** + +### updateHash() + +> **updateHash**(`hash`, `context`): `void` + +Defined in: [webpack/types.d.ts:4126](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4126) + +#### Parameters + +##### hash + +`Hash` + +##### context + +`UpdateHashContextDependency` + +#### Returns + +`void` + +#### Inherited from + +`DependenciesBlock.updateHash` diff --git a/api/classes/ModuleFactory.md b/api/classes/ModuleFactory.md new file mode 100644 index 0000000..9ad8735 --- /dev/null +++ b/api/classes/ModuleFactory.md @@ -0,0 +1,43 @@ +--- +title: ModuleFactory +--- + +[webpack](../globals.md) / ModuleFactory + +# Class: ModuleFactory + +Defined in: [webpack/types.d.ts:10864](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10864) + +## Constructors + +### Constructor + +> **new ModuleFactory**(): `ModuleFactory` + +Defined in: [webpack/types.d.ts:10865](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10865) + +#### Returns + +`ModuleFactory` + +## Methods + +### create() + +> **create**(`data`, `callback`): `void` + +Defined in: [webpack/types.d.ts:10866](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10866) + +#### Parameters + +##### data + +`ModuleFactoryCreateData` + +##### callback + +(`err?`, `result?`) => `void` + +#### Returns + +`void` diff --git a/api/classes/ModuleGraph.md b/api/classes/ModuleGraph.md new file mode 100644 index 0000000..0d88645 --- /dev/null +++ b/api/classes/ModuleGraph.md @@ -0,0 +1,1257 @@ +--- +title: ModuleGraph +--- + +[webpack](../globals.md) / ModuleGraph + +# Class: ModuleGraph + +Defined in: [webpack/types.d.ts:11063](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11063) + +## Constructors + +### Constructor + +> **new ModuleGraph**(): `ModuleGraph` + +Defined in: [webpack/types.d.ts:11064](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11064) + +#### Returns + +`ModuleGraph` + +## Properties + +### ModuleGraphConnection + +> `static` **ModuleGraphConnection**: *typeof* [`ModuleGraphConnection`](ModuleGraphConnection.md) + +Defined in: [webpack/types.d.ts:11193](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11193) + +## Methods + +### addExplanation() + +> **addExplanation**(`dependency`, `explanation`): `void` + +Defined in: [webpack/types.d.ts:11088](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11088) + +#### Parameters + +##### dependency + +[`Dependency`](Dependency.md) + +##### explanation + +`string` + +#### Returns + +`void` + +*** + +### addExtraReason() + +> **addExtraReason**(`module`, `explanation`): `void` + +Defined in: [webpack/types.d.ts:11102](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11102) + +#### Parameters + +##### module + +[`Module`](Module.md) + +##### explanation + +`string` + +#### Returns + +`void` + +*** + +### cached() + +> **cached**\<`T`, `R`\>(`fn`, ...`args`): `R` + +Defined in: [webpack/types.d.ts:11157](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11157) + +#### Type Parameters + +##### T + +`T` *extends* `any`[] + +##### R + +`R` + +#### Parameters + +##### fn + +(`moduleGraph`, ...`args`) => `R` + +##### args + +...`T` + +#### Returns + +`R` + +*** + +### cloneModuleAttributes() + +> **cloneModuleAttributes**(`sourceModule`, `targetModule`): `void` + +Defined in: [webpack/types.d.ts:11089](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11089) + +#### Parameters + +##### sourceModule + +[`Module`](Module.md) + +##### targetModule + +[`Module`](Module.md) + +#### Returns + +`void` + +*** + +### copyOutgoingModuleConnections() + +> **copyOutgoingModuleConnections**(`oldModule`, `newModule`, `filterConnection`): `void` + +Defined in: [webpack/types.d.ts:11097](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11097) + +#### Parameters + +##### oldModule + +[`Module`](Module.md) + +##### newModule + +[`Module`](Module.md) + +##### filterConnection + +(`moduleGraphConnection`) => `boolean` + +#### Returns + +`void` + +*** + +### dependencyCacheProvide() + +> **dependencyCacheProvide**\<`D`, `ARGS`, `R`\>(`dependency`, ...`args`): `R` + +Defined in: [webpack/types.d.ts:11164](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11164) + +#### Type Parameters + +##### D + +`D` *extends* [`Dependency`](Dependency.md) + +##### ARGS + +`ARGS` *extends* `any`[] + +##### R + +`R` + +#### Parameters + +##### dependency + +`D` + +##### args + +...\[`ARGS`, `...((moduleGraph: ModuleGraph, dependency: D, args: ARGS) => R)[]`\] + +#### Returns + +`R` + +*** + +### finishUpdateParent() + +> **finishUpdateParent**(): `void` + +Defined in: [webpack/types.d.ts:11086](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11086) + +#### Returns + +`void` + +*** + +### freeze() + +> **freeze**(`cacheStage?`): `void` + +Defined in: [webpack/types.d.ts:11155](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11155) + +#### Parameters + +##### cacheStage? + +`string` + +#### Returns + +`void` + +*** + +### getConnection() + +> **getConnection**(`dependency`): [`ModuleGraphConnection`](ModuleGraphConnection.md) + +Defined in: [webpack/types.d.ts:11104](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11104) + +#### Parameters + +##### dependency + +[`Dependency`](Dependency.md) + +#### Returns + +[`ModuleGraphConnection`](ModuleGraphConnection.md) + +*** + +### getDepth() + +> **getDepth**(`module`): `number` + +Defined in: [webpack/types.d.ts:11147](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11147) + +#### Parameters + +##### module + +[`Module`](Module.md) + +#### Returns + +`number` + +*** + +### getExportInfo() + +> **getExportInfo**(`module`, `exportName`): `ExportInfo` + +Defined in: [webpack/types.d.ts:11135](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11135) + +#### Parameters + +##### module + +[`Module`](Module.md) + +##### exportName + +`string` + +#### Returns + +`ExportInfo` + +*** + +### getExportsInfo() + +> **getExportsInfo**(`module`): `ExportsInfo` + +Defined in: [webpack/types.d.ts:11134](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11134) + +#### Parameters + +##### module + +[`Module`](Module.md) + +#### Returns + +`ExportsInfo` + +*** + +### getIncomingConnections() + +> **getIncomingConnections**(`module`): `Iterable`\<[`ModuleGraphConnection`](ModuleGraphConnection.md)\> + +Defined in: [webpack/types.d.ts:11108](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11108) + +#### Parameters + +##### module + +[`Module`](Module.md) + +#### Returns + +`Iterable`\<[`ModuleGraphConnection`](ModuleGraphConnection.md)\> + +*** + +### getIncomingConnectionsByOriginModule() + +> **getIncomingConnectionsByOriginModule**(`module`): `ReadonlyMap`\<[`Module`](Module.md), readonly [`ModuleGraphConnection`](ModuleGraphConnection.md)[]\> + +Defined in: [webpack/types.d.ts:11110](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11110) + +#### Parameters + +##### module + +[`Module`](Module.md) + +#### Returns + +`ReadonlyMap`\<[`Module`](Module.md), readonly [`ModuleGraphConnection`](ModuleGraphConnection.md)[]\> + +*** + +### getIssuer() + +> **getIssuer**(`module`): [`Module`](Module.md) + +Defined in: [webpack/types.d.ts:11123](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11123) + +#### Parameters + +##### module + +[`Module`](Module.md) + +#### Returns + +[`Module`](Module.md) + +*** + +### getMeta() + +> **getMeta**(`thing`): `Meta` + +Defined in: [webpack/types.d.ts:11153](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11153) + +#### Parameters + +##### thing + +`object` + +#### Returns + +`Meta` + +*** + +### getMetaIfExisting() + +> **getMetaIfExisting**(`thing`): `Meta` + +Defined in: [webpack/types.d.ts:11154](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11154) + +#### Parameters + +##### thing + +`object` + +#### Returns + +`Meta` + +*** + +### getModule() + +> **getModule**(`dependency`): [`Module`](Module.md) + +Defined in: [webpack/types.d.ts:11105](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11105) + +#### Parameters + +##### dependency + +[`Dependency`](Dependency.md) + +#### Returns + +[`Module`](Module.md) + +*** + +### getOptimizationBailout() + +> **getOptimizationBailout**(`module`): (`string` \| (`requestShortener`) => `string`)[] + +Defined in: [webpack/types.d.ts:11126](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11126) + +#### Parameters + +##### module + +[`Module`](Module.md) + +#### Returns + +(`string` \| (`requestShortener`) => `string`)[] + +*** + +### getOrigin() + +> **getOrigin**(`dependency`): [`Module`](Module.md) + +Defined in: [webpack/types.d.ts:11106](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11106) + +#### Parameters + +##### dependency + +[`Dependency`](Dependency.md) + +#### Returns + +[`Module`](Module.md) + +*** + +### getOutgoingConnections() + +> **getOutgoingConnections**(`module`): `Iterable`\<[`ModuleGraphConnection`](ModuleGraphConnection.md)\> + +Defined in: [webpack/types.d.ts:11109](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11109) + +#### Parameters + +##### module + +[`Module`](Module.md) + +#### Returns + +`Iterable`\<[`ModuleGraphConnection`](ModuleGraphConnection.md)\> + +*** + +### getOutgoingConnectionsByModule() + +> **getOutgoingConnectionsByModule**(`module`): `ReadonlyMap`\<[`Module`](Module.md), readonly [`ModuleGraphConnection`](ModuleGraphConnection.md)[]\> + +Defined in: [webpack/types.d.ts:11116](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11116) + +#### Parameters + +##### module + +[`Module`](Module.md) + +#### Returns + +`ReadonlyMap`\<[`Module`](Module.md), readonly [`ModuleGraphConnection`](ModuleGraphConnection.md)[]\> + +*** + +### getParentBlock() + +> **getParentBlock**(`dependency`): `DependenciesBlock` + +Defined in: [webpack/types.d.ts:11073](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11073) + +#### Parameters + +##### dependency + +[`Dependency`](Dependency.md) + +#### Returns + +`DependenciesBlock` + +*** + +### getParentBlockIndex() + +> **getParentBlockIndex**(`dependency`): `number` + +Defined in: [webpack/types.d.ts:11074](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11074) + +#### Parameters + +##### dependency + +[`Dependency`](Dependency.md) + +#### Returns + +`number` + +*** + +### getParentModule() + +> **getParentModule**(`dependency`): [`Module`](Module.md) + +Defined in: [webpack/types.d.ts:11072](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11072) + +#### Parameters + +##### dependency + +[`Dependency`](Dependency.md) + +#### Returns + +[`Module`](Module.md) + +*** + +### getPostOrderIndex() + +> **getPostOrderIndex**(`module`): `number` + +Defined in: [webpack/types.d.ts:11142](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11142) + +#### Parameters + +##### module + +[`Module`](Module.md) + +#### Returns + +`number` + +*** + +### getPreOrderIndex() + +> **getPreOrderIndex**(`module`): `number` + +Defined in: [webpack/types.d.ts:11141](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11141) + +#### Parameters + +##### module + +[`Module`](Module.md) + +#### Returns + +`number` + +*** + +### getProfile() + +> **getProfile**(`module`): `ModuleProfile` + +Defined in: [webpack/types.d.ts:11121](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11121) + +#### Parameters + +##### module + +[`Module`](Module.md) + +#### Returns + +`ModuleProfile` + +*** + +### getProvidedExports() + +> **getProvidedExports**(`module`): `true` \| `string`[] + +Defined in: [webpack/types.d.ts:11129](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11129) + +#### Parameters + +##### module + +[`Module`](Module.md) + +#### Returns + +`true` \| `string`[] + +*** + +### getReadOnlyExportInfo() + +> **getReadOnlyExportInfo**(`module`, `exportName`): `ExportInfo` + +Defined in: [webpack/types.d.ts:11136](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11136) + +#### Parameters + +##### module + +[`Module`](Module.md) + +##### exportName + +`string` + +#### Returns + +`ExportInfo` + +*** + +### getResolvedModule() + +> **getResolvedModule**(`dependency`): [`Module`](Module.md) + +Defined in: [webpack/types.d.ts:11103](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11103) + +#### Parameters + +##### dependency + +[`Dependency`](Dependency.md) + +#### Returns + +[`Module`](Module.md) + +*** + +### getResolvedOrigin() + +> **getResolvedOrigin**(`dependency`): [`Module`](Module.md) + +Defined in: [webpack/types.d.ts:11107](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11107) + +#### Parameters + +##### dependency + +[`Dependency`](Dependency.md) + +#### Returns + +[`Module`](Module.md) + +*** + +### getUsedExports() + +> **getUsedExports**(`module`, `runtime`): `boolean` \| `SortableSet`\<`string`\> + +Defined in: [webpack/types.d.ts:11137](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11137) + +#### Parameters + +##### module + +[`Module`](Module.md) + +##### runtime + +`RuntimeSpec` + +#### Returns + +`boolean` \| `SortableSet`\<`string`\> + +*** + +### isAsync() + +> **isAsync**(`module`): `boolean` + +Defined in: [webpack/types.d.ts:11150](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11150) + +#### Parameters + +##### module + +[`Module`](Module.md) + +#### Returns + +`boolean` + +*** + +### isDeferred() + +> **isDeferred**(`module`): `boolean` + +Defined in: [webpack/types.d.ts:11151](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11151) + +#### Parameters + +##### module + +[`Module`](Module.md) + +#### Returns + +`boolean` + +*** + +### isExportProvided() + +> **isExportProvided**(`module`, `exportName`): `boolean` + +Defined in: [webpack/types.d.ts:11130](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11130) + +#### Parameters + +##### module + +[`Module`](Module.md) + +##### exportName + +`string` | `string`[] + +#### Returns + +`boolean` + +*** + +### moveModuleConnections() + +> **moveModuleConnections**(`oldModule`, `newModule`, `filterConnection`): `void` + +Defined in: [webpack/types.d.ts:11092](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11092) + +#### Parameters + +##### oldModule + +[`Module`](Module.md) + +##### newModule + +[`Module`](Module.md) + +##### filterConnection + +(`moduleGraphConnection`) => `boolean` + +#### Returns + +`void` + +*** + +### removeAllModuleAttributes() + +> **removeAllModuleAttributes**(): `void` + +Defined in: [webpack/types.d.ts:11091](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11091) + +#### Returns + +`void` + +*** + +### removeConnection() + +> **removeConnection**(`dependency`): `void` + +Defined in: [webpack/types.d.ts:11087](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11087) + +#### Parameters + +##### dependency + +[`Dependency`](Dependency.md) + +#### Returns + +`void` + +*** + +### removeModuleAttributes() + +> **removeModuleAttributes**(`module`): `void` + +Defined in: [webpack/types.d.ts:11090](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11090) + +#### Parameters + +##### module + +[`Module`](Module.md) + +#### Returns + +`void` + +*** + +### setAsync() + +> **setAsync**(`module`): `void` + +Defined in: [webpack/types.d.ts:11152](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11152) + +#### Parameters + +##### module + +[`Module`](Module.md) + +#### Returns + +`void` + +*** + +### setDepth() + +> **setDepth**(`module`, `depth`): `void` + +Defined in: [webpack/types.d.ts:11148](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11148) + +#### Parameters + +##### module + +[`Module`](Module.md) + +##### depth + +`number` + +#### Returns + +`void` + +*** + +### setDepthIfLower() + +> **setDepthIfLower**(`module`, `depth`): `boolean` + +Defined in: [webpack/types.d.ts:11149](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11149) + +#### Parameters + +##### module + +[`Module`](Module.md) + +##### depth + +`number` + +#### Returns + +`boolean` + +*** + +### setIssuer() + +> **setIssuer**(`module`, `issuer`): `void` + +Defined in: [webpack/types.d.ts:11124](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11124) + +#### Parameters + +##### module + +[`Module`](Module.md) + +##### issuer + +[`Module`](Module.md) + +#### Returns + +`void` + +*** + +### setIssuerIfUnset() + +> **setIssuerIfUnset**(`module`, `issuer`): `void` + +Defined in: [webpack/types.d.ts:11125](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11125) + +#### Parameters + +##### module + +[`Module`](Module.md) + +##### issuer + +[`Module`](Module.md) + +#### Returns + +`void` + +*** + +### setModuleMemCaches() + +> **setModuleMemCaches**(`moduleMemCaches`): `void` + +Defined in: [webpack/types.d.ts:11161](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11161) + +#### Parameters + +##### moduleMemCaches + +`Map`\<[`Module`](Module.md), `WeakTupleMap`\<`any`[], `any`\>\> + +#### Returns + +`void` + +*** + +### setParentDependenciesBlockIndex() + +> **setParentDependenciesBlockIndex**(`dependency`, `index`): `void` + +Defined in: [webpack/types.d.ts:11071](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11071) + +#### Parameters + +##### dependency + +[`Dependency`](Dependency.md) + +##### index + +`number` + +#### Returns + +`void` + +*** + +### setParents() + +> **setParents**(`dependency`, `block`, `module`, `indexInBlock?`): `void` + +Defined in: [webpack/types.d.ts:11065](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11065) + +#### Parameters + +##### dependency + +[`Dependency`](Dependency.md) + +##### block + +`DependenciesBlock` + +##### module + +[`Module`](Module.md) + +##### indexInBlock? + +`number` + +#### Returns + +`void` + +*** + +### setPostOrderIndex() + +> **setPostOrderIndex**(`module`, `index`): `void` + +Defined in: [webpack/types.d.ts:11145](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11145) + +#### Parameters + +##### module + +[`Module`](Module.md) + +##### index + +`number` + +#### Returns + +`void` + +*** + +### setPostOrderIndexIfUnset() + +> **setPostOrderIndexIfUnset**(`module`, `index`): `boolean` + +Defined in: [webpack/types.d.ts:11146](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11146) + +#### Parameters + +##### module + +[`Module`](Module.md) + +##### index + +`number` + +#### Returns + +`boolean` + +*** + +### setPreOrderIndex() + +> **setPreOrderIndex**(`module`, `index`): `void` + +Defined in: [webpack/types.d.ts:11143](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11143) + +#### Parameters + +##### module + +[`Module`](Module.md) + +##### index + +`number` + +#### Returns + +`void` + +*** + +### setPreOrderIndexIfUnset() + +> **setPreOrderIndexIfUnset**(`module`, `index`): `boolean` + +Defined in: [webpack/types.d.ts:11144](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11144) + +#### Parameters + +##### module + +[`Module`](Module.md) + +##### index + +`number` + +#### Returns + +`boolean` + +*** + +### setProfile() + +> **setProfile**(`module`, `profile?`): `void` + +Defined in: [webpack/types.d.ts:11122](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11122) + +#### Parameters + +##### module + +[`Module`](Module.md) + +##### profile? + +`ModuleProfile` + +#### Returns + +`void` + +*** + +### setResolvedModule() + +> **setResolvedModule**(`originModule`, `dependency`, `module`): `void` + +Defined in: [webpack/types.d.ts:11075](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11075) + +#### Parameters + +##### originModule + +[`Module`](Module.md) + +##### dependency + +[`Dependency`](Dependency.md) + +##### module + +[`Module`](Module.md) + +#### Returns + +`void` + +*** + +### unfreeze() + +> **unfreeze**(): `void` + +Defined in: [webpack/types.d.ts:11156](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11156) + +#### Returns + +`void` + +*** + +### updateModule() + +> **updateModule**(`dependency`, `module`): `void` + +Defined in: [webpack/types.d.ts:11080](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11080) + +#### Parameters + +##### dependency + +[`Dependency`](Dependency.md) + +##### module + +[`Module`](Module.md) + +#### Returns + +`void` + +*** + +### updateParent() + +> **updateParent**(`dependency`, `connection?`, `parentModule?`): `void` + +Defined in: [webpack/types.d.ts:11081](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11081) + +#### Parameters + +##### dependency + +[`Dependency`](Dependency.md) + +##### connection? + +[`ModuleGraphConnection`](ModuleGraphConnection.md) + +##### parentModule? + +[`Module`](Module.md) + +#### Returns + +`void` + +*** + +### ~~clearModuleGraphForModule()~~ + +> `static` **clearModuleGraphForModule**(`module`): `void` + +Defined in: [webpack/types.d.ts:11192](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11192) + +#### Parameters + +##### module + +[`Module`](Module.md) + +#### Returns + +`void` + +#### Deprecated + +*** + +### ~~getModuleGraphForModule()~~ + +> `static` **getModuleGraphForModule**(`module`, `deprecateMessage`, `deprecationCode`): `ModuleGraph` + +Defined in: [webpack/types.d.ts:11175](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11175) + +#### Parameters + +##### module + +[`Module`](Module.md) + +##### deprecateMessage + +`string` + +##### deprecationCode + +`string` + +#### Returns + +`ModuleGraph` + +#### Deprecated + +*** + +### ~~setModuleGraphForModule()~~ + +> `static` **setModuleGraphForModule**(`module`, `moduleGraph`): `void` + +Defined in: [webpack/types.d.ts:11184](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11184) + +#### Parameters + +##### module + +[`Module`](Module.md) + +##### moduleGraph + +`ModuleGraph` + +#### Returns + +`void` + +#### Deprecated diff --git a/api/classes/ModuleGraphConnection.md b/api/classes/ModuleGraphConnection.md new file mode 100644 index 0000000..9ab707b --- /dev/null +++ b/api/classes/ModuleGraphConnection.md @@ -0,0 +1,291 @@ +--- +title: ModuleGraphConnection +--- + +[webpack](../globals.md) / ModuleGraphConnection + +# Class: ModuleGraphConnection + +Defined in: [webpack/types.d.ts:11195](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11195) + +## Constructors + +### Constructor + +> **new ModuleGraphConnection**(`originModule`, `dependency`, `module`, `explanation?`, `weak?`, `condition?`): `ModuleGraphConnection` + +Defined in: [webpack/types.d.ts:11196](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11196) + +#### Parameters + +##### originModule + +[`Module`](Module.md) + +##### dependency + +[`Dependency`](Dependency.md) + +##### module + +[`Module`](Module.md) + +##### explanation? + +`string` + +##### weak? + +`boolean` + +##### condition? + +`false` | (`moduleGraphConnection`, `runtime`) => `ConnectionState` + +#### Returns + +`ModuleGraphConnection` + +## Properties + +### condition? + +> `optional` **condition**: `false` \| (`moduleGraphConnection`, `runtime`) => `ConnectionState` + +Defined in: [webpack/types.d.ts:11217](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11217) + +*** + +### conditional + +> **conditional**: `boolean` + +Defined in: [webpack/types.d.ts:11216](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11216) + +*** + +### dependency + +> **dependency**: [`Dependency`](Dependency.md) + +Defined in: [webpack/types.d.ts:11212](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11212) + +*** + +### explanations? + +> `optional` **explanations**: `Set`\<`string`\> + +Defined in: [webpack/types.d.ts:11224](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11224) + +*** + +### module + +> **module**: [`Module`](Module.md) + +Defined in: [webpack/types.d.ts:11214](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11214) + +*** + +### originModule + +> **originModule**: [`Module`](Module.md) + +Defined in: [webpack/types.d.ts:11210](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11210) + +*** + +### resolvedModule + +> **resolvedModule**: [`Module`](Module.md) + +Defined in: [webpack/types.d.ts:11213](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11213) + +*** + +### resolvedOriginModule + +> **resolvedOriginModule**: [`Module`](Module.md) + +Defined in: [webpack/types.d.ts:11211](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11211) + +*** + +### weak? + +> `optional` **weak**: `boolean` + +Defined in: [webpack/types.d.ts:11215](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11215) + +*** + +### addConnectionStates() + +> `static` **addConnectionStates**: (`a`, `b`) => `ConnectionState` + +Defined in: [webpack/types.d.ts:11240](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11240) + +#### Parameters + +##### a + +`ConnectionState` + +##### b + +`ConnectionState` + +#### Returns + +`ConnectionState` + +*** + +### CIRCULAR\_CONNECTION + +> `static` **CIRCULAR\_CONNECTION**: *typeof* `CIRCULAR_CONNECTION` + +Defined in: [webpack/types.d.ts:11238](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11238) + +*** + +### TRANSITIVE\_ONLY + +> `static` **TRANSITIVE\_ONLY**: *typeof* `TRANSITIVE_ONLY` + +Defined in: [webpack/types.d.ts:11239](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11239) + +## Accessors + +### explanation + +#### Get Signature + +> **get** **explanation**(): `string` + +Defined in: [webpack/types.d.ts:11233](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11233) + +##### Returns + +`string` + +## Methods + +### addCondition() + +> **addCondition**(`condition`): `void` + +Defined in: [webpack/types.d.ts:11226](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11226) + +#### Parameters + +##### condition + +(`moduleGraphConnection`, `runtime`) => `ConnectionState` + +#### Returns + +`void` + +*** + +### addExplanation() + +> **addExplanation**(`explanation`): `void` + +Defined in: [webpack/types.d.ts:11232](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11232) + +#### Parameters + +##### explanation + +`string` + +#### Returns + +`void` + +*** + +### clone() + +> **clone**(): `ModuleGraphConnection` + +Defined in: [webpack/types.d.ts:11225](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11225) + +#### Returns + +`ModuleGraphConnection` + +*** + +### getActiveState() + +> **getActiveState**(`runtime`): `ConnectionState` + +Defined in: [webpack/types.d.ts:11236](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11236) + +#### Parameters + +##### runtime + +`RuntimeSpec` + +#### Returns + +`ConnectionState` + +*** + +### isActive() + +> **isActive**(`runtime`): `boolean` + +Defined in: [webpack/types.d.ts:11234](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11234) + +#### Parameters + +##### runtime + +`RuntimeSpec` + +#### Returns + +`boolean` + +*** + +### isTargetActive() + +> **isTargetActive**(`runtime`): `boolean` + +Defined in: [webpack/types.d.ts:11235](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11235) + +#### Parameters + +##### runtime + +`RuntimeSpec` + +#### Returns + +`boolean` + +*** + +### setActive() + +> **setActive**(`value`): `void` + +Defined in: [webpack/types.d.ts:11237](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11237) + +#### Parameters + +##### value + +`boolean` + +#### Returns + +`void` diff --git a/api/classes/MultiCompiler.md b/api/classes/MultiCompiler.md new file mode 100644 index 0000000..ddb1402 --- /dev/null +++ b/api/classes/MultiCompiler.md @@ -0,0 +1,281 @@ +--- +title: MultiCompiler +--- + +[webpack](../globals.md) / MultiCompiler + +# Class: MultiCompiler + +Defined in: [webpack/types.d.ts:11642](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11642) + +## Constructors + +### Constructor + +> **new MultiCompiler**(`compilers`, `options`): `MultiCompiler` + +Defined in: [webpack/types.d.ts:11643](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11643) + +#### Parameters + +##### compilers + +`Record`\<`string`, [`Compiler`](Compiler.md)\> | [`Compiler`](Compiler.md)[] + +##### options + +[`MultiCompilerOptions`](../interfaces/MultiCompilerOptions.md) + +#### Returns + +`MultiCompiler` + +## Properties + +### compilers + +> **compilers**: [`Compiler`](Compiler.md)[] + +Defined in: [webpack/types.d.ts:11657](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11657) + +*** + +### dependencies + +> **dependencies**: `WeakMap`\<[`Compiler`](Compiler.md), `string`[]\> + +Defined in: [webpack/types.d.ts:11658](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11658) + +*** + +### hooks + +> **hooks**: `Readonly`\<\{ `done`: `SyncHook`\<\[[`MultiStats`](MultiStats.md)\]\>; `infrastructureLog`: `MultiHook`\<`SyncBailHook`\<\[`string`, `string`, `undefined` \| `any`[]\], `true` \| `void`\>\>; `invalid`: `MultiHook`\<`SyncHook`\<\[`null` \| `string`, `number`\]\>\>; `run`: `MultiHook`\<`AsyncSeriesHook`\<\[[`Compiler`](Compiler.md)\]\>\>; `watchClose`: `SyncHook`\<\[\]\>; `watchRun`: `MultiHook`\<`AsyncSeriesHook`\<\[[`Compiler`](Compiler.md)\]\>\>; \}\> + +Defined in: [webpack/types.d.ts:11647](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11647) + +*** + +### inputFileSystem + +> **inputFileSystem**: [`InputFileSystem`](../interfaces/InputFileSystem.md) + +Defined in: [webpack/types.d.ts:11662](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11662) + +*** + +### intermediateFileSystem + +> **intermediateFileSystem**: `IntermediateFileSystem` + +Defined in: [webpack/types.d.ts:11665](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11665) + +*** + +### outputFileSystem + +> **outputFileSystem**: [`OutputFileSystem`](../interfaces/OutputFileSystem.md) + +Defined in: [webpack/types.d.ts:11663](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11663) + +*** + +### running + +> **running**: `boolean` + +Defined in: [webpack/types.d.ts:11659](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11659) + +*** + +### watchFileSystem + +> **watchFileSystem**: `WatchFileSystem` + +Defined in: [webpack/types.d.ts:11664](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11664) + +## Accessors + +### options + +#### Get Signature + +> **get** **options**(): [`WebpackOptionsNormalized`](../interfaces/WebpackOptionsNormalized.md)[] & [`MultiCompilerOptions`](../interfaces/MultiCompilerOptions.md) + +Defined in: [webpack/types.d.ts:11660](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11660) + +##### Returns + +[`WebpackOptionsNormalized`](../interfaces/WebpackOptionsNormalized.md)[] & [`MultiCompilerOptions`](../interfaces/MultiCompilerOptions.md) + +*** + +### outputPath + +#### Get Signature + +> **get** **outputPath**(): `string` + +Defined in: [webpack/types.d.ts:11661](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11661) + +##### Returns + +`string` + +## Methods + +### close() + +> **close**(`callback`): `void` + +Defined in: [webpack/types.d.ts:11690](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11690) + +#### Parameters + +##### callback + +(`err`, `result?`) => `void` + +#### Returns + +`void` + +*** + +### getInfrastructureLogger() + +> **getInfrastructureLogger**(`name`): `WebpackLogger` + +Defined in: [webpack/types.d.ts:11666](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11666) + +#### Parameters + +##### name + +`string` | () => `string` + +#### Returns + +`WebpackLogger` + +*** + +### purgeInputFileSystem() + +> **purgeInputFileSystem**(): `void` + +Defined in: [webpack/types.d.ts:11689](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11689) + +#### Returns + +`void` + +*** + +### run() + +> **run**(`callback`): `void` + +Defined in: [webpack/types.d.ts:11688](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11688) + +#### Parameters + +##### callback + +`CallbackWebpackFunction_2`\<[`MultiStats`](MultiStats.md), `void`\> + +#### Returns + +`void` + +*** + +### ~~runWithDependencies()~~ + +> **runWithDependencies**(`compilers`, `fn`, `callback`): `void` + +Defined in: [webpack/types.d.ts:11676](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11676) + +This method should have been private + +#### Parameters + +##### compilers + +[`Compiler`](Compiler.md)[] + +##### fn + +(`compiler`, `callback`) => `void` + +##### callback + +`CallbackWebpackFunction_2`\<[`Stats`](Stats.md)[], `void`\> + +#### Returns + +`void` + +#### Deprecated + +*** + +### setDependencies() + +> **setDependencies**(`compiler`, `dependencies`): `void` + +Defined in: [webpack/types.d.ts:11667](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11667) + +#### Parameters + +##### compiler + +[`Compiler`](Compiler.md) + +##### dependencies + +`string`[] + +#### Returns + +`void` + +*** + +### validateDependencies() + +> **validateDependencies**(`callback`): `boolean` + +Defined in: [webpack/types.d.ts:11668](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11668) + +#### Parameters + +##### callback + +`CallbackWebpackFunction_2`\<[`MultiStats`](MultiStats.md), `void`\> + +#### Returns + +`boolean` + +*** + +### watch() + +> **watch**(`watchOptions`, `handler`): `MultiWatching` + +Defined in: [webpack/types.d.ts:11684](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11684) + +#### Parameters + +##### watchOptions + +`WatchOptions` | `WatchOptions`[] + +##### handler + +`CallbackWebpackFunction_2`\<[`MultiStats`](MultiStats.md), `void`\> + +#### Returns + +`MultiWatching` diff --git a/api/classes/MultiStats.md b/api/classes/MultiStats.md new file mode 100644 index 0000000..6696124 --- /dev/null +++ b/api/classes/MultiStats.md @@ -0,0 +1,101 @@ +--- +title: MultiStats +--- + +[webpack](../globals.md) / MultiStats + +# Abstract Class: MultiStats + +Defined in: [webpack/types.d.ts:11699](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11699) + +## Constructors + +### Constructor + +> **new MultiStats**(): `MultiStats` + +#### Returns + +`MultiStats` + +## Properties + +### stats + +> **stats**: [`Stats`](Stats.md)[] + +Defined in: [webpack/types.d.ts:11700](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11700) + +## Accessors + +### hash + +#### Get Signature + +> **get** **hash**(): `string` + +Defined in: [webpack/types.d.ts:11701](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11701) + +##### Returns + +`string` + +## Methods + +### hasErrors() + +> **hasErrors**(): `boolean` + +Defined in: [webpack/types.d.ts:11702](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11702) + +#### Returns + +`boolean` + +*** + +### hasWarnings() + +> **hasWarnings**(): `boolean` + +Defined in: [webpack/types.d.ts:11703](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11703) + +#### Returns + +`boolean` + +*** + +### toJson() + +> **toJson**(`options?`): [`StatsCompilation`](../type-aliases/StatsCompilation.md) + +Defined in: [webpack/types.d.ts:11704](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11704) + +#### Parameters + +##### options? + +`boolean` | `"none"` | `"normal"` | `"summary"` | `"verbose"` | `"errors-only"` | `"errors-warnings"` | `"minimal"` | `"detailed"` | [`StatsOptions`](../interfaces/StatsOptions.md) + +#### Returns + +[`StatsCompilation`](../type-aliases/StatsCompilation.md) + +*** + +### toString() + +> **toString**(`options?`): `string` + +Defined in: [webpack/types.d.ts:11717](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11717) + +#### Parameters + +##### options? + +`boolean` | `"none"` | `"normal"` | `"summary"` | `"verbose"` | `"errors-only"` | `"errors-warnings"` | `"minimal"` | `"detailed"` | [`StatsOptions`](../interfaces/StatsOptions.md) + +#### Returns + +`string` diff --git a/api/classes/NoEmitOnErrorsPlugin.md b/api/classes/NoEmitOnErrorsPlugin.md new file mode 100644 index 0000000..bbbcc52 --- /dev/null +++ b/api/classes/NoEmitOnErrorsPlugin.md @@ -0,0 +1,41 @@ +--- +title: NoEmitOnErrorsPlugin +--- + +[webpack](../globals.md) / NoEmitOnErrorsPlugin + +# Class: NoEmitOnErrorsPlugin + +Defined in: [webpack/types.d.ts:11790](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11790) + +## Constructors + +### Constructor + +> **new NoEmitOnErrorsPlugin**(): `NoEmitOnErrorsPlugin` + +Defined in: [webpack/types.d.ts:11791](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11791) + +#### Returns + +`NoEmitOnErrorsPlugin` + +## Methods + +### apply() + +> **apply**(`compiler`): `void` + +Defined in: [webpack/types.d.ts:11796](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11796) + +Apply the plugin + +#### Parameters + +##### compiler + +[`Compiler`](Compiler.md) + +#### Returns + +`void` diff --git a/api/classes/NormalModule.md b/api/classes/NormalModule.md new file mode 100644 index 0000000..72d863f --- /dev/null +++ b/api/classes/NormalModule.md @@ -0,0 +1,2019 @@ +--- +title: NormalModule +--- + +[webpack](../globals.md) / NormalModule + +# Class: NormalModule + +Defined in: [webpack/types.d.ts:11866](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11866) + +## Extends + +- [`Module`](Module.md) + +## Constructors + +### Constructor + +> **new NormalModule**(`__namedParameters`): `NormalModule` + +Defined in: [webpack/types.d.ts:11867](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11867) + +#### Parameters + +##### \_\_namedParameters + +`NormalModuleCreateData` + +#### Returns + +`NormalModule` + +#### Overrides + +[`Module`](Module.md).[`constructor`](Module.md#constructor) + +## Properties + +### binary + +> **binary**: `boolean` + +Defined in: [webpack/types.d.ts:11871](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11871) + +*** + +### blocks + +> **blocks**: [`AsyncDependenciesBlock`](AsyncDependenciesBlock.md)[] + +Defined in: [webpack/types.d.ts:4110](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4110) + +#### Inherited from + +[`Module`](Module.md).[`blocks`](Module.md#blocks) + +*** + +### buildInfo? + +> `optional` **buildInfo**: `BuildInfo` + +Defined in: [webpack/types.d.ts:10642](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10642) + +#### Inherited from + +[`Module`](Module.md).[`buildInfo`](Module.md#buildinfo) + +*** + +### buildMeta? + +> `optional` **buildMeta**: `BuildMeta` + +Defined in: [webpack/types.d.ts:10641](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10641) + +#### Inherited from + +[`Module`](Module.md).[`buildMeta`](Module.md#buildmeta) + +*** + +### codeGenerationDependencies? + +> `optional` **codeGenerationDependencies**: [`Dependency`](Dependency.md)[] + +Defined in: [webpack/types.d.ts:10644](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10644) + +#### Inherited from + +[`Module`](Module.md).[`codeGenerationDependencies`](Module.md#codegenerationdependencies) + +*** + +### context + +> **context**: `string` + +Defined in: [webpack/types.d.ts:10632](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10632) + +#### Inherited from + +[`Module`](Module.md).[`context`](Module.md#context) + +*** + +### debugId + +> **debugId**: `number` + +Defined in: [webpack/types.d.ts:10635](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10635) + +#### Inherited from + +[`Module`](Module.md).[`debugId`](Module.md#debugid) + +*** + +### dependencies + +> **dependencies**: [`Dependency`](Dependency.md)[] + +Defined in: [webpack/types.d.ts:4109](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4109) + +#### Inherited from + +[`Module`](Module.md).[`dependencies`](Module.md#dependencies) + +*** + +### depth + +> **depth**: `number` + +Defined in: [webpack/types.d.ts:10655](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10655) + +#### Inherited from + +[`Module`](Module.md).[`depth`](Module.md#depth) + +*** + +### error + +> **error**: [`WebpackError`](WebpackError.md) + +Defined in: [webpack/types.d.ts:11881](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11881) + +*** + +### extractSourceMap + +> **extractSourceMap**: `boolean` + +Defined in: [webpack/types.d.ts:11880](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11880) + +*** + +### factoryMeta? + +> `optional` **factoryMeta**: `FactoryMeta` + +Defined in: [webpack/types.d.ts:10637](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10637) + +#### Inherited from + +[`Module`](Module.md).[`factoryMeta`](Module.md#factorymeta) + +*** + +### generator? + +> `optional` **generator**: [`Generator`](Generator.md) + +Defined in: [webpack/types.d.ts:11874](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11874) + +*** + +### generatorOptions? + +> `optional` **generatorOptions**: `GeneratorOptions` + +Defined in: [webpack/types.d.ts:11875](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11875) + +*** + +### hot + +> **hot**: `boolean` + +Defined in: [webpack/types.d.ts:10640](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10640) + +#### Inherited from + +[`Module`](Module.md).[`hot`](Module.md#hot) + +*** + +### ~~id~~ + +> **id**: `string` \| `number` + +Defined in: [webpack/types.d.ts:10649](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10649) + +#### Deprecated + +#### Inherited from + +[`Module`](Module.md).[`id`](Module.md#id) + +*** + +### index + +> **index**: `number` + +Defined in: [webpack/types.d.ts:10653](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10653) + +#### Inherited from + +[`Module`](Module.md).[`index`](Module.md#index) + +*** + +### index2 + +> **index2**: `number` + +Defined in: [webpack/types.d.ts:10654](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10654) + +#### Inherited from + +[`Module`](Module.md).[`index2`](Module.md#index2) + +*** + +### issuer? + +> `optional` **issuer**: [`Module`](Module.md) + +Defined in: [webpack/types.d.ts:10656](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10656) + +#### Inherited from + +[`Module`](Module.md).[`issuer`](Module.md#issuer) + +*** + +### layer + +> **layer**: `string` + +Defined in: [webpack/types.d.ts:10633](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10633) + +#### Inherited from + +[`Module`](Module.md).[`layer`](Module.md#layer) + +*** + +### loaders + +> **loaders**: `LoaderItem`[] + +Defined in: [webpack/types.d.ts:11879](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11879) + +*** + +### matchResource? + +> `optional` **matchResource**: `string` + +Defined in: [webpack/types.d.ts:11878](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11878) + +*** + +### needId + +> **needId**: `boolean` + +Defined in: [webpack/types.d.ts:10634](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10634) + +#### Inherited from + +[`Module`](Module.md).[`needId`](Module.md#needid) + +*** + +### parent? + +> `optional` **parent**: `DependenciesBlock` + +Defined in: [webpack/types.d.ts:4111](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4111) + +#### Inherited from + +[`Module`](Module.md).[`parent`](Module.md#parent) + +*** + +### parser? + +> `optional` **parser**: [`Parser`](Parser.md) + +Defined in: [webpack/types.d.ts:11872](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11872) + +*** + +### parserOptions? + +> `optional` **parserOptions**: `ParserOptions` + +Defined in: [webpack/types.d.ts:11873](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11873) + +*** + +### presentationalDependencies? + +> `optional` **presentationalDependencies**: [`Dependency`](Dependency.md)[] + +Defined in: [webpack/types.d.ts:10643](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10643) + +#### Inherited from + +[`Module`](Module.md).[`presentationalDependencies`](Module.md#presentationaldependencies) + +*** + +### profile? + +> `optional` **profile**: `ModuleProfile` + +Defined in: [webpack/types.d.ts:10652](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10652) + +#### Inherited from + +[`Module`](Module.md).[`profile`](Module.md#profile) + +*** + +### rawRequest + +> **rawRequest**: `string` + +Defined in: [webpack/types.d.ts:11870](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11870) + +*** + +### request + +> **request**: `string` + +Defined in: [webpack/types.d.ts:11868](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11868) + +*** + +### resolveOptions? + +> `optional` **resolveOptions**: [`ResolveOptions`](../interfaces/ResolveOptions.md) + +Defined in: [webpack/types.d.ts:10636](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10636) + +#### Inherited from + +[`Module`](Module.md).[`resolveOptions`](Module.md#resolveoptions) + +*** + +### resource + +> **resource**: `string` + +Defined in: [webpack/types.d.ts:11876](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11876) + +*** + +### resourceResolveData? + +> `optional` **resourceResolveData**: `ResourceSchemeData` & `Partial`\<`ResolveRequest`\> + +Defined in: [webpack/types.d.ts:11877](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11877) + +*** + +### type + +> **type**: `string` + +Defined in: [webpack/types.d.ts:10631](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10631) + +#### Inherited from + +[`Module`](Module.md).[`type`](Module.md#type) + +*** + +### used + +> **used**: `any` + +Defined in: [webpack/types.d.ts:10790](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10790) + +#### Inherited from + +[`Module`](Module.md).[`used`](Module.md#used) + +*** + +### userRequest + +> **userRequest**: `string` + +Defined in: [webpack/types.d.ts:11869](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11869) + +*** + +### useSimpleSourceMap + +> **useSimpleSourceMap**: `boolean` + +Defined in: [webpack/types.d.ts:10639](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10639) + +#### Inherited from + +[`Module`](Module.md).[`useSimpleSourceMap`](Module.md#usesimplesourcemap) + +*** + +### useSourceMap + +> **useSourceMap**: `boolean` + +Defined in: [webpack/types.d.ts:10638](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10638) + +#### Inherited from + +[`Module`](Module.md).[`useSourceMap`](Module.md#usesourcemap) + +## Accessors + +### chunksIterable + +#### Get Signature + +> **get** **chunksIterable**(): `Iterable`\<[`Chunk`](Chunk.md)\> + +Defined in: [webpack/types.d.ts:10673](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10673) + +##### Returns + +`Iterable`\<[`Chunk`](Chunk.md)\> + +#### Inherited from + +[`Module`](Module.md).[`chunksIterable`](Module.md#chunksiterable) + +*** + +### errors + +#### Get Signature + +> **get** **errors**(): `any` + +Defined in: [webpack/types.d.ts:10788](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10788) + +##### Returns + +`any` + +#### Inherited from + +[`Module`](Module.md).[`errors`](Module.md#errors) + +*** + +### exportsArgument + +#### Get Signature + +> **get** **exportsArgument**(): `string` + +Defined in: [webpack/types.d.ts:10675](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10675) + +##### Returns + +`string` + +#### Inherited from + +[`Module`](Module.md).[`exportsArgument`](Module.md#exportsargument) + +*** + +### hasEqualsChunks + +#### Get Signature + +> **get** **hasEqualsChunks**(): `any` + +Defined in: [webpack/types.d.ts:10786](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10786) + +##### Returns + +`any` + +#### Inherited from + +[`Module`](Module.md).[`hasEqualsChunks`](Module.md#hasequalschunks) + +*** + +### hash + +#### Get Signature + +> **get** **hash**(): `string` + +Defined in: [webpack/types.d.ts:10650](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10650) + +##### Returns + +`string` + +#### Inherited from + +[`Module`](Module.md).[`hash`](Module.md#hash) + +*** + +### isUsed + +#### Get Signature + +> **get** **isUsed**(): `any` + +Defined in: [webpack/types.d.ts:10787](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10787) + +##### Returns + +`any` + +#### Inherited from + +[`Module`](Module.md).[`isUsed`](Module.md#isused) + +*** + +### moduleArgument + +#### Get Signature + +> **get** **moduleArgument**(): `string` + +Defined in: [webpack/types.d.ts:10676](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10676) + +##### Returns + +`string` + +#### Inherited from + +[`Module`](Module.md).[`moduleArgument`](Module.md#moduleargument) + +*** + +### optimizationBailout + +#### Get Signature + +> **get** **optimizationBailout**(): (`string` \| (`requestShortener`) => `string`)[] + +Defined in: [webpack/types.d.ts:10662](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10662) + +##### Deprecated + +##### Returns + +(`string` \| (`requestShortener`) => `string`)[] + +#### Inherited from + +[`Module`](Module.md).[`optimizationBailout`](Module.md#optimizationbailout) + +*** + +### optional + +#### Get Signature + +> **get** **optional**(): `boolean` + +Defined in: [webpack/types.d.ts:10666](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10666) + +##### Returns + +`boolean` + +#### Inherited from + +[`Module`](Module.md).[`optional`](Module.md#optional) + +*** + +### renderedHash + +#### Get Signature + +> **get** **renderedHash**(): `string` + +Defined in: [webpack/types.d.ts:10651](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10651) + +##### Returns + +`string` + +#### Inherited from + +[`Module`](Module.md).[`renderedHash`](Module.md#renderedhash) + +*** + +### usedExports + +#### Get Signature + +> **get** **usedExports**(): `boolean` \| `SortableSet`\<`string`\> + +Defined in: [webpack/types.d.ts:10657](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10657) + +##### Returns + +`boolean` \| `SortableSet`\<`string`\> + +#### Inherited from + +[`Module`](Module.md).[`usedExports`](Module.md#usedexports) + +*** + +### warnings + +#### Get Signature + +> **get** **warnings**(): `any` + +Defined in: [webpack/types.d.ts:10789](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10789) + +##### Returns + +`any` + +#### Inherited from + +[`Module`](Module.md).[`warnings`](Module.md#warnings) + +## Methods + +### addBlock() + +> **addBlock**(`block`): `void` + +Defined in: [webpack/types.d.ts:4118](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4118) + +Adds a DependencyBlock to DependencyBlock relationship. +This is used for when a Module has a AsyncDependencyBlock tie (for code-splitting) + +#### Parameters + +##### block + +[`AsyncDependenciesBlock`](AsyncDependenciesBlock.md) + +#### Returns + +`void` + +#### Inherited from + +[`Module`](Module.md).[`addBlock`](Module.md#addblock) + +*** + +### addCacheDependencies() + +> **addCacheDependencies**(`fileDependencies`, `contextDependencies`, `missingDependencies`, `buildDependencies`): `void` + +Defined in: [webpack/types.d.ts:10780](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10780) + +#### Parameters + +##### fileDependencies + +[`LazySet`](../webpack/namespaces/export=/namespaces/util/classes/LazySet.md)\<`string`\> + +##### contextDependencies + +[`LazySet`](../webpack/namespaces/export=/namespaces/util/classes/LazySet.md)\<`string`\> + +##### missingDependencies + +[`LazySet`](../webpack/namespaces/export=/namespaces/util/classes/LazySet.md)\<`string`\> + +##### buildDependencies + +[`LazySet`](../webpack/namespaces/export=/namespaces/util/classes/LazySet.md)\<`string`\> + +#### Returns + +`void` + +#### Inherited from + +[`Module`](Module.md).[`addCacheDependencies`](Module.md#addcachedependencies) + +*** + +### addChunk() + +> **addChunk**(`chunk`): `boolean` + +Defined in: [webpack/types.d.ts:10667](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10667) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`Module`](Module.md).[`addChunk`](Module.md#addchunk) + +*** + +### addCodeGenerationDependency() + +> **addCodeGenerationDependency**(`codeGenerationDependency`): `void` + +Defined in: [webpack/types.d.ts:10679](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10679) + +#### Parameters + +##### codeGenerationDependency + +[`Dependency`](Dependency.md) + +#### Returns + +`void` + +#### Inherited from + +[`Module`](Module.md).[`addCodeGenerationDependency`](Module.md#addcodegenerationdependency) + +*** + +### addDependency() + +> **addDependency**(`dependency`): `void` + +Defined in: [webpack/types.d.ts:4119](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4119) + +#### Parameters + +##### dependency + +[`Dependency`](Dependency.md) + +#### Returns + +`void` + +#### Inherited from + +[`Module`](Module.md).[`addDependency`](Module.md#adddependency) + +*** + +### addError() + +> **addError**(`error`): `void` + +Defined in: [webpack/types.d.ts:10683](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10683) + +#### Parameters + +##### error + +[`WebpackError`](WebpackError.md) + +#### Returns + +`void` + +#### Inherited from + +[`Module`](Module.md).[`addError`](Module.md#adderror) + +*** + +### addPresentationalDependency() + +> **addPresentationalDependency**(`presentationalDependency`): `void` + +Defined in: [webpack/types.d.ts:10678](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10678) + +#### Parameters + +##### presentationalDependency + +[`Dependency`](Dependency.md) + +#### Returns + +`void` + +#### Inherited from + +[`Module`](Module.md).[`addPresentationalDependency`](Module.md#addpresentationaldependency) + +*** + +### addWarning() + +> **addWarning**(`warning`): `void` + +Defined in: [webpack/types.d.ts:10680](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10680) + +#### Parameters + +##### warning + +[`WebpackError`](WebpackError.md) + +#### Returns + +`void` + +#### Inherited from + +[`Module`](Module.md).[`addWarning`](Module.md#addwarning) + +*** + +### applyNoParseRule() + +> **applyNoParseRule**(`rule`, `content`): `boolean` + +Defined in: [webpack/types.d.ts:11909](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11909) + +#### Parameters + +##### rule + +`string` | `RegExp` | (`content`) => `boolean` + +##### content + +`string` + +#### Returns + +`boolean` + +*** + +### build() + +> **build**(`options`, `compilation`, `resolver`, `fs`, `callback`): `void` + +Defined in: [webpack/types.d.ts:10724](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10724) + +#### Parameters + +##### options + +`WebpackOptionsNormalizedWithDefaults` + +##### compilation + +[`Compilation`](Compilation.md) + +##### resolver + +`ResolverWithOptions` + +##### fs + +[`InputFileSystem`](../interfaces/InputFileSystem.md) + +##### callback + +(`err?`) => `void` + +#### Returns + +`void` + +#### Inherited from + +[`Module`](Module.md).[`build`](Module.md#build) + +*** + +### chunkCondition() + +> **chunkCondition**(`chunk`, `compilation`): `boolean` + +Defined in: [webpack/types.d.ts:10759](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10759) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +##### compilation + +[`Compilation`](Compilation.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`Module`](Module.md).[`chunkCondition`](Module.md#chunkcondition) + +*** + +### cleanupForCache() + +> **cleanupForCache**(): `void` + +Defined in: [webpack/types.d.ts:10778](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10778) + +Assuming this module is in the cache. Remove internal references to allow freeing some memory. + +#### Returns + +`void` + +#### Inherited from + +[`Module`](Module.md).[`cleanupForCache`](Module.md#cleanupforcache) + +*** + +### clearDependenciesAndBlocks() + +> **clearDependenciesAndBlocks**(): `void` + +Defined in: [webpack/types.d.ts:4125](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4125) + +Removes all dependencies and blocks + +#### Returns + +`void` + +#### Inherited from + +[`Module`](Module.md).[`clearDependenciesAndBlocks`](Module.md#cleardependenciesandblocks) + +*** + +### clearWarningsAndErrors() + +> **clearWarningsAndErrors**(): `void` + +Defined in: [webpack/types.d.ts:10690](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10690) + +removes all warnings and errors + +#### Returns + +`void` + +#### Inherited from + +[`Module`](Module.md).[`clearWarningsAndErrors`](Module.md#clearwarningsanderrors) + +*** + +### codeGeneration() + +> **codeGeneration**(`context`): `CodeGenerationResult` + +Defined in: [webpack/types.d.ts:10758](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10758) + +#### Parameters + +##### context + +`CodeGenerationContext` + +#### Returns + +`CodeGenerationResult` + +#### Inherited from + +[`Module`](Module.md).[`codeGeneration`](Module.md#codegeneration) + +*** + +### createSource() + +> **createSource**(`context`, `content`, `sourceMap?`, `associatedObjectForCache?`): [`Source`](../webpack/namespaces/export=/namespaces/sources/classes/Source.md) + +Defined in: [webpack/types.d.ts:11902](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11902) + +#### Parameters + +##### context + +`string` + +##### content + +`string` | `Buffer`\<`ArrayBufferLike`\> + +##### sourceMap? + +`string` | `RawSourceMap` + +##### associatedObjectForCache? + +`object` + +#### Returns + +[`Source`](../webpack/namespaces/export=/namespaces/sources/classes/Source.md) + +*** + +### createSourceForAsset() + +> **createSourceForAsset**(`context`, `name`, `content`, `sourceMap?`, `associatedObjectForCache?`): [`Source`](../webpack/namespaces/export=/namespaces/sources/classes/Source.md) + +Defined in: [webpack/types.d.ts:11891](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11891) + +#### Parameters + +##### context + +`string` + +##### name + +`string` + +##### content + +`string` | `Buffer`\<`ArrayBufferLike`\> + +##### sourceMap? + +`string` | `RawSourceMap` + +##### associatedObjectForCache? + +`object` + +#### Returns + +[`Source`](../webpack/namespaces/export=/namespaces/sources/classes/Source.md) + +*** + +### deserialize() + +> **deserialize**(`__namedParameters`): `void` + +Defined in: [webpack/types.d.ts:4128](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4128) + +#### Parameters + +##### \_\_namedParameters + +[`ObjectDeserializerContext`](../interfaces/ObjectDeserializerContext.md) + +#### Returns + +`void` + +#### Inherited from + +[`Module`](Module.md).[`deserialize`](Module.md#deserialize) + +*** + +### getChunks() + +> **getChunks**(): [`Chunk`](Chunk.md)[] + +Defined in: [webpack/types.d.ts:10671](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10671) + +#### Returns + +[`Chunk`](Chunk.md)[] + +#### Inherited from + +[`Module`](Module.md).[`getChunks`](Module.md#getchunks) + +*** + +### getConcatenationBailoutReason() + +> **getConcatenationBailoutReason**(`context`): `string` + +Defined in: [webpack/types.d.ts:10754](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10754) + +#### Parameters + +##### context + +`ConcatenationBailoutReasonContext` + +#### Returns + +`string` + +#### Inherited from + +[`Module`](Module.md).[`getConcatenationBailoutReason`](Module.md#getconcatenationbailoutreason) + +*** + +### getCurrentLoader() + +> **getCurrentLoader**(`loaderContext`, `index?`): `LoaderItem` + +Defined in: [webpack/types.d.ts:11898](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11898) + +#### Parameters + +##### loaderContext + +`AnyLoaderContext` + +##### index? + +`number` + +#### Returns + +`LoaderItem` + +*** + +### getErrors() + +> **getErrors**(): `Iterable`\<[`WebpackError`](WebpackError.md), `any`, `any`\> + +Defined in: [webpack/types.d.ts:10684](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10684) + +#### Returns + +`Iterable`\<[`WebpackError`](WebpackError.md), `any`, `any`\> + +#### Inherited from + +[`Module`](Module.md).[`getErrors`](Module.md#geterrors) + +*** + +### getExportsType() + +> **getExportsType**(`moduleGraph`, `strict?`): `ExportsType` + +Defined in: [webpack/types.d.ts:10677](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10677) + +#### Parameters + +##### moduleGraph + +[`ModuleGraph`](ModuleGraph.md) + +##### strict? + +`boolean` + +#### Returns + +`ExportsType` + +#### Inherited from + +[`Module`](Module.md).[`getExportsType`](Module.md#getexportstype) + +*** + +### getNumberOfChunks() + +> **getNumberOfChunks**(): `number` + +Defined in: [webpack/types.d.ts:10672](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10672) + +#### Returns + +`number` + +#### Inherited from + +[`Module`](Module.md).[`getNumberOfChunks`](Module.md#getnumberofchunks) + +*** + +### getNumberOfErrors() + +> **getNumberOfErrors**(): `number` + +Defined in: [webpack/types.d.ts:10685](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10685) + +#### Returns + +`number` + +#### Inherited from + +[`Module`](Module.md).[`getNumberOfErrors`](Module.md#getnumberoferrors) + +*** + +### getNumberOfWarnings() + +> **getNumberOfWarnings**(): `number` + +Defined in: [webpack/types.d.ts:10682](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10682) + +#### Returns + +`number` + +#### Inherited from + +[`Module`](Module.md).[`getNumberOfWarnings`](Module.md#getnumberofwarnings) + +*** + +### getResource() + +> **getResource**(): `string` + +Defined in: [webpack/types.d.ts:11882](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11882) + +#### Returns + +`string` + +*** + +### getRootBlock() + +> **getRootBlock**(): `DependenciesBlock` + +Defined in: [webpack/types.d.ts:4112](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4112) + +#### Returns + +`DependenciesBlock` + +#### Inherited from + +[`Module`](Module.md).[`getRootBlock`](Module.md#getrootblock) + +*** + +### getSideEffectsConnectionState() + +> **getSideEffectsConnectionState**(`moduleGraph`): `ConnectionState` + +Defined in: [webpack/types.d.ts:10757](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10757) + +#### Parameters + +##### moduleGraph + +[`ModuleGraph`](ModuleGraph.md) + +#### Returns + +`ConnectionState` + +#### Inherited from + +[`Module`](Module.md).[`getSideEffectsConnectionState`](Module.md#getsideeffectsconnectionstate) + +*** + +### getSourceBasicTypes() + +> **getSourceBasicTypes**(): `ReadonlySet`\<`string`\> + +Defined in: [webpack/types.d.ts:10740](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10740) + +Basic source types are high-level categories like javascript, css, webassembly, etc. +We only have built-in knowledge about the javascript basic type here; other basic types may be +added or changed over time by generators and do not need to be handled or detected here. +Some modules, e.g. RemoteModule, may return non-basic source types like "remote" and "share-init" +from getSourceTypes(), but their generated output is still JavaScript, i.e. their basic type is JS. + +#### Returns + +`ReadonlySet`\<`string`\> + +#### Inherited from + +[`Module`](Module.md).[`getSourceBasicTypes`](Module.md#getsourcebasictypes) + +*** + +### getSourceTypes() + +> **getSourceTypes**(): `ReadonlySet`\<`string`\> + +Defined in: [webpack/types.d.ts:10731](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10731) + +#### Returns + +`ReadonlySet`\<`string`\> + +#### Inherited from + +[`Module`](Module.md).[`getSourceTypes`](Module.md#getsourcetypes) + +*** + +### getUnsafeCacheData() + +> **getUnsafeCacheData**(): `UnsafeCacheData` + +Defined in: [webpack/types.d.ts:10773](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10773) + +Module should be unsafe cached. Get data that's needed for that. +This data will be passed to restoreFromUnsafeCache later. + +#### Returns + +`UnsafeCacheData` + +#### Inherited from + +[`Module`](Module.md).[`getUnsafeCacheData`](Module.md#getunsafecachedata) + +*** + +### getWarnings() + +> **getWarnings**(): `Iterable`\<[`WebpackError`](WebpackError.md), `any`, `any`\> + +Defined in: [webpack/types.d.ts:10681](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10681) + +#### Returns + +`Iterable`\<[`WebpackError`](WebpackError.md), `any`, `any`\> + +#### Inherited from + +[`Module`](Module.md).[`getWarnings`](Module.md#getwarnings) + +*** + +### hasChunkCondition() + +> **hasChunkCondition**(): `boolean` + +Defined in: [webpack/types.d.ts:10760](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10760) + +#### Returns + +`boolean` + +#### Inherited from + +[`Module`](Module.md).[`hasChunkCondition`](Module.md#haschunkcondition) + +*** + +### hasReasonForChunk() + +> **hasReasonForChunk**(`chunk`, `moduleGraph`, `chunkGraph`): `boolean` + +Defined in: [webpack/types.d.ts:10702](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10702) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +##### moduleGraph + +[`ModuleGraph`](ModuleGraph.md) + +##### chunkGraph + +[`ChunkGraph`](ChunkGraph.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`Module`](Module.md).[`hasReasonForChunk`](Module.md#hasreasonforchunk) + +*** + +### hasReasons() + +> **hasReasons**(`moduleGraph`, `runtime`): `boolean` + +Defined in: [webpack/types.d.ts:10707](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10707) + +#### Parameters + +##### moduleGraph + +[`ModuleGraph`](ModuleGraph.md) + +##### runtime + +`RuntimeSpec` + +#### Returns + +`boolean` + +#### Inherited from + +[`Module`](Module.md).[`hasReasons`](Module.md#hasreasons) + +*** + +### identifier() + +> **identifier**(): `string` + +Defined in: [webpack/types.d.ts:10722](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10722) + +#### Returns + +`string` + +#### Inherited from + +[`Module`](Module.md).[`identifier`](Module.md#identifier) + +*** + +### invalidateBuild() + +> **invalidateBuild**(): `void` + +Defined in: [webpack/types.d.ts:10721](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10721) + +#### Returns + +`void` + +#### Inherited from + +[`Module`](Module.md).[`invalidateBuild`](Module.md#invalidatebuild) + +*** + +### isAccessibleInChunk() + +> **isAccessibleInChunk**(`chunkGraph`, `chunk`, `ignoreChunk?`): `boolean` + +Defined in: [webpack/types.d.ts:10692](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10692) + +#### Parameters + +##### chunkGraph + +[`ChunkGraph`](ChunkGraph.md) + +##### chunk + +[`Chunk`](Chunk.md) + +##### ignoreChunk? + +[`Chunk`](Chunk.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`Module`](Module.md).[`isAccessibleInChunk`](Module.md#isaccessibleinchunk) + +*** + +### isAccessibleInChunkGroup() + +> **isAccessibleInChunkGroup**(`chunkGraph`, `chunkGroup`, `ignoreChunk?`): `boolean` + +Defined in: [webpack/types.d.ts:10697](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10697) + +#### Parameters + +##### chunkGraph + +[`ChunkGraph`](ChunkGraph.md) + +##### chunkGroup + +[`ChunkGroup`](ChunkGroup.md) + +##### ignoreChunk? + +[`Chunk`](Chunk.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`Module`](Module.md).[`isAccessibleInChunkGroup`](Module.md#isaccessibleinchunkgroup) + +*** + +### isEntryModule() + +> **isEntryModule**(): `boolean` + +Defined in: [webpack/types.d.ts:10670](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10670) + +#### Returns + +`boolean` + +#### Inherited from + +[`Module`](Module.md).[`isEntryModule`](Module.md#isentrymodule) + +*** + +### isInChunk() + +> **isInChunk**(`chunk`): `boolean` + +Defined in: [webpack/types.d.ts:10669](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10669) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`Module`](Module.md).[`isInChunk`](Module.md#isinchunk) + +*** + +### isOptional() + +> **isOptional**(`moduleGraph`): `boolean` + +Defined in: [webpack/types.d.ts:10691](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10691) + +#### Parameters + +##### moduleGraph + +[`ModuleGraph`](ModuleGraph.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`Module`](Module.md).[`isOptional`](Module.md#isoptional) + +*** + +### isProvided() + +> **isProvided**(`exportName`): `boolean` + +Defined in: [webpack/types.d.ts:10674](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10674) + +#### Parameters + +##### exportName + +`string` + +#### Returns + +`boolean` + +#### Inherited from + +[`Module`](Module.md).[`isProvided`](Module.md#isprovided) + +*** + +### libIdent() + +> **libIdent**(`options`): `string` + +Defined in: [webpack/types.d.ts:10752](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10752) + +#### Parameters + +##### options + +`LibIdentOptions` + +#### Returns + +`string` + +#### Inherited from + +[`Module`](Module.md).[`libIdent`](Module.md#libident) + +*** + +### markModuleAsErrored() + +> **markModuleAsErrored**(`error`): `void` + +Defined in: [webpack/types.d.ts:11908](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11908) + +#### Parameters + +##### error + +[`WebpackError`](WebpackError.md) + +#### Returns + +`void` + +*** + +### nameForCondition() + +> **nameForCondition**(): `string` + +Defined in: [webpack/types.d.ts:10753](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10753) + +#### Returns + +`string` + +#### Inherited from + +[`Module`](Module.md).[`nameForCondition`](Module.md#nameforcondition) + +*** + +### needBuild() + +> **needBuild**(`context`, `callback`): `void` + +Defined in: [webpack/types.d.ts:10708](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10708) + +#### Parameters + +##### context + +`NeedBuildContext` + +##### callback + +(`err?`, `needBuild?`) => `void` + +#### Returns + +`void` + +#### Inherited from + +[`Module`](Module.md).[`needBuild`](Module.md#needbuild) + +*** + +### ~~needRebuild()~~ + +> **needRebuild**(`fileTimestamps`, `contextTimestamps`): `boolean` + +Defined in: [webpack/types.d.ts:10717](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10717) + +Use needBuild instead + +#### Parameters + +##### fileTimestamps + +`Map`\<`string`, `number`\> + +##### contextTimestamps + +`Map`\<`string`, `number`\> + +#### Returns + +`boolean` + +#### Deprecated + +#### Inherited from + +[`Module`](Module.md).[`needRebuild`](Module.md#needrebuild) + +*** + +### originalSource() + +> **originalSource**(): [`Source`](../webpack/namespaces/export=/namespaces/sources/classes/Source.md) + +Defined in: [webpack/types.d.ts:10779](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10779) + +#### Returns + +[`Source`](../webpack/namespaces/export=/namespaces/sources/classes/Source.md) + +#### Inherited from + +[`Module`](Module.md).[`originalSource`](Module.md#originalsource) + +*** + +### readableIdentifier() + +> **readableIdentifier**(`requestShortener`): `string` + +Defined in: [webpack/types.d.ts:10723](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10723) + +#### Parameters + +##### requestShortener + +`RequestShortener` + +#### Returns + +`string` + +#### Inherited from + +[`Module`](Module.md).[`readableIdentifier`](Module.md#readableidentifier) + +*** + +### removeChunk() + +> **removeChunk**(`chunk`): `void` + +Defined in: [webpack/types.d.ts:10668](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10668) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +#### Returns + +`void` + +#### Inherited from + +[`Module`](Module.md).[`removeChunk`](Module.md#removechunk) + +*** + +### removeDependency() + +> **removeDependency**(`dependency`): `void` + +Defined in: [webpack/types.d.ts:4120](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4120) + +#### Parameters + +##### dependency + +[`Dependency`](Dependency.md) + +#### Returns + +`void` + +#### Inherited from + +[`Module`](Module.md).[`removeDependency`](Module.md#removedependency) + +*** + +### restoreFromUnsafeCache() + +> **restoreFromUnsafeCache**(`unsafeCacheData`, `normalModuleFactory`): `void` + +Defined in: [webpack/types.d.ts:11887](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11887) + +restore unsafe cache data + +#### Parameters + +##### unsafeCacheData + +`UnsafeCacheData` + +##### normalModuleFactory + +`NormalModuleFactory` + +#### Returns + +`void` + +*** + +### serialize() + +> **serialize**(`__namedParameters`): `void` + +Defined in: [webpack/types.d.ts:4127](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4127) + +#### Parameters + +##### \_\_namedParameters + +[`ObjectSerializerContext`](../interfaces/ObjectSerializerContext.md) + +#### Returns + +`void` + +#### Inherited from + +[`Module`](Module.md).[`serialize`](Module.md#serialize) + +*** + +### shouldPreventParsing() + +> **shouldPreventParsing**(`noParseRule`, `request`): `boolean` + +Defined in: [webpack/types.d.ts:11913](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11913) + +#### Parameters + +##### noParseRule + +`string` | `RegExp` | (`content`) => `boolean` | (`string` \| `RegExp` \| (`content`) => `boolean`)[] + +##### request + +`string` + +#### Returns + +`boolean` + +*** + +### size() + +> **size**(`type?`): `number` + +Defined in: [webpack/types.d.ts:10751](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10751) + +#### Parameters + +##### type? + +`string` + +#### Returns + +`number` + +#### Inherited from + +[`Module`](Module.md).[`size`](Module.md#size) + +*** + +### ~~source()~~ + +> **source**(`dependencyTemplates`, `runtimeTemplate`, `type?`): [`Source`](../webpack/namespaces/export=/namespaces/sources/classes/Source.md) + +Defined in: [webpack/types.d.ts:10746](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10746) + +Use codeGeneration() instead + +#### Parameters + +##### dependencyTemplates + +`DependencyTemplates` + +##### runtimeTemplate + +`RuntimeTemplate` + +##### type? + +`string` + +#### Returns + +[`Source`](../webpack/namespaces/export=/namespaces/sources/classes/Source.md) + +#### Deprecated + +#### Inherited from + +[`Module`](Module.md).[`source`](Module.md#source) + +*** + +### updateCacheModule() + +> **updateCacheModule**(`module`): `void` + +Defined in: [webpack/types.d.ts:10767](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10767) + +Assuming this module is in the cache. Update the (cached) module with +the fresh module from the factory. Usually updates internal references +and properties. + +#### Parameters + +##### module + +[`Module`](Module.md) + +#### Returns + +`void` + +#### Inherited from + +[`Module`](Module.md).[`updateCacheModule`](Module.md#updatecachemodule) + +*** + +### updateHash() + +> **updateHash**(`hash`, `context`): `void` + +Defined in: [webpack/types.d.ts:4126](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4126) + +#### Parameters + +##### hash + +`Hash` + +##### context + +`UpdateHashContextDependency` + +#### Returns + +`void` + +#### Inherited from + +[`Module`](Module.md).[`updateHash`](Module.md#updatehash) + +*** + +### deserialize() + +> `static` **deserialize**(`context`): `NormalModule` + +Defined in: [webpack/types.d.ts:11925](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11925) + +#### Parameters + +##### context + +[`ObjectDeserializerContext`](../interfaces/ObjectDeserializerContext.md) + +#### Returns + +`NormalModule` + +*** + +### getCompilationHooks() + +> `static` **getCompilationHooks**(`compilation`): `NormalModuleCompilationHooks` + +Defined in: [webpack/types.d.ts:11922](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11922) + +#### Parameters + +##### compilation + +[`Compilation`](Compilation.md) + +#### Returns + +`NormalModuleCompilationHooks` diff --git a/api/classes/NormalModuleReplacementPlugin.md b/api/classes/NormalModuleReplacementPlugin.md new file mode 100644 index 0000000..404cad9 --- /dev/null +++ b/api/classes/NormalModuleReplacementPlugin.md @@ -0,0 +1,69 @@ +--- +title: NormalModuleReplacementPlugin +--- + +[webpack](../globals.md) / NormalModuleReplacementPlugin + +# Class: NormalModuleReplacementPlugin + +Defined in: [webpack/types.d.ts:12387](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L12387) + +## Constructors + +### Constructor + +> **new NormalModuleReplacementPlugin**(`resourceRegExp`, `newResource`): `NormalModuleReplacementPlugin` + +Defined in: [webpack/types.d.ts:12391](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L12391) + +Create an instance of the plugin + +#### Parameters + +##### resourceRegExp + +`RegExp` + +##### newResource + +`string` | (`resolveData`) => `void` + +#### Returns + +`NormalModuleReplacementPlugin` + +## Properties + +### newResource + +> **newResource**: `string` \| (`resolveData`) => `void` + +Defined in: [webpack/types.d.ts:12396](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L12396) + +*** + +### resourceRegExp + +> **resourceRegExp**: `RegExp` + +Defined in: [webpack/types.d.ts:12395](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L12395) + +## Methods + +### apply() + +> **apply**(`compiler`): `void` + +Defined in: [webpack/types.d.ts:12401](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L12401) + +Apply the plugin + +#### Parameters + +##### compiler + +[`Compiler`](Compiler.md) + +#### Returns + +`void` diff --git a/api/classes/Parser.md b/api/classes/Parser.md new file mode 100644 index 0000000..fbc4b67 --- /dev/null +++ b/api/classes/Parser.md @@ -0,0 +1,47 @@ +--- +title: Parser +--- + +[webpack](../globals.md) / Parser + +# Class: Parser + +Defined in: [webpack/types.d.ts:13962](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L13962) + +## Extended by + +- [`JavascriptParser`](../webpack/namespaces/export=/namespaces/javascript/classes/JavascriptParser.md) + +## Constructors + +### Constructor + +> **new Parser**(): `ParserClass` + +Defined in: [webpack/types.d.ts:13963](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L13963) + +#### Returns + +`ParserClass` + +## Methods + +### parse() + +> **parse**(`source`, `state`): [`ParserState`](../type-aliases/ParserState.md) + +Defined in: [webpack/types.d.ts:13964](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L13964) + +#### Parameters + +##### source + +`string` | `Buffer`\<`ArrayBufferLike`\> | `PreparsedAst` + +##### state + +[`ParserState`](../type-aliases/ParserState.md) + +#### Returns + +[`ParserState`](../type-aliases/ParserState.md) diff --git a/api/classes/PlatformPlugin.md b/api/classes/PlatformPlugin.md new file mode 100644 index 0000000..125aff8 --- /dev/null +++ b/api/classes/PlatformPlugin.md @@ -0,0 +1,55 @@ +--- +title: PlatformPlugin +--- + +[webpack](../globals.md) / PlatformPlugin + +# Class: PlatformPlugin + +Defined in: [webpack/types.d.ts:14132](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L14132) + +## Constructors + +### Constructor + +> **new PlatformPlugin**(`platform`): `PlatformPlugin` + +Defined in: [webpack/types.d.ts:14133](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L14133) + +#### Parameters + +##### platform + +`Partial`\<`PlatformTargetProperties`\> + +#### Returns + +`PlatformPlugin` + +## Properties + +### platform + +> **platform**: `Partial`\<`PlatformTargetProperties`\> + +Defined in: [webpack/types.d.ts:14134](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L14134) + +## Methods + +### apply() + +> **apply**(`compiler`): `void` + +Defined in: [webpack/types.d.ts:14139](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L14139) + +Apply the plugin + +#### Parameters + +##### compiler + +[`Compiler`](Compiler.md) + +#### Returns + +`void` diff --git a/api/classes/PrefetchPlugin.md b/api/classes/PrefetchPlugin.md new file mode 100644 index 0000000..9f2b133 --- /dev/null +++ b/api/classes/PrefetchPlugin.md @@ -0,0 +1,67 @@ +--- +title: PrefetchPlugin +--- + +[webpack](../globals.md) / PrefetchPlugin + +# Class: PrefetchPlugin + +Defined in: [webpack/types.d.ts:14194](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L14194) + +## Constructors + +### Constructor + +> **new PrefetchPlugin**(`context`, `request?`): `PrefetchPlugin` + +Defined in: [webpack/types.d.ts:14195](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L14195) + +#### Parameters + +##### context + +`string` + +##### request? + +`string` + +#### Returns + +`PrefetchPlugin` + +## Properties + +### context + +> **context**: `string` + +Defined in: [webpack/types.d.ts:14196](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L14196) + +*** + +### request + +> **request**: `string` + +Defined in: [webpack/types.d.ts:14197](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L14197) + +## Methods + +### apply() + +> **apply**(`compiler`): `void` + +Defined in: [webpack/types.d.ts:14202](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L14202) + +Apply the plugin + +#### Parameters + +##### compiler + +[`Compiler`](Compiler.md) + +#### Returns + +`void` diff --git a/api/classes/ProgressPlugin.md b/api/classes/ProgressPlugin.md new file mode 100644 index 0000000..e1e946a --- /dev/null +++ b/api/classes/ProgressPlugin.md @@ -0,0 +1,223 @@ +--- +title: ProgressPlugin +--- + +[webpack](../globals.md) / ProgressPlugin + +# Class: ProgressPlugin + +Defined in: [webpack/types.d.ts:14277](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L14277) + +## Constructors + +### Constructor + +> **new ProgressPlugin**(`options?`): `ProgressPlugin` + +Defined in: [webpack/types.d.ts:14278](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L14278) + +#### Parameters + +##### options? + +`ProgressPluginArgument` + +#### Returns + +`ProgressPlugin` + +## Properties + +### dependenciesCount + +> **dependenciesCount**: `number` + +Defined in: [webpack/types.d.ts:14283](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L14283) + +*** + +### handler()? + +> `optional` **handler**: (`percentage`, `msg`, ...`args`) => `void` + +Defined in: [webpack/types.d.ts:14281](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L14281) + +#### Parameters + +##### percentage + +`number` + +##### msg + +`string` + +##### args + +...`string`[] + +#### Returns + +`void` + +*** + +### modulesCount + +> **modulesCount**: `number` + +Defined in: [webpack/types.d.ts:14282](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L14282) + +*** + +### options + +> **options**: `ProgressPluginOptions` + +Defined in: [webpack/types.d.ts:14279](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L14279) + +*** + +### percentBy + +> **percentBy**: `"entries"` \| `"dependencies"` \| `"modules"` + +Defined in: [webpack/types.d.ts:14288](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L14288) + +*** + +### profile + +> **profile**: `boolean` + +Defined in: [webpack/types.d.ts:14280](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L14280) + +*** + +### showActiveModules + +> **showActiveModules**: `boolean` + +Defined in: [webpack/types.d.ts:14287](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L14287) + +*** + +### showDependencies + +> **showDependencies**: `boolean` + +Defined in: [webpack/types.d.ts:14286](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L14286) + +*** + +### showEntries + +> **showEntries**: `boolean` + +Defined in: [webpack/types.d.ts:14284](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L14284) + +*** + +### showModules + +> **showModules**: `boolean` + +Defined in: [webpack/types.d.ts:14285](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L14285) + +*** + +### createDefaultHandler() + +> `static` **createDefaultHandler**: (`profile`, `logger`) => (`percentage`, `msg`, ...`args`) => `void` + +Defined in: [webpack/types.d.ts:14294](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L14294) + +#### Parameters + +##### profile + +`boolean` + +##### logger + +`WebpackLogger` + +#### Returns + +> (`percentage`, `msg`, ...`args`): `void` + +##### Parameters + +###### percentage + +`number` + +###### msg + +`string` + +###### args + +...`string`[] + +##### Returns + +`void` + +*** + +### defaultOptions + +> `static` **defaultOptions**: `Required`\<`Omit`\<`ProgressPluginOptions`, `"handler"`\>\> + +Defined in: [webpack/types.d.ts:14293](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L14293) + +## Methods + +### apply() + +> **apply**(`compiler`): `void` + +Defined in: [webpack/types.d.ts:14289](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L14289) + +#### Parameters + +##### compiler + +[`Compiler`](Compiler.md) | [`MultiCompiler`](MultiCompiler.md) + +#### Returns + +`void` + +*** + +### getReporter() + +> `static` **getReporter**(`compiler`): (`p`, ...`args`) => `void` + +Defined in: [webpack/types.d.ts:14290](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L14290) + +#### Parameters + +##### compiler + +[`Compiler`](Compiler.md) + +#### Returns + +> (`p`, ...`args`): `void` + +##### Parameters + +###### p + +`number` + +###### args + +...`string`[] + +##### Returns + +`void` diff --git a/api/classes/ProvidePlugin.md b/api/classes/ProvidePlugin.md new file mode 100644 index 0000000..7afd379 --- /dev/null +++ b/api/classes/ProvidePlugin.md @@ -0,0 +1,55 @@ +--- +title: ProvidePlugin +--- + +[webpack](../globals.md) / ProvidePlugin + +# Class: ProvidePlugin + +Defined in: [webpack/types.d.ts:14352](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L14352) + +## Constructors + +### Constructor + +> **new ProvidePlugin**(`definitions`): `ProvidePlugin` + +Defined in: [webpack/types.d.ts:14353](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L14353) + +#### Parameters + +##### definitions + +`Record`\<`string`, `string` \| `string`[]\> + +#### Returns + +`ProvidePlugin` + +## Properties + +### definitions + +> **definitions**: `Record`\<`string`, `string` \| `string`[]\> + +Defined in: [webpack/types.d.ts:14354](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L14354) + +## Methods + +### apply() + +> **apply**(`compiler`): `void` + +Defined in: [webpack/types.d.ts:14359](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L14359) + +Apply the plugin + +#### Parameters + +##### compiler + +[`Compiler`](Compiler.md) + +#### Returns + +`void` diff --git a/api/classes/Resolver.md b/api/classes/Resolver.md new file mode 100644 index 0000000..40e376a --- /dev/null +++ b/api/classes/Resolver.md @@ -0,0 +1,285 @@ +--- +title: Resolver +--- + +[webpack](../globals.md) / Resolver + +# Abstract Class: Resolver + +Defined in: [webpack/types.d.ts:15984](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L15984) + +## Constructors + +### Constructor + +> **new Resolver**(): `Resolver` + +#### Returns + +`Resolver` + +## Properties + +### fileSystem + +> **fileSystem**: `FileSystem` + +Defined in: [webpack/types.d.ts:15985](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L15985) + +*** + +### hooks + +> **hooks**: `KnownHooks` + +Defined in: [webpack/types.d.ts:15987](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L15987) + +*** + +### options + +> **options**: `ResolveOptionsResolverFactoryObject1` + +Defined in: [webpack/types.d.ts:15986](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L15986) + +## Methods + +### doResolve() + +> **doResolve**(`hook`, `request`, `message`, `resolveContext`, `callback`): `void` + +Defined in: [webpack/types.d.ts:16026](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L16026) + +#### Parameters + +##### hook + +`AsyncSeriesBailHook`\<\[`ResolveRequest`, `ResolveContext`\], `ResolveRequest`\> + +##### request + +`ResolveRequest` + +##### message + +`string` + +##### resolveContext + +`ResolveContext` + +##### callback + +(`err?`, `result?`) => `void` + +#### Returns + +`void` + +*** + +### ensureHook() + +> **ensureHook**(`name`): `AsyncSeriesBailHook`\<\[`ResolveRequest`, `ResolveContext`\], `ResolveRequest`\> + +Defined in: [webpack/types.d.ts:15988](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L15988) + +#### Parameters + +##### name + +`string` | `AsyncSeriesBailHook`\<\[`ResolveRequest`, `ResolveContext`\], `ResolveRequest`, `UnsetAdditionalOptions`\> + +#### Returns + +`AsyncSeriesBailHook`\<\[`ResolveRequest`, `ResolveContext`\], `ResolveRequest`\> + +*** + +### getHook() + +> **getHook**(`name`): `AsyncSeriesBailHook`\<\[`ResolveRequest`, `ResolveContext`\], `ResolveRequest`\> + +Defined in: [webpack/types.d.ts:15999](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L15999) + +#### Parameters + +##### name + +`string` | `AsyncSeriesBailHook`\<\[`ResolveRequest`, `ResolveContext`\], `ResolveRequest`, `UnsetAdditionalOptions`\> + +#### Returns + +`AsyncSeriesBailHook`\<\[`ResolveRequest`, `ResolveContext`\], `ResolveRequest`\> + +*** + +### isDirectory() + +> **isDirectory**(`path`): `boolean` + +Defined in: [webpack/types.d.ts:16039](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L16039) + +#### Parameters + +##### path + +`string` + +#### Returns + +`boolean` + +*** + +### isModule() + +> **isModule**(`path`): `boolean` + +Defined in: [webpack/types.d.ts:16037](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L16037) + +#### Parameters + +##### path + +`string` + +#### Returns + +`boolean` + +*** + +### isPrivate() + +> **isPrivate**(`path`): `boolean` + +Defined in: [webpack/types.d.ts:16038](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L16038) + +#### Parameters + +##### path + +`string` + +#### Returns + +`boolean` + +*** + +### join() + +> **join**(`path`, `request`): `string` + +Defined in: [webpack/types.d.ts:16040](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L16040) + +#### Parameters + +##### path + +`string` + +##### request + +`string` + +#### Returns + +`string` + +*** + +### normalize() + +> **normalize**(`path`): `string` + +Defined in: [webpack/types.d.ts:16041](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L16041) + +#### Parameters + +##### path + +`string` + +#### Returns + +`string` + +*** + +### parse() + +> **parse**(`identifier`): `ParsedIdentifier` + +Defined in: [webpack/types.d.ts:16036](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L16036) + +#### Parameters + +##### identifier + +`string` + +#### Returns + +`ParsedIdentifier` + +*** + +### resolve() + +> **resolve**(`context`, `path`, `request`, `resolveContext`, `callback`): `void` + +Defined in: [webpack/types.d.ts:16015](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L16015) + +#### Parameters + +##### context + +`ContextTypes` + +##### path + +`string` + +##### request + +`string` + +##### resolveContext + +`ResolveContext` + +##### callback + +(`err`, `res?`, `req?`) => `void` + +#### Returns + +`void` + +*** + +### resolveSync() + +> **resolveSync**(`context`, `path`, `request`): `string` \| `false` + +Defined in: [webpack/types.d.ts:16010](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L16010) + +#### Parameters + +##### context + +`ContextTypes` + +##### path + +`string` + +##### request + +`string` + +#### Returns + +`string` \| `false` diff --git a/api/classes/RuntimeModule.md b/api/classes/RuntimeModule.md new file mode 100644 index 0000000..670c3e7 --- /dev/null +++ b/api/classes/RuntimeModule.md @@ -0,0 +1,1856 @@ +--- +title: RuntimeModule +--- + +[webpack](../globals.md) / RuntimeModule + +# Class: RuntimeModule + +Defined in: [webpack/types.d.ts:16561](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L16561) + +## Extends + +- [`Module`](Module.md) + +## Extended by + +- [`GetChunkFilenameRuntimeModule`](../webpack/namespaces/export=/namespaces/runtime/classes/GetChunkFilenameRuntimeModule.md) +- [`JsonpChunkLoadingRuntimeModule`](../webpack/namespaces/export=/namespaces/web/classes/JsonpChunkLoadingRuntimeModule.md) +- [`CssLoadingRuntimeModule`](../webpack/namespaces/export=/namespaces/web/classes/CssLoadingRuntimeModule.md) +- [`ModuleChunkLoadingRuntimeModule`](../webpack/namespaces/export=/namespaces/esm/classes/ModuleChunkLoadingRuntimeModule.md) + +## Constructors + +### Constructor + +> **new RuntimeModule**(`name`, `stage?`): `RuntimeModule` + +Defined in: [webpack/types.d.ts:16562](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L16562) + +#### Parameters + +##### name + +`string` + +##### stage? + +`number` + +#### Returns + +`RuntimeModule` + +#### Overrides + +[`Module`](Module.md).[`constructor`](Module.md#constructor) + +## Properties + +### blocks + +> **blocks**: [`AsyncDependenciesBlock`](AsyncDependenciesBlock.md)[] + +Defined in: [webpack/types.d.ts:4110](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4110) + +#### Inherited from + +[`Module`](Module.md).[`blocks`](Module.md#blocks) + +*** + +### buildInfo? + +> `optional` **buildInfo**: `BuildInfo` + +Defined in: [webpack/types.d.ts:10642](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10642) + +#### Inherited from + +[`Module`](Module.md).[`buildInfo`](Module.md#buildinfo) + +*** + +### buildMeta? + +> `optional` **buildMeta**: `BuildMeta` + +Defined in: [webpack/types.d.ts:10641](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10641) + +#### Inherited from + +[`Module`](Module.md).[`buildMeta`](Module.md#buildmeta) + +*** + +### chunk? + +> `optional` **chunk**: [`Chunk`](Chunk.md) + +Defined in: [webpack/types.d.ts:16566](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L16566) + +*** + +### chunkGraph? + +> `optional` **chunkGraph**: [`ChunkGraph`](ChunkGraph.md) + +Defined in: [webpack/types.d.ts:16567](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L16567) + +*** + +### codeGenerationDependencies? + +> `optional` **codeGenerationDependencies**: [`Dependency`](Dependency.md)[] + +Defined in: [webpack/types.d.ts:10644](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10644) + +#### Inherited from + +[`Module`](Module.md).[`codeGenerationDependencies`](Module.md#codegenerationdependencies) + +*** + +### compilation? + +> `optional` **compilation**: [`Compilation`](Compilation.md) + +Defined in: [webpack/types.d.ts:16565](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L16565) + +*** + +### context + +> **context**: `string` + +Defined in: [webpack/types.d.ts:10632](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10632) + +#### Inherited from + +[`Module`](Module.md).[`context`](Module.md#context) + +*** + +### debugId + +> **debugId**: `number` + +Defined in: [webpack/types.d.ts:10635](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10635) + +#### Inherited from + +[`Module`](Module.md).[`debugId`](Module.md#debugid) + +*** + +### dependencies + +> **dependencies**: [`Dependency`](Dependency.md)[] + +Defined in: [webpack/types.d.ts:4109](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4109) + +#### Inherited from + +[`Module`](Module.md).[`dependencies`](Module.md#dependencies) + +*** + +### dependentHash + +> **dependentHash**: `boolean` + +Defined in: [webpack/types.d.ts:16569](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L16569) + +*** + +### depth + +> **depth**: `number` + +Defined in: [webpack/types.d.ts:10655](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10655) + +#### Inherited from + +[`Module`](Module.md).[`depth`](Module.md#depth) + +*** + +### factoryMeta? + +> `optional` **factoryMeta**: `FactoryMeta` + +Defined in: [webpack/types.d.ts:10637](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10637) + +#### Inherited from + +[`Module`](Module.md).[`factoryMeta`](Module.md#factorymeta) + +*** + +### fullHash + +> **fullHash**: `boolean` + +Defined in: [webpack/types.d.ts:16568](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L16568) + +*** + +### hot + +> **hot**: `boolean` + +Defined in: [webpack/types.d.ts:10640](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10640) + +#### Inherited from + +[`Module`](Module.md).[`hot`](Module.md#hot) + +*** + +### ~~id~~ + +> **id**: `string` \| `number` + +Defined in: [webpack/types.d.ts:10649](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10649) + +#### Deprecated + +#### Inherited from + +[`Module`](Module.md).[`id`](Module.md#id) + +*** + +### index + +> **index**: `number` + +Defined in: [webpack/types.d.ts:10653](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10653) + +#### Inherited from + +[`Module`](Module.md).[`index`](Module.md#index) + +*** + +### index2 + +> **index2**: `number` + +Defined in: [webpack/types.d.ts:10654](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10654) + +#### Inherited from + +[`Module`](Module.md).[`index2`](Module.md#index2) + +*** + +### issuer? + +> `optional` **issuer**: [`Module`](Module.md) + +Defined in: [webpack/types.d.ts:10656](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10656) + +#### Inherited from + +[`Module`](Module.md).[`issuer`](Module.md#issuer) + +*** + +### layer + +> **layer**: `string` + +Defined in: [webpack/types.d.ts:10633](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10633) + +#### Inherited from + +[`Module`](Module.md).[`layer`](Module.md#layer) + +*** + +### name + +> **name**: `string` + +Defined in: [webpack/types.d.ts:16563](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L16563) + +*** + +### needId + +> **needId**: `boolean` + +Defined in: [webpack/types.d.ts:10634](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10634) + +#### Inherited from + +[`Module`](Module.md).[`needId`](Module.md#needid) + +*** + +### parent? + +> `optional` **parent**: `DependenciesBlock` + +Defined in: [webpack/types.d.ts:4111](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4111) + +#### Inherited from + +[`Module`](Module.md).[`parent`](Module.md#parent) + +*** + +### presentationalDependencies? + +> `optional` **presentationalDependencies**: [`Dependency`](Dependency.md)[] + +Defined in: [webpack/types.d.ts:10643](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10643) + +#### Inherited from + +[`Module`](Module.md).[`presentationalDependencies`](Module.md#presentationaldependencies) + +*** + +### profile? + +> `optional` **profile**: `ModuleProfile` + +Defined in: [webpack/types.d.ts:10652](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10652) + +#### Inherited from + +[`Module`](Module.md).[`profile`](Module.md#profile) + +*** + +### resolveOptions? + +> `optional` **resolveOptions**: [`ResolveOptions`](../interfaces/ResolveOptions.md) + +Defined in: [webpack/types.d.ts:10636](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10636) + +#### Inherited from + +[`Module`](Module.md).[`resolveOptions`](Module.md#resolveoptions) + +*** + +### stage + +> **stage**: `number` + +Defined in: [webpack/types.d.ts:16564](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L16564) + +*** + +### type + +> **type**: `string` + +Defined in: [webpack/types.d.ts:10631](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10631) + +#### Inherited from + +[`Module`](Module.md).[`type`](Module.md#type) + +*** + +### used + +> **used**: `any` + +Defined in: [webpack/types.d.ts:10790](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10790) + +#### Inherited from + +[`Module`](Module.md).[`used`](Module.md#used) + +*** + +### useSimpleSourceMap + +> **useSimpleSourceMap**: `boolean` + +Defined in: [webpack/types.d.ts:10639](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10639) + +#### Inherited from + +[`Module`](Module.md).[`useSimpleSourceMap`](Module.md#usesimplesourcemap) + +*** + +### useSourceMap + +> **useSourceMap**: `boolean` + +Defined in: [webpack/types.d.ts:10638](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10638) + +#### Inherited from + +[`Module`](Module.md).[`useSourceMap`](Module.md#usesourcemap) + +*** + +### STAGE\_ATTACH + +> `static` **STAGE\_ATTACH**: `number` + +Defined in: [webpack/types.d.ts:16588](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L16588) + +Runtime modules which attach to handlers of other runtime modules + +*** + +### STAGE\_BASIC + +> `static` **STAGE\_BASIC**: `number` + +Defined in: [webpack/types.d.ts:16583](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L16583) + +Runtime modules with simple dependencies on other runtime modules + +*** + +### STAGE\_NORMAL + +> `static` **STAGE\_NORMAL**: `number` + +Defined in: [webpack/types.d.ts:16578](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L16578) + +Runtime modules without any dependencies to other runtime modules + +*** + +### STAGE\_TRIGGER + +> `static` **STAGE\_TRIGGER**: `number` + +Defined in: [webpack/types.d.ts:16593](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L16593) + +Runtime modules which trigger actions on bootstrap + +## Accessors + +### chunksIterable + +#### Get Signature + +> **get** **chunksIterable**(): `Iterable`\<[`Chunk`](Chunk.md)\> + +Defined in: [webpack/types.d.ts:10673](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10673) + +##### Returns + +`Iterable`\<[`Chunk`](Chunk.md)\> + +#### Inherited from + +[`Module`](Module.md).[`chunksIterable`](Module.md#chunksiterable) + +*** + +### errors + +#### Get Signature + +> **get** **errors**(): `any` + +Defined in: [webpack/types.d.ts:10788](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10788) + +##### Returns + +`any` + +#### Inherited from + +[`Module`](Module.md).[`errors`](Module.md#errors) + +*** + +### exportsArgument + +#### Get Signature + +> **get** **exportsArgument**(): `string` + +Defined in: [webpack/types.d.ts:10675](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10675) + +##### Returns + +`string` + +#### Inherited from + +[`Module`](Module.md).[`exportsArgument`](Module.md#exportsargument) + +*** + +### hasEqualsChunks + +#### Get Signature + +> **get** **hasEqualsChunks**(): `any` + +Defined in: [webpack/types.d.ts:10786](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10786) + +##### Returns + +`any` + +#### Inherited from + +[`Module`](Module.md).[`hasEqualsChunks`](Module.md#hasequalschunks) + +*** + +### hash + +#### Get Signature + +> **get** **hash**(): `string` + +Defined in: [webpack/types.d.ts:10650](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10650) + +##### Returns + +`string` + +#### Inherited from + +[`Module`](Module.md).[`hash`](Module.md#hash) + +*** + +### isUsed + +#### Get Signature + +> **get** **isUsed**(): `any` + +Defined in: [webpack/types.d.ts:10787](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10787) + +##### Returns + +`any` + +#### Inherited from + +[`Module`](Module.md).[`isUsed`](Module.md#isused) + +*** + +### moduleArgument + +#### Get Signature + +> **get** **moduleArgument**(): `string` + +Defined in: [webpack/types.d.ts:10676](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10676) + +##### Returns + +`string` + +#### Inherited from + +[`Module`](Module.md).[`moduleArgument`](Module.md#moduleargument) + +*** + +### optimizationBailout + +#### Get Signature + +> **get** **optimizationBailout**(): (`string` \| (`requestShortener`) => `string`)[] + +Defined in: [webpack/types.d.ts:10662](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10662) + +##### Deprecated + +##### Returns + +(`string` \| (`requestShortener`) => `string`)[] + +#### Inherited from + +[`Module`](Module.md).[`optimizationBailout`](Module.md#optimizationbailout) + +*** + +### optional + +#### Get Signature + +> **get** **optional**(): `boolean` + +Defined in: [webpack/types.d.ts:10666](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10666) + +##### Returns + +`boolean` + +#### Inherited from + +[`Module`](Module.md).[`optional`](Module.md#optional) + +*** + +### renderedHash + +#### Get Signature + +> **get** **renderedHash**(): `string` + +Defined in: [webpack/types.d.ts:10651](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10651) + +##### Returns + +`string` + +#### Inherited from + +[`Module`](Module.md).[`renderedHash`](Module.md#renderedhash) + +*** + +### usedExports + +#### Get Signature + +> **get** **usedExports**(): `boolean` \| `SortableSet`\<`string`\> + +Defined in: [webpack/types.d.ts:10657](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10657) + +##### Returns + +`boolean` \| `SortableSet`\<`string`\> + +#### Inherited from + +[`Module`](Module.md).[`usedExports`](Module.md#usedexports) + +*** + +### warnings + +#### Get Signature + +> **get** **warnings**(): `any` + +Defined in: [webpack/types.d.ts:10789](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10789) + +##### Returns + +`any` + +#### Inherited from + +[`Module`](Module.md).[`warnings`](Module.md#warnings) + +## Methods + +### addBlock() + +> **addBlock**(`block`): `void` + +Defined in: [webpack/types.d.ts:4118](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4118) + +Adds a DependencyBlock to DependencyBlock relationship. +This is used for when a Module has a AsyncDependencyBlock tie (for code-splitting) + +#### Parameters + +##### block + +[`AsyncDependenciesBlock`](AsyncDependenciesBlock.md) + +#### Returns + +`void` + +#### Inherited from + +[`Module`](Module.md).[`addBlock`](Module.md#addblock) + +*** + +### addCacheDependencies() + +> **addCacheDependencies**(`fileDependencies`, `contextDependencies`, `missingDependencies`, `buildDependencies`): `void` + +Defined in: [webpack/types.d.ts:10780](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10780) + +#### Parameters + +##### fileDependencies + +[`LazySet`](../webpack/namespaces/export=/namespaces/util/classes/LazySet.md)\<`string`\> + +##### contextDependencies + +[`LazySet`](../webpack/namespaces/export=/namespaces/util/classes/LazySet.md)\<`string`\> + +##### missingDependencies + +[`LazySet`](../webpack/namespaces/export=/namespaces/util/classes/LazySet.md)\<`string`\> + +##### buildDependencies + +[`LazySet`](../webpack/namespaces/export=/namespaces/util/classes/LazySet.md)\<`string`\> + +#### Returns + +`void` + +#### Inherited from + +[`Module`](Module.md).[`addCacheDependencies`](Module.md#addcachedependencies) + +*** + +### addChunk() + +> **addChunk**(`chunk`): `boolean` + +Defined in: [webpack/types.d.ts:10667](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10667) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`Module`](Module.md).[`addChunk`](Module.md#addchunk) + +*** + +### addCodeGenerationDependency() + +> **addCodeGenerationDependency**(`codeGenerationDependency`): `void` + +Defined in: [webpack/types.d.ts:10679](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10679) + +#### Parameters + +##### codeGenerationDependency + +[`Dependency`](Dependency.md) + +#### Returns + +`void` + +#### Inherited from + +[`Module`](Module.md).[`addCodeGenerationDependency`](Module.md#addcodegenerationdependency) + +*** + +### addDependency() + +> **addDependency**(`dependency`): `void` + +Defined in: [webpack/types.d.ts:4119](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4119) + +#### Parameters + +##### dependency + +[`Dependency`](Dependency.md) + +#### Returns + +`void` + +#### Inherited from + +[`Module`](Module.md).[`addDependency`](Module.md#adddependency) + +*** + +### addError() + +> **addError**(`error`): `void` + +Defined in: [webpack/types.d.ts:10683](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10683) + +#### Parameters + +##### error + +[`WebpackError`](WebpackError.md) + +#### Returns + +`void` + +#### Inherited from + +[`Module`](Module.md).[`addError`](Module.md#adderror) + +*** + +### addPresentationalDependency() + +> **addPresentationalDependency**(`presentationalDependency`): `void` + +Defined in: [webpack/types.d.ts:10678](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10678) + +#### Parameters + +##### presentationalDependency + +[`Dependency`](Dependency.md) + +#### Returns + +`void` + +#### Inherited from + +[`Module`](Module.md).[`addPresentationalDependency`](Module.md#addpresentationaldependency) + +*** + +### addWarning() + +> **addWarning**(`warning`): `void` + +Defined in: [webpack/types.d.ts:10680](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10680) + +#### Parameters + +##### warning + +[`WebpackError`](WebpackError.md) + +#### Returns + +`void` + +#### Inherited from + +[`Module`](Module.md).[`addWarning`](Module.md#addwarning) + +*** + +### attach() + +> **attach**(`compilation`, `chunk`, `chunkGraph?`): `void` + +Defined in: [webpack/types.d.ts:16570](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L16570) + +#### Parameters + +##### compilation + +[`Compilation`](Compilation.md) + +##### chunk + +[`Chunk`](Chunk.md) + +##### chunkGraph? + +[`ChunkGraph`](ChunkGraph.md) + +#### Returns + +`void` + +*** + +### build() + +> **build**(`options`, `compilation`, `resolver`, `fs`, `callback`): `void` + +Defined in: [webpack/types.d.ts:10724](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10724) + +#### Parameters + +##### options + +`WebpackOptionsNormalizedWithDefaults` + +##### compilation + +[`Compilation`](Compilation.md) + +##### resolver + +`ResolverWithOptions` + +##### fs + +[`InputFileSystem`](../interfaces/InputFileSystem.md) + +##### callback + +(`err?`) => `void` + +#### Returns + +`void` + +#### Inherited from + +[`Module`](Module.md).[`build`](Module.md#build) + +*** + +### chunkCondition() + +> **chunkCondition**(`chunk`, `compilation`): `boolean` + +Defined in: [webpack/types.d.ts:10759](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10759) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +##### compilation + +[`Compilation`](Compilation.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`Module`](Module.md).[`chunkCondition`](Module.md#chunkcondition) + +*** + +### cleanupForCache() + +> **cleanupForCache**(): `void` + +Defined in: [webpack/types.d.ts:10778](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10778) + +Assuming this module is in the cache. Remove internal references to allow freeing some memory. + +#### Returns + +`void` + +#### Inherited from + +[`Module`](Module.md).[`cleanupForCache`](Module.md#cleanupforcache) + +*** + +### clearDependenciesAndBlocks() + +> **clearDependenciesAndBlocks**(): `void` + +Defined in: [webpack/types.d.ts:4125](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4125) + +Removes all dependencies and blocks + +#### Returns + +`void` + +#### Inherited from + +[`Module`](Module.md).[`clearDependenciesAndBlocks`](Module.md#cleardependenciesandblocks) + +*** + +### clearWarningsAndErrors() + +> **clearWarningsAndErrors**(): `void` + +Defined in: [webpack/types.d.ts:10690](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10690) + +removes all warnings and errors + +#### Returns + +`void` + +#### Inherited from + +[`Module`](Module.md).[`clearWarningsAndErrors`](Module.md#clearwarningsanderrors) + +*** + +### codeGeneration() + +> **codeGeneration**(`context`): `CodeGenerationResult` + +Defined in: [webpack/types.d.ts:10758](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10758) + +#### Parameters + +##### context + +`CodeGenerationContext` + +#### Returns + +`CodeGenerationResult` + +#### Inherited from + +[`Module`](Module.md).[`codeGeneration`](Module.md#codegeneration) + +*** + +### deserialize() + +> **deserialize**(`__namedParameters`): `void` + +Defined in: [webpack/types.d.ts:4128](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4128) + +#### Parameters + +##### \_\_namedParameters + +[`ObjectDeserializerContext`](../interfaces/ObjectDeserializerContext.md) + +#### Returns + +`void` + +#### Inherited from + +[`Module`](Module.md).[`deserialize`](Module.md#deserialize) + +*** + +### generate() + +> **generate**(): `string` + +Defined in: [webpack/types.d.ts:16571](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L16571) + +#### Returns + +`string` + +*** + +### getChunks() + +> **getChunks**(): [`Chunk`](Chunk.md)[] + +Defined in: [webpack/types.d.ts:10671](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10671) + +#### Returns + +[`Chunk`](Chunk.md)[] + +#### Inherited from + +[`Module`](Module.md).[`getChunks`](Module.md#getchunks) + +*** + +### getConcatenationBailoutReason() + +> **getConcatenationBailoutReason**(`context`): `string` + +Defined in: [webpack/types.d.ts:10754](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10754) + +#### Parameters + +##### context + +`ConcatenationBailoutReasonContext` + +#### Returns + +`string` + +#### Inherited from + +[`Module`](Module.md).[`getConcatenationBailoutReason`](Module.md#getconcatenationbailoutreason) + +*** + +### getErrors() + +> **getErrors**(): `Iterable`\<[`WebpackError`](WebpackError.md), `any`, `any`\> + +Defined in: [webpack/types.d.ts:10684](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10684) + +#### Returns + +`Iterable`\<[`WebpackError`](WebpackError.md), `any`, `any`\> + +#### Inherited from + +[`Module`](Module.md).[`getErrors`](Module.md#geterrors) + +*** + +### getExportsType() + +> **getExportsType**(`moduleGraph`, `strict?`): `ExportsType` + +Defined in: [webpack/types.d.ts:10677](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10677) + +#### Parameters + +##### moduleGraph + +[`ModuleGraph`](ModuleGraph.md) + +##### strict? + +`boolean` + +#### Returns + +`ExportsType` + +#### Inherited from + +[`Module`](Module.md).[`getExportsType`](Module.md#getexportstype) + +*** + +### getGeneratedCode() + +> **getGeneratedCode**(): `string` + +Defined in: [webpack/types.d.ts:16572](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L16572) + +#### Returns + +`string` + +*** + +### getNumberOfChunks() + +> **getNumberOfChunks**(): `number` + +Defined in: [webpack/types.d.ts:10672](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10672) + +#### Returns + +`number` + +#### Inherited from + +[`Module`](Module.md).[`getNumberOfChunks`](Module.md#getnumberofchunks) + +*** + +### getNumberOfErrors() + +> **getNumberOfErrors**(): `number` + +Defined in: [webpack/types.d.ts:10685](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10685) + +#### Returns + +`number` + +#### Inherited from + +[`Module`](Module.md).[`getNumberOfErrors`](Module.md#getnumberoferrors) + +*** + +### getNumberOfWarnings() + +> **getNumberOfWarnings**(): `number` + +Defined in: [webpack/types.d.ts:10682](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10682) + +#### Returns + +`number` + +#### Inherited from + +[`Module`](Module.md).[`getNumberOfWarnings`](Module.md#getnumberofwarnings) + +*** + +### getRootBlock() + +> **getRootBlock**(): `DependenciesBlock` + +Defined in: [webpack/types.d.ts:4112](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4112) + +#### Returns + +`DependenciesBlock` + +#### Inherited from + +[`Module`](Module.md).[`getRootBlock`](Module.md#getrootblock) + +*** + +### getSideEffectsConnectionState() + +> **getSideEffectsConnectionState**(`moduleGraph`): `ConnectionState` + +Defined in: [webpack/types.d.ts:10757](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10757) + +#### Parameters + +##### moduleGraph + +[`ModuleGraph`](ModuleGraph.md) + +#### Returns + +`ConnectionState` + +#### Inherited from + +[`Module`](Module.md).[`getSideEffectsConnectionState`](Module.md#getsideeffectsconnectionstate) + +*** + +### getSourceBasicTypes() + +> **getSourceBasicTypes**(): `ReadonlySet`\<`string`\> + +Defined in: [webpack/types.d.ts:10740](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10740) + +Basic source types are high-level categories like javascript, css, webassembly, etc. +We only have built-in knowledge about the javascript basic type here; other basic types may be +added or changed over time by generators and do not need to be handled or detected here. +Some modules, e.g. RemoteModule, may return non-basic source types like "remote" and "share-init" +from getSourceTypes(), but their generated output is still JavaScript, i.e. their basic type is JS. + +#### Returns + +`ReadonlySet`\<`string`\> + +#### Inherited from + +[`Module`](Module.md).[`getSourceBasicTypes`](Module.md#getsourcebasictypes) + +*** + +### getSourceTypes() + +> **getSourceTypes**(): `ReadonlySet`\<`string`\> + +Defined in: [webpack/types.d.ts:10731](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10731) + +#### Returns + +`ReadonlySet`\<`string`\> + +#### Inherited from + +[`Module`](Module.md).[`getSourceTypes`](Module.md#getsourcetypes) + +*** + +### getUnsafeCacheData() + +> **getUnsafeCacheData**(): `UnsafeCacheData` + +Defined in: [webpack/types.d.ts:10773](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10773) + +Module should be unsafe cached. Get data that's needed for that. +This data will be passed to restoreFromUnsafeCache later. + +#### Returns + +`UnsafeCacheData` + +#### Inherited from + +[`Module`](Module.md).[`getUnsafeCacheData`](Module.md#getunsafecachedata) + +*** + +### getWarnings() + +> **getWarnings**(): `Iterable`\<[`WebpackError`](WebpackError.md), `any`, `any`\> + +Defined in: [webpack/types.d.ts:10681](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10681) + +#### Returns + +`Iterable`\<[`WebpackError`](WebpackError.md), `any`, `any`\> + +#### Inherited from + +[`Module`](Module.md).[`getWarnings`](Module.md#getwarnings) + +*** + +### hasChunkCondition() + +> **hasChunkCondition**(): `boolean` + +Defined in: [webpack/types.d.ts:10760](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10760) + +#### Returns + +`boolean` + +#### Inherited from + +[`Module`](Module.md).[`hasChunkCondition`](Module.md#haschunkcondition) + +*** + +### hasReasonForChunk() + +> **hasReasonForChunk**(`chunk`, `moduleGraph`, `chunkGraph`): `boolean` + +Defined in: [webpack/types.d.ts:10702](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10702) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +##### moduleGraph + +[`ModuleGraph`](ModuleGraph.md) + +##### chunkGraph + +[`ChunkGraph`](ChunkGraph.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`Module`](Module.md).[`hasReasonForChunk`](Module.md#hasreasonforchunk) + +*** + +### hasReasons() + +> **hasReasons**(`moduleGraph`, `runtime`): `boolean` + +Defined in: [webpack/types.d.ts:10707](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10707) + +#### Parameters + +##### moduleGraph + +[`ModuleGraph`](ModuleGraph.md) + +##### runtime + +`RuntimeSpec` + +#### Returns + +`boolean` + +#### Inherited from + +[`Module`](Module.md).[`hasReasons`](Module.md#hasreasons) + +*** + +### identifier() + +> **identifier**(): `string` + +Defined in: [webpack/types.d.ts:10722](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10722) + +#### Returns + +`string` + +#### Inherited from + +[`Module`](Module.md).[`identifier`](Module.md#identifier) + +*** + +### invalidateBuild() + +> **invalidateBuild**(): `void` + +Defined in: [webpack/types.d.ts:10721](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10721) + +#### Returns + +`void` + +#### Inherited from + +[`Module`](Module.md).[`invalidateBuild`](Module.md#invalidatebuild) + +*** + +### isAccessibleInChunk() + +> **isAccessibleInChunk**(`chunkGraph`, `chunk`, `ignoreChunk?`): `boolean` + +Defined in: [webpack/types.d.ts:10692](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10692) + +#### Parameters + +##### chunkGraph + +[`ChunkGraph`](ChunkGraph.md) + +##### chunk + +[`Chunk`](Chunk.md) + +##### ignoreChunk? + +[`Chunk`](Chunk.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`Module`](Module.md).[`isAccessibleInChunk`](Module.md#isaccessibleinchunk) + +*** + +### isAccessibleInChunkGroup() + +> **isAccessibleInChunkGroup**(`chunkGraph`, `chunkGroup`, `ignoreChunk?`): `boolean` + +Defined in: [webpack/types.d.ts:10697](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10697) + +#### Parameters + +##### chunkGraph + +[`ChunkGraph`](ChunkGraph.md) + +##### chunkGroup + +[`ChunkGroup`](ChunkGroup.md) + +##### ignoreChunk? + +[`Chunk`](Chunk.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`Module`](Module.md).[`isAccessibleInChunkGroup`](Module.md#isaccessibleinchunkgroup) + +*** + +### isEntryModule() + +> **isEntryModule**(): `boolean` + +Defined in: [webpack/types.d.ts:10670](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10670) + +#### Returns + +`boolean` + +#### Inherited from + +[`Module`](Module.md).[`isEntryModule`](Module.md#isentrymodule) + +*** + +### isInChunk() + +> **isInChunk**(`chunk`): `boolean` + +Defined in: [webpack/types.d.ts:10669](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10669) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`Module`](Module.md).[`isInChunk`](Module.md#isinchunk) + +*** + +### isOptional() + +> **isOptional**(`moduleGraph`): `boolean` + +Defined in: [webpack/types.d.ts:10691](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10691) + +#### Parameters + +##### moduleGraph + +[`ModuleGraph`](ModuleGraph.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`Module`](Module.md).[`isOptional`](Module.md#isoptional) + +*** + +### isProvided() + +> **isProvided**(`exportName`): `boolean` + +Defined in: [webpack/types.d.ts:10674](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10674) + +#### Parameters + +##### exportName + +`string` + +#### Returns + +`boolean` + +#### Inherited from + +[`Module`](Module.md).[`isProvided`](Module.md#isprovided) + +*** + +### libIdent() + +> **libIdent**(`options`): `string` + +Defined in: [webpack/types.d.ts:10752](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10752) + +#### Parameters + +##### options + +`LibIdentOptions` + +#### Returns + +`string` + +#### Inherited from + +[`Module`](Module.md).[`libIdent`](Module.md#libident) + +*** + +### nameForCondition() + +> **nameForCondition**(): `string` + +Defined in: [webpack/types.d.ts:10753](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10753) + +#### Returns + +`string` + +#### Inherited from + +[`Module`](Module.md).[`nameForCondition`](Module.md#nameforcondition) + +*** + +### needBuild() + +> **needBuild**(`context`, `callback`): `void` + +Defined in: [webpack/types.d.ts:10708](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10708) + +#### Parameters + +##### context + +`NeedBuildContext` + +##### callback + +(`err?`, `needBuild?`) => `void` + +#### Returns + +`void` + +#### Inherited from + +[`Module`](Module.md).[`needBuild`](Module.md#needbuild) + +*** + +### ~~needRebuild()~~ + +> **needRebuild**(`fileTimestamps`, `contextTimestamps`): `boolean` + +Defined in: [webpack/types.d.ts:10717](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10717) + +Use needBuild instead + +#### Parameters + +##### fileTimestamps + +`Map`\<`string`, `number`\> + +##### contextTimestamps + +`Map`\<`string`, `number`\> + +#### Returns + +`boolean` + +#### Deprecated + +#### Inherited from + +[`Module`](Module.md).[`needRebuild`](Module.md#needrebuild) + +*** + +### originalSource() + +> **originalSource**(): [`Source`](../webpack/namespaces/export=/namespaces/sources/classes/Source.md) + +Defined in: [webpack/types.d.ts:10779](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10779) + +#### Returns + +[`Source`](../webpack/namespaces/export=/namespaces/sources/classes/Source.md) + +#### Inherited from + +[`Module`](Module.md).[`originalSource`](Module.md#originalsource) + +*** + +### readableIdentifier() + +> **readableIdentifier**(`requestShortener`): `string` + +Defined in: [webpack/types.d.ts:10723](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10723) + +#### Parameters + +##### requestShortener + +`RequestShortener` + +#### Returns + +`string` + +#### Inherited from + +[`Module`](Module.md).[`readableIdentifier`](Module.md#readableidentifier) + +*** + +### removeChunk() + +> **removeChunk**(`chunk`): `void` + +Defined in: [webpack/types.d.ts:10668](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10668) + +#### Parameters + +##### chunk + +[`Chunk`](Chunk.md) + +#### Returns + +`void` + +#### Inherited from + +[`Module`](Module.md).[`removeChunk`](Module.md#removechunk) + +*** + +### removeDependency() + +> **removeDependency**(`dependency`): `void` + +Defined in: [webpack/types.d.ts:4120](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4120) + +#### Parameters + +##### dependency + +[`Dependency`](Dependency.md) + +#### Returns + +`void` + +#### Inherited from + +[`Module`](Module.md).[`removeDependency`](Module.md#removedependency) + +*** + +### serialize() + +> **serialize**(`__namedParameters`): `void` + +Defined in: [webpack/types.d.ts:4127](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4127) + +#### Parameters + +##### \_\_namedParameters + +[`ObjectSerializerContext`](../interfaces/ObjectSerializerContext.md) + +#### Returns + +`void` + +#### Inherited from + +[`Module`](Module.md).[`serialize`](Module.md#serialize) + +*** + +### shouldIsolate() + +> **shouldIsolate**(): `boolean` + +Defined in: [webpack/types.d.ts:16573](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L16573) + +#### Returns + +`boolean` + +*** + +### size() + +> **size**(`type?`): `number` + +Defined in: [webpack/types.d.ts:10751](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10751) + +#### Parameters + +##### type? + +`string` + +#### Returns + +`number` + +#### Inherited from + +[`Module`](Module.md).[`size`](Module.md#size) + +*** + +### ~~source()~~ + +> **source**(`dependencyTemplates`, `runtimeTemplate`, `type?`): [`Source`](../webpack/namespaces/export=/namespaces/sources/classes/Source.md) + +Defined in: [webpack/types.d.ts:10746](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10746) + +Use codeGeneration() instead + +#### Parameters + +##### dependencyTemplates + +`DependencyTemplates` + +##### runtimeTemplate + +`RuntimeTemplate` + +##### type? + +`string` + +#### Returns + +[`Source`](../webpack/namespaces/export=/namespaces/sources/classes/Source.md) + +#### Deprecated + +#### Inherited from + +[`Module`](Module.md).[`source`](Module.md#source) + +*** + +### updateCacheModule() + +> **updateCacheModule**(`module`): `void` + +Defined in: [webpack/types.d.ts:10767](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10767) + +Assuming this module is in the cache. Update the (cached) module with +the fresh module from the factory. Usually updates internal references +and properties. + +#### Parameters + +##### module + +[`Module`](Module.md) + +#### Returns + +`void` + +#### Inherited from + +[`Module`](Module.md).[`updateCacheModule`](Module.md#updatecachemodule) + +*** + +### updateHash() + +> **updateHash**(`hash`, `context`): `void` + +Defined in: [webpack/types.d.ts:4126](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4126) + +#### Parameters + +##### hash + +`Hash` + +##### context + +`UpdateHashContextDependency` + +#### Returns + +`void` + +#### Inherited from + +[`Module`](Module.md).[`updateHash`](Module.md#updatehash) diff --git a/api/classes/SourceMapDevToolPlugin.md b/api/classes/SourceMapDevToolPlugin.md new file mode 100644 index 0000000..649e095 --- /dev/null +++ b/api/classes/SourceMapDevToolPlugin.md @@ -0,0 +1,95 @@ +--- +title: SourceMapDevToolPlugin +--- + +[webpack](../globals.md) / SourceMapDevToolPlugin + +# Class: SourceMapDevToolPlugin + +Defined in: [webpack/types.d.ts:17493](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L17493) + +## Constructors + +### Constructor + +> **new SourceMapDevToolPlugin**(`options?`): `SourceMapDevToolPlugin` + +Defined in: [webpack/types.d.ts:17494](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L17494) + +#### Parameters + +##### options? + +`SourceMapDevToolPluginOptions` + +#### Returns + +`SourceMapDevToolPlugin` + +## Properties + +### fallbackModuleFilenameTemplate + +> **fallbackModuleFilenameTemplate**: `DevtoolFallbackModuleFilenameTemplate` + +Defined in: [webpack/types.d.ts:17501](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L17501) + +*** + +### moduleFilenameTemplate + +> **moduleFilenameTemplate**: `DevtoolModuleFilenameTemplate` + +Defined in: [webpack/types.d.ts:17500](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L17500) + +*** + +### namespace + +> **namespace**: `string` + +Defined in: [webpack/types.d.ts:17502](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L17502) + +*** + +### options + +> **options**: `SourceMapDevToolPluginOptions` + +Defined in: [webpack/types.d.ts:17503](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L17503) + +*** + +### sourceMapFilename? + +> `optional` **sourceMapFilename**: `string` \| `false` + +Defined in: [webpack/types.d.ts:17495](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L17495) + +*** + +### sourceMappingURLComment + +> **sourceMappingURLComment**: `string` \| `false` \| (`pathData`, `assetInfo?`) => `string` + +Defined in: [webpack/types.d.ts:17496](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L17496) + +## Methods + +### apply() + +> **apply**(`compiler`): `void` + +Defined in: [webpack/types.d.ts:17508](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L17508) + +Apply the plugin + +#### Parameters + +##### compiler + +[`Compiler`](Compiler.md) + +#### Returns + +`void` diff --git a/api/classes/Stats.md b/api/classes/Stats.md new file mode 100644 index 0000000..941cee5 --- /dev/null +++ b/api/classes/Stats.md @@ -0,0 +1,137 @@ +--- +title: Stats +--- + +[webpack](../globals.md) / Stats + +# Class: Stats + +Defined in: [webpack/types.d.ts:17896](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L17896) + +## Constructors + +### Constructor + +> **new Stats**(`compilation`): `Stats` + +Defined in: [webpack/types.d.ts:17897](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L17897) + +#### Parameters + +##### compilation + +[`Compilation`](Compilation.md) + +#### Returns + +`Stats` + +## Properties + +### compilation + +> **compilation**: [`Compilation`](Compilation.md) + +Defined in: [webpack/types.d.ts:17898](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L17898) + +## Accessors + +### endTime + +#### Get Signature + +> **get** **endTime**(): `number` + +Defined in: [webpack/types.d.ts:17901](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L17901) + +##### Returns + +`number` + +*** + +### hash + +#### Get Signature + +> **get** **hash**(): `string` + +Defined in: [webpack/types.d.ts:17899](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L17899) + +##### Returns + +`string` + +*** + +### startTime + +#### Get Signature + +> **get** **startTime**(): `number` + +Defined in: [webpack/types.d.ts:17900](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L17900) + +##### Returns + +`number` + +## Methods + +### hasErrors() + +> **hasErrors**(): `boolean` + +Defined in: [webpack/types.d.ts:17903](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L17903) + +#### Returns + +`boolean` + +*** + +### hasWarnings() + +> **hasWarnings**(): `boolean` + +Defined in: [webpack/types.d.ts:17902](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L17902) + +#### Returns + +`boolean` + +*** + +### toJson() + +> **toJson**(`options?`): [`StatsCompilation`](../type-aliases/StatsCompilation.md) + +Defined in: [webpack/types.d.ts:17904](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L17904) + +#### Parameters + +##### options? + +`boolean` | `"none"` | `"normal"` | `"summary"` | `"verbose"` | `"errors-only"` | `"errors-warnings"` | `"minimal"` | `"detailed"` | [`StatsOptions`](../interfaces/StatsOptions.md) + +#### Returns + +[`StatsCompilation`](../type-aliases/StatsCompilation.md) + +*** + +### toString() + +> **toString**(`options?`): `string` + +Defined in: [webpack/types.d.ts:17917](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L17917) + +#### Parameters + +##### options? + +`boolean` | `"none"` | `"normal"` | `"summary"` | `"verbose"` | `"errors-only"` | `"errors-warnings"` | `"minimal"` | `"detailed"` | [`StatsOptions`](../interfaces/StatsOptions.md) + +#### Returns + +`string` diff --git a/api/classes/Template.md b/api/classes/Template.md new file mode 100644 index 0000000..282f75e --- /dev/null +++ b/api/classes/Template.md @@ -0,0 +1,313 @@ +--- +title: Template +--- + +[webpack](../globals.md) / Template + +# Class: Template + +Defined in: [webpack/types.d.ts:18613](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L18613) + +## Constructors + +### Constructor + +> **new Template**(): `Template` + +Defined in: [webpack/types.d.ts:18614](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L18614) + +#### Returns + +`Template` + +## Properties + +### NUMBER\_OF\_IDENTIFIER\_CONTINUATION\_CHARS + +> `static` **NUMBER\_OF\_IDENTIFIER\_CONTINUATION\_CHARS**: `number` + +Defined in: [webpack/types.d.ts:18642](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L18642) + +*** + +### NUMBER\_OF\_IDENTIFIER\_START\_CHARS + +> `static` **NUMBER\_OF\_IDENTIFIER\_START\_CHARS**: `number` + +Defined in: [webpack/types.d.ts:18643](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L18643) + +## Methods + +### asString() + +> `static` **asString**(`str`): `string` + +Defined in: [webpack/types.d.ts:18624](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L18624) + +#### Parameters + +##### str + +`string` | `string`[] + +#### Returns + +`string` + +*** + +### getFunctionContent() + +> `static` **getFunctionContent**(`fn`): `string` + +Defined in: [webpack/types.d.ts:18615](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L18615) + +#### Parameters + +##### fn + +`Stringable` + +#### Returns + +`string` + +*** + +### getModulesArrayBounds() + +> `static` **getModulesArrayBounds**(`modules`): `false` \| \[`number`, `number`\] + +Defined in: [webpack/types.d.ts:18625](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L18625) + +#### Parameters + +##### modules + +`WithId`[] + +#### Returns + +`false` \| \[`number`, `number`\] + +*** + +### indent() + +> `static` **indent**(`s`): `string` + +Defined in: [webpack/types.d.ts:18622](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L18622) + +#### Parameters + +##### s + +`string` | `string`[] + +#### Returns + +`string` + +*** + +### numberToIdentifier() + +> `static` **numberToIdentifier**(`n`): `string` + +Defined in: [webpack/types.d.ts:18620](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L18620) + +#### Parameters + +##### n + +`number` + +#### Returns + +`string` + +*** + +### numberToIdentifierContinuation() + +> `static` **numberToIdentifierContinuation**(`n`): `string` + +Defined in: [webpack/types.d.ts:18621](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L18621) + +#### Parameters + +##### n + +`number` + +#### Returns + +`string` + +*** + +### prefix() + +> `static` **prefix**(`s`, `prefix`): `string` + +Defined in: [webpack/types.d.ts:18623](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L18623) + +#### Parameters + +##### s + +`string` | `string`[] + +##### prefix + +`string` + +#### Returns + +`string` + +*** + +### renderChunkModules() + +> `static` **renderChunkModules**(`renderContext`, `modules`, `renderModule`, `prefix?`): [`Source`](../webpack/namespaces/export=/namespaces/sources/classes/Source.md) + +Defined in: [webpack/types.d.ts:18626](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L18626) + +#### Parameters + +##### renderContext + +`ChunkRenderContextJavascriptModulesPlugin` + +##### modules + +[`Module`](Module.md)[] + +##### renderModule + +(`module`, `renderInArray?`) => [`Source`](../webpack/namespaces/export=/namespaces/sources/classes/Source.md) + +##### prefix? + +`string` + +#### Returns + +[`Source`](../webpack/namespaces/export=/namespaces/sources/classes/Source.md) + +*** + +### renderChunkRuntimeModules() + +> `static` **renderChunkRuntimeModules**(`runtimeModules`, `renderContext`): [`Source`](../webpack/namespaces/export=/namespaces/sources/classes/Source.md) + +Defined in: [webpack/types.d.ts:18638](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L18638) + +#### Parameters + +##### runtimeModules + +[`RuntimeModule`](RuntimeModule.md)[] + +##### renderContext + +`RenderContextJavascriptModulesPlugin` + +#### Returns + +[`Source`](../webpack/namespaces/export=/namespaces/sources/classes/Source.md) + +*** + +### renderRuntimeModules() + +> `static` **renderRuntimeModules**(`runtimeModules`, `renderContext`): [`Source`](../webpack/namespaces/export=/namespaces/sources/classes/Source.md) + +Defined in: [webpack/types.d.ts:18632](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L18632) + +#### Parameters + +##### runtimeModules + +[`RuntimeModule`](RuntimeModule.md)[] + +##### renderContext + +`RenderContextJavascriptModulesPlugin` & `object` + +#### Returns + +[`Source`](../webpack/namespaces/export=/namespaces/sources/classes/Source.md) + +*** + +### toComment() + +> `static` **toComment**(`str`): `string` + +Defined in: [webpack/types.d.ts:18617](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L18617) + +#### Parameters + +##### str + +`string` + +#### Returns + +`string` + +*** + +### toIdentifier() + +> `static` **toIdentifier**(`str`): `string` + +Defined in: [webpack/types.d.ts:18616](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L18616) + +#### Parameters + +##### str + +`string` + +#### Returns + +`string` + +*** + +### toNormalComment() + +> `static` **toNormalComment**(`str`): `string` + +Defined in: [webpack/types.d.ts:18618](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L18618) + +#### Parameters + +##### str + +`string` + +#### Returns + +`string` + +*** + +### toPath() + +> `static` **toPath**(`str`): `string` + +Defined in: [webpack/types.d.ts:18619](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L18619) + +#### Parameters + +##### str + +`string` + +#### Returns + +`string` diff --git a/api/classes/WatchIgnorePlugin.md b/api/classes/WatchIgnorePlugin.md new file mode 100644 index 0000000..cb8d66e --- /dev/null +++ b/api/classes/WatchIgnorePlugin.md @@ -0,0 +1,55 @@ +--- +title: WatchIgnorePlugin +--- + +[webpack](../globals.md) / WatchIgnorePlugin + +# Class: WatchIgnorePlugin + +Defined in: [webpack/types.d.ts:18839](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L18839) + +## Constructors + +### Constructor + +> **new WatchIgnorePlugin**(`options`): `WatchIgnorePlugin` + +Defined in: [webpack/types.d.ts:18840](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L18840) + +#### Parameters + +##### options + +`WatchIgnorePluginOptions` + +#### Returns + +`WatchIgnorePlugin` + +## Properties + +### options + +> **options**: `WatchIgnorePluginOptions` + +Defined in: [webpack/types.d.ts:18841](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L18841) + +## Methods + +### apply() + +> **apply**(`compiler`): `void` + +Defined in: [webpack/types.d.ts:18846](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L18846) + +Apply the plugin + +#### Parameters + +##### compiler + +[`Compiler`](Compiler.md) + +#### Returns + +`void` diff --git a/api/classes/Watching.md b/api/classes/Watching.md new file mode 100644 index 0000000..946bd12 --- /dev/null +++ b/api/classes/Watching.md @@ -0,0 +1,223 @@ +--- +title: Watching +--- + +[webpack](../globals.md) / Watching + +# Abstract Class: Watching + +Defined in: [webpack/types.d.ts:18969](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L18969) + +## Constructors + +### Constructor + +> **new Watching**(): `Watching` + +#### Returns + +`Watching` + +## Properties + +### blocked + +> **blocked**: `boolean` + +Defined in: [webpack/types.d.ts:18976](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L18976) + +*** + +### callbacks + +> **callbacks**: (`err`, `result?`) => `void`[] + +Defined in: [webpack/types.d.ts:18973](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L18973) + +#### Parameters + +##### err + +`Error` + +##### result? + +`void` + +#### Returns + +`void` + +*** + +### closed + +> **closed**: `boolean` + +Defined in: [webpack/types.d.ts:18974](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L18974) + +*** + +### compiler + +> **compiler**: [`Compiler`](Compiler.md) + +Defined in: [webpack/types.d.ts:18978](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L18978) + +*** + +### handler + +> **handler**: `CallbackWebpackFunction_2`\<[`Stats`](Stats.md), `void`\> + +Defined in: [webpack/types.d.ts:18972](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L18972) + +*** + +### invalid + +> **invalid**: `boolean` + +Defined in: [webpack/types.d.ts:18971](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L18971) + +*** + +### lastWatcherStartTime? + +> `optional` **lastWatcherStartTime**: `number` + +Defined in: [webpack/types.d.ts:18982](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L18982) + +*** + +### pausedWatcher? + +> `optional` **pausedWatcher**: `Watcher` + +Defined in: [webpack/types.d.ts:18981](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L18981) + +*** + +### running + +> **running**: `boolean` + +Defined in: [webpack/types.d.ts:18979](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L18979) + +*** + +### startTime + +> **startTime**: `number` + +Defined in: [webpack/types.d.ts:18970](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L18970) + +*** + +### suspended + +> **suspended**: `boolean` + +Defined in: [webpack/types.d.ts:18975](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L18975) + +*** + +### watcher? + +> `optional` **watcher**: `Watcher` + +Defined in: [webpack/types.d.ts:18980](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L18980) + +*** + +### watchOptions + +> **watchOptions**: `WatchOptions` + +Defined in: [webpack/types.d.ts:18977](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L18977) + +## Methods + +### close() + +> **close**(`callback`): `void` + +Defined in: [webpack/types.d.ts:18991](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L18991) + +#### Parameters + +##### callback + +(`err`, `result?`) => `void` + +#### Returns + +`void` + +*** + +### invalidate() + +> **invalidate**(`callback?`): `void` + +Defined in: [webpack/types.d.ts:18988](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L18988) + +#### Parameters + +##### callback? + +(`err`, `result?`) => `void` + +#### Returns + +`void` + +*** + +### resume() + +> **resume**(): `void` + +Defined in: [webpack/types.d.ts:18990](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L18990) + +#### Returns + +`void` + +*** + +### suspend() + +> **suspend**(): `void` + +Defined in: [webpack/types.d.ts:18989](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L18989) + +#### Returns + +`void` + +*** + +### watch() + +> **watch**(`files`, `dirs`, `missing`): `void` + +Defined in: [webpack/types.d.ts:18983](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L18983) + +#### Parameters + +##### files + +`Iterable`\<`string`\> + +##### dirs + +`Iterable`\<`string`\> + +##### missing + +`Iterable`\<`string`\> + +#### Returns + +`void` diff --git a/api/classes/WebpackError.md b/api/classes/WebpackError.md new file mode 100644 index 0000000..d9625ce --- /dev/null +++ b/api/classes/WebpackError.md @@ -0,0 +1,278 @@ +--- +title: WebpackError +--- + +[webpack](../globals.md) / WebpackError + +# Class: WebpackError + +Defined in: [webpack/types.d.ts:19041](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L19041) + +## Extends + +- `Error` + +## Indexable + +\[`index`: `number`\]: () => `string` + +## Constructors + +### Constructor + +> **new WebpackError**(`message?`, `options?`): `WebpackError` + +Defined in: [webpack/types.d.ts:19045](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L19045) + +Creates an instance of WebpackError. + +#### Parameters + +##### message? + +`string` + +##### options? + +###### cause? + +`unknown` + +#### Returns + +`WebpackError` + +#### Overrides + +`Error.constructor` + +## Properties + +### chunk? + +> `optional` **chunk**: [`Chunk`](Chunk.md) + +Defined in: [webpack/types.d.ts:19051](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L19051) + +*** + +### details? + +> `optional` **details**: `string` + +Defined in: [webpack/types.d.ts:19047](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L19047) + +*** + +### file? + +> `optional` **file**: `string` + +Defined in: [webpack/types.d.ts:19052](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L19052) + +*** + +### hideStack? + +> `optional` **hideStack**: `boolean` + +Defined in: [webpack/types.d.ts:19050](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L19050) + +*** + +### loc? + +> `optional` **loc**: `SyntheticDependencyLocation` \| `RealDependencyLocation` + +Defined in: [webpack/types.d.ts:19049](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L19049) + +*** + +### message + +> **message**: `string` + +Defined in: docs.webpack.js.org/node\_modules/typescript/lib/lib.es5.d.ts:1077 + +#### Inherited from + +`Error.message` + +*** + +### module? + +> `optional` **module**: [`Module`](Module.md) + +Defined in: [webpack/types.d.ts:19048](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L19048) + +*** + +### name + +> **name**: `string` + +Defined in: docs.webpack.js.org/node\_modules/typescript/lib/lib.es5.d.ts:1076 + +#### Inherited from + +`Error.name` + +*** + +### stack? + +> `optional` **stack**: `string` + +Defined in: docs.webpack.js.org/node\_modules/typescript/lib/lib.es5.d.ts:1078 + +#### Inherited from + +`Error.stack` + +*** + +### stackTraceLimit + +> `static` **stackTraceLimit**: `number` + +Defined in: [webpack/types.d.ts:19107](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L19107) + +The `Error.stackTraceLimit` property specifies the number of stack frames +collected by a stack trace (whether generated by `new Error().stack` or +`Error.captureStackTrace(obj)`). +The default value is `10` but may be set to any valid JavaScript number. Changes +will affect any stack trace captured _after_ the value has been changed. +If set to a non-number value, or set to a negative number, stack traces will +not capture any frames. + +#### Overrides + +`Error.stackTraceLimit` + +## Methods + +### deserialize() + +> **deserialize**(`__namedParameters`): `void` + +Defined in: [webpack/types.d.ts:19054](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L19054) + +#### Parameters + +##### \_\_namedParameters + +[`ObjectDeserializerContext`](../interfaces/ObjectDeserializerContext.md) + +#### Returns + +`void` + +*** + +### serialize() + +> **serialize**(`__namedParameters`): `void` + +Defined in: [webpack/types.d.ts:19053](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L19053) + +#### Parameters + +##### \_\_namedParameters + +[`ObjectSerializerContext`](../interfaces/ObjectSerializerContext.md) + +#### Returns + +`void` + +*** + +### captureStackTrace() + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Defined in: [webpack/types.d.ts:19092](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L19092) + +Creates a `.stack` property on `targetObject`, which when accessed returns +a string representing the location in the code at which +`Error.captureStackTrace()` was called. +```js +const myObject = {}; +Error.captureStackTrace(myObject); +myObject.stack; // Similar to `new Error().stack` +``` +The first line of the trace will be prefixed with +`${myObject.name}: ${myObject.message}`. +The optional `constructorOpt` argument accepts a function. If given, all frames +above `constructorOpt`, including `constructorOpt`, will be omitted from the +generated stack trace. +The `constructorOpt` argument is useful for hiding implementation +details of error generation from the user. For instance: +```js +function a() { + b(); +} +function b() { + c(); +} +function c() { + // Create an error without stack trace to avoid calculating the stack trace twice. + const { stackTraceLimit } = Error; + Error.stackTraceLimit = 0; + const error = new Error(); + Error.stackTraceLimit = stackTraceLimit; + // Capture the stack trace above function b + Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace + throw error; +} +a(); +``` + +#### Parameters + +##### targetObject + +`object` + +##### constructorOpt? + +`Function` + +#### Returns + +`void` + +#### Overrides + +`Error.captureStackTrace` + +*** + +### prepareStackTrace() + +> `static` **prepareStackTrace**(`err`, `stackTraces`): `any` + +Defined in: [webpack/types.d.ts:19096](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L19096) + +#### Parameters + +##### err + +`Error` + +##### stackTraces + +`CallSite`[] + +#### Returns + +`any` + +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Overrides + +`Error.prepareStackTrace` diff --git a/api/classes/WebpackOptionsApply.md b/api/classes/WebpackOptionsApply.md new file mode 100644 index 0000000..42a95c3 --- /dev/null +++ b/api/classes/WebpackOptionsApply.md @@ -0,0 +1,59 @@ +--- +title: WebpackOptionsApply +--- + +[webpack](../globals.md) / WebpackOptionsApply + +# Class: WebpackOptionsApply + +Defined in: [webpack/types.d.ts:19131](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L19131) + +## Extends + +- `OptionsApply` + +## Constructors + +### Constructor + +> **new WebpackOptionsApply**(): `WebpackOptionsApply` + +Defined in: [webpack/types.d.ts:19132](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L19132) + +#### Returns + +`WebpackOptionsApply` + +#### Overrides + +`OptionsApply.constructor` + +## Methods + +### process() + +> **process**(`options`, `compiler`, `interception?`): `WebpackOptionsNormalizedWithDefaults` + +Defined in: [webpack/types.d.ts:13225](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L13225) + +#### Parameters + +##### options + +`WebpackOptionsNormalizedWithDefaults` + +##### compiler + +[`Compiler`](Compiler.md) + +##### interception? + +`WebpackOptionsInterception` + +#### Returns + +`WebpackOptionsNormalizedWithDefaults` + +#### Inherited from + +`OptionsApply.process` diff --git a/api/classes/WebpackOptionsDefaulter.md b/api/classes/WebpackOptionsDefaulter.md new file mode 100644 index 0000000..0adc252 --- /dev/null +++ b/api/classes/WebpackOptionsDefaulter.md @@ -0,0 +1,39 @@ +--- +title: WebpackOptionsDefaulter +--- + +[webpack](../globals.md) / WebpackOptionsDefaulter + +# Class: WebpackOptionsDefaulter + +Defined in: [webpack/types.d.ts:19134](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L19134) + +## Constructors + +### Constructor + +> **new WebpackOptionsDefaulter**(): `WebpackOptionsDefaulter` + +Defined in: [webpack/types.d.ts:19135](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L19135) + +#### Returns + +`WebpackOptionsDefaulter` + +## Methods + +### process() + +> **process**(`options`): [`WebpackOptionsNormalized`](../interfaces/WebpackOptionsNormalized.md) + +Defined in: [webpack/types.d.ts:19136](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L19136) + +#### Parameters + +##### options + +[`Configuration`](../interfaces/Configuration.md) + +#### Returns + +[`WebpackOptionsNormalized`](../interfaces/WebpackOptionsNormalized.md) diff --git a/api/functions/export=.md b/api/functions/export=.md new file mode 100644 index 0000000..29c4b66 --- /dev/null +++ b/api/functions/export=.md @@ -0,0 +1,79 @@ +--- +title: export= +--- + +[webpack](../globals.md) / export= + +# Function: export=() + +## Call Signature + +> **export=**(`options`, `callback`): [`Compiler`](../classes/Compiler.md) + +Defined in: [webpack/types.d.ts:19547](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L19547) + +### Parameters + +#### options + +[`Configuration`](../interfaces/Configuration.md) + +#### callback + +`CallbackWebpackFunction_2`\<[`Stats`](../classes/Stats.md), `void`\> + +### Returns + +[`Compiler`](../classes/Compiler.md) + +## Call Signature + +> **export=**(`options`): [`Compiler`](../classes/Compiler.md) + +Defined in: [webpack/types.d.ts:19551](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L19551) + +### Parameters + +#### options + +[`Configuration`](../interfaces/Configuration.md) + +### Returns + +[`Compiler`](../classes/Compiler.md) + +## Call Signature + +> **export=**(`options`, `callback`): [`MultiCompiler`](../classes/MultiCompiler.md) + +Defined in: [webpack/types.d.ts:19552](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L19552) + +### Parameters + +#### options + +[`MultiConfiguration`](../type-aliases/MultiConfiguration.md) + +#### callback + +`CallbackWebpackFunction_2`\<[`MultiStats`](../classes/MultiStats.md), `void`\> + +### Returns + +[`MultiCompiler`](../classes/MultiCompiler.md) + +## Call Signature + +> **export=**(`options`): [`MultiCompiler`](../classes/MultiCompiler.md) + +Defined in: [webpack/types.d.ts:19556](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L19556) + +### Parameters + +#### options + +[`MultiConfiguration`](../type-aliases/MultiConfiguration.md) + +### Returns + +[`MultiCompiler`](../classes/MultiCompiler.md) diff --git a/api/globals.md b/api/globals.md new file mode 100644 index 0000000..e571010 --- /dev/null +++ b/api/globals.md @@ -0,0 +1,185 @@ +--- +title: webpack +--- + +# webpack + +## Namespaces + +- [export=](webpack/namespaces/export=/index.md) + +## Classes + +- [AsyncDependenciesBlock](classes/AsyncDependenciesBlock.md) +- [AutomaticPrefetchPlugin](classes/AutomaticPrefetchPlugin.md) +- [BannerPlugin](classes/BannerPlugin.md) +- [Cache](classes/Cache.md) +- [Chunk](classes/Chunk.md) +- [ChunkGraph](classes/ChunkGraph.md) +- [ChunkGroup](classes/ChunkGroup.md) +- [CleanPlugin](classes/CleanPlugin.md) +- [CodeGenerationResults](classes/CodeGenerationResults.md) +- [Compilation](classes/Compilation.md) +- [Compiler](classes/Compiler.md) +- [ConcatenationScope](classes/ConcatenationScope.md) +- [ContextExclusionPlugin](classes/ContextExclusionPlugin.md) +- [ContextReplacementPlugin](classes/ContextReplacementPlugin.md) +- [DefinePlugin](classes/DefinePlugin.md) +- [DelegatedPlugin](classes/DelegatedPlugin.md) +- [Dependency](classes/Dependency.md) +- [DllPlugin](classes/DllPlugin.md) +- [DllReferencePlugin](classes/DllReferencePlugin.md) +- [DotenvPlugin](classes/DotenvPlugin.md) +- [DynamicEntryPlugin](classes/DynamicEntryPlugin.md) +- [EntryOptionPlugin](classes/EntryOptionPlugin.md) +- [EntryPlugin](classes/EntryPlugin.md) +- [Entrypoint](classes/Entrypoint.md) +- [EnvironmentPlugin](classes/EnvironmentPlugin.md) +- [EvalDevToolModulePlugin](classes/EvalDevToolModulePlugin.md) +- [EvalSourceMapDevToolPlugin](classes/EvalSourceMapDevToolPlugin.md) +- [ExternalModule](classes/ExternalModule.md) +- [ExternalsPlugin](classes/ExternalsPlugin.md) +- [Generator](classes/Generator.md) +- [HotModuleReplacementPlugin](classes/HotModuleReplacementPlugin.md) +- [HotUpdateChunk](classes/HotUpdateChunk.md) +- [IgnorePlugin](classes/IgnorePlugin.md) +- [InitFragment](classes/InitFragment.md) +- [JavascriptModulesPlugin](classes/JavascriptModulesPlugin.md) +- [LibManifestPlugin](classes/LibManifestPlugin.md) +- [LibraryTemplatePlugin](classes/LibraryTemplatePlugin.md) +- [LoaderOptionsPlugin](classes/LoaderOptionsPlugin.md) +- [LoaderTargetPlugin](classes/LoaderTargetPlugin.md) +- [ManifestPlugin](classes/ManifestPlugin.md) +- [Module](classes/Module.md) +- [ModuleFactory](classes/ModuleFactory.md) +- [ModuleGraph](classes/ModuleGraph.md) +- [ModuleGraphConnection](classes/ModuleGraphConnection.md) +- [MultiCompiler](classes/MultiCompiler.md) +- [MultiStats](classes/MultiStats.md) +- [NoEmitOnErrorsPlugin](classes/NoEmitOnErrorsPlugin.md) +- [NormalModule](classes/NormalModule.md) +- [NormalModuleReplacementPlugin](classes/NormalModuleReplacementPlugin.md) +- [Parser](classes/Parser.md) +- [PlatformPlugin](classes/PlatformPlugin.md) +- [PrefetchPlugin](classes/PrefetchPlugin.md) +- [ProgressPlugin](classes/ProgressPlugin.md) +- [ProvidePlugin](classes/ProvidePlugin.md) +- [Resolver](classes/Resolver.md) +- [RuntimeModule](classes/RuntimeModule.md) +- [SourceMapDevToolPlugin](classes/SourceMapDevToolPlugin.md) +- [Stats](classes/Stats.md) +- [Template](classes/Template.md) +- [WatchIgnorePlugin](classes/WatchIgnorePlugin.md) +- [Watching](classes/Watching.md) +- [WebpackError](classes/WebpackError.md) +- [WebpackOptionsApply](classes/WebpackOptionsApply.md) +- [WebpackOptionsDefaulter](classes/WebpackOptionsDefaulter.md) + +## Interfaces + +- [Argument](interfaces/Argument.md) +- [Asset](interfaces/Asset.md) +- [AssetEmittedInfo](interfaces/AssetEmittedInfo.md) +- [Colors](interfaces/Colors.md) +- [ColorsOptions](interfaces/ColorsOptions.md) +- [Configuration](interfaces/Configuration.md) +- [EntryObject](interfaces/EntryObject.md) +- [ExternalItemFunctionData](interfaces/ExternalItemFunctionData.md) +- [ExternalItemObjectKnown](interfaces/ExternalItemObjectKnown.md) +- [ExternalItemObjectUnknown](interfaces/ExternalItemObjectUnknown.md) +- [FileCacheOptions](interfaces/FileCacheOptions.md) +- [GeneratorOptionsByModuleTypeKnown](interfaces/GeneratorOptionsByModuleTypeKnown.md) +- [InputFileSystem](interfaces/InputFileSystem.md) +- [LibraryOptions](interfaces/LibraryOptions.md) +- [LoaderDefinitionFunction](interfaces/LoaderDefinitionFunction.md) +- [LoaderModule](interfaces/LoaderModule.md) +- [MemoryCacheOptions](interfaces/MemoryCacheOptions.md) +- [ModuleOptions](interfaces/ModuleOptions.md) +- [MultiCompilerOptions](interfaces/MultiCompilerOptions.md) +- [ObjectDeserializerContext](interfaces/ObjectDeserializerContext.md) +- [ObjectSerializerContext](interfaces/ObjectSerializerContext.md) +- [OutputFileSystem](interfaces/OutputFileSystem.md) +- [ParserOptionsByModuleTypeKnown](interfaces/ParserOptionsByModuleTypeKnown.md) +- [PathData](interfaces/PathData.md) +- [PitchLoaderDefinitionFunction](interfaces/PitchLoaderDefinitionFunction.md) +- [Problem](interfaces/Problem.md) +- [RawLoaderDefinitionFunction](interfaces/RawLoaderDefinitionFunction.md) +- [RenderManifestOptions](interfaces/RenderManifestOptions.md) +- [ResolveData](interfaces/ResolveData.md) +- [ResolveOptions](interfaces/ResolveOptions.md) +- [RuleSetRule](interfaces/RuleSetRule.md) +- [StatsOptions](interfaces/StatsOptions.md) +- [WebpackOptionsNormalized](interfaces/WebpackOptionsNormalized.md) +- [WebpackPluginInstance](interfaces/WebpackPluginInstance.md) + +## Type Aliases + +- [AssetInfo](type-aliases/AssetInfo.md) +- [Entry](type-aliases/Entry.md) +- [EntryNormalized](type-aliases/EntryNormalized.md) +- [EntryOptions](type-aliases/EntryOptions.md) +- [ExternalItem](type-aliases/ExternalItem.md) +- [ExternalItemFunction](type-aliases/ExternalItemFunction.md) +- [ExternalItemFunctionCallback](type-aliases/ExternalItemFunctionCallback.md) +- [ExternalItemFunctionDataGetResolve](type-aliases/ExternalItemFunctionDataGetResolve.md) +- [ExternalItemFunctionDataGetResolveCallbackResult](type-aliases/ExternalItemFunctionDataGetResolveCallbackResult.md) +- [ExternalItemFunctionDataGetResolveResult](type-aliases/ExternalItemFunctionDataGetResolveResult.md) +- [ExternalItemFunctionPromise](type-aliases/ExternalItemFunctionPromise.md) +- [ExternalItemValue](type-aliases/ExternalItemValue.md) +- [Externals](type-aliases/Externals.md) +- [LoaderContext](type-aliases/LoaderContext.md) +- [LoaderDefinition](type-aliases/LoaderDefinition.md) +- [MultiConfiguration](type-aliases/MultiConfiguration.md) +- [ParserState](type-aliases/ParserState.md) +- [RawLoaderDefinition](type-aliases/RawLoaderDefinition.md) +- [RenderManifestEntry](type-aliases/RenderManifestEntry.md) +- [ResolvePluginInstance](type-aliases/ResolvePluginInstance.md) +- [RuleSetCondition](type-aliases/RuleSetCondition.md) +- [RuleSetConditionAbsolute](type-aliases/RuleSetConditionAbsolute.md) +- [RuleSetUse](type-aliases/RuleSetUse.md) +- [RuleSetUseFunction](type-aliases/RuleSetUseFunction.md) +- [RuleSetUseItem](type-aliases/RuleSetUseItem.md) +- [StatsAsset](type-aliases/StatsAsset.md) +- [StatsChunk](type-aliases/StatsChunk.md) +- [StatsChunkGroup](type-aliases/StatsChunkGroup.md) +- [StatsChunkOrigin](type-aliases/StatsChunkOrigin.md) +- [StatsCompilation](type-aliases/StatsCompilation.md) +- [StatsError](type-aliases/StatsError.md) +- [StatsLogging](type-aliases/StatsLogging.md) +- [StatsLoggingEntry](type-aliases/StatsLoggingEntry.md) +- [StatsModule](type-aliases/StatsModule.md) +- [StatsModuleIssuer](type-aliases/StatsModuleIssuer.md) +- [StatsModuleReason](type-aliases/StatsModuleReason.md) +- [StatsModuleTraceDependency](type-aliases/StatsModuleTraceDependency.md) +- [StatsModuleTraceItem](type-aliases/StatsModuleTraceItem.md) +- [StatsProfile](type-aliases/StatsProfile.md) +- [TemplatePath](type-aliases/TemplatePath.md) +- [WebpackPluginFunction](type-aliases/WebpackPluginFunction.md) + +## Functions + +- [export=](functions/export=.md) + +## References + +### MultiStatsOptions + +Renames and re-exports [StatsOptions](interfaces/StatsOptions.md) + +*** + +### SingleEntryPlugin + +Renames and re-exports [EntryPlugin](classes/EntryPlugin.md) + +*** + +### ValidationError + +Renames and re-exports [WebpackOptionsValidationError](webpack/namespaces/export=/classes/WebpackOptionsValidationError.md) + +*** + +### WebpackOptionsValidationError + +Re-exports [WebpackOptionsValidationError](webpack/namespaces/export=/classes/WebpackOptionsValidationError.md) diff --git a/api/index.md b/api/index.md new file mode 100644 index 0000000..f4e2651 --- /dev/null +++ b/api/index.md @@ -0,0 +1,665 @@ +--- +title: webpack +--- + +
+ + + +
+
+ +[![npm][npm]][npm-url] + +[![node][node]][node-url] +[![builds1][builds1]][builds1-url] +[![dependency-review][dependency-review]][dependency-review-url] +[![coverage][cover]][cover-url] +[![pkg.pr.new](https://pkg.pr.new/badge/webpack/webpack)](https://pkg.pr.new/~/webpack/webpack) +[![PR's welcome][prs]][prs-url] +[![compatibility-score](https://api.dependabot.com/badges/compatibility_score?dependency-name=webpack&package-manager=npm_and_yarn&previous-version=5.72.1&new-version=5.73.0)](https://docs.github.com/en/code-security/dependabot/dependabot-security-updates/about-dependabot-security-updates#about-compatibility-scores) +[![downloads](https://img.shields.io/npm/dm/webpack.svg)](https://npmcharts.com/compare/webpack?minimal=true) +[![install-size](https://packagephobia.com/badge?p=webpack)](https://packagephobia.com/result?p=webpack) +[![backers](https://opencollective.com/webpack/backers/badge.svg)](https://opencollective.com/webpack#backer) +[![sponsors](https://opencollective.com/webpack/sponsors/badge.svg)](https://opencollective.com/webpack#sponsors) +[![contributors](https://img.shields.io/github/contributors/webpack/webpack.svg)](https://github.com/webpack/webpack/graphs/contributors) +[![discussions](https://img.shields.io/github/discussions/webpack/webpack)](https://github.com/webpack/webpack/discussions) +[![discord](https://img.shields.io/discord/1180618526436888586?label=discord&logo=discord&logoColor=white&style=flat)](https://discord.gg/5sxFZPdx2k) +[![LFX Health Score](https://insights.linuxfoundation.org/api/badge/health-score?project=webpack)](https://insights.linuxfoundation.org/project/webpack) + +

webpack

+

+ Webpack is a module bundler. Its main purpose is to bundle JavaScript files for usage in a browser, yet it is also capable of transforming, bundling, or packaging just about any resource or asset. +

+
+ +## Table of Contents + +- [Install](#install) +- [Introduction](#introduction) +- [Concepts](#concepts) +- [Contributing](#contributing) +- [Support](#support) +- [Current project members](#current-project-members) + - [TSC (Technical Steering Committee)](#tsc-technical-steering-committee) + - [Core Collaborators](#core-collaborators) +- [Sponsoring](#sponsoring) + - [Premium Partners](#premium-partners) + - [Gold Sponsors](#gold-sponsors) + - [Silver Sponsors](#silver-sponsors) + - [Bronze Sponsors](#bronze-sponsors) + - [Backers](#backers) +- [Special Thanks](#special-thanks-to) + +## Install + +Install with npm: + +```bash +npm install --save-dev webpack +``` + +Install with yarn: + +```bash +yarn add webpack --dev +``` + +## Introduction + +Webpack is a bundler for modules. The main purpose is to bundle JavaScript +files for usage in a browser, yet it is also capable of transforming, bundling, +or packaging just about any resource or asset. + +**TL;DR** + +- Bundles [ES Modules](https://www.2ality.com/2014/09/es6-modules-final.html), [CommonJS](https://wiki.commonjs.org/), and [AMD](https://github.com/amdjs/amdjs-api/wiki/AMD) modules (even combined). +- Can create a single bundle or multiple chunks that are asynchronously loaded at runtime (to reduce initial loading time). +- Dependencies are resolved during compilation, reducing the runtime size. +- Loaders can preprocess files while compiling, e.g. TypeScript to JavaScript, Handlebars strings to compiled functions, images to Base64, etc. +- Highly modular plugin system to do whatever else your application requires. + +#### Learn about webpack through videos! + +- [Understanding Webpack - Video 1](https://www.youtube.com/watch?v=xj93pvQIsRo) +- [Understanding Webpack - Video 2](https://www.youtube.com/watch?v=4tQiJaFzuJ8) + +### Get Started + +Check out webpack's quick [**Get Started**](https://webpack.js.org/guides/getting-started) guide and the [other guides](https://webpack.js.org/guides/). + +### Browser Compatibility + +Webpack supports all browsers that are [ES5-compliant](https://kangax.github.io/compat-table/es5/) (IE8 and below are not supported). +Webpack also needs `Promise` for `import()` and `require.ensure()`. If you want to support older browsers, you will need to [load a polyfill](https://webpack.js.org/guides/shimming/) before using these expressions. + +## Concepts + +### [Plugins](https://webpack.js.org/plugins/) + +Webpack has a [rich plugin +interface](https://webpack.js.org/plugins/). Most of the features +within webpack itself use this plugin interface. This makes webpack very +**flexible**. + +| Name | Status | Install Size | Description | +| :---------------------------------------: | :----------------: | :-----------------: | :-------------------------------------------------------------------------------------- | +| [mini-css-extract-plugin][mini-css] | ![mini-css-npm] | ![mini-css-size] | Extracts CSS into separate files. It creates a CSS file per JS file which contains CSS. | +| [compression-webpack-plugin][compression] | ![compression-npm] | ![compression-size] | Prepares compressed versions of assets to serve them with Content-Encoding | +| [html-bundler-webpack-plugin][bundler] | ![bundler-npm] | ![bundler-size] | Renders a template (EJS, Handlebars, Pug) with referenced source asset files into HTML. | +| [html-webpack-plugin][html-plugin] | ![html-plugin-npm] | ![html-plugin-size] | Simplifies creation of HTML files (`index.html`) to serve your bundles | +| [pug-plugin][pug-plugin] | ![pug-plugin-npm] | ![pug-plugin-size] | Renders Pug files to HTML, extracts JS and CSS from sources specified directly in Pug. | + +[common-npm]: https://img.shields.io/npm/v/webpack.svg +[mini-css]: https://github.com/webpack-contrib/mini-css-extract-plugin +[mini-css-npm]: https://img.shields.io/npm/v/mini-css-extract-plugin.svg +[mini-css-size]: https://packagephobia.com/badge?p=mini-css-extract-plugin +[component]: https://github.com/webpack-contrib/component-webpack-plugin +[component-npm]: https://img.shields.io/npm/v/component-webpack-plugin.svg +[component-size]: https://packagephobia.com/badge?p=component-webpack-plugin +[compression]: https://github.com/webpack-contrib/compression-webpack-plugin +[compression-npm]: https://img.shields.io/npm/v/compression-webpack-plugin.svg +[compression-size]: https://packagephobia.com/badge?p=compression-webpack-plugin +[bundler]: https://github.com/webdiscus/html-bundler-webpack-plugin +[bundler-npm]: https://img.shields.io/npm/v/html-bundler-webpack-plugin.svg +[bundler-size]: https://packagephobia.com/badge?p=html-bundler-webpack-plugin +[html-plugin]: https://github.com/jantimon/html-webpack-plugin +[html-plugin-npm]: https://img.shields.io/npm/v/html-webpack-plugin.svg +[html-plugin-size]: https://packagephobia.com/badge?p=html-webpack-plugin +[pug-plugin]: https://github.com/webdiscus/pug-plugin +[pug-plugin-npm]: https://img.shields.io/npm/v/pug-plugin.svg +[pug-plugin-size]: https://packagephobia.com/badge?p=pug-plugin + +### [Loaders](https://webpack.js.org/loaders/) + +Webpack enables the use of loaders to preprocess files. This allows you to bundle +**any static resource** way beyond JavaScript. You can easily [write your own +loaders](https://webpack.js.org/api/loaders/) using Node.js. + +Loaders are activated by using `loadername!` prefixes in `require()` statements, +or are automatically applied via regex from your webpack configuration. + +#### JSON + +| Name | Status | Install Size | Description | +| :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :---------: | :----------: | :------------------------------: | +| | ![cson-npm] | ![cson-size] | Loads and transpiles a CSON file | + +[cson-npm]: https://img.shields.io/npm/v/cson-loader.svg +[cson-size]: https://packagephobia.com/badge?p=cson-loader + +#### Transpiling + +| Name | Status | Install Size | Description | +| :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------: | :------------: | :------------------------------------------------------------------------------------------------ | +| | ![babel-npm] | ![babel-size] | Loads ES2015+ code and transpiles to ES5 using Babel | +| | ![type-npm] | ![type-size] | Loads TypeScript like JavaScript | +| | ![coffee-npm] | ![coffee-size] | Loads CoffeeScript like JavaScript | + +[babel-npm]: https://img.shields.io/npm/v/babel-loader.svg +[babel-size]: https://packagephobia.com/badge?p=babel-loader +[coffee-npm]: https://img.shields.io/npm/v/coffee-loader.svg +[coffee-size]: https://packagephobia.com/badge?p=coffee-loader +[type-npm]: https://img.shields.io/npm/v/ts-loader.svg +[type-size]: https://packagephobia.com/badge?p=ts-loader + +#### Templating + +| Name | Status | Install Size | Description | +| :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-------------: | :--------------: | :-------------------------------------------------------------------------------------- | +| | ![html-npm] | ![html-size] | Exports HTML as string, requires references to static resources | +| | ![pug-npm] | ![pug-size] | Loads Pug templates and returns a function | +| | ![pug3-npm] | ![pug3-size] | Compiles Pug to a function or HTML string, useful for use with Vue, React, Angular | +| | ![md-npm] | ![md-size] | Compiles Markdown to HTML | +| | ![posthtml-npm] | ![posthtml-size] | Loads and transforms a HTML file using [PostHTML](https://github.com/posthtml/posthtml) | +| | ![hbs-npm] | ![hbs-size] | Compiles Handlebars to HTML | + +[html-npm]: https://img.shields.io/npm/v/html-loader.svg +[html-size]: https://packagephobia.com/badge?p=html-loader +[pug-npm]: https://img.shields.io/npm/v/pug-loader.svg +[pug-size]: https://packagephobia.com/badge?p=pug-loader +[pug3-npm]: https://img.shields.io/npm/v/@webdiscus/pug-loader.svg +[pug3-size]: https://packagephobia.com/badge?p=@webdiscus/pug-loader +[jade-npm]: https://img.shields.io/npm/v/jade-loader.svg +[jade-size]: https://packagephobia.com/badge?p=jade-loader +[md-npm]: https://img.shields.io/npm/v/markdown-loader.svg +[md-size]: https://packagephobia.com/badge?p=markdown-loader +[posthtml-npm]: https://img.shields.io/npm/v/posthtml-loader.svg +[posthtml-size]: https://packagephobia.com/badge?p=posthtml-loader +[hbs-npm]: https://img.shields.io/npm/v/handlebars-loader.svg +[hbs-size]: https://packagephobia.com/badge?p=handlebars-loader + +#### Styling + +| Name | Status | Install Size | Description | +| :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :------------: | :-------------: | :----------------------------------------------------------------------- | +| `