Type Alias ConnectionErrorEvent

Connection error event when a user cancels a connection or there is an error during the connection process.

type ConnectionErrorEvent = {
    custom_data: Version;
    error_code: CONNECT_EVENT_ERROR_CODES | null;
    error_message: string;
    is_success: false;
    type: "connection-error";
}

Index

Properties

custom_data error_code error_message is_success type

Properties

custom_data

custom_data: Version

Custom data for the connection.

error_code

error_code: CONNECT_EVENT_ERROR_CODES | null

Error code.

error_message

error_message: string

Reason for the error.

is_success

is_success: false

Connection success flag.

type

type: "connection-error"

Event type.