Store - Memorio

🖥️ Browser & Edge: Uses localStorage for persistence ⚙️ Node.js/Deno: Falls back to in-memory storage (not persistent)

Store provides persistent localStorage management with a simple API. Data survives page refreshes and browser restarts.

Installation

npm install memorio

import 'memorio';

Quick Examples

Example 1: Basic Usage

// Save data
store.set('username', 'Mario');
store.set('score', 1500);

// Read data
console.log(store.get('username')); // "Mario"
console.log(store.get('score'));    // 1500

// Check if using real persistence
console.log(store.isPersistent); // true in browser, false in Node.js/Deno

Example 2: Intermediate

// Store objects
store.set('user', { name: 'Luigi', level: 5 });
const user = store.get('user');
console.log(user.name); // "Luigi"

// Remove single item
store.remove('username');

// Check size
const totalSize = store.size();
console.log(`${totalSize} bytes`);

Example 3: Advanced

// Get storage quota (returns Promise<[usage, quota]> in KB)
const [used, total] = await store.quota();
console.log(`Using ${used} out of ${total} KB`);

// Get total size in characters
const size = store.size();
console.log(`${size} bytes`);

// Clear all data
store.removeAll();
// or use alias
store.clearAll();

// Handle errors gracefully
try {
  store.set('largeData', hugeObject);
} catch (err) {
  console.error('Storage full:', err);
}

API Reference

Methods

Properties

Supported Types

// All JSON-serializable types work
store.set('string', 'hello');
store.set('number', 42);
store.set('boolean', true);
store.set('array', [1, 2, 3]);
store.set('object', { key: 'value' });
store.set('null', null);
store.set('undefined', null); // converted to null

Not Supported

// Functions will log an error
store.set('myFunc', () => {});
// Output: "It's not secure to store functions."

Platform Comparison

How It Works

Store wraps the browser's localStorage API with:

• Automatic JSON serialization/deserialization
• Error handling for parse failures
• Size calculation
• Quota monitoring

Storage Limits

• Chrome/Safari: ~5-10 MB
• Firefox: ~10 MB
• Edge: ~5-10 MB

Use store.quota() to monitor usage.

Best Practices

1. Prefix keys: store.set('app_username', '...')
2. Check before set: if (store.get('key')) { ... }
3. Handle quota: Try/catch around large data
4. Clean up: store.removeAll() on logout