listr2

Appearance

Documentation / listr2 / SimpleRenderer

Class: SimpleRenderer ​

The definition of a ListrRenderer.

See ​

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

Implements ​

Constructors ​

new SimpleRenderer() ​

new SimpleRenderer(tasks, options): SimpleRenderer

Parameters ​

• tasks: ListrSimpleRendererTask[]

• options: ListrSimpleRendererOptions

Returns ​

SimpleRenderer

Defined in ​

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

Defined in ​

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

Defined in ​

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

Defined in ​

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

Methods ​

end() ​

end(): void

A function to what to do on end of the render

Returns ​

void

Implementation of ​

ListrRenderer.end

Defined in ​

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

Defined in ​

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