Skip to content

TypeScript SDK

TypeScript/JavaScript client for HeliosDB-Lite server.

Installation

npm install heliosdb-lite
# or
yarn add heliosdb-lite

Quick Start

import { HeliosDBClient } from 'heliosdb-lite';

const client = new HeliosDBClient({
  baseUrl: 'http://localhost:8080',
  apiKey: 'your-api-key',
  branch: 'main'
});

// Query
const result = await client.query('SELECT * FROM users');
console.log(result.rows);

// With parameters
const users = await client.query(
  'SELECT * FROM users WHERE id = $1',
  [1]
);

await client.close();
const results = await client.vectorSearch('documents', 'search query', {
  topK: 10,
  minScore: 0.5,
  filter: { category: 'tech' }
});

for (const result of results) {
  console.log(`${result.id}: ${result.score}`);
}

Branching

await client.createBranch('dev', 'main');
await client.mergeBranch('dev', 'main');

Agent Memory

await client.memoryAdd('session_123', 'user', 'Hello!');
const messages = await client.memoryGet('session_123', 50);
const relevant = await client.memorySearch('session_123', 'query', 5);

See API Reference for complete documentation.