Skip to main content

Overview

@speckle/objectloader2 is a JavaScript/TypeScript package for loading and traversing Speckle objects. It provides utilities for working with Speckle’s object-based data model in web and Node.js applications. Package: @speckle/objectloader2 on npm
This package reads object graphs, so a 2026.9 bundle version is not loadable through it — the objects endpoints return 404. Start from Building applications in 2026.9 for the load path to move to.
Compatibility mode keeps a workspace’s versions in the object-graph format until it ends on 1 November 2026. See Compatibility mode.

Installation

Quick Start

Loaders are built through ObjectLoader2Factory, 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

Documentation

For complete documentation, examples, and API reference, visit the package on npm: View on npm →:
This documentation is a stub. Full documentation coming soon. For now, refer to the npm package page for detailed usage examples and API documentation.
Last modified on September 29, 2026