diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..d101bc4 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +node_modules +*.generated.json \ No newline at end of file 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..24a94ac --- /dev/null +++ b/api/classes/AsyncDependenciesBlock.md @@ -0,0 +1,306 @@ +--- +title: AsyncDependenciesBlock +--- + +[webpack](../globals) / 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) + +#### 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) + +#### 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..5f961b2 --- /dev/null +++ b/api/classes/AutomaticPrefetchPlugin.md @@ -0,0 +1,41 @@ +--- +title: AutomaticPrefetchPlugin +--- + +[webpack](../globals) / 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..adb0ff1 --- /dev/null +++ b/api/classes/BannerPlugin.md @@ -0,0 +1,83 @@ +--- +title: BannerPlugin +--- + +[webpack](../globals) / 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..97d5ded --- /dev/null +++ b/api/classes/Cache.md @@ -0,0 +1,225 @@ +--- +title: Cache +--- + +[webpack](../globals) / 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`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<`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`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<`string`> + +##### callback + +`CallbackCacheCache`<`void`> + +#### Returns + +`void` diff --git a/api/classes/Chunk.md b/api/classes/Chunk.md new file mode 100644 index 0000000..163e638 --- /dev/null +++ b/api/classes/Chunk.md @@ -0,0 +1,843 @@ +--- +title: Chunk +--- + +[webpack](../globals) / 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`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`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`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`Module`](Module.md)> + +Defined in: [webpack/types.d.ts:1322](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1322) + +##### Returns + +[`Iterable`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`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`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set)<`Chunk`> + +Defined in: [webpack/types.d.ts:1356](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1356) + +#### Returns + +[`Set`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set)<`Chunk`> + +*** + +### getAllInitialChunks() + +> **getAllInitialChunks**(): [`Set`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set)<`Chunk`> + +Defined in: [webpack/types.d.ts:1357](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1357) + +#### Returns + +[`Set`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set)<`Chunk`> + +*** + +### getAllReferencedAsyncEntrypoints() + +> **getAllReferencedAsyncEntrypoints**(): [`Set`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set)<[`Entrypoint`](Entrypoint.md)> + +Defined in: [webpack/types.d.ts:1359](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1359) + +#### Returns + +[`Set`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set)<[`Entrypoint`](Entrypoint.md)> + +*** + +### getAllReferencedChunks() + +> **getAllReferencedChunks**(): [`Set`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set)<`Chunk`> + +Defined in: [webpack/types.d.ts:1358](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1358) + +#### Returns + +[`Set`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set)<`Chunk`> + +*** + +### getChildIdsByOrders() + +> **getChildIdsByOrders**(`chunkGraph`, `filterFn?`): [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`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`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`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) + +Defined in: [webpack/types.d.ts:1347](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1347) + +#### Returns + +[`EntryOptions`](../type-aliases/EntryOptions) + +*** + +### 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..5cf8747 --- /dev/null +++ b/api/classes/ChunkGraph.md @@ -0,0 +1,1859 @@ +--- +title: ChunkGraph +--- + +[webpack](../globals) / 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`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<`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`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`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`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`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`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`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`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`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`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`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`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`RuntimeModule`](RuntimeModule.md), `any`, `any`> + +*** + +### getChunkEntryDependentChunksIterable() + +> **getChunkEntryDependentChunksIterable**(`chunk`): [`Iterable`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`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`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`Chunk`](Chunk.md)> + +*** + +### getChunkEntryModulesIterable() + +> **getChunkEntryModulesIterable**(`chunk`): [`Iterable`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`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`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`Module`](Module.md)> + +*** + +### getChunkEntryModulesWithChunkGroupIterable() + +> **getChunkEntryModulesWithChunkGroupIterable**(`chunk`): [`Iterable`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<\[[`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`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<\[[`Module`](Module.md), [`Entrypoint`](Entrypoint.md)]> + +*** + +### getChunkFullHashModulesIterable() + +> **getChunkFullHashModulesIterable**(`chunk`): [`Iterable`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`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`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`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`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`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`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`Module`](Module.md)> + +*** + +### getChunkModulesIterableBySourceType() + +> **getChunkModulesIterableBySourceType**(`chunk`, `sourceType`): [`Iterable`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`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`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`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`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`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`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`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`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`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`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`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`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`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`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`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/util/namespaces/runtime/classes/RuntimeSpecSet) + +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/util/namespaces/runtime/classes/RuntimeSpecSet) + +*** + +### 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`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`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`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`Module`](Module.md)> + +*** + +### getOrderedChunkModulesIterableBySourceType() + +> **getOrderedChunkModulesIterableBySourceType**(`chunk`, `sourceType`, `comparator`): [`Iterable`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`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`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`Module`](Module.md), `any`, `any`> + +*** + +### getOrderedModuleChunksIterable() + +> **getOrderedModuleChunksIterable**(`module`, `sortFn`): [`Iterable`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`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`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`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`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`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`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`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..41d51c2 --- /dev/null +++ b/api/classes/ChunkGroup.md @@ -0,0 +1,759 @@ +--- +title: ChunkGroup +--- + +[webpack](../globals) / 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`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`AsyncDependenciesBlock`](AsyncDependenciesBlock.md)> + +Defined in: [webpack/types.d.ts:1657](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1657) + +##### Returns + +[`Iterable`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`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`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`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`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`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..14aaf36 --- /dev/null +++ b/api/classes/CleanPlugin.md @@ -0,0 +1,73 @@ +--- +title: CleanPlugin +--- + +[webpack](../globals) / 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..f5a60f4 --- /dev/null +++ b/api/classes/CodeGenerationResults.md @@ -0,0 +1,193 @@ +--- +title: CodeGenerationResults +--- + +[webpack](../globals) / 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`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Map)<[`Module`](Module.md), [`RuntimeSpecMap`](../webpack/namespaces/util/namespaces/runtime/classes/RuntimeSpecMap)<`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/sources/classes/Source) + +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/sources/classes/Source) + +*** + +### 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..9e743a5 --- /dev/null +++ b/api/classes/Compilation.md @@ -0,0 +1,1980 @@ +--- +title: Compilation +--- + +[webpack](../globals) / 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`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Map)<`string`, [`AssetInfo`](../type-aliases/AssetInfo)> + +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/util/classes/LazySet)<`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`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`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`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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/util/classes/LazySet)<`string`> + +##### Parameters + +###### item + +`string` + +##### Returns + +[`LazySet`](../webpack/namespaces/util/classes/LazySet)<`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/util/classes/LazySet)<`string`> + +Defined in: [webpack/types.d.ts:2482](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2482) + +*** + +### creatingModuleDuringBuild + +> **creatingModuleDuringBuild**: [`WeakMap`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/WeakMap)<[`Module`](Module.md), [`Set`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Map)<`string`, `EntryData`> + +Defined in: [webpack/types.d.ts:2453](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2453) + +*** + +### entrypoints + +> **entrypoints**: [`Map`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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/util/classes/LazySet)<`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`](https://www.typescriptlang.org/docs/handbook/utility-types.html#readonlytype)<{ `addEntry`: `SyncHook`<\[[`Dependency`](Dependency.md), [`EntryOptions`](../type-aliases/EntryOptions)]>; `additionalAssets`: `FakeHook`<[`Pick`](https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys)<`AsyncSeriesHook`<\[]>, `"name"` | `"tap"` | `"tapAsync"` | `"tapPromise"`>>; `additionalChunkAssets`: `FakeHook`<[`Pick`](https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys)<`AsyncSeriesHook`<\[[`Set`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set)<[`Chunk`](Chunk.md)>]>, `"name"` | `"tap"` | `"tapAsync"` | `"tapPromise"`>>; `additionalChunkRuntimeRequirements`: `SyncHook`<\[[`Chunk`](Chunk.md), [`Set`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set)<`string`>, `RuntimeRequirementsContext`]>; `additionalModuleRuntimeRequirements`: `SyncHook`<\[[`Module`](Module.md), [`Set`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set)<`string`>, `RuntimeRequirementsContext`]>; `additionalTreeRuntimeRequirements`: `SyncHook`<\[[`Chunk`](Chunk.md), [`Set`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set)<`string`>, `RuntimeRequirementsContext`]>; `afterChunks`: `SyncHook`<\[[`Iterable`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`Chunk`](Chunk.md)>]>; `afterCodeGeneration`: `SyncHook`<\[]>; `afterHash`: `SyncHook`<\[]>; `afterModuleHash`: `SyncHook`<\[]>; `afterOptimizeAssets`: `SyncHook`<\[`CompilationAssets`]>; `afterOptimizeChunkAssets`: `FakeHook`<[`Pick`](https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys)<`AsyncSeriesHook`<\[[`Set`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set)<[`Chunk`](Chunk.md)>]>, `"name"` | `"tap"` | `"tapAsync"` | `"tapPromise"`>>; `afterOptimizeChunkIds`: `SyncHook`<\[[`Iterable`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`Chunk`](Chunk.md)>]>; `afterOptimizeChunkModules`: `SyncHook`<\[[`Iterable`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`Chunk`](Chunk.md)>, [`Iterable`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`Module`](Module.md)>]>; `afterOptimizeChunks`: `SyncHook`<\[[`Iterable`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`Chunk`](Chunk.md)>, [`ChunkGroup`](ChunkGroup.md)\[]]>; `afterOptimizeDependencies`: `SyncHook`<\[[`Iterable`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`Module`](Module.md)>]>; `afterOptimizeModuleIds`: `SyncHook`<\[[`Iterable`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`Module`](Module.md)>]>; `afterOptimizeModules`: `SyncHook`<\[[`Iterable`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`Module`](Module.md)>]>; `afterOptimizeTree`: `SyncHook`<\[[`Iterable`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`Chunk`](Chunk.md)>, [`Iterable`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`Module`](Module.md)>]>; `afterProcessAssets`: `SyncHook`<\[`CompilationAssets`]>; `afterRuntimeRequirements`: `SyncHook`<\[]>; `afterSeal`: `AsyncSeriesHook`<\[]>; `assetPath`: `SyncWaterfallHook`<\[`string`, [`PathData`](../interfaces/PathData), `undefined` | [`AssetInfo`](../type-aliases/AssetInfo)], `string`>; `beforeChunkAssets`: `SyncHook`<\[]>; `beforeChunkIds`: `SyncHook`<\[[`Iterable`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`Chunk`](Chunk.md)>]>; `beforeChunks`: `SyncHook`<\[]>; `beforeCodeGeneration`: `SyncHook`<\[]>; `beforeHash`: `SyncHook`<\[]>; `beforeModuleAssets`: `SyncHook`<\[]>; `beforeModuleHash`: `SyncHook`<\[]>; `beforeModuleIds`: `SyncHook`<\[[`Iterable`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`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`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`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), [`Error`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error)]>; `failedModule`: `SyncHook`<\[[`Module`](Module.md), [`WebpackError`](WebpackError.md)]>; `finishModules`: `AsyncSeriesHook`<\[[`Iterable`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`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`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`Module`](Module.md)>]>; `needAdditionalPass`: `SyncBailHook`<\[], `boolean` | `void`>; `needAdditionalSeal`: `SyncBailHook`<\[], `boolean` | `void`>; `optimize`: `SyncHook`<\[]>; `optimizeAssets`: `AsyncSeriesHook`<\[`CompilationAssets`], `ProcessAssetsAdditionalOptions`>; `optimizeChunkAssets`: `FakeHook`<[`Pick`](https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys)<`AsyncSeriesHook`<\[[`Set`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set)<[`Chunk`](Chunk.md)>]>, `"name"` | `"tap"` | `"tapAsync"` | `"tapPromise"`>>; `optimizeChunkIds`: `SyncHook`<\[[`Iterable`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`Chunk`](Chunk.md)>]>; `optimizeChunkModules`: `AsyncSeriesBailHook`<\[[`Iterable`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`Chunk`](Chunk.md)>, [`Iterable`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`Module`](Module.md)>], `void`>; `optimizeChunks`: `SyncBailHook`<\[[`Iterable`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`Chunk`](Chunk.md)>, [`ChunkGroup`](ChunkGroup.md)\[]], `boolean` | `void`>; `optimizeCodeGeneration`: `SyncHook`<\[[`Iterable`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`Module`](Module.md)>]>; `optimizeDependencies`: `SyncBailHook`<\[[`Iterable`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`Module`](Module.md)>], `boolean` | `void`>; `optimizeModuleIds`: `SyncHook`<\[[`Iterable`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`Module`](Module.md)>]>; `optimizeModules`: `SyncBailHook`<\[[`Iterable`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`Module`](Module.md)>], `boolean` | `void`>; `optimizeTree`: `AsyncSeriesHook`<\[[`Iterable`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`Chunk`](Chunk.md)>, [`Iterable`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`Module`](Module.md)>]>; `prepareModuleExecution`: `AsyncParallelHook`<\[`ExecuteModuleArgument`, `ExecuteModuleContext`]>; `processAdditionalAssets`: `AsyncSeriesHook`<\[`CompilationAssets`]>; `processAssets`: `AsyncSeriesHook`<\[`CompilationAssets`], `ProcessAssetsAdditionalOptions`>; `processErrors`: `SyncWaterfallHook`<\[[`Error`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error)\[]], [`Error`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error)\[]>; `processWarnings`: `SyncWaterfallHook`<\[[`Error`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error)\[]], [`Error`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error)\[]>; `rebuildModule`: `SyncHook`<\[[`Module`](Module.md)]>; `record`: `SyncHook`<\[`Compilation`, `Records`]>; `recordChunks`: `SyncHook`<\[[`Iterable`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`Chunk`](Chunk.md)>, `Records`]>; `recordHash`: `SyncHook`<\[`Records`]>; `recordModules`: `SyncHook`<\[[`Iterable`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`Module`](Module.md)>, `Records`]>; `renderManifest`: `SyncWaterfallHook`<\[[`RenderManifestEntry`](../type-aliases/RenderManifestEntry)\[], [`RenderManifestOptions`](../interfaces/RenderManifestOptions)], [`RenderManifestEntry`](../type-aliases/RenderManifestEntry)\[]>; `reviveChunks`: `SyncHook`<\[[`Iterable`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`Chunk`](Chunk.md)>, `Records`]>; `reviveModules`: `SyncHook`<\[[`Iterable`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`Module`](Module.md)>, `Records`]>; `runtimeModule`: `SyncHook`<\[[`RuntimeModule`](RuntimeModule.md), [`Chunk`](Chunk.md)]>; `runtimeRequirementInChunk`: `HookMap`<`SyncBailHook`<\[[`Chunk`](Chunk.md), [`Set`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set)<`string`>, `RuntimeRequirementsContext`], `void`>>; `runtimeRequirementInModule`: `HookMap`<`SyncBailHook`<\[[`Module`](Module.md), [`Set`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set)<`string`>, `RuntimeRequirementsContext`], `void`>>; `runtimeRequirementInTree`: `HookMap`<`SyncBailHook`<\[[`Chunk`](Chunk.md), [`Set`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set)<`string`>, `RuntimeRequirementsContext`], `void`>>; `seal`: `SyncHook`<\[]>; `shouldGenerateChunkAssets`: `SyncBailHook`<\[], `boolean` | `void`>; `shouldRecord`: `SyncBailHook`<\[], `boolean` | `void`>; `statsFactory`: `SyncHook`<\[`StatsFactory`, `NormalizedStatsOptions`]>; `statsNormalize`: `SyncHook`<\[[`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<`NormalizedStatsOptions`>, `CreateStatsOptionsContext`]>; `statsPreset`: `HookMap`<`SyncHook`<\[[`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<`NormalizedStatsOptions`>, `CreateStatsOptionsContext`]>>; `statsPrinter`: `SyncHook`<\[`StatsPrinter`, `NormalizedStatsOptions`]>; `stillValidModule`: `SyncHook`<\[[`Module`](Module.md)]>; `succeedEntry`: `SyncHook`<\[[`Dependency`](Dependency.md), [`EntryOptions`](../type-aliases/EntryOptions), [`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) + +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`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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/util/classes/LazySet)<`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`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set)<`number`> + +Defined in: [webpack/types.d.ts:2473](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2473) + +*** + +### usedModuleIds + +> **usedModuleIds**: [`Set`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set)<`number`> + +Defined in: [webpack/types.d.ts:2474](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2474) + +*** + +### valueCacheVersions + +> **valueCacheVersions**: [`Map`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Map)<`string`, `ValueCacheVersion`> + +Defined in: [webpack/types.d.ts:2419](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2419) + +*** + +### warnings + +> **warnings**: [`Error`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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) + +##### 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) + +##### 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) + +##### 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`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<`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`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<`OutputNormalized`> + +##### plugins? + +(`false` | `""` | `0` | [`WebpackPluginInstance`](../interfaces/WebpackPluginInstance) | (`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) + +##### 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/sources/classes/Source) + +##### assetInfo? + +[`AssetInfo`](../type-aliases/AssetInfo) + +#### 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`](https://www.typescriptlang.org/docs/handbook/utility-types.html#readonlytype)<[`Asset`](../interfaces/Asset)> + +Defined in: [webpack/types.d.ts:2670](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2670) + +#### Parameters + +##### name + +`string` + +#### Returns + +[`Readonly`](https://www.typescriptlang.org/docs/handbook/utility-types.html#readonlytype)<[`Asset`](../interfaces/Asset)> + +*** + +### 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) + +##### data + +[`PathData`](../interfaces/PathData) + +#### 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) + +##### data + +[`PathData`](../interfaces/PathData) + +#### Returns + +`InterpolatedPathAndAssetInfo` + +*** + +### getAssets() + +> **getAssets**(): [`Readonly`](https://www.typescriptlang.org/docs/handbook/utility-types.html#readonlytype)<[`Asset`](../interfaces/Asset)>\[] + +Defined in: [webpack/types.d.ts:2669](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2669) + +#### Returns + +[`Readonly`](https://www.typescriptlang.org/docs/handbook/utility-types.html#readonlytype)<[`Asset`](../interfaces/Asset)>\[] + +*** + +### 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`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error)\[] + +Defined in: [webpack/types.d.ts:2686](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2686) + +#### Returns + +[`Error`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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) + +##### data? + +[`PathData`](../interfaces/PathData) + +#### 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) + +##### data? + +[`PathData`](../interfaces/PathData) + +#### Returns + +`InterpolatedPathAndAssetInfo` + +*** + +### getRenderManifest() + +> **getRenderManifest**(`options`): [`RenderManifestEntry`](../type-aliases/RenderManifestEntry)\[] + +Defined in: [webpack/types.d.ts:2673](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2673) + +#### Parameters + +##### options + +[`RenderManifestOptions`](../interfaces/RenderManifestOptions) + +#### Returns + +[`RenderManifestEntry`](../type-aliases/RenderManifestEntry)\[] + +*** + +### 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`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error)\[] + +Defined in: [webpack/types.d.ts:2685](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2685) + +#### Returns + +[`Error`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`Chunk`](Chunk.md)> + +chunkGraphEntries + +###### chunks? + +[`Iterable`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`Chunk`](Chunk.md)> + +chunks + +###### codeGenerationResults? + +[`CodeGenerationResults`](CodeGenerationResults.md) + +codeGenerationResults + +###### modules? + +[`Iterable`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`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/sources/classes/Source) | (`source`) => [`Source`](../webpack/namespaces/sources/classes/Source) + +##### assetInfoUpdateOrFunction? + +[`AssetInfo`](../type-aliases/AssetInfo) | (`assetInfo?`) => [`AssetInfo`](../type-aliases/AssetInfo) + +#### Returns + +`void` diff --git a/api/classes/Compiler.md b/api/classes/Compiler.md new file mode 100644 index 0000000..6f0b69a --- /dev/null +++ b/api/classes/Compiler.md @@ -0,0 +1,685 @@ +--- +title: Compiler +--- + +[webpack](../globals) / 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) + +#### 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`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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`](https://www.typescriptlang.org/docs/handbook/utility-types.html#readonlytype)<{ `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)]>; `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)], `boolean` | `void`>; `environment`: `SyncHook`<\[]>; `failed`: `SyncHook`<\[[`Error`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set)<`string` | [`RegExp`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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) + +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`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set)<`string` | [`RegExp`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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) + +Defined in: [webpack/types.d.ts:2958](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L2958) + +*** + +### outputFileSystem + +> **outputFileSystem**: [`OutputFileSystem`](../interfaces/OutputFileSystem) + +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`](https://www.typescriptlang.org/docs/handbook/utility-types.html#readonlytype)<`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`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set)<`string` | [`RegExp`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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=) + +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`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<`OutputNormalized`> + +##### plugins? + +(`false` | `""` | `0` | [`WebpackPluginInstance`](../interfaces/WebpackPluginInstance) | (`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..7fa0950 --- /dev/null +++ b/api/classes/ConcatenationScope.md @@ -0,0 +1,237 @@ +--- +title: ConcatenationScope +--- + +[webpack](../globals) / 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`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Map)<[`Module`](Module.md), `ModuleInfo`> | `ModuleInfo`\[] + +##### currentModule + +`ConcatenatedModuleInfo` + +##### usedNames + +[`Set`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set)<`string`> + +#### Returns + +`ConcatenationScope` + +## Properties + +### usedNames + +> **usedNames**: [`Set`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<`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..e88a9d9 --- /dev/null +++ b/api/classes/ContextExclusionPlugin.md @@ -0,0 +1,55 @@ +--- +title: ContextExclusionPlugin +--- + +[webpack](../globals) / 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`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/RegExp) + +#### Returns + +`ContextExclusionPlugin` + +## Properties + +### negativeMatcher + +> **negativeMatcher**: [`RegExp`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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..84e65aa --- /dev/null +++ b/api/classes/ContextReplacementPlugin.md @@ -0,0 +1,131 @@ +--- +title: ContextReplacementPlugin +--- + +[webpack](../globals) / 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`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/RegExp) + +##### newContentResource? + +`string` | `boolean` | [`RegExp`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/RegExp) | (`context`) => `void` + +##### newContentRecursive? + +`boolean` | [`RegExp`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/RegExp) | `NewContentCreateContextMap` + +##### newContentRegExp? + +[`RegExp`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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) + +##### 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`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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..c55607e --- /dev/null +++ b/api/classes/DefinePlugin.md @@ -0,0 +1,97 @@ +--- +title: DefinePlugin +--- + +[webpack](../globals) / 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..338b94f --- /dev/null +++ b/api/classes/DelegatedPlugin.md @@ -0,0 +1,55 @@ +--- +title: DelegatedPlugin +--- + +[webpack](../globals) / 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..50f766c --- /dev/null +++ b/api/classes/Dependency.md @@ -0,0 +1,442 @@ +--- +title: Dependency +--- + +[webpack](../globals) / 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/dependencies/classes/ModuleDependency) +* [`NullDependency`](../webpack/namespaces/dependencies/classes/NullDependency) + +## 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) + +#### 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) + +#### 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..4897189 --- /dev/null +++ b/api/classes/DllPlugin.md @@ -0,0 +1,55 @@ +--- +title: DllPlugin +--- + +[webpack](../globals) / 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..cfc1fa2 --- /dev/null +++ b/api/classes/DllReferencePlugin.md @@ -0,0 +1,55 @@ +--- +title: DllReferencePlugin +--- + +[webpack](../globals) / 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..7c73075 --- /dev/null +++ b/api/classes/DotenvPlugin.md @@ -0,0 +1,53 @@ +--- +title: DotenvPlugin +--- + +[webpack](../globals) / 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..c65b48f --- /dev/null +++ b/api/classes/DynamicEntryPlugin.md @@ -0,0 +1,71 @@ +--- +title: DynamicEntryPlugin +--- + +[webpack](../globals) / 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`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<`EntryStaticNormalized`> + +Defined in: [webpack/types.d.ts:4653](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L4653) + +#### Returns + +[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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..0347c22 --- /dev/null +++ b/api/classes/EntryOptionPlugin.md @@ -0,0 +1,91 @@ +--- +title: EntryOptionPlugin +--- + +[webpack](../globals) / 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) + +#### Returns + +`void` + +*** + +### entryDescriptionToOptions() + +> `static` **entryDescriptionToOptions**(`compiler`, `name`, `desc`): [`EntryOptions`](../type-aliases/EntryOptions) + +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) diff --git a/api/classes/EntryPlugin.md b/api/classes/EntryPlugin.md new file mode 100644 index 0000000..206135b --- /dev/null +++ b/api/classes/EntryPlugin.md @@ -0,0 +1,103 @@ +--- +title: EntryPlugin +--- + +[webpack](../globals) / 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) + +#### 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) + +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) + +#### Returns + +`EntryDependency` diff --git a/api/classes/Entrypoint.md b/api/classes/Entrypoint.md new file mode 100644 index 0000000..944c030 --- /dev/null +++ b/api/classes/Entrypoint.md @@ -0,0 +1,1052 @@ +--- +title: Entrypoint +--- + +[webpack](../globals) / 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`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`AsyncDependenciesBlock`](AsyncDependenciesBlock.md)> + +Defined in: [webpack/types.d.ts:1657](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1657) + +##### Returns + +[`Iterable`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`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`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`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`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`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..afcced1 --- /dev/null +++ b/api/classes/EnvironmentPlugin.md @@ -0,0 +1,63 @@ +--- +title: EnvironmentPlugin +--- + +[webpack](../globals) / 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`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `any`>)\[] + +#### Returns + +`EnvironmentPlugin` + +## Properties + +### defaultValues + +> **defaultValues**: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`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..813b46f --- /dev/null +++ b/api/classes/EvalDevToolModulePlugin.md @@ -0,0 +1,71 @@ +--- +title: EvalDevToolModulePlugin +--- + +[webpack](../globals) / 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..3d80189 --- /dev/null +++ b/api/classes/EvalSourceMapDevToolPlugin.md @@ -0,0 +1,79 @@ +--- +title: EvalSourceMapDevToolPlugin +--- + +[webpack](../globals) / 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..ffef409 --- /dev/null +++ b/api/classes/ExternalModule.md @@ -0,0 +1,1781 @@ +--- +title: ExternalModule +--- + +[webpack](../globals) / 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/esm/classes/ModuleChunkLoadingRuntimeModule).[`context`](../webpack/namespaces/esm/classes/ModuleChunkLoadingRuntimeModule) + +*** + +### 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/esm/classes/ModuleChunkLoadingRuntimeModule).[`depth`](../webpack/namespaces/esm/classes/ModuleChunkLoadingRuntimeModule) + +*** + +### 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/esm/classes/ModuleChunkLoadingRuntimeModule).[`id`](../webpack/namespaces/esm/classes/ModuleChunkLoadingRuntimeModule) + +*** + +### 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/esm/classes/ModuleChunkLoadingRuntimeModule).[`index`](../webpack/namespaces/esm/classes/ModuleChunkLoadingRuntimeModule) + +*** + +### 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/esm/classes/ModuleChunkLoadingRuntimeModule).[`index2`](../webpack/namespaces/esm/classes/ModuleChunkLoadingRuntimeModule) + +*** + +### 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/esm/classes/ModuleChunkLoadingRuntimeModule).[`issuer`](../webpack/namespaces/esm/classes/ModuleChunkLoadingRuntimeModule) + +*** + +### 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/esm/classes/ModuleChunkLoadingRuntimeModule).[`layer`](../webpack/namespaces/esm/classes/ModuleChunkLoadingRuntimeModule) + +*** + +### 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) + +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`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`Chunk`](Chunk.md)> + +Defined in: [webpack/types.d.ts:10673](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10673) + +##### Returns + +[`Iterable`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`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/esm/classes/ModuleChunkLoadingRuntimeModule).[`usedExports`](../webpack/namespaces/esm/classes/ModuleChunkLoadingRuntimeModule) + +*** + +### 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/util/classes/LazySet)<`string`> + +##### contextDependencies + +[`LazySet`](../webpack/namespaces/util/classes/LazySet)<`string`> + +##### missingDependencies + +[`LazySet`](../webpack/namespaces/util/classes/LazySet)<`string`> + +##### buildDependencies + +[`LazySet`](../webpack/namespaces/util/classes/LazySet)<`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) + +##### 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) + +#### 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`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`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`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`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`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`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`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`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`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Map)<`string`, `number`> + +##### contextTimestamps + +[`Map`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Map)<`string`, `number`> + +#### Returns + +`boolean` + +#### Deprecated + +#### Inherited from + +[`Module`](Module.md).[`needRebuild`](Module.md#needrebuild) + +*** + +### originalSource() + +> **originalSource**(): [`Source`](../webpack/namespaces/sources/classes/Source) + +Defined in: [webpack/types.d.ts:10779](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10779) + +#### Returns + +[`Source`](../webpack/namespaces/sources/classes/Source) + +#### 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) + +#### 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/sources/classes/Source) + +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/sources/classes/Source) + +#### 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..c23e368 --- /dev/null +++ b/api/classes/ExternalsPlugin.md @@ -0,0 +1,67 @@ +--- +title: ExternalsPlugin +--- + +[webpack](../globals) / 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) + +#### Returns + +`ExternalsPlugin` + +## Properties + +### externals + +> **externals**: [`Externals`](../type-aliases/Externals) + +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..750936e --- /dev/null +++ b/api/classes/Generator.md @@ -0,0 +1,143 @@ +--- +title: Generator +--- + +[webpack](../globals) / 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/sources/classes/Source) + +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/sources/classes/Source) + +*** + +### 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..3286d09 --- /dev/null +++ b/api/classes/HotModuleReplacementPlugin.md @@ -0,0 +1,59 @@ +--- +title: HotModuleReplacementPlugin +--- + +[webpack](../globals) / 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/javascript/classes/JavascriptParser) + +#### Returns + +`HMRJavascriptParserHooks` diff --git a/api/classes/HotUpdateChunk.md b/api/classes/HotUpdateChunk.md new file mode 100644 index 0000000..543138a --- /dev/null +++ b/api/classes/HotUpdateChunk.md @@ -0,0 +1,1069 @@ +--- +title: HotUpdateChunk +--- + +[webpack](../globals) / 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`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`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`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`Module`](Module.md)> + +Defined in: [webpack/types.d.ts:1322](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1322) + +##### Returns + +[`Iterable`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`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`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set)<[`Chunk`](Chunk.md)> + +Defined in: [webpack/types.d.ts:1356](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1356) + +#### Returns + +[`Set`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set)<[`Chunk`](Chunk.md)> + +#### Inherited from + +[`Chunk`](Chunk.md).[`getAllAsyncChunks`](Chunk.md#getallasyncchunks) + +*** + +### getAllInitialChunks() + +> **getAllInitialChunks**(): [`Set`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set)<[`Chunk`](Chunk.md)> + +Defined in: [webpack/types.d.ts:1357](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1357) + +#### Returns + +[`Set`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set)<[`Chunk`](Chunk.md)> + +#### Inherited from + +[`Chunk`](Chunk.md).[`getAllInitialChunks`](Chunk.md#getallinitialchunks) + +*** + +### getAllReferencedAsyncEntrypoints() + +> **getAllReferencedAsyncEntrypoints**(): [`Set`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set)<[`Entrypoint`](Entrypoint.md)> + +Defined in: [webpack/types.d.ts:1359](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1359) + +#### Returns + +[`Set`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set)<[`Entrypoint`](Entrypoint.md)> + +#### Inherited from + +[`Chunk`](Chunk.md).[`getAllReferencedAsyncEntrypoints`](Chunk.md#getallreferencedasyncentrypoints) + +*** + +### getAllReferencedChunks() + +> **getAllReferencedChunks**(): [`Set`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set)<[`Chunk`](Chunk.md)> + +Defined in: [webpack/types.d.ts:1358](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1358) + +#### Returns + +[`Set`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set)<[`Chunk`](Chunk.md)> + +#### Inherited from + +[`Chunk`](Chunk.md).[`getAllReferencedChunks`](Chunk.md#getallreferencedchunks) + +*** + +### getChildIdsByOrders() + +> **getChildIdsByOrders**(`chunkGraph`, `filterFn?`): [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`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`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`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) + +Defined in: [webpack/types.d.ts:1347](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L1347) + +#### Returns + +[`EntryOptions`](../type-aliases/EntryOptions) + +#### 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..6304086 --- /dev/null +++ b/api/classes/IgnorePlugin.md @@ -0,0 +1,75 @@ +--- +title: IgnorePlugin +--- + +[webpack](../globals) / 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) + +#### Returns + +`false` diff --git a/api/classes/InitFragment.md b/api/classes/InitFragment.md new file mode 100644 index 0000000..2381066 --- /dev/null +++ b/api/classes/InitFragment.md @@ -0,0 +1,249 @@ +--- +title: InitFragment +--- + +[webpack](../globals) / 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/sources/classes/Source) + +##### stage + +`number` + +##### position + +`number` + +##### key? + +`string` + +##### endContent? + +`string` | [`Source`](../webpack/namespaces/sources/classes/Source) + +#### Returns + +`InitFragment`<`GenerateContext`> + +## Properties + +### content? + +> `optional` **content**: `string` | [`Source`](../webpack/namespaces/sources/classes/Source) + +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/sources/classes/Source) + +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) + +#### Returns + +`void` + +*** + +### getContent() + +> **getContent**(`context`): `string` | [`Source`](../webpack/namespaces/sources/classes/Source) + +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/sources/classes/Source) + +*** + +### getEndContent() + +> **getEndContent**(`context`): `string` | [`Source`](../webpack/namespaces/sources/classes/Source) + +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/sources/classes/Source) + +*** + +### 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) + +#### Returns + +`void` + +*** + +### addToSource() + +> `static` **addToSource**<`Context`>(`source`, `initFragments`, `context`): [`Source`](../webpack/namespaces/sources/classes/Source) + +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/sources/classes/Source) + +##### initFragments + +`MaybeMergeableInitFragment`<`Context`>\[] + +##### context + +`Context` + +#### Returns + +[`Source`](../webpack/namespaces/sources/classes/Source) diff --git a/api/classes/JavascriptModulesPlugin.md b/api/classes/JavascriptModulesPlugin.md new file mode 100644 index 0000000..372ccc4 --- /dev/null +++ b/api/classes/JavascriptModulesPlugin.md @@ -0,0 +1,261 @@ +--- +title: JavascriptModulesPlugin +--- + +[webpack](../globals) / 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/sources/classes/Source) + +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/sources/classes/Source) + +*** + +### renderMain() + +> **renderMain**(`renderContext`, `hooks`, `compilation`): [`Source`](../webpack/namespaces/sources/classes/Source) + +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/sources/classes/Source) + +*** + +### renderModule() + +> **renderModule**(`module`, `renderContext`, `hooks`): [`Source`](../webpack/namespaces/sources/classes/Source) + +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/sources/classes/Source) + +*** + +### 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) + +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) + +*** + +### 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..7734c2c --- /dev/null +++ b/api/classes/LibManifestPlugin.md @@ -0,0 +1,55 @@ +--- +title: LibManifestPlugin +--- + +[webpack](../globals) / 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..8f712aa --- /dev/null +++ b/api/classes/LibraryTemplatePlugin.md @@ -0,0 +1,91 @@ +--- +title: LibraryTemplatePlugin +--- + +[webpack](../globals) / 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..8218c45 --- /dev/null +++ b/api/classes/LoaderOptionsPlugin.md @@ -0,0 +1,55 @@ +--- +title: LoaderOptionsPlugin +--- + +[webpack](../globals) / 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..19a2ab9 --- /dev/null +++ b/api/classes/LoaderTargetPlugin.md @@ -0,0 +1,55 @@ +--- +title: LoaderTargetPlugin +--- + +[webpack](../globals) / 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..10395e1 --- /dev/null +++ b/api/classes/ManifestPlugin.md @@ -0,0 +1,55 @@ +--- +title: ManifestPlugin +--- + +[webpack](../globals) / 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..9165d8b --- /dev/null +++ b/api/classes/Module.md @@ -0,0 +1,1393 @@ +--- +title: Module +--- + +[webpack](../globals) / 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) + +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`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`Chunk`](Chunk.md)> + +Defined in: [webpack/types.d.ts:10673](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10673) + +##### Returns + +[`Iterable`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`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/util/classes/LazySet)<`string`> + +##### contextDependencies + +[`LazySet`](../webpack/namespaces/util/classes/LazySet)<`string`> + +##### missingDependencies + +[`LazySet`](../webpack/namespaces/util/classes/LazySet)<`string`> + +##### buildDependencies + +[`LazySet`](../webpack/namespaces/util/classes/LazySet)<`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) + +##### 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) + +#### 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`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`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`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`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`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`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`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`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`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Map)<`string`, `number`> + +##### contextTimestamps + +[`Map`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Map)<`string`, `number`> + +#### Returns + +`boolean` + +#### Deprecated + +*** + +### originalSource() + +> **originalSource**(): [`Source`](../webpack/namespaces/sources/classes/Source) + +Defined in: [webpack/types.d.ts:10779](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10779) + +#### Returns + +[`Source`](../webpack/namespaces/sources/classes/Source) + +*** + +### 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) + +#### 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/sources/classes/Source) + +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/sources/classes/Source) + +#### 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..2aa35b6 --- /dev/null +++ b/api/classes/ModuleFactory.md @@ -0,0 +1,43 @@ +--- +title: ModuleFactory +--- + +[webpack](../globals) / 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..198640c --- /dev/null +++ b/api/classes/ModuleGraph.md @@ -0,0 +1,1257 @@ +--- +title: ModuleGraph +--- + +[webpack](../globals) / 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`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`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`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`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`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`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`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`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`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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..921a563 --- /dev/null +++ b/api/classes/ModuleGraphConnection.md @@ -0,0 +1,291 @@ +--- +title: ModuleGraphConnection +--- + +[webpack](../globals) / 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`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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..11a4c82 --- /dev/null +++ b/api/classes/MultiCompiler.md @@ -0,0 +1,281 @@ +--- +title: MultiCompiler +--- + +[webpack](../globals) / 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`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, [`Compiler`](Compiler.md)> | [`Compiler`](Compiler.md)\[] + +##### options + +[`MultiCompilerOptions`](../interfaces/MultiCompilerOptions) + +#### 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`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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`](https://www.typescriptlang.org/docs/handbook/utility-types.html#readonlytype)<{ `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) + +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) + +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)\[] & [`MultiCompilerOptions`](../interfaces/MultiCompilerOptions) + +Defined in: [webpack/types.d.ts:11660](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L11660) + +##### Returns + +[`WebpackOptionsNormalized`](../interfaces/WebpackOptionsNormalized)\[] & [`MultiCompilerOptions`](../interfaces/MultiCompilerOptions) + +*** + +### 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..d3a4640 --- /dev/null +++ b/api/classes/MultiStats.md @@ -0,0 +1,101 @@ +--- +title: MultiStats +--- + +[webpack](../globals) / 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) + +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) + +#### Returns + +[`StatsCompilation`](../type-aliases/StatsCompilation) + +*** + +### 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) + +#### Returns + +`string` diff --git a/api/classes/NoEmitOnErrorsPlugin.md b/api/classes/NoEmitOnErrorsPlugin.md new file mode 100644 index 0000000..d4c1e27 --- /dev/null +++ b/api/classes/NoEmitOnErrorsPlugin.md @@ -0,0 +1,41 @@ +--- +title: NoEmitOnErrorsPlugin +--- + +[webpack](../globals) / 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..91255ad --- /dev/null +++ b/api/classes/NormalModule.md @@ -0,0 +1,2019 @@ +--- +title: NormalModule +--- + +[webpack](../globals) / 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) + +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`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<`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`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`Chunk`](Chunk.md)> + +Defined in: [webpack/types.d.ts:10673](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10673) + +##### Returns + +[`Iterable`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`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/util/classes/LazySet)<`string`> + +##### contextDependencies + +[`LazySet`](../webpack/namespaces/util/classes/LazySet)<`string`> + +##### missingDependencies + +[`LazySet`](../webpack/namespaces/util/classes/LazySet)<`string`> + +##### buildDependencies + +[`LazySet`](../webpack/namespaces/util/classes/LazySet)<`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`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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) + +##### 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/sources/classes/Source) + +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/sources/classes/Source) + +*** + +### createSourceForAsset() + +> **createSourceForAsset**(`context`, `name`, `content`, `sourceMap?`, `associatedObjectForCache?`): [`Source`](../webpack/namespaces/sources/classes/Source) + +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/sources/classes/Source) + +*** + +### 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) + +#### 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`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`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`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`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`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`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`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`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`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Map)<`string`, `number`> + +##### contextTimestamps + +[`Map`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Map)<`string`, `number`> + +#### Returns + +`boolean` + +#### Deprecated + +#### Inherited from + +[`Module`](Module.md).[`needRebuild`](Module.md#needrebuild) + +*** + +### originalSource() + +> **originalSource**(): [`Source`](../webpack/namespaces/sources/classes/Source) + +Defined in: [webpack/types.d.ts:10779](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10779) + +#### Returns + +[`Source`](../webpack/namespaces/sources/classes/Source) + +#### 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) + +#### 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`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/RegExp) | (`content`) => `boolean` | (`string` | [`RegExp`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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/sources/classes/Source) + +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/sources/classes/Source) + +#### 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) + +#### 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..3c87649 --- /dev/null +++ b/api/classes/NormalModuleReplacementPlugin.md @@ -0,0 +1,69 @@ +--- +title: NormalModuleReplacementPlugin +--- + +[webpack](../globals) / 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`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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..0a18157 --- /dev/null +++ b/api/classes/Parser.md @@ -0,0 +1,47 @@ +--- +title: Parser +--- + +[webpack](../globals) / 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/javascript/classes/JavascriptParser) + +## 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) + +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) + +#### Returns + +[`ParserState`](../type-aliases/ParserState) diff --git a/api/classes/PlatformPlugin.md b/api/classes/PlatformPlugin.md new file mode 100644 index 0000000..5f243ea --- /dev/null +++ b/api/classes/PlatformPlugin.md @@ -0,0 +1,55 @@ +--- +title: PlatformPlugin +--- + +[webpack](../globals) / 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`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<`PlatformTargetProperties`> + +#### Returns + +`PlatformPlugin` + +## Properties + +### platform + +> **platform**: [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)<`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..0d06710 --- /dev/null +++ b/api/classes/PrefetchPlugin.md @@ -0,0 +1,67 @@ +--- +title: PrefetchPlugin +--- + +[webpack](../globals) / 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..243ee09 --- /dev/null +++ b/api/classes/ProgressPlugin.md @@ -0,0 +1,223 @@ +--- +title: ProgressPlugin +--- + +[webpack](../globals) / 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`](https://www.typescriptlang.org/docs/handbook/utility-types.html#requiredtype)<[`Omit`](https://www.typescriptlang.org/docs/handbook/utility-types.html#omittype-keys)<`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..8a40bd6 --- /dev/null +++ b/api/classes/ProvidePlugin.md @@ -0,0 +1,55 @@ +--- +title: ProvidePlugin +--- + +[webpack](../globals) / 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`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`string`, `string` | `string`\[]> + +#### Returns + +`ProvidePlugin` + +## Properties + +### definitions + +> **definitions**: [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)<`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..f716fcd --- /dev/null +++ b/api/classes/Resolver.md @@ -0,0 +1,285 @@ +--- +title: Resolver +--- + +[webpack](../globals) / 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..9bd3a54 --- /dev/null +++ b/api/classes/RuntimeModule.md @@ -0,0 +1,1856 @@ +--- +title: RuntimeModule +--- + +[webpack](../globals) / 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/runtime/classes/GetChunkFilenameRuntimeModule) +* [`JsonpChunkLoadingRuntimeModule`](../webpack/namespaces/web/classes/JsonpChunkLoadingRuntimeModule) +* [`CssLoadingRuntimeModule`](../webpack/namespaces/web/classes/CssLoadingRuntimeModule) +* [`ModuleChunkLoadingRuntimeModule`](../webpack/namespaces/esm/classes/ModuleChunkLoadingRuntimeModule) + +## 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) + +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`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`Chunk`](Chunk.md)> + +Defined in: [webpack/types.d.ts:10673](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10673) + +##### Returns + +[`Iterable`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`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/util/classes/LazySet)<`string`> + +##### contextDependencies + +[`LazySet`](../webpack/namespaces/util/classes/LazySet)<`string`> + +##### missingDependencies + +[`LazySet`](../webpack/namespaces/util/classes/LazySet)<`string`> + +##### buildDependencies + +[`LazySet`](../webpack/namespaces/util/classes/LazySet)<`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) + +##### 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) + +#### 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`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`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`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`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`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`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`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<[`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`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Map)<`string`, `number`> + +##### contextTimestamps + +[`Map`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Map)<`string`, `number`> + +#### Returns + +`boolean` + +#### Deprecated + +#### Inherited from + +[`Module`](Module.md).[`needRebuild`](Module.md#needrebuild) + +*** + +### originalSource() + +> **originalSource**(): [`Source`](../webpack/namespaces/sources/classes/Source) + +Defined in: [webpack/types.d.ts:10779](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L10779) + +#### Returns + +[`Source`](../webpack/namespaces/sources/classes/Source) + +#### 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) + +#### 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/sources/classes/Source) + +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/sources/classes/Source) + +#### 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..2638eed --- /dev/null +++ b/api/classes/SourceMapDevToolPlugin.md @@ -0,0 +1,95 @@ +--- +title: SourceMapDevToolPlugin +--- + +[webpack](../globals) / 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..d2c99c4 --- /dev/null +++ b/api/classes/Stats.md @@ -0,0 +1,137 @@ +--- +title: Stats +--- + +[webpack](../globals) / 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) + +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) + +#### Returns + +[`StatsCompilation`](../type-aliases/StatsCompilation) + +*** + +### 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) + +#### Returns + +`string` diff --git a/api/classes/Template.md b/api/classes/Template.md new file mode 100644 index 0000000..1f3cf21 --- /dev/null +++ b/api/classes/Template.md @@ -0,0 +1,313 @@ +--- +title: Template +--- + +[webpack](../globals) / 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/sources/classes/Source) + +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/sources/classes/Source) + +##### prefix? + +`string` + +#### Returns + +[`Source`](../webpack/namespaces/sources/classes/Source) + +*** + +### renderChunkRuntimeModules() + +> `static` **renderChunkRuntimeModules**(`runtimeModules`, `renderContext`): [`Source`](../webpack/namespaces/sources/classes/Source) + +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/sources/classes/Source) + +*** + +### renderRuntimeModules() + +> `static` **renderRuntimeModules**(`runtimeModules`, `renderContext`): [`Source`](../webpack/namespaces/sources/classes/Source) + +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/sources/classes/Source) + +*** + +### 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..4fed09a --- /dev/null +++ b/api/classes/WatchIgnorePlugin.md @@ -0,0 +1,55 @@ +--- +title: WatchIgnorePlugin +--- + +[webpack](../globals) / 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..db287f9 --- /dev/null +++ b/api/classes/Watching.md @@ -0,0 +1,223 @@ +--- +title: Watching +--- + +[webpack](../globals) / 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`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<`string`> + +##### dirs + +[`Iterable`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<`string`> + +##### missing + +[`Iterable`](https://www.typescriptlang.org/docs/handbook/iterators-and-generators.html#iterable-interface)<`string`> + +#### Returns + +`void` diff --git a/api/classes/WebpackError.md b/api/classes/WebpackError.md new file mode 100644 index 0000000..0f74f6f --- /dev/null +++ b/api/classes/WebpackError.md @@ -0,0 +1,281 @@ +--- +title: WebpackError +--- + +[webpack](../globals) / WebpackError + +# Class: WebpackError + +Defined in: [webpack/types.d.ts:19041](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L19041) + +## Extends + +* [`Error`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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) + +#### 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) + +#### 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`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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..4ebe251 --- /dev/null +++ b/api/classes/WebpackOptionsApply.md @@ -0,0 +1,59 @@ +--- +title: WebpackOptionsApply +--- + +[webpack](../globals) / 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..dfcd5d0 --- /dev/null +++ b/api/classes/WebpackOptionsDefaulter.md @@ -0,0 +1,39 @@ +--- +title: WebpackOptionsDefaulter +--- + +[webpack](../globals) / 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) + +Defined in: [webpack/types.d.ts:19136](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L19136) + +#### Parameters + +##### options + +[`Configuration`](../interfaces/Configuration) + +#### Returns + +[`WebpackOptionsNormalized`](../interfaces/WebpackOptionsNormalized) diff --git a/api/classes/WebpackOptionsValidationError.md b/api/classes/WebpackOptionsValidationError.md new file mode 100644 index 0000000..b3733c4 --- /dev/null +++ b/api/classes/WebpackOptionsValidationError.md @@ -0,0 +1,409 @@ +--- +title: WebpackOptionsValidationError +--- + +[webpack](../globals) / WebpackOptionsValidationError + +# Class: WebpackOptionsValidationError + +Defined in: webpack/node\_modules/schema-utils/declarations/ValidationError.d.ts:9 + +## Extends + +* [`Error`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error) + +## Constructors + +### Constructor + +> **new WebpackOptionsValidationError**(`errors`, `schema`, `configuration?`): `ValidationError` + +Defined in: webpack/node\_modules/schema-utils/declarations/ValidationError.d.ts:15 + +#### Parameters + +##### errors + +`SchemaUtilErrorObject`\[] + +array of error objects + +##### schema + +`Schema` + +schema + +##### configuration? + +`ValidationErrorConfiguration` + +configuration + +#### Returns + +`ValidationError` + +#### Overrides + +`Error.constructor` + +## Properties + +### baseDataPath + +> **baseDataPath**: `string` + +Defined in: webpack/node\_modules/schema-utils/declarations/ValidationError.d.ts:27 + +*** + +### errors + +> **errors**: `SchemaUtilErrorObject`\[] + +Defined in: webpack/node\_modules/schema-utils/declarations/ValidationError.d.ts:21 + +*** + +### headerName + +> **headerName**: `string` + +Defined in: webpack/node\_modules/schema-utils/declarations/ValidationError.d.ts:25 + +*** + +### message + +> **message**: `string` + +Defined in: docs.webpack.js.org/node\_modules/typescript/lib/lib.es5.d.ts:1077 + +#### Inherited from + +`Error.message` + +*** + +### name + +> **name**: `string` + +Defined in: docs.webpack.js.org/node\_modules/typescript/lib/lib.es5.d.ts:1076 + +#### Inherited from + +`Error.name` + +*** + +### postFormatter + +> **postFormatter**: `PostFormatter` + +Defined in: webpack/node\_modules/schema-utils/declarations/ValidationError.d.ts:29 + +*** + +### schema + +> **schema**: `Schema` + +Defined in: webpack/node\_modules/schema-utils/declarations/ValidationError.d.ts:23 + +*** + +### 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: docs.webpack.js.org/node\_modules/@types/node/globals.d.ts:67 + +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. + +#### Inherited from + +`Error.stackTraceLimit` + +## Methods + +### formatSchema() + +> **formatSchema**(`schema`, `logic?`, `prevSchemas?`): `string` + +Defined in: webpack/node\_modules/schema-utils/declarations/ValidationError.d.ts:41 + +#### Parameters + +##### schema + +`Schema` + +schema + +##### logic? + +`boolean` + +logic + +##### prevSchemas? + +`object`\[] + +prev schemas + +#### Returns + +`string` + +formatted schema + +*** + +### formatValidationError() + +> **formatValidationError**(`error`): `string` + +Defined in: webpack/node\_modules/schema-utils/declarations/ValidationError.d.ts:68 + +#### Parameters + +##### error + +`SchemaUtilErrorObject` + +error object + +#### Returns + +`string` + +formatted error object + +*** + +### formatValidationErrors() + +> **formatValidationErrors**(`errors`): `string` + +Defined in: webpack/node\_modules/schema-utils/declarations/ValidationError.d.ts:73 + +#### Parameters + +##### errors + +`SchemaUtilErrorObject`\[] + +errors + +#### Returns + +`string` + +formatted errors + +*** + +### getSchemaPart() + +> **getSchemaPart**(`path`): `Schema` + +Defined in: webpack/node\_modules/schema-utils/declarations/ValidationError.d.ts:34 + +#### Parameters + +##### path + +`string` + +path + +#### Returns + +`Schema` + +schema + +*** + +### getSchemaPartDescription() + +> **getSchemaPartDescription**(`schemaPart?`): `string` + +Defined in: webpack/node\_modules/schema-utils/declarations/ValidationError.d.ts:63 + +#### Parameters + +##### schemaPart? + +`Schema` + +schema part + +#### Returns + +`string` + +schema part description + +*** + +### getSchemaPartText() + +> **getSchemaPartText**(`schemaPart?`, `additionalPath?`, `needDot?`, `logic?`): `string` + +Defined in: webpack/node\_modules/schema-utils/declarations/ValidationError.d.ts:53 + +#### Parameters + +##### schemaPart? + +`Schema` + +schema part + +##### additionalPath? + +additional path + +`boolean` | `string`\[] + +##### needDot? + +`boolean` + +true when need dot + +##### logic? + +`boolean` + +logic + +#### Returns + +`string` + +schema part text + +*** + +### captureStackTrace() + +> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void` + +Defined in: docs.webpack.js.org/node\_modules/@types/node/globals.d.ts:51 + +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`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Function) + +#### Returns + +`void` + +#### Inherited from + +`Error.captureStackTrace` + +*** + +### prepareStackTrace() + +> `static` **prepareStackTrace**(`err`, `stackTraces`): `any` + +Defined in: docs.webpack.js.org/node\_modules/@types/node/globals.d.ts:55 + +#### Parameters + +##### err + +[`Error`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error) + +##### stackTraces + +`CallSite`\[] + +#### Returns + +`any` + +#### See + +https://v8.dev/docs/stack-trace-api#customizing-stack-traces + +#### Inherited from + +`Error.prepareStackTrace` 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/functions/export=.md b/api/functions/export=.md new file mode 100644 index 0000000..a053df5 --- /dev/null +++ b/api/functions/export=.md @@ -0,0 +1,79 @@ +--- +title: export= +--- + +[webpack](../globals) / export= + +# Function: export=() + +## Call Signature + +> **export=**(`options`, `callback`): [`Compiler`](../classes/Compiler) + +Defined in: [webpack/types.d.ts:19547](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L19547) + +### Parameters + +#### options + +[`Configuration`](../interfaces/Configuration) + +#### callback + +`CallbackWebpackFunction_2`<[`Stats`](../classes/Stats), `void`> + +### Returns + +[`Compiler`](../classes/Compiler) + +## Call Signature + +> **export=**(`options`): [`Compiler`](../classes/Compiler) + +Defined in: [webpack/types.d.ts:19551](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L19551) + +### Parameters + +#### options + +[`Configuration`](../interfaces/Configuration) + +### Returns + +[`Compiler`](../classes/Compiler) + +## Call Signature + +> **export=**(`options`, `callback`): [`MultiCompiler`](../classes/MultiCompiler) + +Defined in: [webpack/types.d.ts:19552](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L19552) + +### Parameters + +#### options + +[`MultiConfiguration`](../type-aliases/MultiConfiguration) + +#### callback + +`CallbackWebpackFunction_2`<[`MultiStats`](../classes/MultiStats), `void`> + +### Returns + +[`MultiCompiler`](../classes/MultiCompiler) + +## Call Signature + +> **export=**(`options`): [`MultiCompiler`](../classes/MultiCompiler) + +Defined in: [webpack/types.d.ts:19556](https://github.com/webpack/webpack/blob/e3298f1e7776ed66e31f70c8bc1bb2ac73f2c024/types.d.ts#L19556) + +### Parameters + +#### options + +[`MultiConfiguration`](../type-aliases/MultiConfiguration) + +### Returns + +[`MultiCompiler`](../classes/MultiCompiler) diff --git a/api/globals.md b/api/globals.md new file mode 100644 index 0000000..ec94a52 --- /dev/null +++ b/api/globals.md @@ -0,0 +1,1071 @@ +--- +title: webpack +--- + +# webpack + +## Namespaces + +* [cache](webpack/namespaces/cache/index.md) +* [cli](webpack/namespaces/cli/index.md) +* [config](webpack/namespaces/config/index.md) +* [container](webpack/namespaces/container/index.md) +* [css](webpack/namespaces/css/index.md) +* [debug](webpack/namespaces/debug/index.md) +* [dependencies](webpack/namespaces/dependencies/index.md) +* [electron](webpack/namespaces/electron/index.md) +* [esm](webpack/namespaces/esm/index.md) +* [experiments](webpack/namespaces/experiments/index.md) +* [ids](webpack/namespaces/ids/index.md) +* [javascript](webpack/namespaces/javascript/index.md) +* [library](webpack/namespaces/library/index.md) +* [ModuleFilenameHelpers](webpack/namespaces/ModuleFilenameHelpers/index.md) +* [node](webpack/namespaces/node/index.md) +* [OptimizationStages](webpack/namespaces/OptimizationStages/index.md) +* [optimize](webpack/namespaces/optimize/index.md) +* [prefetch](webpack/namespaces/prefetch/index.md) +* [runtime](webpack/namespaces/runtime/index.md) +* [RuntimeGlobals](webpack/namespaces/RuntimeGlobals/index.md) +* [sharing](webpack/namespaces/sharing/index.md) +* [sources](webpack/namespaces/sources/index.md) +* [util](webpack/namespaces/util/index.md) +* [wasm](webpack/namespaces/wasm/index.md) +* [web](webpack/namespaces/web/index.md) +* [webworker](webpack/namespaces/webworker/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) +* [WebpackOptionsValidationError](classes/WebpackOptionsValidationError.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) + +## Variables + +* [UsageState](variables/UsageState.md) +* [validate](variables/validate.md) +* [validateSchema](variables/validateSchema.md) +* [version](variables/version.md) +* [webpack](variables/webpack.md) + +## Functions + +* [export=](functions/export=.md) + +## References + +### Argument + +Re-exports [Argument](interfaces/Argument.md) + +*** + +### Asset + +Re-exports [Asset](interfaces/Asset.md) + +*** + +### AssetEmittedInfo + +Re-exports [AssetEmittedInfo](interfaces/AssetEmittedInfo.md) + +*** + +### AssetInfo + +Re-exports [AssetInfo](type-aliases/AssetInfo.md) + +*** + +### AsyncDependenciesBlock + +Re-exports [AsyncDependenciesBlock](classes/AsyncDependenciesBlock.md) + +*** + +### AutomaticPrefetchPlugin + +Re-exports [AutomaticPrefetchPlugin](classes/AutomaticPrefetchPlugin.md) + +*** + +### BannerPlugin + +Re-exports [BannerPlugin](classes/BannerPlugin.md) + +*** + +### Cache + +Re-exports [Cache](classes/Cache.md) + +*** + +### Chunk + +Re-exports [Chunk](classes/Chunk.md) + +*** + +### ChunkGraph + +Re-exports [ChunkGraph](classes/ChunkGraph.md) + +*** + +### ChunkGroup + +Re-exports [ChunkGroup](classes/ChunkGroup.md) + +*** + +### CleanPlugin + +Re-exports [CleanPlugin](classes/CleanPlugin.md) + +*** + +### CodeGenerationResults + +Re-exports [CodeGenerationResults](classes/CodeGenerationResults.md) + +*** + +### Colors + +Re-exports [Colors](interfaces/Colors.md) + +*** + +### ColorsOptions + +Re-exports [ColorsOptions](interfaces/ColorsOptions.md) + +*** + +### Compilation + +Re-exports [Compilation](classes/Compilation.md) + +*** + +### Compiler + +Re-exports [Compiler](classes/Compiler.md) + +*** + +### ConcatenationScope + +Re-exports [ConcatenationScope](classes/ConcatenationScope.md) + +*** + +### Configuration + +Re-exports [Configuration](interfaces/Configuration.md) + +*** + +### ContextExclusionPlugin + +Re-exports [ContextExclusionPlugin](classes/ContextExclusionPlugin.md) + +*** + +### ContextReplacementPlugin + +Re-exports [ContextReplacementPlugin](classes/ContextReplacementPlugin.md) + +*** + +### DefinePlugin + +Re-exports [DefinePlugin](classes/DefinePlugin.md) + +*** + +### DelegatedPlugin + +Re-exports [DelegatedPlugin](classes/DelegatedPlugin.md) + +*** + +### Dependency + +Re-exports [Dependency](classes/Dependency.md) + +*** + +### DllPlugin + +Re-exports [DllPlugin](classes/DllPlugin.md) + +*** + +### DllReferencePlugin + +Re-exports [DllReferencePlugin](classes/DllReferencePlugin.md) + +*** + +### DotenvPlugin + +Re-exports [DotenvPlugin](classes/DotenvPlugin.md) + +*** + +### DynamicEntryPlugin + +Re-exports [DynamicEntryPlugin](classes/DynamicEntryPlugin.md) + +*** + +### Entry + +Re-exports [Entry](type-aliases/Entry.md) + +*** + +### EntryNormalized + +Re-exports [EntryNormalized](type-aliases/EntryNormalized.md) + +*** + +### EntryObject + +Re-exports [EntryObject](interfaces/EntryObject.md) + +*** + +### EntryOptionPlugin + +Re-exports [EntryOptionPlugin](classes/EntryOptionPlugin.md) + +*** + +### EntryOptions + +Re-exports [EntryOptions](type-aliases/EntryOptions.md) + +*** + +### EntryPlugin + +Re-exports [EntryPlugin](classes/EntryPlugin.md) + +*** + +### Entrypoint + +Re-exports [Entrypoint](classes/Entrypoint.md) + +*** + +### EnvironmentPlugin + +Re-exports [EnvironmentPlugin](classes/EnvironmentPlugin.md) + +*** + +### EvalDevToolModulePlugin + +Re-exports [EvalDevToolModulePlugin](classes/EvalDevToolModulePlugin.md) + +*** + +### EvalSourceMapDevToolPlugin + +Re-exports [EvalSourceMapDevToolPlugin](classes/EvalSourceMapDevToolPlugin.md) + +*** + +### ExternalItem + +Re-exports [ExternalItem](type-aliases/ExternalItem.md) + +*** + +### ExternalItemFunction + +Re-exports [ExternalItemFunction](type-aliases/ExternalItemFunction.md) + +*** + +### ExternalItemFunctionCallback + +Re-exports [ExternalItemFunctionCallback](type-aliases/ExternalItemFunctionCallback.md) + +*** + +### ExternalItemFunctionData + +Re-exports [ExternalItemFunctionData](interfaces/ExternalItemFunctionData.md) + +*** + +### ExternalItemFunctionDataGetResolve + +Re-exports [ExternalItemFunctionDataGetResolve](type-aliases/ExternalItemFunctionDataGetResolve.md) + +*** + +### ExternalItemFunctionDataGetResolveCallbackResult + +Re-exports [ExternalItemFunctionDataGetResolveCallbackResult](type-aliases/ExternalItemFunctionDataGetResolveCallbackResult.md) + +*** + +### ExternalItemFunctionDataGetResolveResult + +Re-exports [ExternalItemFunctionDataGetResolveResult](type-aliases/ExternalItemFunctionDataGetResolveResult.md) + +*** + +### ExternalItemFunctionPromise + +Re-exports [ExternalItemFunctionPromise](type-aliases/ExternalItemFunctionPromise.md) + +*** + +### ExternalItemObjectKnown + +Re-exports [ExternalItemObjectKnown](interfaces/ExternalItemObjectKnown.md) + +*** + +### ExternalItemObjectUnknown + +Re-exports [ExternalItemObjectUnknown](interfaces/ExternalItemObjectUnknown.md) + +*** + +### ExternalItemValue + +Re-exports [ExternalItemValue](type-aliases/ExternalItemValue.md) + +*** + +### ExternalModule + +Re-exports [ExternalModule](classes/ExternalModule.md) + +*** + +### Externals + +Re-exports [Externals](type-aliases/Externals.md) + +*** + +### ExternalsPlugin + +Re-exports [ExternalsPlugin](classes/ExternalsPlugin.md) + +*** + +### FileCacheOptions + +Re-exports [FileCacheOptions](interfaces/FileCacheOptions.md) + +*** + +### Generator + +Re-exports [Generator](classes/Generator.md) + +*** + +### GeneratorOptionsByModuleTypeKnown + +Re-exports [GeneratorOptionsByModuleTypeKnown](interfaces/GeneratorOptionsByModuleTypeKnown.md) + +*** + +### HotModuleReplacementPlugin + +Re-exports [HotModuleReplacementPlugin](classes/HotModuleReplacementPlugin.md) + +*** + +### HotUpdateChunk + +Re-exports [HotUpdateChunk](classes/HotUpdateChunk.md) + +*** + +### IgnorePlugin + +Re-exports [IgnorePlugin](classes/IgnorePlugin.md) + +*** + +### InitFragment + +Re-exports [InitFragment](classes/InitFragment.md) + +*** + +### InputFileSystem + +Re-exports [InputFileSystem](interfaces/InputFileSystem.md) + +*** + +### JavascriptModulesPlugin + +Re-exports [JavascriptModulesPlugin](classes/JavascriptModulesPlugin.md) + +*** + +### LibManifestPlugin + +Re-exports [LibManifestPlugin](classes/LibManifestPlugin.md) + +*** + +### LibraryOptions + +Re-exports [LibraryOptions](interfaces/LibraryOptions.md) + +*** + +### LibraryTemplatePlugin + +Re-exports [LibraryTemplatePlugin](classes/LibraryTemplatePlugin.md) + +*** + +### LoaderContext + +Re-exports [LoaderContext](type-aliases/LoaderContext.md) + +*** + +### LoaderDefinition + +Re-exports [LoaderDefinition](type-aliases/LoaderDefinition.md) + +*** + +### LoaderDefinitionFunction + +Re-exports [LoaderDefinitionFunction](interfaces/LoaderDefinitionFunction.md) + +*** + +### LoaderModule + +Re-exports [LoaderModule](interfaces/LoaderModule.md) + +*** + +### LoaderOptionsPlugin + +Re-exports [LoaderOptionsPlugin](classes/LoaderOptionsPlugin.md) + +*** + +### LoaderTargetPlugin + +Re-exports [LoaderTargetPlugin](classes/LoaderTargetPlugin.md) + +*** + +### ManifestPlugin + +Re-exports [ManifestPlugin](classes/ManifestPlugin.md) + +*** + +### MemoryCacheOptions + +Re-exports [MemoryCacheOptions](interfaces/MemoryCacheOptions.md) + +*** + +### Module + +Re-exports [Module](classes/Module.md) + +*** + +### ModuleFactory + +Re-exports [ModuleFactory](classes/ModuleFactory.md) + +*** + +### ModuleGraph + +Re-exports [ModuleGraph](classes/ModuleGraph.md) + +*** + +### ModuleGraphConnection + +Re-exports [ModuleGraphConnection](classes/ModuleGraphConnection.md) + +*** + +### ModuleOptions + +Re-exports [ModuleOptions](interfaces/ModuleOptions.md) + +*** + +### MultiCompiler + +Re-exports [MultiCompiler](classes/MultiCompiler.md) + +*** + +### MultiCompilerOptions + +Re-exports [MultiCompilerOptions](interfaces/MultiCompilerOptions.md) + +*** + +### MultiConfiguration + +Re-exports [MultiConfiguration](type-aliases/MultiConfiguration.md) + +*** + +### MultiStats + +Re-exports [MultiStats](classes/MultiStats.md) + +*** + +### MultiStatsOptions + +Renames and re-exports [StatsOptions](interfaces/StatsOptions.md) + +*** + +### MultiStatsOptions + +Renames and re-exports [StatsOptions](interfaces/StatsOptions.md) + +*** + +### NoEmitOnErrorsPlugin + +Re-exports [NoEmitOnErrorsPlugin](classes/NoEmitOnErrorsPlugin.md) + +*** + +### NormalModule + +Re-exports [NormalModule](classes/NormalModule.md) + +*** + +### NormalModuleReplacementPlugin + +Re-exports [NormalModuleReplacementPlugin](classes/NormalModuleReplacementPlugin.md) + +*** + +### ObjectDeserializerContext + +Re-exports [ObjectDeserializerContext](interfaces/ObjectDeserializerContext.md) + +*** + +### ObjectSerializerContext + +Re-exports [ObjectSerializerContext](interfaces/ObjectSerializerContext.md) + +*** + +### OutputFileSystem + +Re-exports [OutputFileSystem](interfaces/OutputFileSystem.md) + +*** + +### Parser + +Re-exports [Parser](classes/Parser.md) + +*** + +### ParserOptionsByModuleTypeKnown + +Re-exports [ParserOptionsByModuleTypeKnown](interfaces/ParserOptionsByModuleTypeKnown.md) + +*** + +### ParserState + +Re-exports [ParserState](type-aliases/ParserState.md) + +*** + +### PathData + +Re-exports [PathData](interfaces/PathData.md) + +*** + +### PitchLoaderDefinitionFunction + +Re-exports [PitchLoaderDefinitionFunction](interfaces/PitchLoaderDefinitionFunction.md) + +*** + +### PlatformPlugin + +Re-exports [PlatformPlugin](classes/PlatformPlugin.md) + +*** + +### PrefetchPlugin + +Re-exports [PrefetchPlugin](classes/PrefetchPlugin.md) + +*** + +### Problem + +Re-exports [Problem](interfaces/Problem.md) + +*** + +### ProgressPlugin + +Re-exports [ProgressPlugin](classes/ProgressPlugin.md) + +*** + +### ProvidePlugin + +Re-exports [ProvidePlugin](classes/ProvidePlugin.md) + +*** + +### RawLoaderDefinition + +Re-exports [RawLoaderDefinition](type-aliases/RawLoaderDefinition.md) + +*** + +### RawLoaderDefinitionFunction + +Re-exports [RawLoaderDefinitionFunction](interfaces/RawLoaderDefinitionFunction.md) + +*** + +### RenderManifestEntry + +Re-exports [RenderManifestEntry](type-aliases/RenderManifestEntry.md) + +*** + +### RenderManifestOptions + +Re-exports [RenderManifestOptions](interfaces/RenderManifestOptions.md) + +*** + +### ResolveData + +Re-exports [ResolveData](interfaces/ResolveData.md) + +*** + +### ResolveOptions + +Re-exports [ResolveOptions](interfaces/ResolveOptions.md) + +*** + +### ResolvePluginInstance + +Re-exports [ResolvePluginInstance](type-aliases/ResolvePluginInstance.md) + +*** + +### Resolver + +Re-exports [Resolver](classes/Resolver.md) + +*** + +### RuleSetCondition + +Re-exports [RuleSetCondition](type-aliases/RuleSetCondition.md) + +*** + +### RuleSetConditionAbsolute + +Re-exports [RuleSetConditionAbsolute](type-aliases/RuleSetConditionAbsolute.md) + +*** + +### RuleSetRule + +Re-exports [RuleSetRule](interfaces/RuleSetRule.md) + +*** + +### RuleSetUse + +Re-exports [RuleSetUse](type-aliases/RuleSetUse.md) + +*** + +### RuleSetUseFunction + +Re-exports [RuleSetUseFunction](type-aliases/RuleSetUseFunction.md) + +*** + +### RuleSetUseItem + +Re-exports [RuleSetUseItem](type-aliases/RuleSetUseItem.md) + +*** + +### RuntimeModule + +Re-exports [RuntimeModule](classes/RuntimeModule.md) + +*** + +### SingleEntryPlugin + +Renames and re-exports [EntryPlugin](classes/EntryPlugin.md) + +*** + +### SingleEntryPlugin + +Renames and re-exports [EntryPlugin](classes/EntryPlugin.md) + +*** + +### SourceMapDevToolPlugin + +Re-exports [SourceMapDevToolPlugin](classes/SourceMapDevToolPlugin.md) + +*** + +### Stats + +Re-exports [Stats](classes/Stats.md) + +*** + +### StatsAsset + +Re-exports [StatsAsset](type-aliases/StatsAsset.md) + +*** + +### StatsChunk + +Re-exports [StatsChunk](type-aliases/StatsChunk.md) + +*** + +### StatsChunkGroup + +Re-exports [StatsChunkGroup](type-aliases/StatsChunkGroup.md) + +*** + +### StatsChunkOrigin + +Re-exports [StatsChunkOrigin](type-aliases/StatsChunkOrigin.md) + +*** + +### StatsCompilation + +Re-exports [StatsCompilation](type-aliases/StatsCompilation.md) + +*** + +### StatsError + +Re-exports [StatsError](type-aliases/StatsError.md) + +*** + +### StatsLogging + +Re-exports [StatsLogging](type-aliases/StatsLogging.md) + +*** + +### StatsLoggingEntry + +Re-exports [StatsLoggingEntry](type-aliases/StatsLoggingEntry.md) + +*** + +### StatsModule + +Re-exports [StatsModule](type-aliases/StatsModule.md) + +*** + +### StatsModuleIssuer + +Re-exports [StatsModuleIssuer](type-aliases/StatsModuleIssuer.md) + +*** + +### StatsModuleReason + +Re-exports [StatsModuleReason](type-aliases/StatsModuleReason.md) + +*** + +### StatsModuleTraceDependency + +Re-exports [StatsModuleTraceDependency](type-aliases/StatsModuleTraceDependency.md) + +*** + +### StatsModuleTraceItem + +Re-exports [StatsModuleTraceItem](type-aliases/StatsModuleTraceItem.md) + +*** + +### StatsOptions + +Re-exports [StatsOptions](interfaces/StatsOptions.md) + +*** + +### StatsProfile + +Re-exports [StatsProfile](type-aliases/StatsProfile.md) + +*** + +### Template + +Re-exports [Template](classes/Template.md) + +*** + +### TemplatePath + +Re-exports [TemplatePath](type-aliases/TemplatePath.md) + +*** + +### ValidationError + +Renames and re-exports [WebpackOptionsValidationError](classes/WebpackOptionsValidationError.md) + +*** + +### ValidationError + +Renames and re-exports [WebpackOptionsValidationError](classes/WebpackOptionsValidationError.md) + +*** + +### WatchIgnorePlugin + +Re-exports [WatchIgnorePlugin](classes/WatchIgnorePlugin.md) + +*** + +### Watching + +Re-exports [Watching](classes/Watching.md) + +*** + +### WebpackError + +Re-exports [WebpackError](classes/WebpackError.md) + +*** + +### WebpackOptionsApply + +Re-exports [WebpackOptionsApply](classes/WebpackOptionsApply.md) + +*** + +### WebpackOptionsDefaulter + +Re-exports [WebpackOptionsDefaulter](classes/WebpackOptionsDefaulter.md) + +*** + +### WebpackOptionsNormalized + +Re-exports [WebpackOptionsNormalized](interfaces/WebpackOptionsNormalized.md) + +*** + +### WebpackOptionsValidationError + +Re-exports [WebpackOptionsValidationError](classes/WebpackOptionsValidationError.md) + +*** + +### WebpackPluginFunction + +Re-exports [WebpackPluginFunction](type-aliases/WebpackPluginFunction.md) + +*** + +### WebpackPluginInstance + +Re-exports [WebpackPluginInstance](interfaces/WebpackPluginInstance.md) diff --git a/api/index.md b/api/index.md new file mode 100644 index 0000000..7af6a49 --- /dev/null +++ b/api/index.md @@ -0,0 +1,486 @@ +--- +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 | +| :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :------------: | :-------------: | :----------------------------------------------------------------------- | +| `