Search
Preparing search index...
The search index is not available
Electron Forge
Options
All
Public
Public/Protected
All
Inherited
Menu
Electron Forge
@electron-forge/plugin-vite
InternalOptions
Plugin
Interface Plugin<A>
Type parameters
A =
any
Hierarchy
OutputPlugin
Partial
<
PluginHooks
>
Plugin
Plugin
Index
Properties
api
augment
Chunk
Hash
banner
cache
Key
footer
generate
Bundle
intro
load
module
Parsed
name
output
Options
outro
render
Chunk
render
Dynamic
Import
render
Error
render
Start
resolve
Dynamic
Import
resolve
File
Url
resolve
Id
resolve
Import
Meta
should
Transform
Cached
Module
transform
version
watch
Change
write
Bundle
Methods
build
End
build
Start
close
Bundle
close
Watcher
on
Log
options
Properties
Optional
api
api
?:
A
augment
Chunk
Hash
augment
Chunk
Hash
:
undefined
|
ObjectHook
<
(
this
:
PluginContext
, chunk
:
RenderedChunk
)
=>
string
|
void
,
{}
>
banner
banner
:
undefined
|
ObjectHook
<
AddonHook
,
{}
>
Optional
cache
Key
cache
Key
?:
string
footer
footer
:
undefined
|
ObjectHook
<
AddonHook
,
{}
>
generate
Bundle
generate
Bundle
:
undefined
|
ObjectHook
<
(
this
:
PluginContext
,
...
parameters
:
[
options
:
NormalizedOutputOptions
,
bundle
:
OutputBundle
,
isWrite
:
boolean
]
)
=>
void
|
Promise
<
void
>
,
{}
>
intro
intro
:
undefined
|
ObjectHook
<
AddonHook
,
{}
>
Optional
load
load
?:
ObjectHook
<
(
this
:
PluginContext
,
...
parameters
:
[
id
:
string
]
)
=>
LoadResult
|
Promise
<
LoadResult
>
,
{}
>
Optional
module
Parsed
module
Parsed
?:
ObjectHook
<
(
this
:
PluginContext
,
...
parameters
:
[
info
:
ModuleInfo
]
)
=>
void
|
Promise
<
void
>
,
{
sequential
?:
boolean
}
>
name
name
:
string
output
Options
output
Options
:
undefined
|
ObjectHook
<
(
this
:
PluginContext
, options
:
OutputOptions
)
=>
NullValue
|
OutputOptions
,
{}
>
outro
outro
:
undefined
|
ObjectHook
<
AddonHook
,
{}
>
render
Chunk
render
Chunk
:
undefined
|
ObjectHook
<
(
this
:
PluginContext
,
...
parameters
:
[
code
:
string
,
chunk
:
RenderedChunk
,
options
:
NormalizedOutputOptions
,
meta
:
{
chunks
:
Record
<
string
,
RenderedChunk
>
}
]
)
=>
string
|
NullValue
|
{
code
:
string
;
map
?:
SourceMapInput
}
|
Promise
<
string
|
NullValue
|
{
code
:
string
;
map
?:
SourceMapInput
}
>
,
{}
>
render
Dynamic
Import
render
Dynamic
Import
:
undefined
|
ObjectHook
<
(
this
:
PluginContext
, options
:
{
customResolution
:
null
|
string
;
format
:
InternalModuleFormat
;
moduleId
:
string
;
targetModuleId
:
null
|
string
}
)
=>
NullValue
|
{
left
:
string
;
right
:
string
}
,
{}
>
render
Error
render
Error
:
undefined
|
ObjectHook
<
(
this
:
PluginContext
,
...
parameters
:
[
error
?:
Error
]
)
=>
void
|
Promise
<
void
>
,
{
sequential
?:
boolean
}
>
render
Start
render
Start
:
undefined
|
ObjectHook
<
(
this
:
PluginContext
,
...
parameters
:
[
outputOptions
:
NormalizedOutputOptions
,
inputOptions
:
NormalizedInputOptions
]
)
=>
void
|
Promise
<
void
>
,
{
sequential
?:
boolean
}
>
Optional
resolve
Dynamic
Import
resolve
Dynamic
Import
?:
ObjectHook
<
(
this
:
PluginContext
,
...
parameters
:
[
specifier
:
string
|
AstNode
,
importer
:
string
,
options
:
{
attributes
:
Record
<
string
,
string
>
}
]
)
=>
ResolveIdResult
|
Promise
<
ResolveIdResult
>
,
{}
>
resolve
File
Url
resolve
File
Url
:
undefined
|
ObjectHook
<
ResolveFileUrlHook
,
{}
>
Optional
resolve
Id
resolve
Id
?:
ObjectHook
<
(
this
:
PluginContext
,
...
parameters
:
[
source
:
string
,
importer
:
string
,
options
:
{
attributes
:
Record
<
string
,
string
>
;
custom
?:
CustomPluginOptions
;
isEntry
:
boolean
}
]
)
=>
ResolveIdResult
|
Promise
<
ResolveIdResult
>
,
{}
>
resolve
Import
Meta
resolve
Import
Meta
:
undefined
|
ObjectHook
<
ResolveImportMetaHook
,
{}
>
Optional
should
Transform
Cached
Module
should
Transform
Cached
Module
?:
ObjectHook
<
(
this
:
PluginContext
,
...
parameters
:
[
options
:
{
ast
:
ProgramNode
;
code
:
string
;
id
:
string
;
meta
:
CustomPluginOptions
;
moduleSideEffects
:
boolean
|
"no-treeshake"
;
resolvedSources
:
ResolvedIdMap
;
syntheticNamedExports
:
string
|
boolean
}
]
)
=>
boolean
|
NullValue
|
Promise
<
boolean
|
NullValue
>
,
{}
>
Optional
transform
transform
?:
ObjectHook
<
(
this
:
TransformPluginContext
,
...
parameters
:
[
code
:
string
,
id
:
string
]
)
=>
TransformResult
|
Promise
<
TransformResult
>
,
{}
>
Optional
version
version
?:
string
Optional
watch
Change
watch
Change
?:
ObjectHook
<
(
this
:
PluginContext
,
...
parameters
:
[
id
:
string
,
change
:
{
event
:
ChangeEvent
}
]
)
=>
void
|
Promise
<
void
>
,
{
sequential
?:
boolean
}
>
write
Bundle
write
Bundle
:
undefined
|
ObjectHook
<
(
this
:
PluginContext
,
...
parameters
:
[
options
:
NormalizedOutputOptions
,
bundle
:
OutputBundle
]
)
=>
void
|
Promise
<
void
>
,
{
sequential
?:
boolean
}
>
Methods
Optional
build
End
build
End
(
this
:
PluginContext
, error
?:
Error
)
:
void
Parameters
this:
PluginContext
Optional
error:
Error
Returns
void
Optional
build
Start
build
Start
(
this
:
PluginContext
, options
:
NormalizedInputOptions
)
:
void
Parameters
this:
PluginContext
options:
NormalizedInputOptions
Returns
void
Optional
close
Bundle
close
Bundle
(
this
:
PluginContext
)
:
void
Parameters
this:
PluginContext
Returns
void
Optional
close
Watcher
close
Watcher
(
this
:
PluginContext
)
:
void
Parameters
this:
PluginContext
Returns
void
Optional
on
Log
on
Log
(
this
:
MinimalPluginContext
, level
:
LogLevel
, log
:
RollupLog
)
:
boolean
|
NullValue
Parameters
this:
MinimalPluginContext
level:
LogLevel
log:
RollupLog
Returns
boolean
|
NullValue
Optional
options
options
(
this
:
MinimalPluginContext
, options
:
InputOptions
)
:
InputOptions
|
NullValue
Parameters
this:
MinimalPluginContext
options:
InputOptions
Returns
InputOptions
|
NullValue
All Modules
Makers
maker-appx
maker-deb
maker-dmg
maker-flatpak
maker-pkg
maker-rpm
maker-snap
maker-squirrel
maker-wix
maker-zip
Plugins
plugin-auto-unpack-natives
plugin-base
plugin-electronegativity
plugin-fuses
plugin-local-electron
plugin-vite
plugin-webpack
Publishers
publisher-base
publisher-bitbucket
publisher-electron-release-server
publisher-gcs
publisher-github
publisher-nucleus
publisher-s3
publisher-snapcraft
publisher-static
Templates
template-base
template-vite
template-vite-typescript
template-webpack
template-webpack-typescript
Utils & Internal Helpers
core
core-utils
maker-base
shared-types
test-utils
tracer
web-multi-logger