tsoa-next / @tsoa-next/runtime / ValidateError

Class: ValidateError

Defined in: packages/runtime/src/routeGeneration/templateHelpers.ts:496

Error thrown when request validation fails in generated routes.

Extends

• Error

Implements

• Exception

Constructors

Constructor

new ValidateError(fields, message): ValidateError;

Defined in: packages/runtime/src/routeGeneration/templateHelpers.ts:500

Parameters

fields

FieldErrors

message

string

Returns

ValidateError

Overrides

Error.constructor

Properties

cause?

optional cause?: unknown;

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:26

Implementation of

Exception.cause

Inherited from

Error.cause

---

fields

fields: FieldErrors;

Defined in: packages/runtime/src/routeGeneration/templateHelpers.ts:501

---

message

message: string;

Defined in: packages/runtime/src/routeGeneration/templateHelpers.ts:502

Implementation of

Exception.message

Inherited from

Error.message

---

name

name: string = 'ValidateError';

Defined in: packages/runtime/src/routeGeneration/templateHelpers.ts:498

Implementation of

Exception.name

Overrides

Error.name

---

stack?

optional stack?: string;

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Implementation of

Exception.stack

Inherited from

Error.stack

---

status

status: number = 400;

Defined in: packages/runtime/src/routeGeneration/templateHelpers.ts:497

Implementation of

Exception.status

---

stackTraceLimit

static stackTraceLimit: number;

Defined in: packages/runtime/node_modules/@types/node/globals.d.ts:68

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

Error.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: packages/runtime/node_modules/@types/node/globals.d.ts:52

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

Error.captureStackTrace

---

isError()

static isError(error): error is Error;

Defined in: node_modules/typescript/lib/lib.esnext.error.d.ts:23

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

error

unknown

Returns

error is Error

Inherited from

Error.isError

---

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

Defined in: packages/runtime/node_modules/@types/node/globals.d.ts:56

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

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

Inherited from

Error.prepareStackTrace