Documentation
Preparing search index...
@electron-forge/plugin-vite
VitePlugin
Class VitePlugin
Hierarchy (
View Summary
)
PluginBase
<
VitePluginConfig
>
VitePlugin
Index
Constructors
constructor
Properties
config
name
Methods
build
build
Renderer
exit
Handler
get
Hooks
init
launch
Renderer
Dev
Servers
package
After
Copy
resolve
Forge
Config
set
Directories
start
Logic
Constructors
constructor
new
VitePlugin
(
config
:
VitePluginConfig
)
:
VitePlugin
Parameters
config
:
VitePluginConfig
Returns
VitePlugin
Properties
config
config
:
VitePluginConfig
name
name
:
string
= 'vite'
Methods
build
build
(
task
?:
ForgeListrTask
<
null
>
,
)
:
Promise
<
void
|
Listr
<
any
,
"default"
,
"simple"
>
>
Parameters
Optional
task
:
ForgeListrTask
<
null
>
Returns
Promise
<
void
|
Listr
<
any
,
"default"
,
"simple"
>
>
build
Renderer
buildRenderer
(
task
?:
ForgeListrTask
<
null
>
,
)
:
Promise
<
Listr
<
null
,
any
,
any
>
|
undefined
>
Parameters
Optional
task
:
ForgeListrTask
<
null
>
Returns
Promise
<
Listr
<
null
,
any
,
any
>
|
undefined
>
exit
Handler
exitHandler
(
options
:
{
cleanup
?:
boolean
;
exit
?:
boolean
}
,
err
?:
Error
)
:
void
Parameters
options
:
{
cleanup
?:
boolean
;
exit
?:
boolean
}
Optional
err
:
Error
Returns
void
get
Hooks
getHooks
()
:
ForgeMultiHookMap
Returns
ForgeMultiHookMap
init
init
(
dir
:
string
)
:
void
Parameters
dir
:
string
Returns
void
launch
Renderer
Dev
Servers
launchRendererDevServers
(
task
?:
ForgeListrTask
<
null
>
,
)
:
Promise
<
Listr
<
null
,
any
,
any
>
|
undefined
>
Parameters
Optional
task
:
ForgeListrTask
<
null
>
Returns
Promise
<
Listr
<
null
,
any
,
any
>
|
undefined
>
package
After
Copy
packageAfterCopy
(
_forgeConfig
:
ResolvedForgeConfig
,
buildPath
:
string
,
)
:
Promise
<
void
>
Parameters
_forgeConfig
:
ResolvedForgeConfig
buildPath
:
string
Returns
Promise
<
void
>
resolve
Forge
Config
resolveForgeConfig
(
forgeConfig
:
ResolvedForgeConfig
,
)
:
Promise
<
ResolvedForgeConfig
>
Parameters
forgeConfig
:
ResolvedForgeConfig
Returns
Promise
<
ResolvedForgeConfig
>
set
Directories
setDirectories
(
dir
:
string
)
:
void
Parameters
dir
:
string
Returns
void
start
Logic
startLogic
(
_startOpts
:
StartOptions
)
:
Promise
<
StartResult
>
Parameters
_startOpts
:
StartOptions
Returns
Promise
<
StartResult
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
config
name
Methods
build
build
Renderer
exit
Handler
get
Hooks
init
launch
Renderer
Dev
Servers
package
After
Copy
resolve
Forge
Config
set
Directories
start
Logic
Documentation
Loading...