@harperfast/rocksdb-js 1.4.2 → 1.5.0

package/README.md

@@ -668,12 +668,25 @@ complete, use the `'aftercommit'` event.
 ## Event API
 
 `rocksdb-js` provides a EventEmitter-like API that lets you asynchronously notify events to one or
-more synchronous listener callbacks. Events are scoped by database path.
+more synchronous listener callbacks. There are two types of events:
+
+- Per-database events: scoped by database path.
+- Process-global events: not scoped by database path.
 
 Unlike `EventEmitter`, events are emitted asynchronously, but in the same order that the listeners
 were added.
 
 ```typescript
+// Process-global events
+RocksDatabase.on('log.warn', console.warn);
+
+RocksDatabase.on('foo', (...args) => {
+	console.log(args);
+});
+RocksDatabase.notify('foo', 'bar');
+RocksDatabase.off('foo', callback);
+
+// Per-database events
 const callback = (name) => console.log(`Hi from ${name}`);
 db.addListener('foo', callback);
 db.notify('foo');
@@ -1103,6 +1116,18 @@ for (const entry of rangeIter) {
 Returns the size of the given transaction log sequence file in bytes. Omit the sequence number to
 get the total size of all the transaction log sequence files for this log.
 
+### Transaction Log Initialization
+
+When a database is opened, `rocksdb-js` will automatically discover the transaction log files. If
+a corrupt transaction log file is detected, the `log.warn` event is emitted on the global
+`RocksDatabase` instance. This should be wired up prior to opening the database.
+
+```typescript
+RocksDatabase.on('log.warn', console.warn);
+
+const db = RocksDatabase.open('path/to/db');
+```
+
 ### Transaction Log Parser
 
 #### `parseTransactionLog(file)`

package/dist/index.cjs

@@ -80,6 +80,10 @@ function locateBinding() {
 }
 const binding = req(locateBinding());
 const config = binding.config;
+const addGlobalListener = binding.addListener;
+const removeGlobalListener = binding.removeListener;
+const globalListenerCount = binding.listenerCount;
+const globalNotify = binding.notify;
 const constants = binding.constants;
 const NativeDatabase = binding.Database;
 const NativeIterator = binding.Iterator;
@@ -1386,6 +1390,60 @@ var RocksDatabase = class RocksDatabase extends DBI {
 	static config(options) {
 		config(options);
 	}
+	/**
+	* Registers a process-wide event listener. Internal events emitted by the
+	* native binding use namespaced keys (e.g. `'transactionLog:warning'`).
+	*
+	* Listeners are not tied to any specific database — they fire for every
+	* matching event emitted in this process.
+	*
+	* @example
+	* ```typescript
+	* RocksDatabase.on('transactionLog:warning', (warning) => {
+	*   console.warn(warning);
+	* });
+	* ```
+	*/
+	static on(event, callback) {
+		addGlobalListener(event, callback);
+	}
+	/**
+	* Alias for {@link RocksDatabase.on}, mirroring the Node `EventEmitter` API.
+	*/
+	static addListener(event, callback) {
+		addGlobalListener(event, callback);
+	}
+	/**
+	* Removes a previously-registered process-wide event listener. The
+	* callback identity must match the one passed to {@link RocksDatabase.on}.
+	*
+	* @returns `true` if a matching listener was removed.
+	*/
+	static off(event, callback) {
+		return removeGlobalListener(event, callback);
+	}
+	/**
+	* Alias for {@link RocksDatabase.off}, mirroring the Node `EventEmitter` API.
+	*/
+	static removeListener(event, callback) {
+		return removeGlobalListener(event, callback);
+	}
+	/**
+	* Returns the number of process-wide listeners registered for the given event.
+	*/
+	static listenerCount(event) {
+		return globalListenerCount(event);
+	}
+	/**
+	* Emits a process-wide event. Mostly intended for tests and as a peer to
+	* {@link RocksDatabase.on} — native code should call `emitGlobalEvent` in
+	* `napi/global_events.h` directly rather than round-tripping through JS.
+	*
+	* @returns `true` if there was at least one listener.
+	*/
+	static notify(event, ...args) {
+		return globalNotify(event, args);
+	}
 	destroy() {
 		this.store.db.destroy();
 	}
@@ -2132,7 +2190,7 @@ function loadLastPosition(transactionLog, readUncommitted) {
 //#region src/index.ts
 const versions = {
 	rocksdb: version,
-	"rocksdb-js": "1.4.2"
+	"rocksdb-js": "1.5.0"
 };
 
 //#endregion