Session - Memorio

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

Session provides temporary storage using browser sessionStorage. Data persists until the tab or window is closed.

Installation

npm install memorio

import 'memorio';

Quick Examples

Example 1: Basic Usage

// Save session data
session.set('token', 'abc123');
session.set('userId', 42);

// Read session data
console.log(session.get('token')); // "abc123"

// Check persistence
console.log(session.isPersistent); // true in browser, false in Node.js/Deno

Example 2: Intermediate

// Store objects
session.set('user', { name: 'Mario', role: 'admin' });

// Remove specific item
session.remove('token');

// Clear all session data
session.removeAll();

Example 3: Advanced

// Check if session has data
if (session.get('authToken')) {
  // User is logged in
}

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

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

// Handle session expiry
window.addEventListener('storage', (e) => {
  if (e.key === 'session' && !e.newValue) {
    // Session cleared
    redirectToLogin();
  }
});

API Reference

Methods

Properties

Store vs Session

Platform Notes

Best Practices

1. Use for auth tokens: session.set('token', jwt)
2. Clear on logout: session.removeAll()
3. Don't use for persistent data
4. Check for null: session.get('key') || defaultValue

Common Use Cases

Authentication

// Login
session.set('authToken', response.token);
session.set('user', response.user);

// Logout
session.removeAll();
router.push('/login');

Form Progress

// Save form draft
session.set('formDraft', formData);

// Restore on page refresh
const draft = session.get('formDraft');
if (draft) restoreForm(draft);