Class Compiler

Hierarchy

Compiler

Constructors

constructor

new Compiler(context, options?): Compiler
Parameters
- context: string
- Optional options: WebpackOptionsNormalized
Returns Compiler
- Defined in node_modules/webpack/types.d.ts:2006

Properties

cache

cache: Cache

compilerPath

compilerPath: string

context

context: string

contextTimestamps

contextTimestamps: ReadonlyMap<string, null | FileSystemInfoEntry | "ignore">

fileTimestamps

fileTimestamps: ReadonlyMap<string, null | FileSystemInfoEntry | "ignore">

fsStartTime

fsStartTime: number

hooks

Type declaration

additionalPass: AsyncSeriesHook<[], UnsetAdditionalOptions>
afterCompile: AsyncSeriesHook<[Compilation], UnsetAdditionalOptions>
afterDone: SyncHook<[Stats], void, UnsetAdditionalOptions>
afterEmit: AsyncSeriesHook<[Compilation], UnsetAdditionalOptions>
afterEnvironment: SyncHook<[], void, UnsetAdditionalOptions>
afterPlugins: SyncHook<[Compiler], void, UnsetAdditionalOptions>
afterResolvers: SyncHook<[Compiler], void, UnsetAdditionalOptions>
assetEmitted: AsyncSeriesHook<[string, AssetEmittedInfo], UnsetAdditionalOptions>
beforeCompile: AsyncSeriesHook<[CompilationParams], UnsetAdditionalOptions>
beforeRun: AsyncSeriesHook<[Compiler], UnsetAdditionalOptions>
compilation: SyncHook<[Compilation, CompilationParams], void, UnsetAdditionalOptions>
compile: SyncHook<[CompilationParams], void, UnsetAdditionalOptions>
contextModuleFactory: SyncHook<[ContextModuleFactory], void, UnsetAdditionalOptions>
done: AsyncSeriesHook<[Stats], UnsetAdditionalOptions>
emit: AsyncSeriesHook<[Compilation], UnsetAdditionalOptions>
emitRecords: AsyncSeriesHook<[], UnsetAdditionalOptions>
entryOption: SyncBailHook<[string, EntryNormalized], boolean, UnsetAdditionalOptions>
environment: SyncHook<[], void, UnsetAdditionalOptions>
failed: SyncHook<[Error], void, UnsetAdditionalOptions>
finishMake: AsyncParallelHook<[Compilation], UnsetAdditionalOptions>
infrastructureLog: SyncBailHook<[string, string, any[]], true, UnsetAdditionalOptions>
initialize: SyncHook<[], void, UnsetAdditionalOptions>
invalid: SyncHook<[null | string, number], void, UnsetAdditionalOptions>
make: AsyncParallelHook<[Compilation], UnsetAdditionalOptions>
normalModuleFactory: SyncHook<[NormalModuleFactory], void, UnsetAdditionalOptions>
readRecords: AsyncSeriesHook<[], UnsetAdditionalOptions>
run: AsyncSeriesHook<[Compiler], UnsetAdditionalOptions>
shouldEmit: SyncBailHook<[Compilation], boolean, UnsetAdditionalOptions>
shutdown: AsyncSeriesHook<[], UnsetAdditionalOptions>
thisCompilation: SyncHook<[Compilation, CompilationParams], void, UnsetAdditionalOptions>
watchClose: SyncHook<[], void, UnsetAdditionalOptions>
watchRun: AsyncSeriesHook<[Compiler], UnsetAdditionalOptions>

idle

idle: boolean

immutablePaths

immutablePaths: Set<string | RegExp>

infrastructureLogger

infrastructureLogger: any

inputFileSystem

inputFileSystem: InputFileSystem

intermediateFileSystem

intermediateFileSystem: IntermediateFileSystem

managedPaths

managedPaths: Set<string | RegExp>

modifiedFiles

modifiedFiles: ReadonlySet<string>

`Optional` moduleMemCaches

moduleMemCaches?: Map<Module, {
    buildInfo: object;
    memCache: WeakTupleMap<any, any>;
    references: WeakMap<Dependency, Module>;
}>

Type declaration

buildInfo: object
memCache: WeakTupleMap<any, any>
references: WeakMap<Dependency, Module>

