listr2

Appearance

Documentation / listr2 / ListrRenderer

Class: ListrRenderer ​

Defined in: packages/listr2/src/interfaces/renderer.interface.ts:132

The definition of a ListrRenderer.

See ​

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

Constructors ​

Constructor ​

new ListrRenderer(tasks, options, events?): ListrRenderer

Defined in: packages/listr2/src/interfaces/renderer.interface.ts:144

create a new renderer

Parameters ​

tasks ​

ListrTaskObject<any, typeof ListrRenderer, typeof ListrRenderer>[]

options ​

Record<PropertyKey, any>

events? ​

ListrEventManager

Returns ​

ListrRenderer

Properties ​

rendererOptions ​

static rendererOptions: Record<PropertyKey, any>

Defined in: packages/listr2/src/interfaces/renderer.interface.ts:134

designate renderer global options that is specific to the current renderer

rendererTaskOptions ​

static rendererTaskOptions: Record<PropertyKey, any>

Defined in: packages/listr2/src/interfaces/renderer.interface.ts:136

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

nonTTY ​

static nonTTY: boolean

Defined in: packages/listr2/src/interfaces/renderer.interface.ts:138

designate whether this renderer can work in non-tty environments

render() ​

render: () => void | Promise<void>

Defined in: packages/listr2/src/interfaces/renderer.interface.ts:140

A function to what to do on render

Returns ​

void | Promise<void>

end() ​

end: (err?) => void

Defined in: packages/listr2/src/interfaces/renderer.interface.ts:142

A function to what to do on end of the render

Parameters ​

err? ​

Error

Returns ​

void