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

Constructors

constructor

Properties

cause code 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: string | Types.ErrorInfo | Error

      The underlying cause of the error.

    Returns Types.ErrorInfo

Properties

Optional cause

cause?: string | Types.ErrorInfo | Error

The underlying cause of the error, where applicable.

code

code: number

Ably error code.

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: Error, stackTraces: CallSite[]) => 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

Generated using TypeDoc