Class ErrorInfo

A generic Ably error object that contains an Ably-specific status code, and a generic status code. Errors returned from the Ably server are compatible with the ErrorInfo structure and should result in errors that inherit from ErrorInfo.

Hierarchy

  • Error
    • ErrorInfo

Constructors

constructor

Properties

cause? code detail? hint? message name stack? statusCode prepareStackTrace? stackTraceLimit

Methods

captureStackTrace

Constructors

constructor

  • Construct an ErrorInfo object.

    Parameters

    • message: string

      A string describing the error.

    • code: number

      Ably error code.

    • statusCode: number

      HTTP Status Code corresponding to this error.

    • Optional cause: ErrorInfo

      The underlying cause of the error.

    • Optional detail: Record<string, string>

      Optional map of string key-value pairs containing structured metadata associated with the error.

    Returns ErrorInfo

Properties

Optional cause

cause?: ErrorInfo

The underlying cause of the error, where applicable.

code

code: number

Ably error code.

Optional detail

detail?: Record<string, string>

Optional map of string key-value pairs containing structured metadata associated with the error.

Optional hint

hint?: string

Actionable remediation guidance describing how to fix the error — distinct from message, which summarises what went wrong. Written as prose suitable for an agent or human to act on without further lookup (typically including the canonical replacement call and a doc link where applicable). Present only on SDK-originating errors that have meaningful remediation steps.

message

message: string

Additional message information, where available.

name

name: string

Optional stack

stack?: string

statusCode

statusCode: number

HTTP Status Code corresponding to this error, where applicable.

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Type declaration

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc