falkordblite

0.2.0 verified Fri May 01 auth: no javascript

Embedded FalkorDB for Node.js/TypeScript, version 0.2.0. Spins up a local redis-server with the FalkorDB module over a Unix socket — zero-config, no system dependencies. Ships TypeScript types, requires Node >=20, and depends on falkordb ^6.0.0 as a peer for the Graph client API. Differentiators: automatic binary download per platform, seamless migration to remote FalkorDB by changing import, and advanced exports for custom embedding.

Common errors

error TypeError: FalkorDB.open is not a function ↓

cause Using default import instead of named import.

fix

Use: import { FalkorDB } from 'falkordblite'

error Error: Cannot find module 'falkordb' ↓

cause Missing peer dependency.

fix

Install the missing package: npm install falkordb

error Error: ENOENT: no such file or directory, stat '/tmp/falkordblite-XXXXXX/redis.conf' ↓

cause Startup timeout or binary not found.

fix

Increase timeout option or check binary download logs.

error Error: Node.js version must be >=20. Current version: v18.x.x ↓

cause Node.js version too old.

fix

Upgrade Node.js to version 20 or higher.

Warnings

breaking Requires Node >=20; runtime error on older versions. ↓

fix Upgrade Node.js to version 20 or higher.

gotcha Unix socket path length must not exceed the system limit; version 0.2.0 fixes a bug allowing paths at exact limit. ↓

fix Update to 0.2.0 or ensure socket path is within limits.

gotcha Automatically downloads FalkorDB binary on first run; requires internet connectivity and disk write access. ↓

fix Ensure network access or provide custom binary paths via options.

deprecated Insecure temporary file handling in versions before 0.2.0 (fixed in PR #8). ↓

fix Update to 0.2.0 or later.

gotcha peer dependency 'falkordb' must be installed separately for Graph API usage. ↓

fix Run 'npm install falkordb' alongside falkordblite.

Install

npm install falkordblite

yarn add falkordblite

pnpm add falkordblite

Imports

FalkorDB
wrong
```
const FalkorDB = require('falkordblite')
```
correct
```
import { FalkorDB } from 'falkordblite'
```
Named export. CommonJS require is possible but ESM preferred. Version 0.2.0 is ESM-only.
FalkorDB (opening connection)
wrong
```
const db = new FalkorDB()
```
correct
```
const db = await FalkorDB.open()
```
Use static async 'open' method; constructor is not exposed for direct instantiation.
Graph
wrong
```
import { Graph } from 'falkordblite'
```
correct
```
import { Graph } from 'falkordb'
```
Graph type is from the peer package 'falkordb', not re-exported from falkordblite.
ConfigGenerator, ServerManager, BinaryManager
wrong
```
import { ConfigGenerator } from 'falkordblite/dist'
```
correct
```
import { ConfigGenerator } from 'falkordblite'
```
Advanced internal exports available from the main entry.

Quickstart

Creates an embedded FalkorDB instance, runs a Cypher query, and closes cleanly.

import { FalkorDB } from 'falkordblite';

async function main() {
  const db = await FalkorDB.open();
  const graph = db.selectGraph('quickstart');
  const result = await graph.query('RETURN 1');
  console.log(result);
  await db.close();
}

main().catch(console.error);