Skip to content

Documentation / listr2 / SimpleRenderer

Class: SimpleRenderer

Defined in: packages/listr2/src/renderer/simple/renderer.ts:7

The definition of a ListrRenderer.

See

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

Implements

Constructors

Constructor

new SimpleRenderer(tasks, options): SimpleRenderer

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

Parameters

tasks

ListrSimpleRendererTask[]

options

ListrSimpleRendererOptions

Returns

SimpleRenderer

Properties

nonTTY

static nonTTY: boolean = true

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

designate whether this renderer can work in non-tty environments

Implementation of

ListrRenderer.nonTTY


rendererOptions

static rendererOptions: ListrSimpleRendererOptions

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

designate renderer global options that is specific to the current renderer

Implementation of

ListrRenderer.rendererOptions


rendererTaskOptions

static rendererTaskOptions: ListrSimpleRendererTaskOptions = {}

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

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

Implementation of

ListrRenderer.rendererTaskOptions

Methods

end()

end(): void

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

A function to what to do on end of the render

Returns

void

Implementation of

ListrRenderer.end


render()

render(): void

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

A function to what to do on render

Returns

void

Implementation of

ListrRenderer.render