`Optional` name

name?: string

options

options: WebpackOptionsNormalized

outputFileSystem

outputFileSystem: OutputFileSystem

outputPath

outputPath: string

`Optional` parentCompilation

parentCompilation?: Compilation

records

records: object

recordsInputPath

recordsInputPath: null | string

recordsOutputPath

recordsOutputPath: null | string

removedFiles

removedFiles: ReadonlySet<string>

requestShortener

requestShortener: RequestShortener

resolverFactory

resolverFactory: ResolverFactory

root

root: Compiler

running

running: boolean

watchFileSystem

watchFileSystem: WatchFileSystem

watchMode

watchMode: boolean

watching

watching: Watching

webpack

webpack: typeof exports

Methods

close

close(callback): void
Parameters
- callback: CallbackFunction<void>
Returns void
- Defined in node_modules/webpack/types.d.ts:2111

compile

compile(callback): void
Parameters
- callback: CallbackFunction<Compilation>
Returns void
- Defined in node_modules/webpack/types.d.ts:2110

createChildCompiler

createChildCompiler(compilation, compilerName, compilerIndex, outputOptions?, plugins?): Compiler
Parameters
- compilation: Compilation
- compilerName: string
- compilerIndex: number
- Optional outputOptions: OutputNormalized
- Optional plugins: WebpackPluginInstance[]
Returns Compiler
- Defined in node_modules/webpack/types.d.ts:2094

createCompilation

createCompilation(params?): Compilation
Parameters
- Optional params: any
Returns Compilation
- Defined in node_modules/webpack/types.d.ts:2102

createContextModuleFactory

createContextModuleFactory(): ContextModuleFactory
Returns ContextModuleFactory
- Defined in node_modules/webpack/types.d.ts:2105

createNormalModuleFactory

createNormalModuleFactory(): NormalModuleFactory
Returns NormalModuleFactory
- Defined in node_modules/webpack/types.d.ts:2104

emitAssets

emitAssets(compilation, callback): void
Parameters
- compilation: Compilation
- callback: CallbackFunction<void>
Returns void
- Defined in node_modules/webpack/types.d.ts:2091

emitRecords

emitRecords(callback): void
Parameters
- callback: CallbackFunction<void>
Returns void
- Defined in node_modules/webpack/types.d.ts:2092

getCache

getCache(name): CacheFacade
Parameters
- name: string
Returns CacheFacade
- Defined in node_modules/webpack/types.d.ts:2079

getInfrastructureLogger

getInfrastructureLogger(name): WebpackLogger
Parameters
- name: string | (() => string)
Returns WebpackLogger
- Defined in node_modules/webpack/types.d.ts:2080

isChild

isChild(): boolean
Returns boolean
- Defined in node_modules/webpack/types.d.ts:2101

newCompilation

newCompilation(params): Compilation
Parameters
- params: CompilationParams
Returns Compilation
- Defined in node_modules/webpack/types.d.ts:2103

newCompilationParams

newCompilationParams(): {
contextModuleFactory: ContextModuleFactory;
normalModuleFactory: NormalModuleFactory;
}
Returns {
contextModuleFactory: ContextModuleFactory;
normalModuleFactory: NormalModuleFactory;
}
- contextModuleFactory: ContextModuleFactory
- normalModuleFactory: NormalModuleFactory
- Defined in node_modules/webpack/types.d.ts:2106

purgeInputFileSystem

purgeInputFileSystem(): void
Returns void
- Defined in node_modules/webpack/types.d.ts:2090

readRecords

readRecords(callback): void
Parameters
- callback: CallbackFunction<void>
Returns void
- Defined in node_modules/webpack/types.d.ts:2093

run

run(callback): void
Parameters
- callback: CallbackFunction<Stats>
Returns void
- Defined in node_modules/webpack/types.d.ts:2082

runAsChild

runAsChild(callback): void
Parameters
- callback: ((err?, entries?, compilation?) => any)
  - - (err?, entries?, compilation?): any
    - Parameters
      
      Optional err: null | Error
      
      Optional entries: Chunk[]
      
      Optional compilation: Compilation
      
      Returns any
Returns void
- Defined in node_modules/webpack/types.d.ts:2083

watch

