Class ArgumentError

Hierarchy

TypeError
- ArgumentError

Index

Constructors

constructor

new ArgumentError(message?: string): ArgumentError
Parameters
- Optional message: string
Returns ArgumentError
Inherited from TypeError.constructor
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1089
new ArgumentError(message?: string): ArgumentError
Parameters
- Optional message: string
Returns ArgumentError
Inherited from TypeError.constructor
- Defined in node_modules/typescript/lib/lib.es5.d.ts:1034

Properties

message

message: string

name

name: "ArgumentError" = ArgumentError.NAME

`Optional` stack

stack?: string

`Static` `Readonly` NAME

NAME: "ArgumentError" = "ArgumentError"

`Static` `Optional` prepareStackTrace

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

Type declaration

- (err: Error, stackTraces: CallSite[]): any
- Optional override for formatting stack traces
  
  See
  https://v8.dev/docs/stack-trace-api#customizing-stack-traces
  Parameters
  - err: Error
  - stackTraces: CallSite[]
  Returns any

`Static` stackTraceLimit

stackTraceLimit: number

Methods

`Static` assert

assert(value: any, name: string, type: "undefined"): asserts value is undefined
Parameters
- value: any
- name: string
- type: "undefined"
Returns asserts value is undefined
- Defined in src/errors/ArgumentError.ts:52
assert(value: any, name: string, type: "null"): asserts value is null
Parameters
- value: any
- name: string
- type: "null"
Returns asserts value is null
- Defined in src/errors/ArgumentError.ts:53
assert(value: any, name: string, type: "boolean"): asserts value is boolean
Parameters
- value: any
- name: string
- type: "boolean"
Returns asserts value is boolean
- Defined in src/errors/ArgumentError.ts:54
assert(value: any, name: string, type: "number"): asserts value is number
Parameters
- value: any
- name: string
- type: "number"
Returns asserts value is number
- Defined in src/errors/ArgumentError.ts:55
assert(value: any, name: string, type: "object"): asserts value is { [key: string]: any }
Parameters
- value: any
- name: string
- type: "object"
Returns asserts value is { [key: string]: any }
- Defined in src/errors/ArgumentError.ts:56
assert(value: any, name: string, type: "string"): asserts value is string
Parameters
- value: any
- name: string
- type: "string"
Returns asserts value is string
- Defined in src/errors/ArgumentError.ts:57
assert(value: any, name: string, type: "Array"): asserts value is any[]
Parameters
- value: any
- name: string
- type: "Array"
Returns asserts value is any[]
- Defined in src/errors/ArgumentError.ts:58
assert(value: any, name: string, type: "ArrayBuffer"): asserts value is ArrayBuffer
Parameters
- value: any
- name: string
- type: "ArrayBuffer"
Returns asserts value is ArrayBuffer
- Defined in src/errors/ArgumentError.ts:59
assert(value: any, name: string, type: "ArrayBufferView"): asserts value is ArrayBufferView
Parameters
- value: any
- name: string
- type: "ArrayBufferView"
Returns asserts value is ArrayBufferView
- Defined in src/errors/ArgumentError.ts:60
assert<T>(value: any, name: string, type: (new (...args: any[]) => T)): asserts value is T
Type Parameters
- T
Parameters
- value: any
- name: string
- type: (new (...args: any[]) => T)
  - - new (...args: any[]): T
    - Parameters
      
      Rest ...args: any[]
      
      Returns T
Returns asserts value is T
- Defined in src/errors/ArgumentError.ts:61
assert(value: any, name: string, type: ArgumentType, ...types: ArgumentType[]): void
Parameters
- value: any
- name: string
- type: ArgumentType
- Rest ...types: ArgumentType[]
Returns void
- Defined in src/errors/ArgumentError.ts:62

`Static` captureStackTrace

