Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/miaowing/x-cache
A finite key-value cache support multi cache algorithm (LRU, FIFO, LFU...).
https://github.com/miaowing/x-cache
Last synced: about 1 month ago
JSON representation
A finite key-value cache support multi cache algorithm (LRU, FIFO, LFU...).
- Host: GitHub
- URL: https://github.com/miaowing/x-cache
- Owner: miaowing
- Created: 2016-07-05T07:59:36.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2016-07-08T06:48:19.000Z (over 8 years ago)
- Last Synced: 2024-10-07T04:48:34.320Z (about 1 month ago)
- Language: JavaScript
- Homepage: https://github.com/miaowing/x-cache/
- Size: 31.3 KB
- Stars: 6
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# X-cache
A finite key-value cache support multi cache algorithm (LRU, FIFO, LFU...).
## Support cache algorithm
| strategy | description | todo |
| ------------- |:------------------------------| -----:|
| fifo | First in First out (FIFO) | |
| lru | Least Recently Used (LRU) | |
| lru-k | Least Recently Used K (LRU-K) | todo |
| 2q | Two queues (2Q) | todo |
| lfu | Least Frequently Used (LFU) | |
| ... | ... | ... |
## Usage
```
$ npm install x-cache --save
```
## Example
```javascript
import {LruXCache, XCache} from 'x-cache';
const cache = new LruXCache(1000);
// or
var XCache = require('x-cache').XCache;
var cache = new XCache('lru', {
limit: 1000
});
cache.put('elwin', 1215);
cache.put('leon', 1233);
cache.put('tom', 1234);
cache.get('elwin'); // 1215
cache.find('elwin'); // true
cache.remove('elwin'); // true
cache.getSize(); // 2
cache.getArray(); // [1234, 1233]
cache.shift();
cache.forEach((v, k, obj) => console.log(v, k)); // 1234, tom
cache.removeAll();
```
## API
### new XCache(strategy, option)
Create a new cache instance.
* strategy: cache algorithm, such as lru, fifo..., you can see support cache algorithm for detail.
* option: it is not always same. if you use lru strategy, the option is {limit: 1000}.
### new LruXCache(limit)
Create a new cache instance using LRU cache algorithm.
* limit: limit the size of cache
### new LfuXCache(limit)
Create a new cache instance using LFU cache algorithm.
* limit: limit the size of cache
### new FifoXCache(limit)
Create a new cache instance using FIFO cache algorithm.
* limit: limit the size of cache
### XCache.prototype.put(key, value): Object entry
Put the value into the cache associated with key.
* key:
* value:
### XCache.prototype.get(key): Object value
Returns the value associated with key or undefined if not in the cache.
* key:
### XCache.prototype.shift(): Object entry
Such as array.shift().
### XCache.prototype.find(key): Boolean bool
Check the key is whether in cache or not.
* key:
### XCache.prototype.remove(key): Boolean bool
Remove the value associated with key, return true if remove successful.
* key:
### XCache.prototype.removeAll()
Clear the cache.
### XCache.prototype.getSize(): Number size
Returns the current size of the cache.
### XCache.prototype.getArray(fromHead): Array array
Returns array {key, value}.
* fromHead: default false
### XCache.prototype.forEach(callback, fromHead)
Iterator, callback(key, value, obj).
* fromHead: default false
## Develop
```
$ npm install
$ npm run build
$ npm run test
```
## Feedback
If you any questions, use [Issues](https://github.com/zfeng217/x-cache/issues).
Sina Weibo: @赵小小峰
## License
MIT Licence.