safe-memory-layer 1.0.0 → 1.1.1

package/README.md

@@ -458,6 +458,69 @@ Works in all modern browsers that support:
 
 No Node.js-specific APIs are used.
 
+## Electron Support
+
+Safe Memory Layer works perfectly in Electron applications, both in the main process and renderer process.
+
+### Main Process
+
+Use MemoryStore in Electron's main process for:
+- Window state management
+- IPC message caching
+- Application state management
+- Session data storage
+
+```typescript
+import { MemoryStore } from "safe-memory-layer";
+
+// Window state store
+const windowStateStore = new MemoryStore<string, WindowState>({
+  defaultTTL: 5 * 60 * 1000, // 5 minutes
+  cleanupInterval: 30_000,
+  autoCleanup: true,
+});
+
+// Save window state
+windowStateStore.set(`window:${windowId}`, {
+  bounds: window.getBounds(),
+  isFocused: window.isFocused(),
+});
+```
+
+### Renderer Process
+
+Use MemoryStore in Electron's renderer process (browser environment) for:
+- UI component state
+- API response caching
+- DOM element metadata (with WeakMemoryStore)
+- User preferences
+
+```typescript
+import { MemoryStore, WeakMemoryStore } from "safe-memory-layer";
+
+// UI state store
+const uiStateStore = new MemoryStore<string, UIState>({
+  defaultTTL: 10 * 60 * 1000, // 10 minutes
+  autoCleanup: true,
+});
+
+// DOM metadata store (auto-cleaned by GC)
+const domStore = new WeakMemoryStore<ElementMetadata>();
+
+const element = document.querySelector("#my-element");
+domStore.set(element, { interactions: 0, lastClick: Date.now() });
+```
+
+### Electron Best Practices
+
+1. **Dispose on app quit**: Always dispose stores when the app quits
+2. **Use TTLs**: Set appropriate TTLs for cached data
+3. **Separate stores**: Use different stores for different concerns
+4. **Cleanup on window close**: Dispose stores when windows are closed
+5. **IPC caching**: Cache IPC responses to reduce main process load
+
+See the `examples/` directory for complete Electron examples.
+
 ## TypeScript Support
 
 Full TypeScript support with generics:
@@ -498,4 +561,8 @@ npm test
 - Event callbacks
 - Statistics tracking
 - Auto-dispose feature
-- Full TypeScript support
+- Full TypeScript support
+
+### 1.1.0
+
+- support Electron desktop (Framework)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "safe-memory-layer",
-  "version": "1.0.0",
+  "version": "1.1.1",
   "description": "Secure, lightweight, dependency-free in-memory storage with TTL support, automatic cleanup, and memory leak prevention for Node.js and browsers",
   "type": "module",
   "main": "./dist/index.cjs",