memoru

memoru

A hash-based LRU cache for Node.js that evicts entries based on memory usage or item count. Designed for high performance and low memory overhead, with TypeScript support and memory monitoring utilities.

ToC

• memoru
  • ToC
  • Features
  • Installation
  • Usage
    • Basic LRU Usage
    • Memory Threshold Eviction
    • TypeScript Support
    • Memory Monitoring Utilities
  • Demo
  • See also

Features

• Fast hash-based LRU cache with O(1) operations
• Eviction based on memory usage or item count
• Optional integration with Node.js memory stats
• Garbage collection monitoring to prevent rotations during GC
• TypeScript support and strict types
• Zero dependencies
• Suitable for caching in memory-constrained environments

Installation

NPM:

npm install memoru

PNPM:

pnpm add memoru

Usage

Basic LRU Usage

import { Memoru } from 'memoru';

const lru = new Memoru({ max: 100 }); // max 100 items
lru.set('foo', 'bar');
console.log(lru.get('foo')); // 'bar'

Memory Threshold Eviction

Evict items automatically when process memory or V8 heap usage exceeds a threshold:

import { Memoru, ProcessMemoryStat } from 'memoru';

const lru = new Memoru({
  max: 1000,
  memoryStats: {
    monitored: [
      { stat: ProcessMemoryStat.RSS, threshold: 100 * 1024 * 1024 }, // 100MB
    ],
    interval: 1000, // check every second
  },
});

TypeScript Support

All APIs are fully typed:

import { Memoru } from 'memoru';

const lru = new Memoru<string, number>({ max: 10 });
lru.set('a', 1);
const value: number | undefined = lru.get('a');

Memory Monitoring Utilities

You can use the memory stats monitor directly:

import { MemoryStatsMonitor, ProcessMemoryStat } from 'memoru';

const monitor = new MemoryStatsMonitor({
  monitored: [{ stat: ProcessMemoryStat.RSS, threshold: 200 * 1024 * 1024 }],
  interval: 5000,
});

monitor.on('threshold', (stat) => {
  console.log('Memory threshold exceeded for', stat);
});

GC Monitoring

You can enable garbage collection monitoring to prevent cache rotations during garbage collection:

import { HeapSpace, Memoru } from 'memoru';

const lru = new Memoru({
  max: 1000,
  respectGC: true, // Prevent rotations during GC
  memoryStats: {
    monitorGC: true, // Enable GC monitoring
    gcCooldown: 500, // Wait 500ms after GC before allowing rotations
    monitored: [
      { stat: HeapSpace.Old, threshold: 50 * 1024 * 1024 }, // 50MB
    ],
    interval: 1000,
  },
});

Note: GC monitoring uses Node.js PerformanceObserver API and works without additional flags.

## Demo

```typescript
import { Memoru } from 'memoru';

const lru = new Memoru({ max: 2 });
lru.set('a', 1);
lru.set('b', 2);
lru.set('c', 3); // 'a' is evicted
console.log(lru.get('a')); // undefined
console.log(lru.get('b')); // 2
console.log(lru.get('c')); // 3

See also

• hashlru - inspiration for the core algorithm
• lru-cache - another popular LRU cache for Node.js