HelixDB Docs

helix-ts is a TypeScript library for interacting with helix-db a powerful graph-vector database written in rust. It enables intuitive and type-safe access to graph-based and vector-based queries, making it ideal for building knowledge graphs, search systems, and LLM pipelines.

Installation

npm install helix-ts

Quick Start

import HelixDB from "helix-ts";

async function main() {
    const client = new HelixDB("http://localhost:6969");

    const result = await client.query("AddUser", {
        name: "Alice",
        age: 25,
    });

    console.log("Created user:", result);
}

main().catch((err) => {
    console.error("AddUser query failed:", err);
});

QUERY AddUser(name: String, age: U8) =>
    user <- AddN<User>({
        name: name,
        age: age
    })
    RETURN user

N::User {
    name: String,
    age: U8
}

Configuration

Custom Endpoint

const client = new HelixDB("https://my-endpoint.com:8080");