What is tiny-lru?
The tiny-lru npm package is a lightweight, in-memory Least Recently Used (LRU) cache. It is designed to be simple and efficient, making it suitable for use in environments where memory usage and performance are critical.
What are tiny-lru's main functionalities?
Creating an LRU Cache
This feature allows you to create an LRU cache with a specified maximum size. The cache will automatically evict the least recently used items when the size limit is reached.
const LRU = require('tiny-lru');
const cache = LRU(100); // Create a cache with a max size of 100 items
Setting and Getting Cache Items
You can store items in the cache using the `set` method and retrieve them using the `get` method. If the item is not found, `get` will return `undefined`.
cache.set('key', 'value');
const value = cache.get('key'); // 'value'
Deleting Cache Items
This feature allows you to delete specific items from the cache using the `delete` method.
cache.set('key', 'value');
cache.delete('key');
const value = cache.get('key'); // undefined
Clearing the Cache
You can clear all items from the cache using the `clear` method, which removes all entries.
cache.set('key1', 'value1');
cache.set('key2', 'value2');
cache.clear();
const value1 = cache.get('key1'); // undefined
const value2 = cache.get('key2'); // undefined
Cache Size and Item Count
This feature allows you to check the current number of items in the cache using the `size` property.
cache.set('key1', 'value1');
cache.set('key2', 'value2');
const size = cache.size; // 2
Other packages similar to tiny-lru
lru-cache
The lru-cache package is another popular LRU cache implementation for Node.js. It offers more features and configuration options compared to tiny-lru, such as time-to-live (TTL) settings for cache entries and more detailed cache statistics.
quick-lru
The quick-lru package is a minimalist LRU cache implementation that focuses on performance and simplicity. It is similar to tiny-lru in terms of its lightweight nature but offers a slightly different API.
node-cache
The node-cache package provides a simple and efficient in-memory caching solution with support for TTL and other advanced features. It is more feature-rich compared to tiny-lru, making it suitable for more complex caching needs.
Tiny LRU
Least Recently Used cache for Client or Server.
var cache = lru(500);
evict
Method
Evicts the least recently used item from cache
@return {Object} LRU instance
Example
cache.evict();
first
Property
Item in "first" or "top" position
Example
var cache = lru();
cache.first;
get
Method
Gets cached item and moves it to the front
@param {String} key Item key
@return {Mixed} Undefined or Item value
Example
var item = cache.get("myKey");
items
Property
Hash of cache items
Example
var cache = lru();
cache.items;
max
Property
Max items to hold in cache (1000)
Example
var cache = lru(500);
cache.max;
last
Property
Item in "last" or "bottom" position
Example
var cache = lru();
cache.last;
length
Property
Number of items in cache
Example
var cache = lru();
cache.length;
remove
Method
Removes item from cache
@param {String} key Item key
@return {Object} Item
Example
var staleItem = cache.remove("myKey");
set
Method
Sets item in cache as first
@param {String} key Item key
@param {Mixed} value Item value
@return {Object} LRU instance
Example
cache.set("myKey", {prop: true});
License
abaaso is licensed under BSD-3 https://raw.github.com/avoidwork/tiny-lru/master/LICENSE
Copyright
Copyright (c) 2013, Jason Mulligan jason.mulligan@avoidwork.com