Skip to content

Main Navigation Repository Listr Task Renderer Migration API

Appearance

Sidebar Navigation

Repository

Changelog

Foreword

Agents

Contributions

Release

Listr

Installation

Environment

Examples

Listr

Concept of Context

Manager

Interruption

Task

Task

Task Options

Error Handling

Subtasks

Title

Output

Conditional Enable

Conditional Skip

Prompts

Retry

Rollback

Renderer

Renderer

Fallback Condition

Default Renderer

Simple Renderer

Verbose Renderer

Silent Renderer

Test Renderer

Custom Renderer

Logger

Process Output

Migration

V6

V7

V8

V9

V10

V11

Api

@listr2

Manager

Classes

Manager

Prompt-adapter-enquirer

Classes

EnquirerPromptOptionsMap

ListrEnquirerPromptAdapter

Interfaces

EnquirerPromptCancelOptions

EnquirerPromptInstance

EnquirerPromptSettings

Type-aliases

EnquirerPromptOptions

EnquirerPromptOptionsType

EnquirerPromptTypes

Prompt-adapter-inquirer

Classes

ListrInquirerPromptAdapter

Listr2

Classes

BaseEventMap

Concurrency

DefaultRenderer

EventManager

Listr

ListrError

ListrEventManager

ListrEventMap

ListrLogger

ListrPromptAdapter

ListrRenderer

ListrRendererError

ListrTaskEventManager

ListrTaskEventMap

ProcessOutput

ProcessOutputBuffer

ProcessOutputStream

PromptError

SilentRenderer

SimpleRenderer

Spinner

TestRenderer

TestRendererSerializer

VerboseRenderer

Enumerations

ListrDefaultRendererLogLevels

ListrEnvironmentVariables

ListrErrorTypes

ListrEventType

ListrLogLevels

ListrRendererSelection

ListrTaskEventType

ListrTaskState

Functions

AssertFunctionOrSelf

CleanseAnsi

CreateWritable

Delay

GetRenderer

GetRendererClass

Indent

IsObservable

IsReadable

IsUnicodeSupported

ParseTimer

ParseTimestamp

Splat

Interfaces

ListrBaseClassOptions

ListrDefaultRendererCache

ListrDefaultRendererOptions

ListrDefaultRendererOutputBuffer

ListrDefaultRendererTaskOptions

ListrLoggerOptions

ListrLoggerStyleMap

ListrOptions

ListrPrimaryRendererOptions

ListrPrimaryRendererSelection

ListrPrimaryRendererTaskOptions

ListrSecondaryRendererOptions

ListrSecondaryRendererSelection

ListrSecondaryRendererTaskOptions

ListrSimpleRendererCache

ListrSimpleRendererOptions

ListrSimpleRendererTaskOptions

ListrSubClassOptions

ListrTask

ListrTaskMessage

ListrTaskObject

ListrTaskRetry

ListrTaskWrapper

ListrTestRendererOptions

ListrVerboseRendererCache

ListrVerboseRendererOptions

ListrVerboseRendererTaskOptions

LoggerFieldFn

LoggerFieldOptions

LoggerFormatOptions

ObservableLike

ProcessOutputBufferEntry

ProcessOutputBufferOptions

ProcessOutputOptions

ProcessOutputRendererOptions

ReadableLike

RendererLoggerOptions

RendererPresetTimer

RendererPresetTimestamp

SupportedRenderer

TestRendererSerializerOutput

Type-aliases

EventData

EventMap

Figures

ListrContext

ListrDefaultRenderer

ListrDefaultRendererOptionsStyle

ListrDefaultRendererTask

ListrDefaultRendererValue

ListrGetRendererClassFromValue

ListrGetRendererOptions

ListrGetRendererTaskOptions

ListrGetRendererValueFromClass

ListrPrimaryRendererValue

ListrRendererCacheMap

ListrRendererFactory

ListrRendererOptions

ListrRendererTask

ListrRendererValue

ListrSecondaryRendererValue

ListrSilentRenderer

ListrSilentRendererOptions

ListrSilentRendererTask

ListrSilentRendererTaskOptions

ListrSilentRendererValue

ListrSimpleRenderer

ListrSimpleRendererTask

ListrSimpleRendererValue

ListrTaskFn

ListrTaskPrompt

ListrTaskResult

ListrTestRenderer

ListrTestRendererTask

ListrTestRendererTaskOptions

ListrTestRendererValue

ListrVerboseRenderer

ListrVerboseRendererTask

ListrVerboseRendererValue

LoggerField

LoggerFormat

PresetTimer

PresetTimestamp

ProcessOutputStreamMap

TestRendererSerializerTaskKeys

Variables

ANSI_ESCAPE

ANSI_ESCAPE_CODES

LISTR_DEFAULT_RENDERER_STYLE

LISTR_LOGGER_STDERR_LEVELS

LISTR_LOGGER_STYLE

PRESET_TIMER

PRESET_TIMESTAMP

Color

Figures

On this page

Are you an LLM? You can read better optimized documentation at /migration.md for this page in Markdown format

Migration

v6
v7
v8
v9
v10
v11

Last updated:

Pager

Next pageChangelog

kilic.dev
Made with Vitepress.