beamable-sdk / constants/Errors / BeamError

Class: BeamError¶

Defined in: src/constants/Errors.ts:14

Standard error thrown by the Beam SDK. * cause – underlying error. * context – arbitrary debug info.

Extends¶

Error

Extended by¶

Constructors¶

Constructor¶

new BeamError(message, options): BeamError

Defined in: src/constants/Errors.ts:18

Parameters¶

message¶

string

options¶

BeamErrorOptions = {}

Returns¶

BeamError

Overrides¶

Error.constructor

Properties¶

cause?¶

readonly optional cause: unknown

Defined in: src/constants/Errors.ts:15

Overrides¶

Error.cause

context?¶

readonly optional context: Record<string, unknown>

Defined in: src/constants/Errors.ts:16

message¶

message: string

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

Inherited from¶

Error.message

name¶

name: string

Defined in: node_modules/.pnpm/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/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from¶

Error.stack

stackTraceLimit¶

static stackTraceLimit: number

Defined in: node_modules/.pnpm/@types+node@22.19.1/node_modules/@types/node/globals.d.ts:68

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¶

toJSON()¶

toJSON(): Record<string, unknown>

Defined in: src/constants/Errors.ts:41

Returns¶

Record<string, unknown>

A plain object suitable for logging or serializing.

captureStackTrace()¶

static captureStackTrace(targetObject, constructorOpt?): void

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

is()¶

static is(err): err is BeamError

Defined in: src/constants/Errors.ts:34

Checks if the given error is a BeamError or any of its subclasses.

Parameters¶

err¶

unknown

Returns¶

err is BeamError

isError()¶

static isError(error): error is Error

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.esnext.error.d.ts:23

Indicates whether the argument provided is a built-in Error instance or not.

Parameters¶

error¶

unknown

Returns¶

error is Error

Inherited from¶

Error.isError

prepareStackTrace()¶

static prepareStackTrace(err, stackTraces): any

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