falkordb 6.7.0 → 6.8.0

package/README.md

@@ -32,12 +32,10 @@ npm install falkordb
 import { FalkorDB } from 'falkordb';
 
 const db = await FalkorDB.connect({
+    host: 'localhost',
+    port: 6379,
     username: 'myUsername',
-    password: 'myPassword',
-    socket: {
-        host: 'localhost',
-        port: 6379
-    }
+    password: 'myPassword'
 })
 
 console.log('Connected to FalkorDB')
@@ -62,6 +60,33 @@ db.close()
 
 To learn more about Cypher query language check: https://docs.falkordb.com/cypher/
 
+### Connection Options
+
+`host` and `port` are the shorthand for a plain TCP connection and default to `localhost:6379`.
+You can also pass a connection URL:
+
+```typescript
+const db = await FalkorDB.connect({ url: 'falkor://localhost:6379' })
+```
+
+For anything beyond host and port — TLS, connection timeouts, keep-alive — use `socket`, which is
+passed to the underlying [node-redis](https://github.com/redis/node-redis) client:
+
+```typescript
+const db = await FalkorDB.connect({
+    socket: {
+        host: 'localhost',
+        port: 6379,
+        tls: true,
+        connectTimeout: 5000
+    }
+})
+```
+
+`url` sets the connection address, so it overrides the top-level `host` and `port`. Other
+`socket` settings such as TLS and timeouts still apply alongside it. When both are given,
+`socket.host` and `socket.port` take precedence over the top-level `host` and `port`.
+
 #### `.stubs()`
 
 Lists the graphs that are currently offloaded to disk ("stubs"). `db.list()` already includes

package/dist/src/falkordb.d.ts

@@ -46,6 +46,16 @@ export interface FalkorDBOptions {
      * Socket connection properties
      */
     socket?: SocketOptions;
+    /**
+     * Server hostname, shorthand for `socket.host`.
+     * Ignored when `url` or `socket.host` is provided.
+     */
+    host?: string;
+    /**
+     * Server port, shorthand for `socket.port`.
+     * Ignored when `url` or `socket.port` is provided.
+     */
+    port?: number;
     /**
      * ACL username ([see ACL guide](https://redis.io/topics/acl))
      */

package/dist/src/falkordb.js

@@ -21,7 +21,18 @@ async function clientFactory(client) {
 class FalkorDB extends events_1.EventEmitter {
     #client = new nullClient_1.NullClient();
     static async connect(options) {
-        const redisOption = (options ?? {});
+        const { host, port, ...rest } = options ?? {};
+        const redisOption = rest;
+        // Support the top-level `host`/`port` shorthand used by the other FalkorDB
+        // clients by folding them into the socket options node-redis expects.
+        // Explicit `socket` values win, and `url` takes precedence over both.
+        if (!redisOption.url && (host !== undefined || port !== undefined)) {
+            redisOption.socket = {
+                ...(host !== undefined && { host }),
+                ...(port !== undefined && { port }),
+                ...redisOption.socket,
+            };
+        }
         // If the URL is provided, and the protocol is `falkor` replaces it with `redis` for the underline redis client
         // e.g. falkor://localhost:6379 -> redis://localhost:6379
         if (redisOption.url && redisOption.url.startsWith('falkor')) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "falkordb",
-  "version": "6.7.0",
+  "version": "6.8.0",
   "description": "A FalkorDB javascript library",
   "license": "MIT",
   "main": "./dist/index.js",
@@ -39,13 +39,13 @@
     "@tsconfig/node20": "^20.1.4",
     "@types/jest": "^30.0.0",
     "@types/lodash": "^4.17.13",
-    "@types/node": "^25.0.2",
+    "@types/node": "^26.2.0",
     "@typescript-eslint/eslint-plugin": "^8.18.2",
     "@typescript-eslint/parser": "^8.18.2",
     "eslint": "^10.0.1",
     "gh-pages": "^6.2.0",
     "jest": "^30.2.0",
-    "release-it": "^19.0.3",
+    "release-it": "^21.0.2",
     "ts-jest": "^29.4.6",
     "typescript": "^5.9.3"
   },