Skip to content

Documentation / listr2 / ListrBaseClassOptions

Interface: ListrBaseClassOptions<Ctx, Renderer, FallbackRenderer>

Parent Listr has more options where you can also change global settings.

Any subtasks will respect those options so they will be stripped of that properties.

Extends

Type parameters

Ctx = ListrContext

Renderer extends ListrRendererValue = ListrPrimaryRendererValue

FallbackRenderer extends ListrRendererValue = ListrSecondaryRendererValue

Properties

ctx?

optional ctx: Ctx

Inject a context through this options wrapper.

Default Value

{}

See

https://listr2.kilic.dev/listr/context.html

Inherited from

ListrOptions.ctx

Source

packages/listr2/src/interfaces/listr.interface.ts:24


concurrent?

optional concurrent: number | boolean

Concurrency limits how many tasks will be running in parallel.

  • false will only run a single task at a time.
  • true will set it to Infinity to run all the tasks in parallel.
  • Given a number it will limit the concurrency to that number.

Default Value

false

Inherited from

ListrOptions.concurrent

Source

packages/listr2/src/interfaces/listr.interface.ts:34


exitOnError?

optional exitOnError: boolean

Determine the default behavior of exiting on errors.

  • true will exit the current Listr whenever it encounters an error.
  • false will continue the execution of current Listr if it encounters an error.

Default Value

true

Inherited from

ListrOptions.exitOnError

Source

packages/listr2/src/interfaces/listr.interface.ts:43


exitAfterRollback?

optional exitAfterRollback: boolean

Determine the behavior of exiting after rollback actions.

This is independent of exitOnError, since failure of a rollback can be a more critical operation comparing to failing a single task.

  • true will stop the execution whenever a rollback happens.
  • false will continue after successfully recovering from a rollback.

Default Value

true

Inherited from

ListrOptions.exitAfterRollback

Source

packages/listr2/src/interfaces/listr.interface.ts:55


collectErrors?

optional collectErrors: false | "minimal" | "full"

Collects errors inside the Listr.errors.

  • false will collect no errors.
  • minimal will only collect the error message and the location.
  • full will clone the current context and task in to the error instance.

Default Value

false

See

https://listr2.kilic.dev/task/error-handling.html#collected-errors

Inherited from

ListrOptions.collectErrors

Source

packages/listr2/src/interfaces/listr.interface.ts:66


registerSignalListeners?

optional registerSignalListeners: boolean

Listr will track SIGINIT signal to update the renderer one last time before failing, therefore it needs to register exit listeners.

Default Value

ts
true

Inherited from

ListrOptions.registerSignalListeners

Source

packages/listr2/src/interfaces/listr.interface.ts:73


fallbackRendererCondition?

optional fallbackRendererCondition: boolean | () => boolean

Determine the certain condition required to use the fallback renderer.

Default Value

ts
handled internally

Inherited from

ListrOptions.fallbackRendererCondition

Source

packages/listr2/src/interfaces/listr.interface.ts:79


silentRendererCondition?

optional silentRendererCondition: boolean | () => boolean

Determine the certain condition required to use the silent renderer.

Default Value

ts
handled internally

Inherited from

ListrOptions.silentRendererCondition

Source

packages/listr2/src/interfaces/listr.interface.ts:85


forceTTY?

optional forceTTY: boolean

Forces TTY stdout even though your current output may not be compatible.

Default Value

false

Inherited from

ListrOptions.forceTTY

Source

packages/listr2/src/interfaces/listr.interface.ts:91


forceUnicode?

optional forceUnicode: boolean

Forces unicode icons even though your current output may not be compatible.

Default Value

false

Inherited from

ListrOptions.forceUnicode

Source

packages/listr2/src/interfaces/listr.interface.ts:97


renderer?

optional renderer: Renderer

Default renderer preferred.

Inherited from

ListrPrimaryRendererSelection.renderer

Source

packages/listr2/src/interfaces/renderer.interface.ts:90


rendererOptions?

optional rendererOptions: ListrGetRendererOptions<Renderer>

Renderer options depending on the current renderer.

Inherited from

ListrPrimaryRendererSelection.rendererOptions

Source

packages/listr2/src/interfaces/renderer.interface.ts:96


fallbackRenderer?

optional fallbackRenderer: FallbackRenderer

Fallback renderer preferred.

Inherited from

ListrSecondaryRendererSelection.fallbackRenderer

Source

packages/listr2/src/interfaces/renderer.interface.ts:108


fallbackRendererOptions?

optional fallbackRendererOptions: ListrGetRendererOptions<FallbackRenderer>

Renderer options depending on the fallback renderer.

Inherited from

ListrSecondaryRendererSelection.fallbackRendererOptions

Source

packages/listr2/src/interfaces/renderer.interface.ts:114