Class ArgumentError<ValueT>

Type parameters

ValueT

Hierarchy

SystemError
- ArgumentError
  - ArgumentNullError
  - ArgumentOutOfRangeError

Index

Constructors

constructor

Properties

serializer

Accessors

Methods

Constructors

constructor

new ArgumentError(argumentName: string, message?: string): ArgumentError

Overrides BaseErrorT.constructor
- Defined in packages/common/src/errors.ts:64
Parameters
- argumentName: string
- Optional message: string
Returns ArgumentError

Properties

Static serializer

serializer: (instance: any) => any

Type declaration

- (instance: any): any
- Parameters
  - instance: any
  Returns any

Accessors

argumentName

get argumentName(): string

- Defined in packages/common/src/errors.ts:88
The name of the argument

Returns string

innerError

get innerError(): BaseError

Inherited from BaseErrorT.innerError
- Defined in packages/common/src/errors.ts:20
Returns BaseError

message

get message(): string

Inherited from BaseErrorT.message
- Defined in packages/common/src/errors.ts:16
Returns string

value

get value(): ValueT

- Defined in packages/common/src/errors.ts:76
The invalid value passed for the given argument

Returns ValueT

Methods

asJSON

asJSON(): any

Inherited from BaseErrorT.asJSON
- Defined in packages/common/src/errors.ts:29
Returns any

withValue

withValue(value: ValueT): this

- Defined in packages/common/src/errors.ts:80
Parameters
- value: ValueT
Returns this

Static setJSONSerializer

setJSONSerializer(serializer: (instance: any) => any): void

Inherited from BaseErrorT.setJSONSerializer
- Defined in packages/common/src/errors.ts:25
Parameters
- serializer: (instance: any) => any
  - - (instance: any): any
    - Parameters
      - instance: any
      Returns any
Returns void

Generated using TypeDoc