EmbedErrorDetailsEvent

Table of Contents

Properties
Usage
Index
Properties
- code
- errorType
- message

Error event object emitted when an error occurs in an embedded component.

This interface defines the structure of error objects returned by the EmbedEvent.Error event. It provides detailed information about what went wrong, including the error type, a human-readable message, and a machine-readable error code.

Properties🔗

errorType: One of the predefined ErrorDetailsTypes values
message: Human-readable error description (string or array of strings for multiple errors)
code: Machine-readable error identifier EmbedErrorCodes values
[key: string]: Additional context-specific for backward compatibility

Usage🔗

Listen to the EmbedEvent.Error event to receive instances of this object and implement appropriate error handling logic based on the errorType.

Version : SDK: 1.44.2 | ThoughtSpot: 26.2.0.cl

Handle specific error types

embed.on(EmbedEvent.Error, (error) => {
  switch (error.code) {
    case EmbedErrorCodes.WORKSHEET_ID_NOT_FOUND:
      console.error('Worksheet ID not found:', error.message, error.code);
      break;
    default:
      console.error('Unknown error:', error);
  }
});

Handle multiple error messages

embed.on(EmbedEvent.Error, (error) => {
  const messages = Array.isArray(error.message)
    ? error.message
    : [error.message];
  messages.forEach(msg => console.error(msg));
});

Index🔗

code

errorType

message

Properties🔗

code🔗

code: EmbedErrorCodes

Machine-readable error code for programmatic error handling

errorType🔗

errorType: ErrorDetailsTypes

The type of error that occurred

message🔗

message: string | string[]

Human-readable error message(s) describing what went wrong