Interface ListrTask<Ctx, Renderer, FallbackRenderer>

Defines the task, conditions and options to run a specific task in the Listr. This defines the external API for the task where TaskWrapper is used internally.

See

https://listr2.kilic.dev/task/task.html

interface ListrTask<Ctx, Renderer, FallbackRenderer> {
    enabled?: boolean | ((ctx) => boolean | Promise<boolean>);
    exitOnError?: boolean | ((ctx) => boolean | Promise<boolean>);
    fallbackRendererOptions?: ListrGetRendererTaskOptions<FallbackRenderer>;
    rendererOptions?: ListrGetRendererTaskOptions<Renderer>;
    retry?: number | {
        delay?: number;
        tries: number;
    };
    rollback?: ListrTaskFn<Ctx, Renderer, FallbackRenderer>;
    skip?: string | boolean | ((ctx) => string | boolean | Promise<string | boolean>);
    task: ListrTaskFn<Ctx, Renderer, FallbackRenderer>;
    title?: string | any[];
}

Type Parameters

  • Ctx = ListrContext
  • Renderer extends ListrRendererFactory = any
  • FallbackRenderer extends ListrRendererFactory = any

Hierarchy

Properties

enabled? exitOnError? fallbackRendererOptions? rendererOptions? retry? rollback? skip? task title?

Properties

Optional enabled

enabled?: boolean | ((ctx) => boolean | Promise<boolean>)

Enable a task depending on the context.

  • The callback function will be evaluated before all the tasks start to check which tasks has been enabled.
  • The callback function will be evaluated again before the task starts.

Type declaration

    • (ctx): boolean | Promise<boolean>

    • Parameters

      Returns boolean | Promise<boolean>

See

https://listr2.kilic.dev/task/enable.html

Optional exitOnError

exitOnError?: boolean | ((ctx) => boolean | Promise<boolean>)

Determine the default behavior of exiting on errors for this attached task.

Type declaration

    • (ctx): boolean | Promise<boolean>

    • Parameters

      Returns boolean | Promise<boolean>

Optional fallbackRendererOptions

fallbackRendererOptions?: ListrGetRendererTaskOptions<FallbackRenderer>

Renderer options depending on the fallback renderer.

Optional rendererOptions

rendererOptions?: ListrGetRendererTaskOptions<Renderer>

Renderer options depending on the current renderer.

Optional retry

retry?: number | {
    delay?: number;
    tries: number;
}

Retries a task with the given amounts whenever a task fails.

Type declaration

  • Optional delay?: number
  • tries: number

See

https://listr2.kilic.dev/task/retry.html

Optional rollback

rollback?: ListrTaskFn<Ctx, Renderer, FallbackRenderer>

The callback function that you provide will run whenever the attached task fails and give you the ability to revert your changes, before failing.

See

https://listr2.kilic.dev/task/rollback.html

Optional skip

skip?: string | boolean | ((ctx) => string | boolean | Promise<string | boolean>)

Skip this task depending on the context.

  • The callback function will be evaluated once before the task starts.

Type declaration

    • (ctx): string | boolean | Promise<string | boolean>

    • Parameters

      Returns string | boolean | Promise<string | boolean>

See

https://listr2.kilic.dev/task/skip.html

task

task: ListrTaskFn<Ctx, Renderer, FallbackRenderer>

The task itself in the form of a Function, Promise, Listr, Observable or Stream.

  • Task will be executed, whenever the provided criterion is met with the current state and whenever the time for that specific task has come.

See

https://listr2.kilic.dev/task/task.html

Optional title

title?: string | any[]

Title of the task.

Give this task a title to enchance it on the preferred renderer.

  • Tasks without a title will be hidden from view in renderers and will act as a background task.

See

https://listr2.kilic.dev/task/title.html

Settings

Member Visibility

Theme

On This Page

enabledexitOnErrorfallbackRendererOptionsrendererOptionsretryrollbackskiptasktitle