Search
Preparing search index...
The search index is not available
Electron Forge
Options
All
Public
Public/Protected
All
Inherited
Menu
Electron Forge
@electron-forge/publisher-s3
InternalOptions
Listr
Class Listr<Ctx, Renderer, FallbackRenderer>
Creates a new set of Listr2 task list.
Type parameters
Ctx
:
ListrContext
=
ListrContext
Renderer
:
ListrRendererValue
=
ListrDefaultRendererValue
FallbackRenderer
:
ListrRendererValue
=
ListrFallbackRendererValue
Hierarchy
Listr
Index
Constructors
constructor
Properties
ctx
err
options
parent
Task
path
render
Hook$
renderer
Class
renderer
Class
Options
task
tasks
Methods
add
run
Constructors
constructor
new
Listr
<
Ctx
,
Renderer
,
FallbackRenderer
>
(
task
:
ListrTask
<
Ctx
,
ListrGetRendererClassFromValue
<
Renderer
>
>
|
ListrTask
<
Ctx
,
ListrGetRendererClassFromValue
<
Renderer
>
>
[]
, options
?:
ListrBaseClassOptions
<
Ctx
,
Renderer
,
FallbackRenderer
>
, parentTask
?:
Task
<
any
,
any
>
)
:
Listr
<
Ctx
,
Renderer
,
FallbackRenderer
>
Type parameters
Ctx
:
unknown
=
any
Renderer
:
ListrRendererValue
=
"default"
FallbackRenderer
:
ListrRendererValue
=
"verbose"
Parameters
task:
ListrTask
<
Ctx
,
ListrGetRendererClassFromValue
<
Renderer
>
>
|
ListrTask
<
Ctx
,
ListrGetRendererClassFromValue
<
Renderer
>
>
[]
Optional
options:
ListrBaseClassOptions
<
Ctx
,
Renderer
,
FallbackRenderer
>
Optional
parentTask:
Task
<
any
,
any
>
Returns
Listr
<
Ctx
,
Renderer
,
FallbackRenderer
>
Properties
ctx
ctx
:
Ctx
err
err
:
ListrError
<
Ctx
>
[]
Optional
options
options
?:
ListrBaseClassOptions
<
Ctx
,
Renderer
,
FallbackRenderer
>
Optional
parent
Task
parent
Task
?:
Task
<
any
,
any
>
path
path
:
string
[]
render
Hook$
render
Hook$
:
Subject
<
void
>
renderer
Class
renderer
Class
:
typeof
ListrRenderer
renderer
Class
Options
renderer
Class
Options
:
Record
<
PropertyKey
,
any
>
task
task
:
ListrTask
<
Ctx
,
ListrGetRendererClassFromValue
<
Renderer
>
>
|
ListrTask
<
Ctx
,
ListrGetRendererClassFromValue
<
Renderer
>
>
[]
tasks
tasks
:
Task
<
Ctx
,
ListrGetRendererClassFromValue
<
Renderer
>
>
[]
Methods
add
add
(
task
:
ListrTask
<
Ctx
,
ListrGetRendererClassFromValue
<
Renderer
>
>
|
ListrTask
<
Ctx
,
ListrGetRendererClassFromValue
<
Renderer
>
>
[]
)
:
void
Parameters
task:
ListrTask
<
Ctx
,
ListrGetRendererClassFromValue
<
Renderer
>
>
|
ListrTask
<
Ctx
,
ListrGetRendererClassFromValue
<
Renderer
>
>
[]
Returns
void
run
run
(
context
?:
Ctx
)
:
Promise
<
Ctx
>
Parameters
Optional
context:
Ctx
Returns
Promise
<
Ctx
>
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
Creates a new set of Listr2 task list.