Class WebpackPlugin

Hierarchy (View Summary)

PluginBase<WebpackPluginConfig>
- WebpackPlugin

Index

Constructors

Properties

Accessors

configGenerator

Methods

compileMain compileRenderers devServerOptions exitHandler getHooks init launchRendererDevServers packageAfterCopy resolveForgeConfig setDirectories startLogic writeJSONStats

Constructors

constructor

new WebpackPlugin(c: WebpackPluginConfig): WebpackPlugin
Parameters
- c: WebpackPluginConfig
Returns WebpackPlugin
Overrides PluginBase.constructor
- Defined in webpack/src/WebpackPlugin.ts:106

Properties

config

config: WebpackPluginConfig

name

name: string = 'webpack'

Accessors

configGenerator

get configGenerator(): WebpackConfigGenerator
Returns WebpackConfigGenerator
- Defined in webpack/src/WebpackPlugin.ts:211

Methods

compileMain

compileMain(watch?: boolean, logger?: Logger): Promise<void>
Parameters
- watch: boolean = false
- Optionallogger: Logger
Returns Promise<void>
- Defined in webpack/src/WebpackPlugin.ts:685

compileRenderers

compileRenderers(watch?: boolean): Promise<void>
Parameters
- watch: boolean = false
Returns Promise<void>
- Defined in webpack/src/WebpackPlugin.ts:744

devServerOptions

devServerOptions(): Configuration
Returns Configuration
- Defined in webpack/src/WebpackPlugin.ts:838

exitHandler

exitHandler(options: { cleanup?: boolean; exit?: boolean }, err?: Error): void
Parameters
- options: { cleanup?: boolean; exit?: boolean }
- Optionalerr: Error
Returns void
- Defined in webpack/src/WebpackPlugin.ts:130

getHooks

getHooks(): ForgeMultiHookMap
Returns ForgeMultiHookMap
Overrides PluginBase.getHooks
- Defined in webpack/src/WebpackPlugin.ts:224

init

init(dir: string): void
Parameters
- dir: string
Returns void
Overrides PluginBase.init
- Defined in webpack/src/WebpackPlugin.ts:196

launchRendererDevServers

launchRendererDevServers(logger: Logger): Promise<void>
Parameters
- logger: Logger
Returns Promise<void>
- Defined in webpack/src/WebpackPlugin.ts:758

packageAfterCopy

packageAfterCopy(
_forgeConfig: ResolvedForgeConfig,
buildPath: string,
): Promise<void>
Parameters
- _forgeConfig: ResolvedForgeConfig
- buildPath: string
Returns Promise<void>
- Defined in webpack/src/WebpackPlugin.ts:664

resolveForgeConfig

resolveForgeConfig(
forgeConfig: ResolvedForgeConfig,
): Promise<ResolvedForgeConfig>
Parameters
- forgeConfig: ResolvedForgeConfig
Returns Promise<ResolvedForgeConfig>
- Defined in webpack/src/WebpackPlugin.ts:613

setDirectories

setDirectories(dir: string): void
Parameters
- dir: string
Returns void
- Defined in webpack/src/WebpackPlugin.ts:206

startLogic

startLogic(_startOpts: StartOptions): Promise<StartResult>
Parameters
- _startOpts: StartOptions
Returns Promise<StartResult>
Inherited from PluginBase.startLogic
- Defined in base/dist/Plugin.d.ts:13

writeJSONStats

writeJSONStats(
    type: string,
    stats: Stats | undefined,
    statsOptions:
        | boolean
        | "none"
        | StatsOptions
        | "summary"
        | "errors-only"
        | "errors-warnings"
        | "minimal"
        | "normal"
        | "detailed"
        | "verbose"
        | undefined,
    suffix: string,
): Promise<void>
Parameters
- type: string
- stats: Stats | undefined
- statsOptions:
      | boolean
      | "none"
      | StatsOptions
      | "summary"
      | "errors-only"
      | "errors-warnings"
      | "minimal"
      | "normal"
      | "detailed"
      | "verbose"
      | undefined
- suffix: string
Returns Promise<void>
- Defined in webpack/src/WebpackPlugin.ts:155