index.ListrError.md

Class: ListrError<Ctx>

index.ListrError

The internal error handling mechanism..

Type parameters

Name	Type
Ctx	extends ListrContext = ListrContext

Hierarchy

• Error

  ↳ ListrError

Methods

captureStackTrace

▸ Static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

Name	Type
targetObject	object
constructorOpt?	Function

Returns

void

Inherited from

Error.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:4

Properties

prepareStackTrace

▪ Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Type declaration

▸ (err, stackTraces): any

Optional override for formatting stack traces

See

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

Parameters

Name	Type
err	Error
stackTraces	CallSite[]

Returns

any

Inherited from

Error.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:11

---

stackTraceLimit

▪ Static stackTraceLimit: number

Inherited from

Error.stackTraceLimit

Defined in

node_modules/@types/node/globals.d.ts:13

---

name

• name: string

Inherited from

Error.name

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1053

---

message

• message: string

Inherited from

Error.message

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1054

---

stack

• Optional stack: string

Inherited from

Error.stack

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1055

---

path

• path: string

Defined in

src/interfaces/listr-error.interface.ts:8

---

ctx

• ctx: Ctx

Defined in

src/interfaces/listr-error.interface.ts:9

---

error

• error: Error

Defined in

src/interfaces/listr-error.interface.ts:11

---

type

• type: ListrErrorTypes

Defined in

src/interfaces/listr-error.interface.ts:11

---

task

• task: ListrTaskObject<Ctx, typeof ListrRenderer>

Defined in

src/interfaces/listr-error.interface.ts:11

Constructors

constructor

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

Type parameters

Name	Type
Ctx	extends unknown = any

Parameters

Name	Type
error	Error
type	ListrErrorTypes
task	ListrTaskObject<Ctx, typeof ListrRenderer>

Overrides

Error.constructor

Defined in

src/interfaces/listr-error.interface.ts:11