Dadado ·
A cache that automatically removes the least-recently-used items.
Features
- Fast LRU implementation
- Gzipped version has less than 400 bytes
- Minimalist API
- Supports to both Node and Browser
- Supports to Types
- Zero-dependency
Installation
To install dadado
, execute:
$ npm install dadado
or
$ yarn add dadado
Quickstart
Dadado
is a cache class which is designed to keep storing just the most recently used items.
To ensure it, the class receives a capacity
, that will be used to discard the least recently used items when the capacity is reached.
import Dadado from 'dadado';
const cache = new Dadado(3);
cache.setItem('key1', 'value1');
cache.setItem('key2', 'value2');
cache.getItem('key1');
cache.setItem('key3', 'value3');
cache.setItem('key4', 'value4');
cache.size();
cache.contains('key2');
cache.contains('key1');
Methods
contains(key: any): boolean
Checks if the given key exist within the cache
setItem(key: any, value: any): boolean
Adds the key-value pair to the cache if the key is not in the cache yet.
Otherwise, if the key exists, updates the value of the key.
In case the current number of keys exceeds the capacity
, then it evicts the least recently used key that is not marked as persistent.
getItem(key: any): any
Retrieves the value associeted with the given key if it exists in the cache.
If the key is not in the cache, it returns undefined
.
removeItem(key: any): boolean
Deletes item and returns true
if the item existed in the cache - persistent will be removed as well.
Returns false
if the element doesn't exist in the cache.
setPersistent(key: any): void
Makes item persistent, i.e the item can no longer be automatically evicted.
However, the item still will be removed when invoking removeItem
or clear
.
import Dadado from 'dadado';
const cache = new Dadado(3);
cache.setItem('key1', 'value1');
cache.setPersistent('key1');
cache.setItem('key2', 'value2');
cache.setItem('key3', 'value3');
cache.setItem('key4', 'value4');
cache.contains('key1');
cache.contains('key2');
removePersistent(key: any): void
Makes item no longer a persistent item.
togglePersistent(key: any): void
Makes item persistent if it was not yet, or otherwise undo the persistent flag.
toArray(): T[][]
Returns an Array based in the current cache with each key-value pair sorted by least-recently-used.
size(): number
Returns the cache size.
clear(): void
Remove all items - even the persistent ones - from the cache.
LICENSE
MIT