Class ParametersError

Error class to be used when the provided options are invalid.

Hierarchy

  • Error
    • ParametersError

Constructors

constructor

Properties

code errors? message name stack? message prepareStackTrace? stackTraceLimit

Methods

captureStackTrace

Constructors

constructor

  • Parameters

    • message: string
    • Optional errors: null | ErrorObject<string, Record<string, any>, unknown>[]
      Optional

    Returns ParametersError

Properties

code

code: string = 'ERR_INVALID_PARAMETERS'

Code to identify the error in catch clauses.

Optional errors

errors?: null | ErrorObject<string, Record<string, any>, unknown>[]

Detailed introspection on the encountered errors, useful to know exactly what failed in the options.

message

message: string

name

name: string

Optional stack

stack?: string

Static message

message: string = 'Invalid parameters. Catch `e.errors` for details.'

Static Optional prepareStackTrace

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

Type declaration

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function
      Optional

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc