Add docs tips about IDB keys

alwaysmeticulous · Oct 18, 2024 · 16f7466 · 16f7466
1 parent c66bfb7
commit 16f7466
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/packages/sdk-bundles-api/src/record/middleware.ts b/packages/sdk-bundles-api/src/record/middleware.ts
@@ -159,6 +159,10 @@ export interface IndexedDBStoreEntries {
   databaseName: string;
   objectStoreName: string;
   entries: {
+    /**
+     * Note if you don't set explicit keys, and instead use 'keyPath' when constructing your store then
+     * the key passed here will be undefined: you'll need to retrieve your key from the value.
+     */
     key?: IDBValidKey;
 
     /**