Skip to main content

Class: PreconditionError

Errors thrown by preconditions

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

Hierarchy

Constructors

constructor

โ€ข new PreconditionError(options)

Constructs an UserError.

Parameters

NameType
optionsOptions

Overrides

UserError.constructor

Defined in

projects/framework/src/lib/errors/PreconditionError.ts:11

Properties

context

โ€ข Readonly context: unknown

User-provided context.

Inherited from

UserError.context

Defined in

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


identifier

โ€ข Readonly identifier: string

An identifier, useful to localize emitted errors.

Inherited from

UserError.identifier

Defined in

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


message

โ€ข message: string

Inherited from

UserError.message

Defined in

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


precondition

โ€ข Readonly precondition: Precondition<PreconditionOptions>

Defined in

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


stack

โ€ข Optional stack: string

Inherited from

UserError.stack

Defined in

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


prepareStackTrace

โ–ช Static Optional prepareStackTrace: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

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

UserError.prepareStackTrace

Defined in

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


stackTraceLimit

โ–ช Static stackTraceLimit: number

Inherited from

UserError.stackTraceLimit

Defined in

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

Accessors

name

โ€ข get name(): string

Returns

string

Overrides

UserError.name

Defined in

projects/framework/src/lib/errors/PreconditionError.ts:17

Methods

captureStackTrace

โ–ธ Static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

NameType
targetObjectobject
constructorOpt?Function

Returns

void

Inherited from

UserError.captureStackTrace

Defined in

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