A high-performance, type-safe in-memory caching library for TypeScript and JavaScript applications.
- 🚀 High Performance Optimized for speed and minimal memory footprint
- ⏱️ TTL Support Flexible time-to-live settings for cache entries
- 🔄 Batch Operations Efficient multi-get, multi-set, and batch delete
- 📊 Built-in Monitoring Statistics tracking and event system
- 🛡️ Type Safety Full TypeScript support with generics for type-safe caching
- 🔧 Configurable Extensive options for fine-tuning behavior
# Using npm
npm install ts-cache
# Using yarn
yarn add ts-cache
# Using pnpm
pnpm add ts-cache
# Using bun
bun add ts-cacheimport cache from 'ts-cache'
// Store a value (with 5 minute TTL)
cache.set('user:123', { name: 'John', role: 'admin' }, 300)
// Retrieve a value with type safety
const user = cache.get<{ name: string, role: string }>('user:123')
if (user) {
console.log(user.name) // TypeScript knows this is a string
}
// Check if a key exists
if (cache.has('user:123')) {
// Key exists and is not expired
}
// Delete a key
cache.del('user:123')
// Get and remove in one operation
const token = cache.take('one-time-token')
// Fetch (get if exists, set if doesn't)
const apiData = cache.fetch('api:users', 300, async () => {
// Only called if 'api:users' doesn't exist
return await fetchFromApi('/users')
})import { Cache } from 'ts-cache'
// Create a custom cache with specific settings
const myCache = new Cache({
stdTTL: 3600, // Default TTL: 1 hour
checkPeriod: 600, // Check for expired items every 10 minutes
maxKeys: 1000, // Maximum 1000 items
useClones: true, // Clone values on get/set operations
deleteOnExpire: true // Remove items when they expire
})
// Use the custom cache instance
myCache.set('key', 'value')// Set multiple values at once
cache.mset([
{ key: 'key1', val: 'value1' },
{ key: 'key2', val: 'value2' },
{ key: 'key3', val: 'value3', ttl: 300 }
])
// Get multiple values at once
const values = cache.mget(['key1', 'key2', 'key3'])
// Delete multiple keys
cache.del(['key1', 'key2'])// Listen for expired items
cache.on('expired', (key, value) => {
console.log(`Item expired: ${key}`)
// Take action, like recomputing the value
})
// Other events: 'set', 'del', 'flush', 'flush-stats'
cache.on('set', (key, value) => {
console.log(`Cache set: ${key}`)
})// Get cache statistics
const stats = cache.getStats()
console.log(stats)
// {
// hits: 127,
// misses: 9,
// keys: 42,
// ksize: 840,
// vsize: 2390
// }
// Reset statistics counters
cache.flushStats()- API Response Caching: Reduce API calls by caching responses
- Computed Values: Store results of expensive calculations
- Session Data: Temporary user session storage
- Rate Limiting: Implement counters with automatic expiration
- Function Memoization: Cache function results for repeated calls
For detailed documentation, see:
Please see the Contributing Guide for details.
For help, discussion about best practices, or any other conversation that would benefit from being searchable:
For casual chit-chat with others using this package:
Join the Stacks Discord Server
“Software that is free, but hopes for a postcard.” We love receiving postcards from around the world showing where Stacks is being used! We showcase them on our website too.
Our address: Stacks.js, 12665 Village Ln #2306, Playa Vista, CA 90094, United States 🌎
We would like to extend our thanks to the following sponsors for funding Stacks development. If you are interested in becoming a sponsor, please reach out to us.
node-cachefor the original Node.js implementation- Chris Breuer
- All Contributors
The MIT License (MIT). Please see LICENSE for more information.
Made with 💙
