@acodeninja/persist 3.1.0-next.2 → 3.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@acodeninja/persist",
-  "version": "3.1.0-next.2",
+  "version": "3.1.0",
   "description": "A JSON based data modelling and persistence module with alternate storage mechanisms.",
   "type": "module",
   "scripts": {

package/src/Connection.js

@@ -483,10 +483,10 @@ export default class Connection {
      * Retrieve a search index to query at your leisure.
      *
      * @param {Model.constructor} modelConstructor
-     * @return {SearchIndex}
+     * @return {Promise<SearchIndex>}
      */
-    async getSearchIndex(modelConstructor) {
-        return await this.#storage.getSearchIndex(modelConstructor)
+    getSearchIndex(modelConstructor) {
+        return this.#storage.getSearchIndex(modelConstructor)
             .then(index => new SearchIndex(modelConstructor, index));
     }
 
@@ -504,13 +504,13 @@ export default class Connection {
     }
 
     /**
-     * Retrieve a index to query at your leisure.
+     * Retrieve an index to query at your leisure.
      *
      * @param {Model.constructor} modelConstructor
-     * @return {FindIndex}
+     * @return {Promise<FindIndex>}
      */
-    async getIndex(modelConstructor) {
-        return await this.#storage.getIndex(modelConstructor)
+    getIndex(modelConstructor) {
+        return this.#storage.getIndex(modelConstructor)
             .then(index => new FindIndex(modelConstructor, index));
     }
 

package/src/data/SearchIndex.js

@@ -13,7 +13,7 @@ export class SearchResult {
 }
 
 /**
- * A full-text search index wrapper using Lunr.js for a given model.
+ * A full-text search index wrapper using Fuse.js for a given model.
  * Supports indexing and querying model data.
  *
  * @class SearchIndex
@@ -39,7 +39,7 @@ export default class SearchIndex {
     }
 
     /**
-     * Performs a search query on the compiled Lunr index.
+     * Performs a search query on the compiled index.
      *
      * @param {string} query - The search string.
      * @return {Array<SearchResult>} An array of search results with model instances and scores.
@@ -51,18 +51,18 @@ export default class SearchIndex {
     }
 
     /**
-     * Lazily compiles and returns the Lunr index instance.
+     * Lazily compiles and returns the index instance.
      *
-     * @return {Fuse} The compiled Lunr index.
+     * @return {Fuse} The compiled index.
      */
     get searchIndex() {
         return this.#compiledIndex ?? this.#compileIndex();
     }
 
     /**
-     * Compiles the Lunr index using the model's search properties.
+     * Compiles the index using the model's search properties.
      *
-     * @return {Fuse} The compiled Lunr index.
+     * @return {Fuse} The compiled index.
      * @private
      */
     #compileIndex() {