This package reads object graphs, the format of versions published before 2026.9, and cannot load
bundle versions. For new work, see Load a bundle in your own
code, or Load a bundle in your Viewer
app if you render with
@speckle/viewer.Overview
@speckle/objectloader2 is a JavaScript/TypeScript package for loading and traversing Speckle object graphs. It provides utilities for working with the object-based data model in web and Node.js applications. Dispatch on Version.schemaVersion before you load: null is an object graph this package reads, 3 is a bundle it cannot.
Package: @speckle/objectloader2 on npm
Installation
Quick Start
Loaders are built throughObjectLoader2Factory, not constructed directly.
createFromObjects(objects) and createFromJSON(json) build a loader over objects you
already hold, with objects[0] as the root.
Features
- Load Speckle objects by ID
- Traverse object hierarchies
- Construct complete object graphs
- Support for references and proxies