IDB - Memorio

🖥️ Browser Only: Requires IndexedDB (not available in Node.js/Deno)

IDB provides access to browser IndexedDB for large data storage. Unlike localStorage, IDB can store large amounts of structured data.

Installation

npm install memorio

import 'memorio';

Quick Examples

Example 1: Basic Usage

// Create a database
idb.db.create('myApp');

// Add data
idb.data.set('myApp', 'users', { id: 1, name: 'Mario' });

// Get data
const user = idb.data.get('myApp', 'users', 1);
console.log(user.name); // "Mario"

Example 2: Intermediate

// Create database with tables
idb.db.create('store');
idb.table.create('store', 'products');

// Add multiple records
idb.data.set('store', 'products', { id: 1, name: 'Apple', price: 1.5 });
idb.data.set('store', 'products', { id: 2, name: 'Banana', price: 0.8 });

// List databases
const databases = idb.db.list();
console.log(databases); // ['myApp', 'store']

Example 3: Advanced

// Check database support
if (idb.db.support()) {
  // Use IDB
}

// Get database info
const version = idb.db.version('store');
const size = idb.db.size('store');

// Delete database
idb.db.delete('store');

// Handle quota
const quota = idb.db.quota();
console.log(`Using ${quota.used} of ${quota.total} bytes`);

API Reference

Database Methods

Table Methods

Data Methods

Data Structure

Each record needs an id field:

idb.data.set('myDB', 'users', {
  id: 1,           // Required!
  name: 'Mario',
  email: 'm@test.com'
});

Platform Support

Storage Limits

• Desktop browsers: 50+ MB (often unlimited)
• Mobile browsers: 50-100 MB
• More than localStorage: Much higher limits

Best Practices

1. Always include id in records
2. Use for large data: images, caches, offline data
3. Check support: idb.db.support()
4. Clean up: idb.db.delete('tempDB')

Use Cases

Offline Data

// Cache API response
idb.data.set('cache', 'apiResponse', {
  id: 'users',
  data: usersArray,
  timestamp: Date.now()
});

Large User Data

// Store user-generated content
idb.data.set('app', 'uploads', {
  id: Date.now(),
  file: fileData,
  userId: currentUser.id
});