Documentation / listr2 / Listr
Class: Listr<Ctx, Renderer, FallbackRenderer>
Defined in: packages/listr2/src/listr.ts:24
Create a new task list with Listr.
See
https://listr2.kilic.dev/listr/listr.html
Type Parameters
Ctx
Ctx
= ListrContext
Renderer
Renderer
extends ListrRendererValue
= ListrPrimaryRendererValue
FallbackRenderer
FallbackRenderer
extends ListrRendererValue
= ListrSecondaryRendererValue
Constructors
Constructor
new Listr<
Ctx
,Renderer
,FallbackRenderer
>(task
,options?
,parentTask?
):Listr
<Ctx
,Renderer
,FallbackRenderer
>
Defined in: packages/listr2/src/listr.ts:42
Parameters
task
ListrTask
<Ctx
, ListrGetRendererClassFromValue
<Renderer
>, ListrGetRendererClassFromValue
<FallbackRenderer
>> | ListrTask
<Ctx
, ListrGetRendererClassFromValue
<Renderer
>, ListrGetRendererClassFromValue
<FallbackRenderer
>>[]
options?
ListrBaseClassOptions
<Ctx
, Renderer
, FallbackRenderer
>
parentTask?
ListrTaskObject
<any
, ListrGetRendererClassFromValue
<Renderer
>, ListrGetRendererClassFromValue
<FallbackRenderer
>>
Returns
Listr
<Ctx
, Renderer
, FallbackRenderer
>
Properties
tasks
tasks:
ListrTaskObject
<Ctx
,ListrGetRendererClassFromValue
<Renderer
>,ListrGetRendererClassFromValue
<FallbackRenderer
>>[] =[]
Defined in: packages/listr2/src/listr.ts:29
errors
errors:
ListrError
<Ctx
>[] =[]
Defined in: packages/listr2/src/listr.ts:30
ctx
ctx:
Ctx
Defined in: packages/listr2/src/listr.ts:31
events
events:
ListrEventManager
Defined in: packages/listr2/src/listr.ts:32
path
path:
string
[] =[]
Defined in: packages/listr2/src/listr.ts:33
rendererClass
rendererClass: typeof
ListrRenderer
Defined in: packages/listr2/src/listr.ts:34
rendererClassOptions
rendererClassOptions:
ListrGetRendererOptions
<ListrGetRendererClassFromValue
<Renderer
> |ListrGetRendererClassFromValue
<FallbackRenderer
>>
Defined in: packages/listr2/src/listr.ts:35
rendererSelection
rendererSelection:
ListrRendererSelection
Defined in: packages/listr2/src/listr.ts:36
boundSignalHandler()
boundSignalHandler: () =>
void
Defined in: packages/listr2/src/listr.ts:37
Returns
void
task
task:
ListrTask
<Ctx
,ListrGetRendererClassFromValue
<Renderer
>,ListrGetRendererClassFromValue
<FallbackRenderer
>> |ListrTask
<Ctx
,ListrGetRendererClassFromValue
<Renderer
>,ListrGetRendererClassFromValue
<FallbackRenderer
>>[]
Defined in: packages/listr2/src/listr.ts:43
options?
optional
options:ListrBaseClassOptions
<Ctx
,Renderer
,FallbackRenderer
>
Defined in: packages/listr2/src/listr.ts:46
parentTask?
optional
parentTask:ListrTaskObject
<any
,ListrGetRendererClassFromValue
<Renderer
>,ListrGetRendererClassFromValue
<FallbackRenderer
>>
Defined in: packages/listr2/src/listr.ts:47
Methods
isRoot()
isRoot():
boolean
Defined in: packages/listr2/src/listr.ts:123
Whether this is the root task.
Returns
boolean
isSubtask()
isSubtask():
boolean
Defined in: packages/listr2/src/listr.ts:130
Whether this is a subtask of another task list.
Returns
boolean
add()
add(
tasks
):void
Defined in: packages/listr2/src/listr.ts:139
Add tasks to current task list.
Parameters
tasks
ListrTask
<Ctx
, ListrGetRendererClassFromValue
<Renderer
>, any
> | ListrTask
<Ctx
, ListrGetRendererClassFromValue
<Renderer
>, any
>[]
Returns
void
See
https://listr2.kilic.dev/task/task.html
run()
run(
context?
):Promise
<Ctx
>
Defined in: packages/listr2/src/listr.ts:148
Run the task list.
Parameters
context?
Ctx
Returns
Promise
<Ctx
>
See
https://listr2.kilic.dev/listr/listr.html#run-the-generated-task-list