Skip to main content

Class: UserError

The UserError class to be emitted in the pieces.

Hierarchy

Constructors

constructor

new UserError(options)

Constructs an UserError.

Parameters

NameTypeDescription
optionsOptionsThe UserError options

Overrides

Error.constructor

Defined in

projects/framework/src/lib/errors/UserError.ts:20

Properties

cause

Optional cause: unknown

Inherited from

Error.cause

Defined in

node_modules/typescript/lib/lib.es2022.error.d.ts:24


context

Readonly context: unknown

User-provided context.

Defined in

projects/framework/src/lib/errors/UserError.ts:14


identifier

Readonly identifier: string

An identifier, useful to localize emitted errors.

Defined in

projects/framework/src/lib/errors/UserError.ts:9


message

message: string

Inherited from

Error.message

Defined in

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


stack

Optional stack: string

Inherited from

Error.stack

Defined in

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


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
NameType
errError
stackTracesCallSite[]
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

Accessors

name

get name(): string

This will be 'UserError' and can be used to distinguish the type of error when any error gets thrown

Returns

string

Overrides

Error.name

Defined in

projects/framework/src/lib/errors/UserError.ts:27

Methods

captureStackTrace

Static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

NameType
targetObjectobject
constructorOpt?Function

Returns

void

Inherited from

Error.captureStackTrace

Defined in

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