Class: ArgumentError

Hierarchy

• TypeError

  ↳ ArgumentError

Constructors

constructor

• new ArgumentError(message?): ArgumentError

Parameters

Name	Type
message?	string

Returns

ArgumentError

Inherited from

TypeError.constructor

• new ArgumentError(message?): ArgumentError

Parameters

Name	Type
message?	string

Returns

ArgumentError

Inherited from

TypeError.constructor

Properties

message

• message: string

Inherited from

TypeError.message

---

name

• name: "ArgumentError"

Overrides

TypeError.name

---

stack

• Optional stack: string

Inherited from

TypeError.stack

---

NAME

▪ Static Readonly NAME: "ArgumentError"

---

prepareStackTrace

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

Type declaration

▸ (err, stackTraces): any

Optional override for formatting stack traces

Parameters

Name	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

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

Inherited from

TypeError.prepareStackTrace

---

stackTraceLimit

▪ Static stackTraceLimit: number

Inherited from

TypeError.stackTraceLimit

Methods

assert

▸ assert(value, name, type): asserts value is undefined

Parameters

Name	Type
value	any
name	string
type	"undefined"

Returns

asserts value is undefined

▸ assert(value, name, type): asserts value is null

Parameters

Name	Type
value	any
name	string
type	"null"

Returns

asserts value is null

▸ assert(value, name, type): asserts value is boolean

Parameters

Name	Type
value	any
name	string
type	"boolean"

Returns

asserts value is boolean

▸ assert(value, name, type): asserts value is number

Parameters

Name	Type
value	any
name	string
type	"number"

Returns

asserts value is number

▸ assert(value, name, type): asserts value is Object

Parameters

Name	Type
value	any
name	string
type	"object"

Returns

asserts value is Object

▸ assert(value, name, type): asserts value is string

Parameters

Name	Type
value	any
name	string
type	"string"

Returns

asserts value is string

▸ assert(value, name, type): asserts value is any[]

Parameters

Name	Type
value	any
name	string
type	"Array"

Returns

asserts value is any[]

▸ assert(value, name, type): asserts value is ArrayBuffer

Parameters

Name	Type
value	any
name	string
type	"ArrayBuffer"

Returns

asserts value is ArrayBuffer

▸ assert(value, name, type): asserts value is ArrayBufferView

Parameters

Name	Type
value	any
name	string
type	"ArrayBufferView"

Returns

asserts value is ArrayBufferView

▸ assert<T>(value, name, type): asserts value is T

Type parameters

Name
T

Parameters

Name	Type
value	any
name	string
type	(...args: any[]) => T

Returns

asserts value is T

▸ assert(value, name, type, ...types): void

Parameters

Name	Type
value	any
name	string
type	ArgumentType
...types	ArgumentType[]

Returns

void

---

captureStackTrace

▸ captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

Name	Type
targetObject	object
constructorOpt?	Function

Returns

void

Inherited from

TypeError.captureStackTrace

---

isType

▸ isType(value, type): value is undefined

Parameters

Name	Type
value	any
type	"undefined"

Returns

value is undefined

▸ isType(value, type): value is null

Parameters

Name	Type
value	any
type	"null"

Returns

value is null

▸ isType(value, type): value is boolean

Parameters

Name	Type
value	any
type	"boolean"

Returns

value is boolean

▸ isType(value, type): value is number

Parameters

Name	Type
value	any
type	"number"

Returns

value is number

▸ isType(value, type): value is object

Parameters

Name	Type
value	any
type	"object"

Returns

value is object

▸ isType(value, type): value is string

Parameters

Name	Type
value	any
type	"string"

Returns

value is string

▸ isType(value, type): value is any[]

Parameters

Name	Type
value	any
type	"Array"

Returns

value is any[]

▸ isType(value, type): value is ArrayBuffer

Parameters

Name	Type
value	any
type	"ArrayBuffer"

Returns

value is ArrayBuffer

▸ isType(value, type): value is ArrayBufferView

Parameters

Name	Type
value	any
type	"ArrayBufferView"

Returns

value is ArrayBufferView

▸ isType<T>(value, type): value is T

Type parameters

Name
T

Parameters

Name	Type
value	any
type	(...args: any[]) => T

Returns

value is T

▸ isType(value, type): boolean

Parameters

Name	Type
value	any
type	ArgumentType

Returns

boolean