Functions — github.com/listr2/listr2

hub / github.com/listr2/listr2 / functions

Functions169 in github.com/listr2/listr2

⨍ Functions 169◇ Types & classes 140

↓ 198 callersFunctiondelay

(time: number)

src/utils/delay.ts:1

↓ 167 callersMethodlog

(level: Levels, message: string | any[], options?: LoggerFieldOptions)

src/utils/logger/logger.ts:30

↓ 94 callersMethodrun

()

examples/manager.example.ts:25

↓ 91 callersMethodrun

(context?: Ctx)

src/listr.ts:137

↓ 72 callersFunctionexpectProcessOutputToMatchSnapshot

(output: MockProcessOutput, name?: string)

tests/utils/mock.ts:17

↓ 59 callersMethodnewListr

( tasks: ListrTask<InjectCtx, ListrGetRendererClassFromValue<InjectRenderer>>[], options?: ListrBaseCl

src/manager.ts:61

↓ 27 callersMethodon

(dispatch: E, handler: (data: EventData<E, Map>) => void)

src/lib/event-manager.ts:12

↓ 24 callersFunctionmockProcessOutput

(output: MockProcessOutput)

tests/utils/mock.ts:5

↓ 24 callersFunctionunmockProcessOutput

(output: MockProcessOutput)

tests/utils/mock.ts:11

↓ 20 callersMethodemit

(dispatch: E, args?: EventData<E, Map>)

src/lib/event-manager.ts:8

↓ 17 callersMethodicon

(level: Levels, icon?: string | false)

src/utils/logger/logger.ts:137

↓ 17 callersMethodskip

* Skip the current task. * * @see {@link https://listr2.kilic.dev/task/skip.html}

src/lib/task-wrapper.ts:91

↓ 16 callersMethodprompt

* Create a new prompt for getting user input through `enquirer`. * * - `enquirer` is a optional peer dependency and has to be already installed

src/lib/task-wrapper.ts:115

↓ 15 callersMethodwrite

(data: Uint8Array | string, ...args: [(string | undefined)?, ((err?: Error) => void)?] | [((err?: Error) => vo

src/utils/process-output/process-output-buffer.ts:23

↓ 10 callersMethodhasFailed

Returns whether this task has been failed.

src/lib/task.ts:193

↓ 10 callersMethodhasTitle

Returns whether this task actually has a title.

src/lib/task.ts:223

↓ 10 callersMethodisRetrying

Returns whether this task has an actively retrying task going on.

src/lib/task.ts:208

↓ 9 callersFunctiongetRendererClass

(renderer: ListrRendererValue)

src/utils/ui/renderer.ts:17

↓ 8 callersMethodadd

(tasks: ListrTask<Ctx, ListrGetRendererClassFromValue<Renderer>> | ListrTask<Ctx, ListrGetRendererClassFromVal

src/listr.ts:133

↓ 8 callersMethodformat

(message: string, icon: string, level: number)

src/renderer/default/renderer.ts:207

↓ 7 callersMethodformat

(level: Levels, message: string | any[], options?: LoggerFieldOptions)

src/utils/logger/logger.ts:154

↓ 7 callersMethodstyle

(task: ListrDefaultRendererTask, output = false)

src/renderer/default/renderer.ts:159

↓ 7 callersMethodtoStdout

(message: string | any[], options?: LoggerFieldOptions, eol = true)

src/utils/logger/logger.ts:42

↓ 6 callersFunctionassertFunctionOrSelf

( functionOrSelf: T, ...args: T extends (...args: any[]) => any ? Parameters<T> : never )

src/utils/assert.ts:6

↓ 6 callersMethodhasSubtasks

Returns whether this task has subtasks.

src/lib/task.ts:163

↓ 6 callersMethodisCompleted

Returns whether this task has been completed.

src/lib/task.ts:188

↓ 6 callersMethodsuffix

(message: string, ...suffixes: LoggerField[])

src/utils/logger/logger.ts:72

↓ 6 callersMethodwrap

(message: string, options?: LoggerFormatOptions)

src/utils/logger/logger.ts:50

↓ 5 callersFunctioncleanseAnsi

(chunk: string)

src/utils/format/cleanse-ansi.ts:3

↓ 5 callersMethodisSkipped

Returns whether this task is skipped.

src/lib/task.ts:183

↓ 5 callersMethodreport

* Report an error that has to be collected and handled. * * @see {@link https://listr2.kilic.dev/task/error-handling.html}

src/lib/task-wrapper.ts:78

↓ 5 callersMethodserialize

(event: T, data: ListrTaskEventMap[T], task?: ListrTestRendererTask)

src/renderer/test/serializer.ts:9

↓ 5 callersFunctionsplat

(message: string, ...splat: any[])

src/utils/format/splat.ts:3

↓ 4 callersMethodcancelPrompt

* Cancel the current active prompt, if there is any. * * @see {@link https://listr2.kilic.dev/task/prompt.html}

src/lib/task-wrapper.ts:125

↓ 4 callersMethodclose

()

src/lib/task.ts:420

↓ 4 callersMethodcomplete

()

src/lib/event-manager.ts:24

↓ 4 callersMethoddump

( task: ListrDefaultRendererTask, level: number, source: ListrLogLevels.OUTPUT | ListrLogLevels.SK

src/renderer/default/renderer.ts:475

↓ 4 callersMethodisPrompt

Returns whether this task has a prompt inside.

src/lib/task.ts:228

↓ 4 callersMethodisStarted

Returns whether this task has started.

src/lib/task.ts:178

↓ 4 callersMethodrunAll

(options?: ListrBaseClassOptions<InjectCtx, Renderer, FallbackRenderer>)

src/manager.ts:48

↓ 3 callersMethodend

()

src/renderer/test/renderer.ts:56

↓ 3 callersMethodfetch

()

src/utils/ui/spinner.ts:14

↓ 3 callersMethodhasFinalized

Returns whether this task is finalized in someform.

src/lib/task.ts:168

↓ 3 callersMethodhasRolledBack

Returns whether the rollback action was successful.

src/lib/task.ts:203

↓ 3 callersMethodindent

( tasks: ListrTask<InjectCtx, ListrGetRendererClassFromValue<Renderer>>[] | ((ctx?: InjectCtx) => ListrTas

src/manager.ts:68

↓ 3 callersMethodisPending

Returns whether this task is in progress.

src/lib/task.ts:173

↓ 3 callersMethodonce

(dispatch: E, handler: (data: EventData<E, Map>) => void)

src/lib/event-manager.ts:16

↓ 3 callersMethodrelease

()

src/utils/process-output/process-output.ts:50

↓ 3 callersMethodtoStderr

(message: string | any[], options?: LoggerFieldOptions, eol = true)

src/utils/logger/logger.ts:46

↓ 2 callersMethodall

()

src/utils/process-output/process-output-buffer.ts:11

↓ 2 callersMethodcheck

* Checks whether the current task with the given context should be set as enabled.

src/lib/task.ts:150

↓ 2 callersFunctioncloneObject

(obj: T)

src/utils/clone.ts:9

↓ 2 callersMethodcreate

(options?: { tasks?: boolean, bottomBar?: boolean, prompt?: boolean })

src/renderer/default/renderer.ts:121

↓ 2 callersFunctioncreateWritable

(cb: (chunk: string) => void)

src/utils/process-output/writable.ts:3

↓ 2 callersMethodhasReset

Returns whether this task has some kind of reset like retry and rollback going on.

src/lib/task.ts:213

↓ 2 callersMethodhijack

()

src/utils/process-output/process-output.ts:40

↓ 2 callersFunctionindent

(string: string, count: number)

src/utils/format/indent.ts:1

↓ 2 callersMethodindent

(str: string, i: number)

src/renderer/default/renderer.ts:512

↓ 2 callersMethodisBottomBar

(task: ListrDefaultRendererTask)

src/renderer/default/renderer.ts:73

↓ 2 callersMethodisPaused

Returns whether this task is currently paused.

src/lib/task.ts:233

↓ 2 callersFunctionisUnicodeSupported

()

src/utils/environment/is-unicode-supported.ts:3

↓ 2 callersMethodoff

(dispatch: E, handler?: (data: EventData<E, Map>) => void)

src/lib/event-manager.ts:20

↓ 2 callersMethodprefix

(message: string, ...prefixes: LoggerField[])

src/utils/logger/logger.ts:94

↓ 2 callersFunctionresolve

(specifier, context, defaultResolver)

loader.js:15

↓ 2 callersMethodrun

(fn: () => Promise<T>)

src/utils/concurrency.ts:39

↓ 2 callersMethodspacing

(message: string | undefined)

src/utils/logger/logger.ts:199

↓ 2 callersMethodstdout

* Generates a fake stdout for your use case, where it will be tunnelled through Listr to handle the rendering process. * * @see {@link https://l

src/lib/task-wrapper.ts:143

↓ 2 callersMethodupdate

()

src/renderer/default/renderer.ts:102

↓ 1 callersFunctionTaskManagerFactory

(override?: ListrBaseClassOptions)

examples/manager.example.ts:4

↓ 1 callersMethodapplyFormat

(message: string, options?: LoggerFormatOptions)

src/utils/logger/logger.ts:191

↓ 1 callersMethodcalculate

(task: ListrDefaultRendererTask)

src/renderer/default/renderer.ts:451

↓ 1 callersMethodcalculate

(task: ListrSimpleRendererTask)

src/renderer/simple/renderer.ts:158

↓ 1 callersMethodcalculate

(task: ListrVerboseRendererTask)

src/renderer/verbose/renderer.ts:143

↓ 1 callersFunctioncreateLargeNestedObject

(depth: number, branches: number)

tests/general.e2e-spec.ts:124

↓ 1 callersMethodfields

(message: string, options?: LoggerFieldOptions<true>)

src/utils/logger/logger.ts:117

↓ 1 callersMethodflush

()

src/utils/concurrency.ts:27

↓ 1 callersMethodgenerate

( tasks: ListrTask<Ctx, ListrGetRendererClassFromValue<Renderer>> | ListrTask<Ctx, ListrGetRendererClassFr

src/listr.ts:168

↓ 1 callersMethodgenerate

(event: T, data: ListrTaskEventMap[T], task?: ListrTestRendererTask)

src/renderer/test/serializer.ts:13

↓ 1 callersFunctiongetRenderer

(options: { renderer: Renderer rendererOptions: ListrGetRendererOptions<Renderer> fallbackRenderer: Fall

src/utils/ui/renderer.ts:25

↓ 1 callersMethodisClosed

Returns whether this task is closed.

src/lib/task.ts:238

↓ 1 callersMethodisEnabled

Returns whether enabled function resolves to true.

src/lib/task.ts:218

↓ 1 callersFunctionisObservable

(obj: any)

src/utils/environment/is-observable.ts:5

↓ 1 callersFunctionisRendererSupported

(renderer: ListrRendererFactory)

src/utils/ui/renderer.ts:13

↓ 1 callersMethodisRollingBack

Returns whether this task has an active rollback task going on.

src/lib/task.ts:198

↓ 1 callersFunctionmain

()

examples/error-handling.example.ts:9

↓ 1 callersMethodpause

Pause the given task for certain time.

src/lib/task.ts:243

↓ 1 callersMethodrender

()

src/renderer/test/renderer.ts:51

↓ 1 callersMethodrenderBottomBar

()

src/renderer/default/renderer.ts:431

↓ 1 callersMethodrenderPrompt

()

src/renderer/default/renderer.ts:443

↓ 1 callersMethodrenderer

(tasks: ListrDefaultRendererTask[], level = 0)

src/renderer/default/renderer.ts:248

↓ 1 callersMethodrenderer

(tasks: ListrSimpleRendererTask[])

src/renderer/simple/renderer.ts:56

↓ 1 callersMethodrenderer

(tasks: ListrTestRendererTask[])

src/renderer/test/renderer.ts:59

↓ 1 callersMethodrenderer

(tasks: ListrVerboseRendererTask[])

src/renderer/verbose/renderer.ts:55

↓ 1 callersMethodreset

()

src/utils/process-output/process-output-buffer.ts:43

↓ 1 callersMethodreset

(task: ListrDefaultRendererTask)

src/renderer/default/renderer.ts:470

↓ 1 callersMethodreset

(task: ListrSimpleRendererTask)

src/renderer/simple/renderer.ts:177

↓ 1 callersMethodreset

(task: ListrVerboseRendererTask)

src/renderer/verbose/renderer.ts:162

↓ 1 callersMethodrun

Run the current task.

src/lib/task.ts:258

↓ 1 callersMethodrunTask

(task: Task<Ctx, ListrGetRendererClassFromValue<Renderer>>)

src/listr.ts:176

↓ 1 callersMethodspin

()

src/utils/ui/spinner.ts:10

next →1–100 of 169, ranked by callers