ArgumentError

ArgumentError constructor. An error when wrong argument is passed to a function

Hierarchy

• Readonly<Error & { cause: unknown; message: string; name: ArgumentError; stack: string } & { name: ArgumentError }>
  • ArgumentError

Index

Constructors

• constructor

Properties

• errorName

Methods

• asString
• hasInstance

Constructors

constructor

• new ArgumentError(...properties: [properties?: ErrorClassProperties<{}>]): ArgumentError

• Inherited from ErrorClass({ errorName: 'ArgumentError', errorMessage: 'Some arguments are invalid or missing', }).constructor

  Error constructor

Properties

staticreadonlyerrorName

errorName: ArgumentError

Inherited from ErrorClass({ errorName: 'ArgumentError', errorMessage: 'Some arguments are invalid or missing', }).errorName

Error name

Methods

staticasString

• asString(self: Error): string

• Inherited from ErrorClass({ errorName: 'ArgumentError', errorMessage: 'Some arguments are invalid or missing', }).asString

  Static method to convert an error to a string

  @example

  CustomError.asString(new Error('my message'));

statichasInstance

• hasInstance<Class>(this: Class, anyValue: unknown): anyValue is InstanceType<Class>

• Inherited from ErrorClass({ errorName: 'ArgumentError', errorMessage: 'Some arguments are invalid or missing', }).hasInstance

  Return true if anyValue is an instance of current class

  ---

  Type parameters

  • Class: new (...args: any) => any