JavaScript / TypeScript SDK

The @localvectordb/sdk package provides a TypeScript-first client for interacting with LocalVectorDB servers from Node.js and browser applications. It mirrors the Python RemoteVectorDB client’s API surface, giving JavaScript and TypeScript developers full access to all LocalVectorDB server features.

Key characteristics:

• Zero runtime dependencies — uses only the built-in fetch API

• TypeScript-first — full type safety with hand-written interfaces and overloaded signatures

• Dual format — ships as both ESM and CommonJS

• Cross-platform — works in Node.js 18+, modern browsers, Deno, Bun, and edge runtimes

• Typed errors — error class hierarchy mirroring server error codes for precise catch handling

• Streaming — async generator-based SSE streaming via for await

• Quick Start
  • Installation
  • Basic Usage
  • Configuration
  • Python Comparison
• LocalVectorDBClient
  • Creating a Client
  • Database Handles
  • Database Management
  • Health & System Info
  • Cross-Database Operations
  • ClientConfig Reference
• DatabaseHandle
  • Database Info
  • Document Operations
  • Search Operations
  • Schema Management
  • Embeddings
  • Document Comparison
  • Tuning & Maintenance
  • QueryOptions Reference
• Streaming Queries
  • Basic Usage
  • With Options
  • Cancellation
  • Collecting Results
  • Error Handling
  • How It Works
• File Upload
  • Browser
  • Node.js
  • Upload Options
  • UploadableFile Type
• Error Handling
  • Error Hierarchy
  • Catching Errors
  • Error Properties
  • Retry Behavior
• Examples
  • RAG (Retrieval-Augmented Generation)
  • Document Ingestion Pipeline
  • Express.js Search API
  • Browser Search Widget
  • Multi-Database Comparison
  • Streaming Progress