listr2

Appearance

Documentation / listr2 / DefaultRenderer

Class: DefaultRenderer ​

Defined in: packages/listr2/src/renderer/default/renderer.ts:21

The definition of a ListrRenderer.

See ​

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

Implements ​

Constructors ​

Constructor ​

new DefaultRenderer(tasks, options, events): DefaultRenderer

Defined in: packages/listr2/src/renderer/default/renderer.ts:63

Parameters ​

tasks ​

ListrDefaultRendererTask[]

options ​

ListrDefaultRendererOptions

events ​

ListrEventManager

Returns ​

DefaultRenderer

Properties ​

nonTTY ​

static nonTTY: boolean = false

Defined in: packages/listr2/src/renderer/default/renderer.ts:22

designate whether this renderer can work in non-tty environments

Implementation of ​

ListrRenderer.nonTTY

rendererOptions ​

static rendererOptions: ListrDefaultRendererOptions

Defined in: packages/listr2/src/renderer/default/renderer.ts:23

designate renderer global options that is specific to the current renderer

Implementation of ​

ListrRenderer.rendererOptions

rendererTaskOptions ​

static rendererTaskOptions: ListrDefaultRendererTaskOptions

Defined in: packages/listr2/src/renderer/default/renderer.ts:42

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

Implementation of ​

ListrRenderer.rendererTaskOptions

Methods ​

render() ​

render(): Promise<void>

Defined in: packages/listr2/src/renderer/default/renderer.ts:88

A function to what to do on render

Returns ​

Promise<void>

Implementation of ​

ListrRenderer.render

update() ​

update(): void

Defined in: packages/listr2/src/renderer/default/renderer.ts:111

Returns ​

void

end() ​

end(): void

Defined in: packages/listr2/src/renderer/default/renderer.ts:115

A function to what to do on end of the render

Returns ​

void

Implementation of ​

ListrRenderer.end

create() ​

create(options?): string

Defined in: packages/listr2/src/renderer/default/renderer.ts:130

Parameters ​

options? ​
tasks? ​

boolean

bottomBar? ​

boolean

prompt? ​

boolean

Returns ​

string

style() ​

protected style(task, output): string

Defined in: packages/listr2/src/renderer/default/renderer.ts:168

Parameters ​

task ​

ListrDefaultRendererTask

output ​

boolean = false

Returns ​

string

format() ​

protected format(message, icon, level): string[]

Defined in: packages/listr2/src/renderer/default/renderer.ts:216

Parameters ​

message ​

string

icon ​

string

level ​

number

Returns ​

string[]

shouldOutputToOutputBar() ​

protected shouldOutputToOutputBar(task): boolean

Defined in: packages/listr2/src/renderer/default/renderer.ts:257

Parameters ​

task ​

ListrDefaultRendererTask

Returns ​

boolean

shouldOutputToBottomBar() ​

protected shouldOutputToBottomBar(task): boolean

Defined in: packages/listr2/src/renderer/default/renderer.ts:263

Parameters ​

task ​

ListrDefaultRendererTask

Returns ​

boolean