Module

webpack / Module

Class: Module

Defined in: webpack/types.d.ts:10629

Extends

• DependenciesBlock

Extended by

• ExternalModule
• NormalModule
• RuntimeModule

Constructors

Constructor

new Module(type, context?, layer?): Module

Defined in: webpack/types.d.ts:10630

Parameters

type

string

context?

string

layer?

string

Returns

Module

Overrides

DependenciesBlock.constructor

Properties

blocks

blocks: AsyncDependenciesBlock[]

Defined in: webpack/types.d.ts:4110

Inherited from

DependenciesBlock.blocks

---

buildInfo?

optional buildInfo: BuildInfo

Defined in: webpack/types.d.ts:10642

---

buildMeta?

optional buildMeta: BuildMeta

Defined in: webpack/types.d.ts:10641

---

codeGenerationDependencies?

optional codeGenerationDependencies: Dependency[]

Defined in: webpack/types.d.ts:10644

---

context

context: string

Defined in: webpack/types.d.ts:10632

---

debugId

debugId: number

Defined in: webpack/types.d.ts:10635

---

dependencies

dependencies: Dependency[]

Defined in: webpack/types.d.ts:4109

Inherited from

DependenciesBlock.dependencies

---

depth

depth: number

Defined in: webpack/types.d.ts:10655

---

factoryMeta?

optional factoryMeta: FactoryMeta

Defined in: webpack/types.d.ts:10637

---

hot

hot: boolean

Defined in: webpack/types.d.ts:10640

---

id

id: string | number

Defined in: webpack/types.d.ts:10649

Deprecated

---

index

index: number

Defined in: webpack/types.d.ts:10653

---

index2

index2: number

Defined in: webpack/types.d.ts:10654

---

issuer?

optional issuer: Module

Defined in: webpack/types.d.ts:10656

---

layer

layer: string

Defined in: webpack/types.d.ts:10633

---

needId

needId: boolean

Defined in: webpack/types.d.ts:10634

---

parent?

optional parent: DependenciesBlock

Defined in: webpack/types.d.ts:4111

Inherited from

DependenciesBlock.parent

---

presentationalDependencies?

optional presentationalDependencies: Dependency[]

Defined in: webpack/types.d.ts:10643

---

profile?

optional profile: ModuleProfile

Defined in: webpack/types.d.ts:10652

---

resolveOptions?

optional resolveOptions: ResolveOptions

Defined in: webpack/types.d.ts:10636

---

type

type: string

Defined in: webpack/types.d.ts:10631

---

used

used: any

Defined in: webpack/types.d.ts:10790

---

useSimpleSourceMap

useSimpleSourceMap: boolean

Defined in: webpack/types.d.ts:10639

---

useSourceMap

useSourceMap: boolean

Defined in: webpack/types.d.ts:10638

Accessors

chunksIterable

Get Signature

get chunksIterable(): Iterable<Chunk>

Defined in: webpack/types.d.ts:10673

Returns

Iterable<Chunk>

---

errors

Get Signature

get errors(): any

Defined in: webpack/types.d.ts:10788

Returns

any

---

exportsArgument

Get Signature

get exportsArgument(): string

Defined in: webpack/types.d.ts:10675

Returns

string

---

hasEqualsChunks

Get Signature

get hasEqualsChunks(): any

Defined in: webpack/types.d.ts:10786

Returns

any

---

hash

Get Signature

get hash(): string

Defined in: webpack/types.d.ts:10650

Returns

string

---

isUsed

Get Signature

get isUsed(): any

Defined in: webpack/types.d.ts:10787

Returns

any

---

moduleArgument

Get Signature

get moduleArgument(): string

Defined in: webpack/types.d.ts:10676

Returns

string

---

optimizationBailout

Get Signature

get optimizationBailout(): (string | (requestShortener) => string)[]

Defined in: webpack/types.d.ts:10662

Deprecated

Returns

(string | (requestShortener) => string)[]

---

optional

Get Signature

get optional(): boolean

Defined in: webpack/types.d.ts:10666

Returns

boolean

---

renderedHash

Get Signature

get renderedHash(): string

Defined in: webpack/types.d.ts:10651

Returns

string

---

usedExports

Get Signature

get usedExports(): boolean | SortableSet<string>

Defined in: webpack/types.d.ts:10657

Returns

boolean | SortableSet<string>

---

warnings

Get Signature

get warnings(): any

Defined in: webpack/types.d.ts:10789

Returns

any

Methods

addBlock()

addBlock(block): void

Defined in: webpack/types.d.ts:4118

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

---

addCacheDependencies()

