API Reference

Full TypeScript API documentation generated from source code using TypeDoc.

Exports

All public exports are available from the main package entry:

import {
  // Adapters
  SheetsAdapter,
  GoogleSheetsAdapter,

  // Query Engine
  Database,

  // Schema
  schema,
  field,
  FieldBuilder,

  // Errors
  SheetsError,
  ConnectionError,
  SheetNotFoundError,
  RowNotFoundError,
  ModelNotFoundError,
  RecordNotFoundError,
  UniqueConstraintError,
  ValidationError,
  SchemaValidationError,

  // Types
  SheetConfig,
  SpreadsheetInfo,
  SheetInfo,
  ClientInitializerGoogle,
  WhereClause,
  FindManyOptions,
  FieldMetadata,
  ModelMetadata,
  SchemaMetadata,
  SupportedFieldType,
} from 'open-sheets-orm';

Sections

Browse the TypeDoc-generated reference for detailed parameter types, return values, and thrown exceptions for every exported symbol.