falkordblite

library0.2.0jsnpmunverified

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.

database vector-search ai-ml

npm install falkordblite

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · FALKORDBLITE

falkordblite

databasejavascriptv0.2.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

FalkorDB

✓ import { FalkorDB } from 'falkordblite'

✗ const FalkorDB = require('falkordblite')

Named export. CommonJS require is possible but ESM preferred. Version 0.2.0 is ESM-only.

FalkorDB (opening connection)

✓ const db = await FalkorDB.open()

✗ const db = new FalkorDB()

Use static async 'open' method; constructor is not exposed for direct instantiation.

Graph

✓ import { Graph } from 'falkordb'

✗ import { Graph } from 'falkordblite'

Graph type is from the peer package 'falkordb', not re-exported from falkordblite.

ConfigGenerator, ServerManager, BinaryManager

✓ import { ConfigGenerator } from 'falkordblite'

✗ import { ConfigGenerator } from 'falkordblite/dist'

Advanced internal exports available from the main entry.

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);

Debug

Known issues

breakingRequires Node >=20; runtime error on older versions.

fix

Upgrade Node.js to version 20 or higher.

affects: >=0.1.0

gotchaUnix 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.

affects: <0.2.0

gotchaAutomatically downloads FalkorDB binary on first run; requires internet connectivity and disk write access.

fix

Ensure network access or provide custom binary paths via options.

affects: >=0.1.0

deprecatedInsecure temporary file handling in versions before 0.2.0 (fixed in PR #8).

fix

Update to 0.2.0 or later.

affects: <0.2.0

gotchapeer dependency 'falkordb' must be installed separately for Graph API usage.

fix

Run 'npm install falkordb' alongside falkordblite.

affects: >=0.1.0

Errors

Common errors & fixes

TypeError: FalkorDB.open is not a function

Using default import instead of named import.

fix

Use: import { FalkorDB } from 'falkordblite'

Error: Cannot find module 'falkordb'

Missing peer dependency.

fix

Install the missing package: npm install falkordb

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

Startup timeout or binary not found.

fix

Increase timeout option or check binary download logs.

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

Node.js version too old.

fix

Upgrade Node.js to version 20 or higher.

Upgrade

Version history

0.2.0latest on npm

Audit

Dependencies

falkordboptionalPeer dependency; provides the Graph API (query, roQuery, etc.) and client connection.

Agent activity

51 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/FalkorDB/falkordblite-ts ↗

packagehttps://www.npmjs.com/package/falkordblite ↗

homepagehttps://www.falkordb.com ↗