captureStackTrace(targetObject: object, constructorOpt?: Function): void
Create .stack property on a target object
Parameters
- targetObject: object
- Optional constructorOpt: Function
Returns void
Inherited from TypeError.captureStackTrace
- Defined in node_modules/@types/node/globals.d.ts:4

`Static` isType

isType(value: any, type: "undefined"): value is undefined
Parameters
- value: any
- type: "undefined"
Returns value is undefined
- Defined in src/errors/ArgumentError.ts:22
isType(value: any, type: "null"): value is null
Parameters
- value: any
- type: "null"
Returns value is null
- Defined in src/errors/ArgumentError.ts:23
isType(value: any, type: "boolean"): value is boolean
Parameters
- value: any
- type: "boolean"
Returns value is boolean
- Defined in src/errors/ArgumentError.ts:24
isType(value: any, type: "number"): value is number
Parameters
- value: any
- type: "number"
Returns value is number
- Defined in src/errors/ArgumentError.ts:25
isType(value: any, type: "object"): value is object
Parameters
- value: any
- type: "object"
Returns value is object
- Defined in src/errors/ArgumentError.ts:26
isType(value: any, type: "string"): value is string
Parameters
- value: any
- type: "string"
Returns value is string
- Defined in src/errors/ArgumentError.ts:27
isType(value: any, type: "Array"): value is any[]
Parameters
- value: any
- type: "Array"
Returns value is any[]
- Defined in src/errors/ArgumentError.ts:28
isType(value: any, type: "ArrayBuffer"): value is ArrayBuffer
Parameters
- value: any
- type: "ArrayBuffer"
Returns value is ArrayBuffer
- Defined in src/errors/ArgumentError.ts:29
isType(value: any, type: "ArrayBufferView"): value is ArrayBufferView
Parameters
- value: any
- type: "ArrayBufferView"
Returns value is ArrayBufferView
- Defined in src/errors/ArgumentError.ts:30
isType<T>(value: any, type: (new (...args: any[]) => T)): value is T
Type Parameters
- T
Parameters
- value: any
- type: (new (...args: any[]) => T)
  - - new (...args: any[]): T
    - Parameters
      
      Rest ...args: any[]
      
      Returns T
Returns value is T
- Defined in src/errors/ArgumentError.ts:31
isType(value: any, type: ArgumentType): boolean
Parameters
- value: any
- type: ArgumentType
Returns boolean
- Defined in src/errors/ArgumentError.ts:33

Class ArgumentError

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional message: string

Returns ArgumentError

Parameters

Optional message: string

Returns ArgumentError

Properties

message

name

Optional stack

Static Readonly NAME

Static Optional prepareStackTrace

Type declaration

See

Parameters

err: Error

stackTraces: CallSite[]

Returns any

Static stackTraceLimit

Methods

Static assert

Parameters

value: any

name: string

type: "undefined"

Returns asserts value is undefined

Parameters

value: any

name: string

type: "null"

Returns asserts value is null

Parameters

value: any

name: string

type: "boolean"

Returns asserts value is boolean

Parameters

value: any

name: string

type: "number"

Returns asserts value is number

Parameters

value: any

name: string

type: "object"

Returns asserts value is { [key: string]: any }

Parameters

value: any

name: string

type: "string"

Returns asserts value is string

Parameters

value: any

name: string

type: "Array"

Returns asserts value is any[]

Parameters

value: any

name: string

type: "ArrayBuffer"

Returns asserts value is ArrayBuffer

Parameters

value: any

name: string

type: "ArrayBufferView"

Returns asserts value is ArrayBufferView

Type Parameters

T

Parameters

value: any

name: string

type: (new (...args: any[]) => T)

`Optional` message: string

`Optional` message: string

`Optional` stack

`Static` `Readonly` NAME

`Static` `Optional` prepareStackTrace

`Static` stackTraceLimit

`Static` assert

`Rest` ...args: any[]

`Rest` ...types: ArgumentType[]

`Static` captureStackTrace

`Optional` constructorOpt: Function

`Static` isType

`Rest` ...args: any[]