Class VitePlugin

Hierarchy (view full)

PluginBase<VitePluginConfig>
- VitePlugin

Index

Constructors

Properties

baseDir config configGeneratorCache isProd name projectDir servers timeFormatter watchers alreadyStarted

Accessors

configGenerator

Methods

build buildRenderer exitHandler getHooks init launchRendererDevServers packageAfterCopy resolveForgeConfig setDirectories startLogic

Constructors

constructor

new VitePlugin(config): VitePlugin
Parameters
- config: VitePluginConfig
Returns VitePlugin
Inherited from PluginBase.constructor
- Defined in base/dist/Plugin.d.ts:10

Properties

`Private` baseDir

baseDir: string

Path where Vite output is generated. Usually ${projectDir}/.vite

config

config: VitePluginConfig

`Private` configGeneratorCache

configGeneratorCache: default

`Private` isProd

isProd: boolean = false

name

name: string = 'vite'

`Private` projectDir

projectDir: string

Path to the root of the Electron app

`Private` servers

servers: ViteDevServer[] = []

`Private` timeFormatter

timeFormatter: DateTimeFormat = ...

`Private` watchers

watchers: RollupWatcher[] = []

`Private` `Static` alreadyStarted

alreadyStarted: boolean = false

Accessors

`Private` configGenerator

get configGenerator(): default
Returns default
- Defined in vite/src/VitePlugin.ts:72

Methods

build

build(task?): Promise<void | Listr<any, "default", "simple">>
Parameters
- Optional task: ForgeListrTask<null>
Returns Promise<void | Listr<any, "default", "simple">>
- Defined in vite/src/VitePlugin.ts:212

buildRenderer

buildRenderer(task?): Promise<undefined | Listr<NewCtx, any, any>>
Parameters
- Optional task: ForgeListrTask<null>
Returns Promise<undefined | Listr<NewCtx, any, any>>
- Defined in vite/src/VitePlugin.ts:341

exitHandler

exitHandler(options, err?): void
Parameters
- options: {
  cleanup?: boolean;
  exit?: boolean;
  }
  - Optional cleanup?: boolean
  - Optional exit?: boolean
- Optional err: Error
Returns void
- Defined in vite/src/VitePlugin.ts:398

getHooks

getHooks(): ForgeMultiHookMap
Returns ForgeMultiHookMap
Overrides PluginBase.getHooks
- Defined in vite/src/VitePlugin.ts:80

init

init(dir): void
Parameters
- dir: string
Returns void
Overrides PluginBase.init
- Defined in vite/src/VitePlugin.ts:55

launchRendererDevServers

launchRendererDevServers(task?): Promise<undefined | Listr<NewCtx, any, any>>
Parameters
- Optional task: ForgeListrTask<null>
Returns Promise<undefined | Listr<NewCtx, any, any>>
- Defined in vite/src/VitePlugin.ts:360

packageAfterCopy

packageAfterCopy(_forgeConfig, buildPath): Promise<void>
Parameters
- _forgeConfig: ResolvedForgeConfig
- buildPath: string
Returns Promise<void>
- Defined in vite/src/VitePlugin.ts:190

resolveForgeConfig

resolveForgeConfig(forgeConfig): Promise<ResolvedForgeConfig>
Parameters
- forgeConfig: ResolvedForgeConfig
Returns Promise<ResolvedForgeConfig>
- Defined in vite/src/VitePlugin.ts:162

setDirectories

setDirectories(dir): void
Parameters
- dir: string
Returns void
- Defined in vite/src/VitePlugin.ts:67

startLogic

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