{"id":25569,"library":"falkordblite","title":"falkordblite","description":"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.","status":"active","version":"0.2.0","language":"javascript","source_language":"en","source_url":"https://github.com/FalkorDB/falkordblite-ts","tags":["javascript","falkordb","graph","database","embedded","redis","cypher","typescript"],"install":[{"cmd":"npm install falkordblite","lang":"bash","label":"npm"},{"cmd":"yarn add falkordblite","lang":"bash","label":"yarn"},{"cmd":"pnpm add falkordblite","lang":"bash","label":"pnpm"}],"dependencies":[{"reason":"Peer dependency; provides the Graph API (query, roQuery, etc.) and client connection.","package":"falkordb","optional":true}],"imports":[{"note":"Named export. CommonJS require is possible but ESM preferred. Version 0.2.0 is ESM-only.","wrong":"const FalkorDB = require('falkordblite')","symbol":"FalkorDB","correct":"import { FalkorDB } from 'falkordblite'"},{"note":"Use static async 'open' method; constructor is not exposed for direct instantiation.","wrong":"const db = new FalkorDB()","symbol":"FalkorDB (opening connection)","correct":"const db = await FalkorDB.open()"},{"note":"Graph type is from the peer package 'falkordb', not re-exported from falkordblite.","wrong":"import { Graph } from 'falkordblite'","symbol":"Graph","correct":"import { Graph } from 'falkordb'"},{"note":"Advanced internal exports available from the main entry.","wrong":"import { ConfigGenerator } from 'falkordblite/dist'","symbol":"ConfigGenerator, ServerManager, BinaryManager","correct":"import { ConfigGenerator } from 'falkordblite'"}],"quickstart":{"code":"import { FalkorDB } from 'falkordblite';\n\nasync function main() {\n  const db = await FalkorDB.open();\n  const graph = db.selectGraph('quickstart');\n  const result = await graph.query('RETURN 1');\n  console.log(result);\n  await db.close();\n}\n\nmain().catch(console.error);","lang":"typescript","description":"Creates an embedded FalkorDB instance, runs a Cypher query, and closes cleanly."},"warnings":[{"fix":"Upgrade Node.js to version 20 or higher.","message":"Requires Node >=20; runtime error on older versions.","severity":"breaking","affected_versions":">=0.1.0"},{"fix":"Update to 0.2.0 or ensure socket path is within limits.","message":"Unix socket path length must not exceed the system limit; version 0.2.0 fixes a bug allowing paths at exact limit.","severity":"gotcha","affected_versions":"<0.2.0"},{"fix":"Ensure network access or provide custom binary paths via options.","message":"Automatically downloads FalkorDB binary on first run; requires internet connectivity and disk write access.","severity":"gotcha","affected_versions":">=0.1.0"},{"fix":"Update to 0.2.0 or later.","message":"Insecure temporary file handling in versions before 0.2.0 (fixed in PR #8).","severity":"deprecated","affected_versions":"<0.2.0"},{"fix":"Run 'npm install falkordb' alongside falkordblite.","message":"peer dependency 'falkordb' must be installed separately for Graph API usage.","severity":"gotcha","affected_versions":">=0.1.0"}],"env_vars":null,"last_verified":"2026-05-01T00:00:00.000Z","next_check":"2026-07-30T00:00:00.000Z","problems":[{"fix":"Use: import { FalkorDB } from 'falkordblite'","cause":"Using default import instead of named import.","error":"TypeError: FalkorDB.open is not a function"},{"fix":"Install the missing package: npm install falkordb","cause":"Missing peer dependency.","error":"Error: Cannot find module 'falkordb'"},{"fix":"Increase timeout option or check binary download logs.","cause":"Startup timeout or binary not found.","error":"Error: ENOENT: no such file or directory, stat '/tmp/falkordblite-XXXXXX/redis.conf'"},{"fix":"Upgrade Node.js to version 20 or higher.","cause":"Node.js version too old.","error":"Error: Node.js version must be >=20. Current version: v18.x.x"}],"ecosystem":"npm","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}