Skip to main content

Class: ArgumentError<T>

Errors thrown by the argument parser

Since​

1.0.0

Extends​

Type Parameters​

Type ParameterDefault type
Tunknown

Constructors​

new ArgumentError()​

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

Parameters​

ParameterType
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

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

parameter​

readonly parameter: string

Defined in​

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

Accessors​

name​

Get Signature​

get name(): string

Returns​

string

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

Overrides​

UserError.name

Defined in​

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