addCacheDependencies(fileDependencies, contextDependencies, missingDependencies, buildDependencies): void

Defined in: webpack/types.d.ts:10780

Parameters

fileDependencies

LazySet<string>

contextDependencies

LazySet<string>

missingDependencies

LazySet<string>

buildDependencies

LazySet<string>

Returns

void

---

addChunk()

addChunk(chunk): boolean

Defined in: webpack/types.d.ts:10667

Parameters

chunk

Chunk

Returns

boolean

---

addCodeGenerationDependency()

addCodeGenerationDependency(codeGenerationDependency): void

Defined in: webpack/types.d.ts:10679

Parameters

codeGenerationDependency

Dependency

Returns

void

---

addDependency()

addDependency(dependency): void

Defined in: webpack/types.d.ts:4119

Parameters

dependency

Dependency

Returns

void

Inherited from

DependenciesBlock.addDependency

---

addError()

addError(error): void

Defined in: webpack/types.d.ts:10683

Parameters

error

WebpackError

Returns

void

---

addPresentationalDependency()

addPresentationalDependency(presentationalDependency): void

Defined in: webpack/types.d.ts:10678

Parameters

presentationalDependency

Dependency

Returns

void

---

addWarning()

addWarning(warning): void

Defined in: webpack/types.d.ts:10680

Parameters

warning

WebpackError

Returns

void

---

build()

build(options, compilation, resolver, fs, callback): void

Defined in: webpack/types.d.ts:10724

Parameters

options

WebpackOptionsNormalizedWithDefaults

compilation

Compilation

resolver

ResolverWithOptions

fs

InputFileSystem

callback

(err?) => void

Returns

void

---

chunkCondition()

chunkCondition(chunk, compilation): boolean

Defined in: webpack/types.d.ts:10759

Parameters

chunk

Chunk

compilation

Compilation

Returns

boolean

---

cleanupForCache()

cleanupForCache(): void

Defined in: webpack/types.d.ts:10778

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

Removes all dependencies and blocks

Returns

void

Inherited from

DependenciesBlock.clearDependenciesAndBlocks

---

clearWarningsAndErrors()

clearWarningsAndErrors(): void

Defined in: webpack/types.d.ts:10690

removes all warnings and errors

Returns

void

---

codeGeneration()

codeGeneration(context): CodeGenerationResult

Defined in: webpack/types.d.ts:10758

Parameters

context

CodeGenerationContext

Returns

CodeGenerationResult

---

deserialize()

deserialize(__namedParameters): void

Defined in: webpack/types.d.ts:4128

Parameters

__namedParameters

ObjectDeserializerContext

Returns

void

Inherited from

DependenciesBlock.deserialize

---

getChunks()

getChunks(): Chunk[]

Defined in: webpack/types.d.ts:10671

Returns

Chunk[]

---

getConcatenationBailoutReason()

getConcatenationBailoutReason(context): string

Defined in: webpack/types.d.ts:10754

Parameters

context

ConcatenationBailoutReasonContext

Returns

string

---

getErrors()

getErrors(): Iterable<WebpackError, any, any>

Defined in: webpack/types.d.ts:10684

Returns

Iterable<WebpackError, any, any>

---

getExportsType()

getExportsType(moduleGraph, strict?): ExportsType

Defined in: webpack/types.d.ts:10677

Parameters

moduleGraph

ModuleGraph

strict?

boolean

Returns

ExportsType

---

getNumberOfChunks()

getNumberOfChunks(): number

Defined in: webpack/types.d.ts:10672

Returns

number

---

getNumberOfErrors()

getNumberOfErrors(): number

Defined in: webpack/types.d.ts:10685

Returns

number

---

getNumberOfWarnings()

getNumberOfWarnings(): number

Defined in: webpack/types.d.ts:10682

Returns

number

---

getRootBlock()

getRootBlock(): DependenciesBlock

Defined in: webpack/types.d.ts:4112

Returns

DependenciesBlock

Inherited from

DependenciesBlock.getRootBlock

---

getSideEffectsConnectionState()

getSideEffectsConnectionState(moduleGraph): ConnectionState

Defined in: webpack/types.d.ts:10757

Parameters

moduleGraph

ModuleGraph

Returns

ConnectionState

---

getSourceBasicTypes()

getSourceBasicTypes(): ReadonlySet<string>

Defined in: webpack/types.d.ts:10740

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

Returns

ReadonlySet<string>

---

getUnsafeCacheData()

getUnsafeCacheData(): UnsafeCacheData

Defined in: webpack/types.d.ts:10773

Module should be unsafe cached. Get data that’s needed for that. This data will be passed to restoreFromUnsafeCache later.

