Class ListrRenderer

The bones of a listr renderer.

Hierarchy

ListrRenderer

Implemented by

Index

Constructors

constructor

Properties

Constructors

constructor

new ListrRenderer(tasks: readonly Task<any, typeof ListrRenderer>[], options: Record<PropertyKey, any>, renderHook$?: Subject<void>): ListrRenderer

- Defined in node_modules/listr2/dist/index.d.ts:659
create a new renderer

Parameters
- tasks: readonly Task<any, typeof ListrRenderer>[]
- options: Record<PropertyKey, any>
- Optional renderHook$: Subject<void>
Returns ListrRenderer

Properties

end

end: (err?: Error) => void

Type declaration

- (err?: Error): void
- A function to what to do on end of the render
  
  Parameters
  - Optional err: Error
  Returns void

render

render: () => void

Type declaration

- (): void
- A function to what to do on render
  
  Returns void

Static nonTTY

nonTTY: boolean

designate whether this renderer can work in non-tty environments

Static rendererOptions

rendererOptions: Record<PropertyKey, any>

designate renderer global options that is specific to the current renderer

Static rendererTaskOptions

rendererTaskOptions: Record<PropertyKey, any>

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