Class: ValidationError

Raised when request validation fails.

Extends

ParmanaError

Constructors

Constructor

new ValidationError(message, options?): ValidationError

Parameters

message

string

options?

requestId?

string

cause?

unknown

Returns

ValidationError

Overrides

ParmanaError.constructor

Properties

code

readonly code: ErrorCode

Stable machine-readable error code.

Inherited from

ParmanaError.code

requestId?

readonly optional requestId?: string

Optional request identifier.

Inherited from

ParmanaError.requestId

cause?

readonly optional cause?: unknown

Optional underlying cause.

Inherited from

ParmanaError.cause

statusCode?

readonly optional statusCode?: number

The HTTP status of the response this error was made from, for example 403 or 503. Absent when no response was received (a network error or a timeout) and for errors raised by the SDK itself. The Python SDK’s equivalent is status_code.

Inherited from

ParmanaError.statusCode

stackTraceLimit

static stackTraceLimit: number

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

ParmanaError.stackTraceLimit

name

name: string

Inherited from

ParmanaError.name

message

message: string

Inherited from

ParmanaError.message

stack?

optional stack?: string

Inherited from

ParmanaError.stack

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

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

ParmanaError.captureStackTrace

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

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

Inherited from

ParmanaError.prepareStackTrace

​Extends

​Constructors

​Constructor

​Parameters

message

options?

requestId?

cause?

​Returns

​Overrides

​Properties

​code

​Inherited from

​requestId?

​Inherited from

​cause?

​Inherited from

​statusCode?

​Inherited from

​stackTraceLimit

​Inherited from

​name

​Inherited from

​message

​Inherited from

​stack?

​Inherited from

​Methods

​captureStackTrace()

​Parameters

targetObject

constructorOpt?

​Returns

​Inherited from

​prepareStackTrace()

​Parameters

err

stackTraces

​Returns

​See

​Inherited from

Extends

Constructors

Constructor

Parameters

Returns

Overrides

Properties

code

Inherited from

requestId?

Inherited from

cause?

Inherited from

statusCode?

Inherited from

stackTraceLimit

Inherited from

name

Inherited from

message

Inherited from

stack?

Inherited from

Methods

captureStackTrace()

Parameters

Returns

Inherited from

prepareStackTrace()

Parameters

Returns

See

Inherited from