jexidb 2.0.1 → 2.0.2

package/README.md

@@ -21,22 +21,18 @@ npm install jexidb
 
 ## 🚀 Quick Start
 
+### ESM
+
 ```javascript
-// import { Database } from 'jexidb'
-const { Database } = require('jexidb');
+import Database from 'jexidb';
 
-// Create database with indexes (supports both .jdb and .jsonl)
+// Prefer default import aliased as Database for clarity
 const db = new Database('./users.jdb', {
-  indexes: {
-    id: 'number',
-    email: 'string',
-    age: 'number'
-  },
+  indexes: { id: 'number', email: 'string', age: 'number' },
   autoSave: true,
   validateOnInit: true
 });
 
-// Initialize
 await db.init();
 
 // Event listeners
@@ -45,12 +41,7 @@ db.on('update', (record, index) => console.log(`Record updated at index ${index}
 db.on('save', () => console.log('Changes saved'));
 
 // Insert data
-const user = await db.insert({
-  id: 1,
-  name: 'John Doe',
-  email: 'john@example.com',
-  age: 30
-});
+await db.insert({ id: 1, name: 'John Doe', email: 'john@example.com', age: 30 });
 
 // Search data (both methods work)
 const john = await db.findOne({ id: 1 });
@@ -59,19 +50,31 @@ const youngUsers = await db.find({ age: { '<': 30 } });
 // JexiDB 1.x compatible query
 const results = await db.query({ name: 'john doe' }, { caseInsensitive: true });
 
-// Update data
+// Update / Delete / Save
 await db.update({ id: 1 }, { age: 31 });
-
-// Remove data
 await db.delete({ id: 1 });
-
-// Save changes
 await db.save();
-
-// Destroy database
 await db.destroy();
 ```
 
+### CommonJS
+
+```javascript
+const Database = require('jexidb');
+// Alternatively (backward compatible): const { Database } = require('jexidb');
+
+const db = new Database('./users.jdb', {
+  indexes: { id: 'number', email: 'string', age: 'number' }
+});
+
+(async () => {
+  await db.init();
+  await db.insert({ id: 1, name: 'John' });
+  console.log(await db.findOne({ id: 1 }));
+  await db.destroy();
+})();
+```
+
 ## 📚 API Reference
 
 ### Constructor

package/dist/index.js

@@ -3,6 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.Database = void 0;
 Object.defineProperty(exports, "FileHandler", {
   enumerable: true,
   get: function () {
@@ -207,11 +208,15 @@ class JexiDBCompatibility extends _JSONLDatabase.default {
   }
 
   /**
-   * Compatibility method: walk() -> find() with async iteration
+   * Streaming iterator over records without loading all into memory
+   * Supports a limited subset of options: { limit }
    */
   async *walk(options = {}) {
-    const results = await this.find({}, options);
-    for (const record of results) {
+    // Delegate to core engine streaming implementation
+    // Ensure pending inserts are flushed by calling super.walk
+    for await (const record of super.walk({
+      limit: options.limit
+    })) {
       yield record;
     }
   }
@@ -289,7 +294,11 @@ class JexiDBCompatibility extends _JSONLDatabase.default {
  */
 
 // Export the compatibility wrapper as default
-var _default = exports.default = JexiDBCompatibility; // Export auxiliary classes for advanced use
+var _default = exports.default = JexiDBCompatibility; // Retrocompat: named export 'Database' (JexiDB v1 used { Database })
+const Database = exports.Database = JexiDBCompatibility;
+
+// Export auxiliary classes for advanced use
+
 // Export useful constants
 const OPERATORS = exports.OPERATORS = {
   GT: '>',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jexidb",
-  "version": "2.0.1",
+  "version": "2.0.2",
   "description": "JexiDB - A fast and reliable local CRUD database for Electron apps with pure JavaScript JSONL architecture",
   "main": "./dist/index.js",
   "module": "./src/index.js",

package/src/index.js

@@ -183,11 +183,13 @@ class JexiDBCompatibility extends JSONLDatabase {
   }
 
   /**
-   * Compatibility method: walk() -> find() with async iteration
+   * Streaming iterator over records without loading all into memory
+   * Supports a limited subset of options: { limit }
    */
   async *walk(options = {}) {
-    const results = await this.find({}, options);
-    for (const record of results) {
+    // Delegate to core engine streaming implementation
+    // Ensure pending inserts are flushed by calling super.walk
+    for await (const record of super.walk({ limit: options.limit })) {
       yield record;
     }
   }
@@ -266,6 +268,8 @@ class JexiDBCompatibility extends JSONLDatabase {
 
 // Export the compatibility wrapper as default
 export default JexiDBCompatibility;
+// Retrocompat: named export 'Database' (JexiDB v1 used { Database })
+export const Database = JexiDBCompatibility;
 
 // Export auxiliary classes for advanced use
 export { FileHandler, IndexManager, IntegrityChecker };