listr2

Appearance

Documentation / listr2 / ListrError

Class: ListrError<Ctx> ​

Defined in: packages/listr2/src/interfaces/listr-error.interface.ts:12

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 ​

Ctx extends ListrContext = ListrContext

Constructors ​

Constructor ​

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

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

Parameters ​

error ​

Error

type ​

ListrErrorTypes

task ​

ListrTaskObject<Ctx, typeof ListrRenderer, typeof ListrRenderer>

Returns ​

ListrError<Ctx>

Overrides ​

Error.constructor

Properties ​

stackTraceLimit ​

static stackTraceLimit: number

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/node/globals.d.ts:162

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from ​

Error.stackTraceLimit

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

cause? ​

optional cause: unknown

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from ​

Error.cause

name ​

name: string

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from ​

Error.name

message ​

message: string

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from ​

Error.message

stack? ​

optional stack: string

Defined in: node_modules/.pnpm/[email protected]/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from ​

Error.stack

Methods ​

captureStackTrace() ​

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/node/globals.d.ts:146

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

js
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

js
function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters ​

targetObject ​

object

constructorOpt? ​

Function

Returns ​

void

Inherited from ​

Error.captureStackTrace

prepareStackTrace() ​

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/.pnpm/@[email protected]/node_modules/@types/node/globals.d.ts:150

Parameters ​

err ​

Error

stackTraces ​

CallSite[]

Returns ​

any

See ​

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

Inherited from ​

Error.prepareStackTrace