Skip to content

Documentation / listr2 / ListrRenderer

Class: ListrRenderer

The definition of a ListrRenderer.

See

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

Constructors

new ListrRenderer(tasks, options, events)

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

create a new renderer

Parameters

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

options: Record<PropertyKey, any>

events?: ListrEventManager

Returns

ListrRenderer

Source

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

Properties

rendererOptions

static rendererOptions: Record<PropertyKey, any>

designate renderer global options that is specific to the current renderer

Source

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


rendererTaskOptions

static rendererTaskOptions: Record<PropertyKey, any>

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

Source

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


nonTTY

static nonTTY: boolean

designate whether this renderer can work in non-tty environments

Source

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


render

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

A function to what to do on render

Returns

void | Promise<void>

Source

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


end

end: (err?) => void

A function to what to do on end of the render

Parameters

err?: Error

Returns

void

Source

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