Skip to content

Documentation / listr2 / ListrTestRendererOptions

Interface: ListrTestRendererOptions

Extends

Properties

subtasks?

optional subtasks: boolean

Log subtasks.

Default Value

true

Source

packages/listr2/src/renderer/test/renderer.interface.ts:15


state?

optional state: ListrTaskState[]

Log given task states.

Source

packages/listr2/src/renderer/test/renderer.interface.ts:19


output?

optional output: boolean

Log output.

Source

packages/listr2/src/renderer/test/renderer.interface.ts:23


prompt?

optional prompt: boolean

Log prompt.

Source

packages/listr2/src/renderer/test/renderer.interface.ts:27


title?

optional title: boolean

Log title changes.

Source

packages/listr2/src/renderer/test/renderer.interface.ts:31


messages?

optional messages: keyof ListrTaskMessage[]

Log given messages.

Source

packages/listr2/src/renderer/test/renderer.interface.ts:35


messagesToStderr?

optional messagesToStderr: keyof ListrTaskMessage[]

Log given messages to stderr instead of stdout.

Source

packages/listr2/src/renderer/test/renderer.interface.ts:39


task?

optional task: false | TestRendererSerializerTaskKeys[]

Serialize the given properties of the task inside the logs.

Source

packages/listr2/src/renderer/test/renderer.interface.ts:43


logger?

optional logger: ListrLogger<ListrLogLevels>

Inject your custom implementation of the ListrLogger.

See

https://listr2.kilic.dev/renderer/logger.html

Inherited from

RendererLoggerOptions.logger

Source

packages/listr2/src/utils/logger/logger.interface.ts:82