Docs

cross-org · Jun 3, 2024 · 4f286c4 · 4f286c4
1 parent 0a802f2
commit 4f286c4
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,13 @@
+## Unrelesed
+
+## Changes
+
+- Remove sync result `noop` as isn't used anywhere anymore
+
+## Fixes
+
+- Fixed Deno panic on decoding data from cache
+
 ## 0.15.7
 
 ## Changes

diff --git a/README.md b/README.md
@@ -267,7 +267,6 @@ await kvStore.open("db/mydatabase.db");
 kvStore.on("sync", (eventData) => {
   switch (eventData.result) {
     case "ready": // No new updates
-    case "blocked": // Synchronization temporarily blocked (e.g., during vacuum)
     case "success": // Synchronization successful, new transactions added
     case "ledgerInvalidated": // Ledger recreated, database reopened and index resynchronized
     case "error": // An error occurred during synchronization

diff --git a/src/lib/kv.ts b/src/lib/kv.ts
@@ -18,7 +18,6 @@ import { EventEmitter } from "node:events";
  * Represents the status of a synchronization operation between the in-memory index and the on-disk ledger.
  */
 export type KVSyncResultStatus =
-  | "noop" /** No operation was performed (e.g., ledger not open). */
   | "ready" /** The database is ready, no new data to synchronize. */
   | "success" /** Synchronization completed successfully, new data was added. */
   | "ledgerInvalidated" /** The ledger was invalidated and needs to be reopened. */