QverisApiError

Error thrown for any failed QVeris API interaction: HTTP errors, failure envelopes, timeouts, and network failures.

Carries the same shape as the wire-level ApiError so callers can branch on status and inspect observability for diagnostics.

Extends

• Error

Implements

• ApiError

Constructors

Constructor

new QverisApiError(error): QverisApiError

Parameters

error

ApiError

Returns

QverisApiError

Overrides

Error.constructor

Properties

cause?

readonly optional cause?: string

Lower-level transport or runtime cause when available

Implementation of

ApiError.cause

Overrides

Error.cause

details?

readonly optional details?: unknown

Original error details if available

Implementation of

ApiError.details

message

message: string

Error message

Implementation of

ApiError.message

Inherited from

Error.message

name

name: string

Inherited from

Error.name

observability?

readonly optional observability?: ApiObservability

Request metadata for diagnosing API failures

Implementation of

ApiError.observability

stack?

optional stack?: string

Inherited from

Error.stack

status

readonly status: number

HTTP status code (0 for network errors, 408 for timeouts)

Implementation of

ApiError.status

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

Error.stackTraceLimit

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

Error.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

Error.prepareStackTrace