listr2

Appearance

Documentation / listr2 / ListrTaskFn

Type Alias: ListrTaskFn<Ctx, Renderer, FallbackRenderer> ​

ListrTaskFn<Ctx, Renderer, FallbackRenderer> = (ctx, task) => void | ListrTaskResult<Ctx>

Defined in: packages/listr2/src/interfaces/task.interface.ts:79

The callback function from the user that defines the task.

Type Parameters ​

Ctx ​

Ctx

Renderer ​

Renderer extends ListrRendererFactory

FallbackRenderer ​

FallbackRenderer extends ListrRendererFactory

Parameters ​

ctx ​

Ctx

task ​

ListrTaskWrapper<Ctx, Renderer, FallbackRenderer>

Returns ​

void | ListrTaskResult<Ctx>