API reference

Reference documentation for every public class, type, and helper in the JavaScript SDK. For task-oriented guidance, see the concepts pages.

Sections

• •

  Core classes - Connecting, sessions, transactions, and query execution.

• •

  Query builders - The chainable builders returned by each query method.

• •

  Data types - Classes for SurrealDB-specific values such as RecordId and Duration.

• •

  Utilities - Helpers for building parameterised queries and comparing values.

• •

  Errors - Error classes raised by the SDK.

• •

  TypeScript types - Type definitions and interfaces used throughout the SDK.