index.ListrRenderer.md

Class: ListrRenderer

index.ListrRenderer

The bones of a listr renderer.

Implemented by

• DefaultRenderer
• ListrBaseRenderer
• SilentRenderer
• SimpleRenderer
• VerboseRenderer

Properties

rendererOptions

▪ Static rendererOptions: Record<PropertyKey, any>

designate renderer global options that is specific to the current renderer

Defined in

src/interfaces/renderer.interface.ts:114

---

rendererTaskOptions

▪ Static rendererTaskOptions: Record<PropertyKey, any>

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

Defined in

src/interfaces/renderer.interface.ts:116

---

nonTTY

▪ Static nonTTY: boolean

designate whether this renderer can work in non-tty environments

Defined in

src/interfaces/renderer.interface.ts:118

---

render

• render: () => void

Type declaration

▸ (): void

A function to what to do on render

Returns

void

Defined in

src/interfaces/renderer.interface.ts:120

---

end

• end: (err?: Error) => void

Type declaration

▸ (err?): void

A function to what to do on end of the render

Parameters

Name	Type
err?	Error

Returns

void

Defined in

src/interfaces/renderer.interface.ts:122

Constructors

constructor

• new ListrRenderer(tasks, options, renderHook$?)

create a new renderer

Parameters

Name	Type
tasks	readonly ListrTaskObject<any, typeof ListrRenderer>[]
options	Record<PropertyKey, any>
renderHook$?	Subject<void>

Defined in

src/interfaces/renderer.interface.ts:124