Documentation / listr2 / ListrTaskWrapper
Interface: ListrTaskWrapper<Ctx, Renderer, FallbackRenderer>
Defined in: packages/listr2/src/lib/task-wrapper.ts:17
The original Task that is defined by the user is wrapped with the TaskWrapper to provide additional functionality.
See
https://listr2.kilic.dev/task/task.html
Type Parameters
Ctx
Ctx
Renderer
Renderer extends ListrRendererFactory
FallbackRenderer
FallbackRenderer extends ListrRendererFactory
Properties
task
task:
ListrTaskObject<Ctx,Renderer,FallbackRenderer>
Defined in: packages/listr2/src/lib/task-wrapper.ts:18
Accessors
title
Get Signature
get title():
string
Defined in: packages/listr2/src/lib/task-wrapper.ts:21
Returns
string
Set Signature
set title(
title):void
Defined in: packages/listr2/src/lib/task-wrapper.ts:30
Title of the current task.
See
https://listr2.kilic.dev/task/title.html
Parameters
title
string | any[]
Returns
void
output
Get Signature
get output():
string
Defined in: packages/listr2/src/lib/task-wrapper.ts:37
Returns
string
Set Signature
set output(
output):void
Defined in: packages/listr2/src/lib/task-wrapper.ts:47
Send output from the current task to the renderer.
See
https://listr2.kilic.dev/task/output.html
Parameters
output
string | any[]
Returns
void
signal
Get Signature
get signal():
AbortSignal
Defined in: packages/listr2/src/lib/task-wrapper.ts:71
The AbortSignal for the current run, aborted when the run is interrupted (e.g. SIGINT). Wire it into your own async work (fetch, child processes, timers) to cancel cooperatively.
See
https://listr2.kilic.dev/task/rollback.html
Returns
AbortSignal
Methods
cancel()
cancel():
void
Defined in: packages/listr2/src/lib/task-wrapper.ts:79
Interrupt the whole run programmatically, as if it received a SIGINT. The other in-flight tasks roll back or are marked as cancelled, then the process exits with 127.
Returns
void
newListr()
newListr<
NewCtx>(task,options?):Listr<NewCtx,any,any>
Defined in: packages/listr2/src/lib/task-wrapper.ts:88
Creates a new set of Listr subtasks.
Type Parameters
NewCtx
NewCtx = Ctx
Parameters
task
ListrTask<NewCtx, Renderer, FallbackRenderer> | ListrTask<NewCtx, Renderer, FallbackRenderer>[] | ((parent) => ListrTask<NewCtx, Renderer, FallbackRenderer> | ListrTask<NewCtx, Renderer, FallbackRenderer>[])
options?
ListrSubClassOptions<NewCtx, Renderer, FallbackRenderer>
Returns
Listr<NewCtx, any, any>
See
https://listr2.kilic.dev/task/subtasks.html
report()
report(
error,type):void
Defined in: packages/listr2/src/lib/task-wrapper.ts:111
Report an error that has to be collected and handled.
Parameters
error
Error
type
Returns
void
See
https://listr2.kilic.dev/task/error-handling.html
skip()
skip(
message?, ...metadata):void
Defined in: packages/listr2/src/lib/task-wrapper.ts:124
Skip the current task.
Parameters
message?
string
metadata
...any[]
Returns
void
See
https://listr2.kilic.dev/task/skip.html
isRetrying()
isRetrying():
ListrTaskRetry
Defined in: packages/listr2/src/lib/task-wrapper.ts:137
Check whether this task is currently in a retry state.
Returns
See
https://listr2.kilic.dev/task/retry.html
prompt()
prompt<
T>(adapter):T
Defined in: packages/listr2/src/lib/task-wrapper.ts:150
Create a new prompt for getting user input through the prompt adapter. This will create a new prompt through the adapter if the task is not currently rendering a prompt or will return the active instance.
This part of the application requires optional peer dependencies, please refer to documentation.
Type Parameters
T
T extends ListrPromptAdapter = ListrPromptAdapter
Parameters
adapter
(task, wrapper) => T
Returns
T
See
https://listr2.kilic.dev/task/prompt.html
stdout()
stdout(
type?):Writable
Defined in: packages/listr2/src/lib/task-wrapper.ts:166
Generates a fake stdout for your use case, where it will be tunnelled through Listr to handle the rendering process.
Parameters
type?
Returns
Writable
See
https://listr2.kilic.dev/renderer/process-output.html
run()
run(
ctx):Promise<void>
Defined in: packages/listr2/src/lib/task-wrapper.ts:181
Run this task.
Parameters
ctx
Ctx
Returns
Promise<void>