listr2

Appearance

Documentation / listr2 / PromptError

Class: PromptError ​

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 ​

new PromptError() ​

new PromptError(message?): PromptError

Parameters ​

• message?: string

Returns ​

PromptError

Inherited from ​

Error.constructor

Defined in ​

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

new PromptError() ​

new PromptError(message?, options?): PromptError

Parameters ​

• message?: string

• options?: ErrorOptions

Returns ​

PromptError

Inherited from ​

Error.constructor

Defined in ​

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

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

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