State - Memorio

✅ Universal: Works in Browser, Node.js, Deno, and Edge Workers

State is a reactive global state manager using JavaScript Proxies. It's simple, powerful, and requires no setup. Data persists only in memory during the session.

Installation

npm install memorio

import 'memorio';

That's it. state is now global.

Quick Examples

Example 1: Basic Usage

// Set a value
state.name = 'Mario';
state.age = 25;

// Get a value
console.log(state.name); // "Mario"

// Simple object
state.user = { name: 'Luigi', level: 1 };

Example 2: Intermediate

// Array operations
state.items = [1, 2, 3];
state.items.push(4);
console.log(state.items); // [1, 2, 3, 4]

// Nested objects
state.config = { theme: 'dark', lang: 'en' };
state.config.theme = 'light';

// List all states
console.log(state.list);

Example 3: Advanced

// Lock state to prevent modifications
state.frozenConfig = { maxUsers: 100 };
state.frozenConfig.lock();
// Now state.frozenConfig cannot be modified

// Path tracking
const path = state.user.path;
console.log(path.name); // "user"
console.log(path.profile.name); // "user.profile"

// Get full path as string
console.log(state.user.__path); // "state.user"

// Protected keys (internal use)
console.log(protect); // Array of protected keys

API Reference

Properties

Methods

Lock

// Lock an object or array
state.myArray = [1, 2, 3];
state.myArray.lock();

// Now any modification will fail
state.myArray.push(4); // Error: state 'myArray' is locked

How It Works

Memorio uses JavaScript Proxy to intercept get/set operations on the global state object. This allows:

1. Reactivity - Any change can trigger observers
2. Nested objects - Deep path tracking
3. Type safety - Full TypeScript support

Platform Notes

Note: In server environments (Node.js/Deno), use memorio.createContext() for request isolation.

Best Practices

1. Use descriptive keys: state.userProfile not state.up
2. Group related data: state.cart.items not state.cartItems
3. Lock static config: state.appConfig.lock()
4. Clean up on logout: state.removeAll()
5. Use path tracking for debugging: state.myData.__path

Common Errors

// Error: protected key
state._internal = 'value';
// Output: "key _internal is protected"

// Error: locked state
state.locked = { x: 1 };
state.locked.lock();
state.locked.x = 2;
// Output: "Error: state 'locked' is locked"