added EVENTS endpoint that emits a 'ready' event immediately after in…

…itialisation
fergiemcdowall · Aug 27, 2024 · c7d852a · c7d852a
1 parent dadba8e
commit c7d852a
Show file tree

Hide file tree

Showing 7 changed files with 27 additions and 10 deletions.
diff --git a/dist/search-index-5.0.0.js b/dist/search-index-5.0.0.js
diff --git a/dist/search-index-esm-5.0.0.js b/dist/search-index-esm-5.0.0.js
diff --git a/dist/search-index.js b/dist/search-index.js
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "search-index",
-  "version": "5.0.0",
+  "version": "5.1.0",
   "description": "A network resilient, persistent full-text search library for the browser and Node.js",
   "keywords": [
     "search",
@@ -75,7 +75,7 @@
   "dependencies": {
     "browser-level": "^1.0.1",
     "classic-level": "^1.4.1",
-    "fergies-inverted-index": "13.0.0",
+    "fergies-inverted-index": "13.1.0",
     "lru-cache": "11.0.0",
     "ngraminator": "3.0.2",
     "p-queue": "8.0.1",

diff --git a/src/SearchIndex.js b/src/SearchIndex.js
@@ -52,6 +52,7 @@ export class SearchIndex {
       tokenizer: defaultPipeline,
       ...ops
     }
+
     this.INDEX = new InvertedIndex({
       ...ops,
       // isLeaf must be like so and is not a user defined option
@@ -65,6 +66,10 @@ export class SearchIndex {
             item === null
         )
     })
+
+    // event bus
+    this.EVENTS = this.INDEX.EVENTS
+
     // Now that constructor is not async- not sure where this should be called...
     this._CACHE = new LRUCache({ max: ops.cacheLength })
     this.r = new Reader(ops, this._CACHE, this.INDEX)

diff --git a/test/src/EVENT-test.js b/test/src/EVENT-test.js
@@ -0,0 +1,12 @@
+import test from 'tape'
+import { SearchIndex } from 'search-index'
+
+const sandbox = 'test/sandbox/'
+const indexName = sandbox + 'EVENTS'
+const global = {}
+
+test('create a search index and listen to the "ready" event', t => {
+  t.plan(2)
+  t.ok((global[indexName] = new SearchIndex({ name: indexName })), !undefined)
+  global[indexName].EVENTS.on('ready', () => t.pass('ready event emitted'))
+})