listr2

Appearance

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

Defined in ​

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

Properties ​

prepareStackTrace()? ​

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

Optional override for formatting stack traces

Parameters ​

• err: Error

• stackTraces: CallSite[]

Returns ​

any

See ​

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

Inherited from ​

Error.prepareStackTrace

Defined in ​

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

stackTraceLimit ​

static stackTraceLimit: number

Inherited from ​

Error.stackTraceLimit

Defined in ​

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

cause? ​

optional cause: unknown

Inherited from ​

Error.cause

Defined in ​

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

name ​

name: string

Inherited from ​

Error.name

Defined in ​

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

message ​

message: string

Inherited from ​

Error.message

Defined in ​

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

stack? ​

optional stack: string

Inherited from ​

Error.stack

Defined in ​

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

path ​

path: string[]

Defined in ​

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

ctx ​

ctx: Ctx

Defined in ​

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

error ​

error: Error

Defined in ​

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

type ​

type: ListrErrorTypes

Defined in ​

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

task ​

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

Defined in ​

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

Defined in ​

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