Skip to content

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(message)

new PromptError(message?): PromptError

Parameters

message?: string

Returns

PromptError

Inherited from

Error.constructor

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es5.d.ts:1081

new PromptError(message, options)

new PromptError(message?, options?): PromptError

Parameters

message?: string

options?: ErrorOptions

Returns

PromptError

Inherited from

Error.constructor

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es5.d.ts:1081

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

Source

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


stackTraceLimit

static stackTraceLimit: number

Inherited from

Error.stackTraceLimit

Source

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


cause?

optional cause: unknown

Inherited from

Error.cause

Source

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


name

name: string

Inherited from

Error.name

Source

node_modules/.pnpm/typescript@5.3.3/node_modules/typescript/lib/lib.es5.d.ts:1075


message

message: string

Inherited from

Error.message

Source

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


stack?

optional stack: string

Inherited from

Error.stack

Source

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

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

Source

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