Class: NlqdbApiError

Defined in: packages/sdk/src/index.ts:1094

Thrown on every failure path (non-2xx, transport, abort, non-JSON proxy body). Branch on err.code — the stable contract is code / httpStatus / body. Treat err.message as debug text only: its format varies by path (e.g. "nlqdb: /v1/ask → 429 rate_limited" vs "nlqdb: /v1/ask network error"), so a surface that renders it verbatim gets unstable copy — render body.message / a code-derived CTA instead (GLOBAL-012). httpStatus === 0 signals a transport-level failure (network / abort) — no response was received.

Extends

• Error

Constructors

Constructor

new NlqdbApiError(
   message,
   httpStatus,
   code,
   path,
   body,
   options?): NlqdbApiError;

Defined in: packages/sdk/src/index.ts:1096

Parameters

Parameter	Type
message	string
httpStatus	number
code	ApiErrorCode
path	string
body	ApiErrorBody | null
options?	{ cause?: unknown; }
options.cause?	unknown

Returns

NlqdbApiError

Overrides

Error.constructor

Properties

Property	Modifier	Type	Default value	Description	Overrides	Inherited from	Defined in
body	readonly	ApiErrorBody | null	undefined	-	-	-	packages/sdk/src/index.ts:1101
cause?	public	unknown	undefined	The cause of the error.	-	Error.cause	node_modules/.bun/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.error.d.ts:26
code	readonly	ApiErrorCode	undefined	-	-	-	packages/sdk/src/index.ts:1099
httpStatus	readonly	number	undefined	-	-	-	packages/sdk/src/index.ts:1098
message	public	string	undefined	-	-	Error.message	node_modules/.bun/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1077
name	readonly	"NlqdbApiError"	"NlqdbApiError"	-	Error.name	-	packages/sdk/src/index.ts:1095
path	readonly	string	undefined	-	-	-	packages/sdk/src/index.ts:1100
stack?	public	string	undefined	-	-	Error.stack	node_modules/.bun/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1078
stackTraceLimit	static	number	undefined	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.	-	Error.stackTraceLimit	node_modules/.bun/@types+node@20.19.43/node_modules/@types/node/globals.d.ts:68

Methods

captureStackTrace()

Call Signature

static captureStackTrace(targetObject, constructorOpt?): void;

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

Parameter	Type
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

Parameter	Type
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

Parameter	Type	Description
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()

static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/.bun/@types+node@20.19.43/node_modules/@types/node/globals.d.ts:56

Parameters

Parameter	Type
err	Error
stackTraces	CallSite[]

Returns

any

See

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

Inherited from

Error.prepareStackTrace