Class StreamError

Custom error class for errors originating from the StreamingManager. StreamError

Hierarchy

GMIError
- StreamError

Index

Constructors

Methods

getHttpStatusCode getUserFriendlyMessage toPlainObject toJSON isGMIError wrap

Properties

streamId? clientId? code details? component? timestamp httpStatusCode? cause?

Constructors

constructor

new StreamError(message, code, streamId?, clientId?, details?): StreamError
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).
- Optional streamId: string
  The ID of the stream involved.
- Optional clientId: string
  The ID of the client involved.
- Optional details: any
  Optional additional context or the underlying error.
Returns StreamError
Overrides GMIError.constructor
- Defined in core/streaming/StreamingManager.ts:94

Methods

getHttpStatusCode

getHttpStatusCode(): number
Returns number
Inherited from GMIError.getHttpStatusCode
- Defined in utils/errors.ts:168

getUserFriendlyMessage

getUserFriendlyMessage(): string
Returns string
Inherited from GMIError.getUserFriendlyMessage
- Defined in utils/errors.ts:176

toPlainObject

toPlainObject(): Record<string, any>
Returns Record<string, any>
Inherited from GMIError.toPlainObject
- Defined in utils/errors.ts:180

toJSON

toJSON(): Record<string, any>
Returns Record<string, any>
Inherited from GMIError.toJSON
- Defined in utils/errors.ts:193

`Static` isGMIError

isGMIError(error): error is GMIError
Parameters
- error: unknown
Returns error is GMIError
Inherited from GMIError.isGMIError
- Defined in utils/errors.ts:197

`Static` wrap

wrap(error, code, message?, componentOrigin?): GMIError
Parameters
- error: unknown
- code: string
- Optional message: string
- Optional componentOrigin: string
Returns GMIError
Inherited from GMIError.wrap
- Defined in utils/errors.ts:201

Properties

`Optional` `Readonly` streamId

streamId?: string

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

`Optional` `Readonly` clientId

clientId?: string

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

`Readonly` code

code: string

`Optional` `Readonly` details

details?: any

`Optional` `Readonly` component

component?: string

`Readonly` timestamp

timestamp: string

`Optional` `Readonly` httpStatusCode

httpStatusCode?: number

`Optional` `Readonly` cause

cause?: unknown