watch(watchOptions, handler): Watching
Parameters
- watchOptions: WatchOptions
- handler: CallbackFunction<Stats>
Returns Watching
- Defined in node_modules/webpack/types.d.ts:2081

Class Compiler

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

context: string

Optional options: WebpackOptionsNormalized

Returns Compiler

Properties

cache

compilerPath

context

contextTimestamps

fileTimestamps

fsStartTime

hooks

Type declaration

additionalPass: AsyncSeriesHook<[], UnsetAdditionalOptions>

afterCompile: AsyncSeriesHook<[Compilation], UnsetAdditionalOptions>

afterDone: SyncHook<[Stats], void, UnsetAdditionalOptions>

afterEmit: AsyncSeriesHook<[Compilation], UnsetAdditionalOptions>

afterEnvironment: SyncHook<[], void, UnsetAdditionalOptions>

afterPlugins: SyncHook<[Compiler], void, UnsetAdditionalOptions>

afterResolvers: SyncHook<[Compiler], void, UnsetAdditionalOptions>

assetEmitted: AsyncSeriesHook<[string, AssetEmittedInfo], UnsetAdditionalOptions>

beforeCompile: AsyncSeriesHook<[CompilationParams], UnsetAdditionalOptions>

beforeRun: AsyncSeriesHook<[Compiler], UnsetAdditionalOptions>

compilation: SyncHook<[Compilation, CompilationParams], void, UnsetAdditionalOptions>

compile: SyncHook<[CompilationParams], void, UnsetAdditionalOptions>

contextModuleFactory: SyncHook<[ContextModuleFactory], void, UnsetAdditionalOptions>

done: AsyncSeriesHook<[Stats], UnsetAdditionalOptions>

emit: AsyncSeriesHook<[Compilation], UnsetAdditionalOptions>

emitRecords: AsyncSeriesHook<[], UnsetAdditionalOptions>

entryOption: SyncBailHook<[string, EntryNormalized], boolean, UnsetAdditionalOptions>

environment: SyncHook<[], void, UnsetAdditionalOptions>

failed: SyncHook<[Error], void, UnsetAdditionalOptions>

finishMake: AsyncParallelHook<[Compilation], UnsetAdditionalOptions>

infrastructureLog: SyncBailHook<[string, string, any[]], true, UnsetAdditionalOptions>

initialize: SyncHook<[], void, UnsetAdditionalOptions>

invalid: SyncHook<[null | string, number], void, UnsetAdditionalOptions>

make: AsyncParallelHook<[Compilation], UnsetAdditionalOptions>

normalModuleFactory: SyncHook<[NormalModuleFactory], void, UnsetAdditionalOptions>

readRecords: AsyncSeriesHook<[], UnsetAdditionalOptions>

run: AsyncSeriesHook<[Compiler], UnsetAdditionalOptions>

shouldEmit: SyncBailHook<[Compilation], boolean, UnsetAdditionalOptions>

shutdown: AsyncSeriesHook<[], UnsetAdditionalOptions>

thisCompilation: SyncHook<[Compilation, CompilationParams], void, UnsetAdditionalOptions>

watchClose: SyncHook<[], void, UnsetAdditionalOptions>

watchRun: AsyncSeriesHook<[Compiler], UnsetAdditionalOptions>

idle

immutablePaths

infrastructureLogger

inputFileSystem

intermediateFileSystem

managedPaths

modifiedFiles

Optional moduleMemCaches

Type declaration

buildInfo: object

memCache: WeakTupleMap<any, any>

references: WeakMap<Dependency, Module>

Optional name

options

outputFileSystem

outputPath

Optional parentCompilation

records

recordsInputPath

recordsOutputPath

removedFiles

requestShortener

resolverFactory

root

running

watchFileSystem

watchMode

`Optional` options: WebpackOptionsNormalized

`Optional` moduleMemCaches

`Optional` name

`Optional` parentCompilation

`Optional` outputOptions: OutputNormalized

`Optional` plugins: WebpackPluginInstance[]

`Optional` params: any

Returns {
contextModuleFactory: ContextModuleFactory;
normalModuleFactory: NormalModuleFactory;
}

`Optional` err: null | Error

`Optional` entries: Chunk[]