@terrantula/sdk

@terrantula/sdk / TerrantulaError

#Class: TerrantulaError

Defined in: packages/sdk/src/helpers.ts:13

Thrown by every SDK method on a non-2xx response.

#Extends

• Error

#Constructors

#Constructor

new TerrantulaError(status, body): TerrantulaError

Defined in: packages/sdk/src/helpers.ts:14

#Parameters

#status

number

#body

unknown

#Returns

TerrantulaError

#Overrides

Error.constructor

#Properties

#body

readonly body: unknown

Defined in: packages/sdk/src/helpers.ts:16

#cause?

optional cause?: unknown

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

The cause of the error.

#Inherited from

Error.cause

#message

message: string

Defined in: node_modules/.bun/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1077

#Inherited from

Error.message

#name

name: string

Defined in: node_modules/.bun/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1076

#Inherited from

Error.name

#stack?

optional stack?: string

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

#Inherited from

Error.stack

#status

readonly status: number

Defined in: packages/sdk/src/helpers.ts:15

#stackTraceLimit

static stackTraceLimit: number

Defined in: node_modules/.bun/@types+node@25.7.0/node_modules/@types/node/globals.d.ts:67

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()

#Call Signature

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.bun/@types+node@25.7.0/node_modules/@types/node/globals.d.ts:51

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

#Call Signature

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.bun/@types+node@20.19.41/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

#Call Signature

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/.bun/bun-types@1.3.14/node_modules/bun-types/globals.d.ts:1042

Create .stack property on a target object

#Parameters

#targetObject

object

#constructorOpt?

Function

#Returns

void

#Inherited from

Error.captureStackTrace

#isError()

static isError(value): value is Error

Defined in: node_modules/.bun/bun-types@1.3.14/node_modules/bun-types/globals.d.ts:1037

Check if a value is an instance of Error

#Parameters

#value

unknown

The value to check

#Returns

value is Error

True if the value is an instance of Error, false otherwise

#Inherited from

Error.isError

#prepareStackTrace()

#Call Signature

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/.bun/@types+node@25.7.0/node_modules/@types/node/globals.d.ts:55

#Parameters

#err

Error

#stackTraces

CallSite[]

#Returns

any

#See

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

#Inherited from

Error.prepareStackTrace

#Call Signature

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/.bun/@types+node@20.19.41/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