Search
Preparing search index...
The search index is not available
Electron Forge
Options
All
Public
Public/Protected
All
Inherited
Menu
Electron Forge
@electron-forge/maker-base
InternalOptions
SnippetPromptOptions
Interface SnippetPromptOptions
Hierarchy
BasePromptOptions
SnippetPromptOptions
Index
Properties
fields
footer
header
initial
message
newline
required
stdin
stdout
template
Methods
format
on
Cancel
on
Submit
result
skip
validate
Properties
fields
fields
:
Partial
<
BasePromptOptionsWithName
>
[]
Optional
footer
footer
?:
string
Optional
header
header
?:
string
Optional
initial
initial
?:
string
|
number
|
boolean
|
number
[]
|
(
(
)
=>
string
)
|
(
(
)
=>
Promise
<
string
>
)
message
message
:
string
|
(
(
)
=>
string
)
|
(
(
)
=>
Promise
<
string
>
)
Optional
newline
newline
?:
string
Optional
required
required
?:
boolean
Optional
stdin
stdin
?:
ReadStream
Optional
stdout
stdout
?:
WriteStream
template
template
:
string
Methods
Optional
format
format
(
value
:
any
)
:
any
Parameters
value:
any
Returns
any
Optional
on
Cancel
on
Cancel
(
name
:
any
, value
:
any
, prompt
:
Enquirer
.
Prompt
)
:
boolean
|
Promise
<
boolean
>
Parameters
name:
any
value:
any
prompt:
Enquirer
.
Prompt
Returns
boolean
|
Promise
<
boolean
>
Optional
on
Submit
on
Submit
(
name
:
any
, value
:
any
, prompt
:
Enquirer
.
Prompt
)
:
boolean
|
Promise
<
boolean
>
Parameters
name:
any
value:
any
prompt:
Enquirer
.
Prompt
Returns
boolean
|
Promise
<
boolean
>
Optional
result
result
(
value
:
any
)
:
any
Parameters
value:
any
Returns
any
Optional
skip
skip
(
value
:
any
)
:
boolean
|
Promise
<
boolean
>
Parameters
value:
any
Returns
boolean
|
Promise
<
boolean
>
Optional
validate
validate
(
value
:
any
, state
:
any
)
:
string
|
boolean
|
Promise
<
string
|
boolean
>
|
Promise
<
boolean
>
|
Promise
<
string
>
Parameters
value:
any
state:
any
Returns
string
|
boolean
|
Promise
<
string
|
boolean
>
|
Promise
<
boolean
>
|
Promise
<
string
>
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