Skip to main content

Class: StreamError

Defined in: packages/agentos/src/core/streaming/StreamingManager.ts:69

Custom error class for errors originating from the StreamingManager. StreamError

Extends​

  • GMIError

Constructors​

Constructor​

new StreamError(message, code, streamId?, clientId?, details?): StreamError

Defined in: packages/agentos/src/core/streaming/StreamingManager.ts:94

Creates an instance of StreamError.

Parameters​

message​

string

The human-readable error message.

code​

string

A specific error code (can be from GMIErrorCode or custom).

streamId?​

string

The ID of the stream involved.

clientId?​

string

The ID of the client involved.

details?​

any

Optional additional context or the underlying error.

Returns​

StreamError

Overrides​

GMIError.constructor

Properties​

cause?​

readonly optional cause: unknown

Defined in: packages/agentos/src/utils/errors.ts:147

Inherited from​

GMIError.cause

clientId?​

readonly optional clientId: string

Defined in: packages/agentos/src/core/streaming/StreamingManager.ts:84

The ID of the client involved in the error, if applicable.

code​

readonly code: string

Defined in: packages/agentos/src/utils/errors.ts:142

Inherited from​

GMIError.code

component?​

readonly optional component: string

Defined in: packages/agentos/src/utils/errors.ts:144

Inherited from​

GMIError.component

details?​

readonly optional details: any

Defined in: packages/agentos/src/utils/errors.ts:143

Inherited from​

GMIError.details

httpStatusCode?​

readonly optional httpStatusCode: number

Defined in: packages/agentos/src/utils/errors.ts:146

Inherited from​

GMIError.httpStatusCode

message​

message: string

Defined in: apps/agentos-live-docs/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from​

GMIError.message

name​

name: string

Defined in: apps/agentos-live-docs/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from​

GMIError.name

stack?​

optional stack: string

Defined in: apps/agentos-live-docs/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from​

GMIError.stack

streamId?​

readonly optional streamId: string

Defined in: packages/agentos/src/core/streaming/StreamingManager.ts:76

The ID of the stream involved in the error, if applicable.

timestamp​

readonly timestamp: string

Defined in: packages/agentos/src/utils/errors.ts:145

Inherited from​

GMIError.timestamp

stackTraceLimit​

static stackTraceLimit: number

Defined in: packages/agentos/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​

GMIError.stackTraceLimit

Methods​

getHttpStatusCode()​

getHttpStatusCode(): number

Defined in: packages/agentos/src/utils/errors.ts:168

Returns​

number

Inherited from​

GMIError.getHttpStatusCode

getUserFriendlyMessage()​

getUserFriendlyMessage(): string

Defined in: packages/agentos/src/utils/errors.ts:176

Returns​

string

Inherited from​

GMIError.getUserFriendlyMessage

toJSON()​

toJSON(): Record<string, any>

Defined in: packages/agentos/src/utils/errors.ts:193

Returns​

Record<string, any>

Inherited from​

GMIError.toJSON

toPlainObject()​

toPlainObject(): Record<string, any>

Defined in: packages/agentos/src/utils/errors.ts:180

Returns​

Record<string, any>

Inherited from​

GMIError.toPlainObject

captureStackTrace()​

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: packages/agentos/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​

GMIError.captureStackTrace

isGMIError()​

static isGMIError(error): error is GMIError

Defined in: packages/agentos/src/utils/errors.ts:197

Parameters​

error​

unknown

Returns​

error is GMIError

Inherited from​

GMIError.isGMIError

prepareStackTrace()​

static prepareStackTrace(err, stackTraces): any

Defined in: packages/agentos/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​

GMIError.prepareStackTrace

wrap()​

static wrap(error, code, message?, componentOrigin?): GMIError

Defined in: packages/agentos/src/utils/errors.ts:201

Parameters​

error​

unknown

code​

string

message?​

string

componentOrigin?​

string

Returns​

GMIError

Inherited from​

GMIError.wrap