tiny-idb 1.3.0 → 1.4.0

package/README.md

@@ -77,12 +77,31 @@ npm install tiny-idb
 | `values()` | Returns an array of all values. |
 | `entries()` | Returns an array of `[key, value]` pairs. |
 | `count()` | Returns the total number of entries. |
+| `raw(cb, mode?)` | Provides direct access to the `IDBObjectStore`. |
 | `update(key, fn)` | Performs an **atomic** read-modify-write. |
 | `push(key, value)` | **Atomically** appends to an array. |
 | `merge(key, patch)` | **Atomically** shallow-merges an object. |
 
 ## Example Use Cases
 
+### Direct IndexedDB Access (Cursors & Search)
+For large datasets where loading everything via `entries()` is inefficient, use `raw()` to perform cursor-based searches or filtered queries.
+```javascript
+const fruits = await tinyIDB.raw(store => {
+  return new Promise((resolve) => {
+    const matches = [];
+    const request = store.openCursor();
+    request.onsuccess = () => {
+      const cursor = request.result;
+      if (cursor) {
+        if (cursor.value.type === 'fruit') matches.push(cursor.value);
+        cursor.continue();
+      } else resolve(matches);
+    };
+  });
+});
+```
+
 ### Iterating over Data
 Use `entries()` to easily process all stored key-value pairs.
 ```javascript

package/index.d.ts

@@ -54,6 +54,14 @@ export interface TinyIDBInstance {
    */
   count(): Promise<number>;
 
+  /**
+   * Direct access to the IDBObjectStore within a transaction.
+   * This provides an "escape hatch" to use native IndexedDB features like cursors, ranges, and search.
+   * @param cb A callback that receives the IDBObjectStore.
+   * @param mode The transaction mode ('readonly' or 'readwrite').
+   */
+  raw<T = any>(cb: (store: IDBObjectStore) => T | Promise<T>, mode?: IDBTransactionMode): Promise<T>;
+
   /**
    * Performs an atomic read-modify-write operation within a single transaction.
    * Note: The function 'fn' must be synchronous or microtask-only (no await on fetch/setTimeout) 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tiny-idb",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "An extremely fast, super simple, and dependency-free IndexedDB wrapper. A drop-in replacement for localStorage with reliability and durability.",
   "main": "tiny-idb.js",
   "module": "tiny-idb.js",

package/tiny-idb.js

@@ -52,6 +52,7 @@ const getAPI = (dbName = 'tiny-idb', storeName = undefined) => {
       return k.map((key, i) => [key, v[i]]);
     }),
     count: () => tx(RO, s => prom(s.count())),
+    raw: (cb, mode = RO) => tx(mode, cb),
     update,
     push: (key, val) => update(key, (c = []) => [...(Array.isArray(c) ? c : []), val]),
     merge: (key, obj) => update(key, (c = {}) => ({ ...(c && typeof c === 'object' ? c : {}), ...obj }))

package/tiny-idb.min.js

@@ -1,2 +1,2 @@
 /** tiny-idb - MIT © Jelodar */
-const e=new Map,t=e=>new Promise((t,r)=>{e.onsuccess=()=>t(e.result),e.onerror=()=>r(e.error)}),r="readonly",o="readwrite",n=(s="tiny-idb",a=void 0)=>{const c=s+"\0"+(a=a||s);if(e.has(c))return e.get(c);let l;const i=async(e,t)=>{const r=await(l||(l=new Promise((e,t)=>{const r=indexedDB.open(s,1);r.onupgradeneeded=()=>r.result.createObjectStore(a),r.onsuccess=()=>{const t=r.result;t.onversionchange=()=>{t.close(),l=null},e(t)},r.onerror=()=>{l=null,t(r.error)}})));return new Promise(async(o,n)=>{const s=r.transaction(a,e);s.onabort=s.onerror=()=>n(s.error||new DOMException("Aborted"));try{const e=await t(s.objectStore(a));s.oncomplete=()=>o(e)}catch(e){try{s.abort()}catch{}n(e)}})},u=(e,r)=>i(o,async o=>t(o.put(await r(await t(o.get(e))),e))),y={open:n,set:(e,r)=>i(o,o=>t(o.put(r,e))),get:e=>i(r,r=>t(r.get(e))),remove:e=>i(o,r=>t(r.delete(e))),clear:()=>i(o,e=>t(e.clear())),keys:()=>i(r,e=>t(e.getAllKeys())),values:()=>i(r,e=>t(e.getAll())),entries:()=>i(r,async e=>{const[r,o]=await Promise.all([t(e.getAllKeys()),t(e.getAll())]);return r.map((e,t)=>[e,o[t]])}),count:()=>i(r,e=>t(e.count())),update:u,push:(e,t)=>u(e,(e=[])=>[...Array.isArray(e)?e:[],t]),merge:(e,t)=>u(e,(e={})=>({...e&&"object"==typeof e?e:{},...t}))};return["get","set","remove"].forEach(e=>y[e+"Item"]=y[e]),e.set(c,y),y};export const tinyIDB=n();export default tinyIDB;
+const e=new Map,t=e=>new Promise((t,r)=>{e.onsuccess=()=>t(e.result),e.onerror=()=>r(e.error)}),r="readonly",o="readwrite",n=(s="tiny-idb",a=void 0)=>{const c=s+"\0"+(a=a||s);if(e.has(c))return e.get(c);let l;const i=async(e,t)=>{const r=await(l||(l=new Promise((e,t)=>{const r=indexedDB.open(s,1);r.onupgradeneeded=()=>r.result.createObjectStore(a),r.onsuccess=()=>{const t=r.result;t.onversionchange=()=>{t.close(),l=null},e(t)},r.onerror=()=>{l=null,t(r.error)}})));return new Promise(async(o,n)=>{const s=r.transaction(a,e);s.onabort=s.onerror=()=>n(s.error||new DOMException("Aborted"));try{const e=await t(s.objectStore(a));s.oncomplete=()=>o(e)}catch(e){try{s.abort()}catch{}n(e)}})},u=(e,r)=>i(o,async o=>t(o.put(await r(await t(o.get(e))),e))),y={open:n,set:(e,r)=>i(o,o=>t(o.put(r,e))),get:e=>i(r,r=>t(r.get(e))),remove:e=>i(o,r=>t(r.delete(e))),clear:()=>i(o,e=>t(e.clear())),keys:()=>i(r,e=>t(e.getAllKeys())),values:()=>i(r,e=>t(e.getAll())),entries:()=>i(r,async e=>{const[r,o]=await Promise.all([t(e.getAllKeys()),t(e.getAll())]);return r.map((e,t)=>[e,o[t]])}),count:()=>i(r,e=>t(e.count())),raw:(e,t=r)=>i(t,e),update:u,push:(e,t)=>u(e,(e=[])=>[...Array.isArray(e)?e:[],t]),merge:(e,t)=>u(e,(e={})=>({...e&&"object"==typeof e?e:{},...t}))};return["get","set","remove"].forEach(e=>y[e+"Item"]=y[e]),e.set(c,y),y};export const tinyIDB=n();export default tinyIDB;