listr2

Appearance

Documentation / listr2 / PromptError

Class: PromptError ​

Defined in: packages/listr2/src/interfaces/prompt-error.interface.ts:6

Internal error handling mechanism for Listr prompts to identify the failing cause is coming from a prompt.

See ​

https://listr2.kilic.dev/task/prompts.html

Extends ​

  • Error

Constructors ​

Constructor ​

new PromptError(message?): PromptError

Defined in: node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es5.d.ts:1082

Parameters ​

message? ​

string

Returns ​

PromptError

Inherited from ​

Error.constructor

Constructor ​

new PromptError(message?, options?): PromptError

Defined in: node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es5.d.ts:1082

Parameters ​

message? ​

string

options? ​

ErrorOptions

Returns ​

PromptError

Inherited from ​

Error.constructor

Properties ​

prepareStackTrace()? ​

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

Defined in: node_modules/.pnpm/@types+node@20.17.19/node_modules/@types/node/globals.d.ts:98

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

stackTraceLimit ​

static stackTraceLimit: number

Defined in: node_modules/.pnpm/@types+node@20.17.19/node_modules/@types/node/globals.d.ts:100

Inherited from ​

Error.stackTraceLimit

cause? ​

optional cause: unknown

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

Inherited from ​

Error.cause

name ​

name: string

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

Inherited from ​

Error.name

message ​

message: string

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

Inherited from ​

Error.message

stack? ​

optional stack: string

Defined in: node_modules/.pnpm/typescript@5.6.3/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/@types+node@20.17.19/node_modules/@types/node/globals.d.ts:91

Create .stack property on a target object

Parameters ​

targetObject ​

object

constructorOpt? ​

Function

Returns ​

void

Inherited from ​

Error.captureStackTrace