Skip to content

Documentation / listr2 / SimpleRenderer

Class: SimpleRenderer

The definition of a ListrRenderer.

See

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

Implements

Constructors

new SimpleRenderer(tasks, options)

new SimpleRenderer(tasks, options): SimpleRenderer

Parameters

tasks: ListrSimpleRendererTask[]

options: ListrSimpleRendererOptions

Returns

SimpleRenderer

Source

packages/listr2/src/renderer/simple/renderer.ts:24

Properties

nonTTY

static nonTTY: boolean = true

designate whether this renderer can work in non-tty environments

Implementation of

ListrRenderer.nonTTY

Source

packages/listr2/src/renderer/simple/renderer.ts:8


rendererOptions

static rendererOptions: ListrSimpleRendererOptions

designate renderer global options that is specific to the current renderer

Implementation of

ListrRenderer.rendererOptions

Source

packages/listr2/src/renderer/simple/renderer.ts:9


rendererTaskOptions

static rendererTaskOptions: ListrSimpleRendererTaskOptions = {}

designate renderer per task options that is specific to the current renderer

Implementation of

ListrRenderer.rendererTaskOptions

Source

packages/listr2/src/renderer/simple/renderer.ts:16


logger

private readonly logger: ListrLogger<string>

Source

packages/listr2/src/renderer/simple/renderer.ts:18


cache

private readonly cache: ListrSimpleRendererCache

Source

packages/listr2/src/renderer/simple/renderer.ts:19


tasks

private readonly tasks: ListrSimpleRendererTask[]

Source

packages/listr2/src/renderer/simple/renderer.ts:25


options

private options: ListrSimpleRendererOptions

Source

packages/listr2/src/renderer/simple/renderer.ts:26

Methods

end()

end(): void

A function to what to do on end of the render

Returns

void

Implementation of

ListrRenderer.end

Source

packages/listr2/src/renderer/simple/renderer.ts:52


render()

render(): void

A function to what to do on render

Returns

void

Implementation of

ListrRenderer.render

Source

packages/listr2/src/renderer/simple/renderer.ts:54


renderer()

private renderer(tasks): void

Parameters

tasks: ListrSimpleRendererTask[]

Returns

void

Source

packages/listr2/src/renderer/simple/renderer.ts:58


calculate()

private calculate(task): void

Parameters

task: ListrSimpleRendererTask

Returns

void

Source

packages/listr2/src/renderer/simple/renderer.ts:160


reset()

private reset(task): void

Parameters

task: ListrSimpleRendererTask

Returns

void

Source

packages/listr2/src/renderer/simple/renderer.ts:179