Skip to content

Documentation / listr2 / ListrError

Class: ListrError<Ctx>

Internal error handling mechanism for Listr collects the errors and details for a failed task.

See

https://listr2.kilic.dev/task/error-handling.html

Extends

  • Error

Type parameters

Ctx extends ListrContext = ListrContext

Constructors

new ListrError()

new ListrError<Ctx>(error, type, task): ListrError<Ctx>

Parameters

error: Error

type: ListrErrorTypes

task: ListrTaskObject<Ctx, typeof ListrRenderer, typeof ListrRenderer>

Returns

ListrError<Ctx>

Overrides

Error.constructor

Source

packages/listr2/src/interfaces/listr-error.interface.ts:16

Properties

prepareStackTrace()?

static optional prepareStackTrace: (err, stackTraces) => any

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Parameters

err: Error

stackTraces: CallSite[]

Returns

any

Inherited from

Error.prepareStackTrace

Source

node_modules/.pnpm/@types+node@20.12.12/node_modules/@types/node/globals.d.ts:28


stackTraceLimit

static stackTraceLimit: number

Inherited from

Error.stackTraceLimit

Source

node_modules/.pnpm/@types+node@20.12.12/node_modules/@types/node/globals.d.ts:30


cause?

optional cause: unknown

Inherited from

Error.cause

Source

node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es2022.error.d.ts:24


name

name: string

Inherited from

Error.name

Source

node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es5.d.ts:1076


message

message: string

Inherited from

Error.message

Source

node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es5.d.ts:1077


stack?

optional stack: string

Inherited from

Error.stack

Source

node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es5.d.ts:1078


path

path: string[]

Source

packages/listr2/src/interfaces/listr-error.interface.ts:13


ctx

ctx: Ctx

Source

packages/listr2/src/interfaces/listr-error.interface.ts:14


error

error: Error

Source

packages/listr2/src/interfaces/listr-error.interface.ts:17


type

type: ListrErrorTypes

Source

packages/listr2/src/interfaces/listr-error.interface.ts:18


task

task: ListrTaskObject<Ctx, typeof ListrRenderer, typeof ListrRenderer>

Source

packages/listr2/src/interfaces/listr-error.interface.ts:19

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

targetObject: object

constructorOpt?: Function

Returns

void

Inherited from

Error.captureStackTrace

Source

node_modules/.pnpm/@types+node@20.12.12/node_modules/@types/node/globals.d.ts:21