Class ParameterError

Hierarchy

TypeError
- ParameterError

Index

Constructors

Properties

field message name stack? target? NAME prepareStackTrace? stackTraceLimit

Methods

assert assertEmpty captureStackTrace

Constructors

constructor

new ParameterError(field: string, target?: null | string, message?: string): ParameterError
Parameters
- field: string
- target: null | string = null
- Optional message: string
Returns ParameterError
Overrides TypeError.constructor
- Defined in src/errors/ParameterError.ts:42

Properties

field

field: string

message

message: string

name

name: "ParameterError" = ParameterError.NAME

`Optional` stack

stack?: string

`Optional` target

target?: string

`Static` `Readonly` NAME

NAME: "ParameterError" = "ParameterError"

`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(target: string, params: any, ...fields: string[]): void
Parameters
- target: string
- params: any
- Rest ...fields: string[]
Returns void
- Defined in src/errors/ParameterError.ts:8
assert(params: any, ...fields: string[]): void
Parameters
- params: any
- Rest ...fields: string[]
Returns void
- Defined in src/errors/ParameterError.ts:9

`Static` assertEmpty

assertEmpty(value: unknown, name: string, target?: string): asserts value
Parameters
- value: unknown
- name: string
- Optional target: string
Returns asserts value
- Defined in src/errors/ParameterError.ts:31

`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

Generated using TypeDoc