Returns

UnsafeCacheData

---

getWarnings()

getWarnings(): Iterable<WebpackError, any, any>

Defined in: webpack/types.d.ts:10681

Returns

Iterable<WebpackError, any, any>

---

hasChunkCondition()

hasChunkCondition(): boolean

Defined in: webpack/types.d.ts:10760

Returns

boolean

---

hasReasonForChunk()

hasReasonForChunk(chunk, moduleGraph, chunkGraph): boolean

Defined in: webpack/types.d.ts:10702

Parameters

chunk

Chunk

moduleGraph

ModuleGraph

chunkGraph

ChunkGraph

Returns

boolean

---

hasReasons()

hasReasons(moduleGraph, runtime): boolean

Defined in: webpack/types.d.ts:10707

Parameters

moduleGraph

ModuleGraph

runtime

RuntimeSpec

Returns

boolean

---

identifier()

identifier(): string

Defined in: webpack/types.d.ts:10722

Returns

string

---

invalidateBuild()

invalidateBuild(): void

Defined in: webpack/types.d.ts:10721

Returns

void

---

isAccessibleInChunk()

isAccessibleInChunk(chunkGraph, chunk, ignoreChunk?): boolean

Defined in: webpack/types.d.ts:10692

Parameters

chunkGraph

ChunkGraph

chunk

Chunk

ignoreChunk?

Chunk

Returns

boolean

---

isAccessibleInChunkGroup()

isAccessibleInChunkGroup(chunkGraph, chunkGroup, ignoreChunk?): boolean

Defined in: webpack/types.d.ts:10697

Parameters

chunkGraph

ChunkGraph

chunkGroup

ChunkGroup

ignoreChunk?

Chunk

Returns

boolean

---

isEntryModule()

isEntryModule(): boolean

Defined in: webpack/types.d.ts:10670

Returns

boolean

---

isInChunk()

isInChunk(chunk): boolean

Defined in: webpack/types.d.ts:10669

Parameters

chunk

Chunk

Returns

boolean

---

isOptional()

isOptional(moduleGraph): boolean

Defined in: webpack/types.d.ts:10691

Parameters

moduleGraph

ModuleGraph

Returns

boolean

---

isProvided()

isProvided(exportName): boolean

Defined in: webpack/types.d.ts:10674

Parameters

exportName

string

Returns

boolean

---

libIdent()

libIdent(options): string

Defined in: webpack/types.d.ts:10752

Parameters

options

LibIdentOptions

Returns

string

---

nameForCondition()

nameForCondition(): string

Defined in: webpack/types.d.ts:10753

Returns

string

---

needBuild()

needBuild(context, callback): void

Defined in: webpack/types.d.ts:10708

Parameters

context

NeedBuildContext

callback

(err?, needBuild?) => void

Returns

void

---

needRebuild()

needRebuild(fileTimestamps, contextTimestamps): boolean

Defined in: webpack/types.d.ts:10717

Use needBuild instead

Parameters

fileTimestamps

Map<string, number>

contextTimestamps

Map<string, number>

Returns

boolean

Deprecated

---

originalSource()

originalSource(): Source

Defined in: webpack/types.d.ts:10779

Returns

Source

---

readableIdentifier()

readableIdentifier(requestShortener): string

Defined in: webpack/types.d.ts:10723

Parameters

requestShortener

RequestShortener

Returns

string

---

removeChunk()

removeChunk(chunk): void

Defined in: webpack/types.d.ts:10668

Parameters

chunk

Chunk

Returns

void

---

removeDependency()

removeDependency(dependency): void

Defined in: webpack/types.d.ts:4120

Parameters

dependency

Dependency

Returns

void

Inherited from

DependenciesBlock.removeDependency

---

serialize()

serialize(__namedParameters): void

Defined in: webpack/types.d.ts:4127

Parameters

__namedParameters

ObjectSerializerContext

Returns

void

Inherited from

DependenciesBlock.serialize

---

size()

size(type?): number

Defined in: webpack/types.d.ts:10751

Parameters

type?

string

Returns

number

---

source()

source(dependencyTemplates, runtimeTemplate, type?): Source

Defined in: webpack/types.d.ts:10746

Use codeGeneration() instead

Parameters

dependencyTemplates

DependencyTemplates

runtimeTemplate

RuntimeTemplate

type?

string

Returns

Source

Deprecated

---

updateCacheModule()

updateCacheModule(module): void

Defined in: webpack/types.d.ts:10767

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

Parameters

hash

Hash

context

UpdateHashContextDependency

Returns

void

Inherited from

DependenciesBlock.updateHash