@ably/chat - v2.0.0
    Preparing search index...

    Interface ErrorInfo

    The runtime ErrorInfo, of which there is exactly one copy, here, so that an error raised by any Pub/Sub package or any SDK layered on it passes instanceof ErrorInfo against the class imported from any other.

    Its instances are exactly the API's ErrorInfo, so an error read off a client is assignable to it. It adds the factories that the SDKs layered on Pub/Sub build their own errors with.

    interface ErrorInfo {
        cause?: ErrorInfo;
        code: number;
        detail?: Record<string, string>;
        message: string;
        name: string;
        remediation?: string;
        stack?: string;
        statusCode: number;
    }

    Hierarchy

    Index

    Properties

    cause? code detail? message name remediation? stack? statusCode

    Properties

    cause?: ErrorInfo

    The underlying cause of the error, where applicable.

    code: number

    Ably error code.

    detail?: Record<string, string>

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

    message: string

    Additional message information, where available.

    name: string
    remediation?: string

    Actionable 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.

    stack?: string
    statusCode: number

    HTTP Status Code corresponding to this error, where applicable.

    Settings

    Member Visibility

    On This Page

    Properties