js-bao-wss-client

---

js-bao-wss-client / JsBaoApiError

Class: JsBaoApiError

Thrown when the server responds with a non-2xx HTTP status. Carries the machine-readable signals apps need to branch on error kind without parsing the message string:

• status — the HTTP status code (always present).
• code — the stable, machine-readable cause. Every 4xx/5xx response the platform produces carries one: the handler's own code where it has one (DOC_ACCESS_DENIED, WORKFLOW_ARCHIVED, VALIDATION_FAILED, …), otherwise a status-derived default (NOT_FOUND, ACCESS_DENIED, UNAUTHENTICATED, INTERNAL_ERROR, …). Branch and localize on this; message and the body's error text may change without notice. undefined means the response did NOT come from the platform's error path — an older server, or an intermediary that answered on its own (a proxy's HTML error page).
• body — the parsed JSON error body ({ error, status, timestamp, code, details? }), or the raw response text for a non-JSON body, or null for an empty body.

The message keeps the legacy HTTP <status>: <text> prefix so existing apps that regex-parse .message keep working — this class is purely additive.

Extends

• Error

Constructors

Constructor

new JsBaoApiError(status, text, body?, code?): JsBaoApiError

Parameters

status

number

text

string

body?

unknown

code?

string

Returns

JsBaoApiError

Overrides

Error.constructor

Properties

body?

readonly optional body?: unknown

---

code?

readonly optional code?: string

---

message

message: string

Inherited from

Error.message

---

name

name: string

Inherited from

Error.name

---

stack?

optional stack?: string

Inherited from

Error.stack

---

status

readonly status: number

---

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