Interface KumaErrorEvent

When an error occurs during evaluation by the WebSocket Server, this error message will be provided to the message handler.

interface KumaErrorEvent {
    type: "error";
    data: {
        code: string;
        message: string;
    };
    cid?: string;
    subscriptions?: unknown[];
}

Hierarchy (view full)

Properties

type data cid? subscriptions?

Properties

type

type: "error"

The type property is used to determine the shape of the data property of the update event.

  • Subscription update events will match KumaSubscriptionEventBase with the subscription name as the value for the type property.
  • Otherwise the type will be:
    • subscriptions if you requested a list of all current subscriptions
    • error if your request resulted in a server error

See

enum MessageEventType

data

data: {
    code: string;
    message: string;
}

The data object will change based on the type of the message.

Type declaration

  • code: string

    error short code

  • message: string

    human readable error message

Optional cid

cid?: string

If the request provided a cid parameter, the response will include the cid provided.

Optional subscriptions

subscriptions?: unknown[]

A list of all active subscriptions if the type is subscriptions

Settings

Member Visibility

Theme

On This Page

typedatacidsubscriptions