TypeScript SDK

The @warmhub/sdk-ts package provides WarmHubClient, a typed client for reading, writing, and navigating WarmHub repositories. It requires Node.js 22.2 or later, or Bun.

Installation, tokens, client options and error handling are shared with the Python SDK and covered once in the SDK Overview — pick its TypeScript tab. In short:

npm install @warmhub/sdk-ts

For a first query against a live repository, follow Connect via SDK on the Get Started page.

Where to go next

Guides explain how the client behaves:

• Client Surfaces — what each surface on WarmHubClient is for: client.repo, client.thing, client.commit, and the rest.
• Read Semantics — filters, glob matching, search modes, batch reads, and anonymous pagination limits.
• Transient Retry — retry and partial-submission behavior for streamed writes.
• Component Identity — how componentRef attribution works for component-installed records.
• SDK Constants — exported constants such as DEFAULT_API_URL and SDK_VERSION.

Concepts shared with Python: Write Methods, Repository Checkpoints, and Repo Statistics.

Reference: the TypeScript SDK reference covers every export in @warmhub/sdk-ts. The WarmHubClient reference has the signature and description of every client method.