UnifiedLiveError

Defined in: packages/core/src/errors.ts:109

Base error for all unified-live SDK errors.

Precondition

message is a non-empty string

Precondition

code is a valid ErrorCode

Precondition

context.platform is a non-empty string

Postcondition

instanceof UnifiedLiveError === true for all SDK errors

Idempotency

constructing with the same arguments yields equivalent errors

Extends

Error

Extended by

Constructors

Constructor

new UnifiedLiveError(message, code, context, options?): UnifiedLiveError

Defined in: packages/core/src/errors.ts:113

Parameters

message

string

code

ErrorCode

context

ErrorContext

options?

cause?

Error

Returns

UnifiedLiveError

Overrides

Error.constructor

Properties

cause?

optional cause: unknown

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

Inherited from

Error.cause

code

readonly code: ErrorCode

Defined in: packages/core/src/errors.ts:110

context

readonly context: ErrorContext

Defined in: packages/core/src/errors.ts:111

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@20.19.25/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

Accessors

[toStringTag]

Get Signature

get [toStringTag](): string

Defined in: packages/core/src/errors.ts:134

Returns

string

platform

Get Signature

get platform(): string

Defined in: packages/core/src/errors.ts:130

Backward-compatible getter for context.platform.

Returns

string

the platform name

retryable

Get Signature

get retryable(): boolean

Defined in: packages/core/src/errors.ts:169

Whether this error is transient and the operation may succeed on retry.

Postcondition

auth errors, not found, validation, and parse errors return false

Returns

boolean

true for rate limits, network issues, and server errors

Methods

toJSON()

toJSON(): Record<string, unknown>

Defined in: packages/core/src/errors.ts:144

Structured representation for JSON.stringify and structured logging.

Returns

Record<string, unknown>

a plain object with error details including cause chain

Postcondition

returned object is JSON-serializable

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

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

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@20.19.25/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