xeokit Core

---

Core types used across the SDK — result handling, errors, events, tasks, progress, and texture transcoding.

---

core holds the small, stable types shared across module boundaries. It has no dependencies on other SDK modules and is safe to import from anywhere.

Features

• SDKResult — return type for fallible SDK operations.
• SDKErrorType — machine-readable error categories.
• SDKInternalException — internal error type for broken invariants and impossible states.
• EventEmitter — typed event wrapper.
• SDKTask / SDKTaskRunner — cooperative task queue with progress reporting.
• SDKProgress — progress snapshot passed to callbacks.
• TextureTranscoder — interface for compressed-texture transcoding.
• EventsLogger — console logger for subscribed events.

Installation

npm install @xeokit/sdk
Copy

Quick Start

1) Branch on SDKResult

import { SDKResult, SDKErrorType } from "@xeokit/sdk/base/core";

const r = doThing();
if (r.ok) {
  useValue(r.value);
} else if (r.type === SDKErrorType.NotSupported) {
  showFallback();
} else {
  console.error(r.error);
}
Copy

2) Subscribe to an EventEmitter

const unsub = viewer.events.onError.subscribe((source, err) => {
  console.warn(`[${source.id}] ${err.error}`);
});

// ...later:
unsub();
Copy