Skip to main content

Class: ArgumentError<T>

Errors thrown by the argument parser

Since

1.0.0

Type parameters

NameType
Tunknown

Hierarchy

Constructors

constructor

new ArgumentError<T>(options): ArgumentError<T>

Type parameters

NameType
Tunknown

Parameters

NameType
optionsOptions<T>

Returns

ArgumentError<T>

Overrides

UserError.constructor

Defined in

projects/framework/src/lib/errors/ArgumentError.ts:13

Properties

argument

Readonly argument: IArgument<T>

Defined in

projects/framework/src/lib/errors/ArgumentError.ts:10


cause

Optional cause: unknown

Inherited from

UserError.cause

Defined in

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


context

Readonly context: unknown

User-provided context.

Inherited from

UserError.context

Defined in

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


identifier

Readonly identifier: string

An identifier, useful to localize emitted errors.

Inherited from

UserError.identifier

Defined in

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


message

message: string

Inherited from

UserError.message

Defined in

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


parameter

Readonly parameter: string

Defined in

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


stack

Optional stack: string

Inherited from

UserError.stack

Defined in

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


prepareStackTrace

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

Optional override for formatting stack traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Type declaration

▸ (err, stackTraces): any

Optional override for formatting stack traces

Parameters
NameType
errError
stackTracesCallSite[]
Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

UserError.prepareStackTrace

Defined in

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


stackTraceLimit

Static stackTraceLimit: number

Inherited from

UserError.stackTraceLimit

Defined in

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

Accessors

name

get name(): string

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

Returns

string

Overrides

UserError.name

Defined in

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

Methods

captureStackTrace

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:21