Class: EngineError

Structured CE.SDK error. Extends the standard JS Error so existing try { ... } catch (error) { console.log(error.message); } flows keep working — message is the engine’s rendered English string. The structured fields (code, category, hint, args, docsUrl, silent) let consumers branch on stable identifiers instead of matching on the message string and surface customer-facing copy + doc links.

Every engine error carries a stable, non-empty catalog code. Branch on the codes you handle and keep a default fallback to the message for the rest — the catalog is append-only, so existing codes never change meaning but new codes ship over time.

The error’s name embeds the code ("EngineError [SCENE.NOT_VALID]"), so stack traces and String(error) identify the failure without inspecting fields. Don’t match on name — narrow with isEngineError (or instanceof) and branch on code.

When logging to an external service, note that JSON.stringify(error) serializes the structured own fields but — as with any Error — omits message and stack. Extract the payload explicitly, e.g. { code: error.code, message: error.message, hint: error.hint, args: error.args }.

Example#

try {
  engine.block.setTextFontSize(blockId, 0);
} catch (error) {
  if (error instanceof EngineError && error.code === 'BLOCK.TEXT_INVALID_FONT_SIZE') {
    toast.show(t(`error.${camelCase(error.code)}`, error.args));
    if (error.docsUrl) window.open(error.docsUrl);
  } else {
    throw error;
  }
}

Extends#

• Error

Constructors#

Error.constructor

Error.constructor

Methods#

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Error.captureStackTrace

captureStackTrace(targetObject: object, constructorOpt?: Function): void

Error.prepareStackTrace

prepareStackTrace(err: Error, stackTraces: CallSite[]): any

Properties#