spincycle
Version:
A reactive message router and object manager that lets clients subscribe to object property changes on the server
138 lines (89 loc) • 2.03 kB
Markdown
LRUCache
====
LRU Cache for node.js/browser.
[![NPM version][npm-image]][npm-url]
[![Build Status][travis-image]][travis-url]
[![Downloads][downloads-image]][downloads-url]
使用链表实现的 LRU 缓存。`get`、`set` 和 `update` 方法会更新 LRU 优先级。
## Install
**Node.js:**
```
npm install lrucache
```
**bower:**
```
bower install lrucache
```
**Browser:**
```
<script src="/pathTo/lrucache.js"></script>
```
## API
```js
var LRUCache = require('lrucache')
```
### LRUCache([capacity])
`LRUCache` 构造函数。
+ **capacity:** Number，可选，设置 LRUCache 的容量，未设置则为无限容量。
```js
var cache = LRUCache(100)
```
### LRUCache.prototype.get(key)
return `value`。
```js
var a = cache.get('a')
```
### LRUCache.prototype.set(key, value)
return `this`。
```js
cache.set('a', [1, 2, 3])
```
### LRUCache.prototype.update(key, fn)
return `this`，如果缓存 `a` 不存在，则不会执行。
```js
cache.update('a', function (a) {
a.push(4)
return a
})
```
### LRUCache.prototype.remove(key)
return `this`。
```js
cache.remove('a')
```
### LRUCache.prototype.removeAll(key)
return `this`。
```js
cache.removeAll()
```
### LRUCache.prototype.keys()
return a array of `keys`。
```
cache.keys()
```
### LRUCache.prototype.has(key)
return `true` or `false`。
```js
cache.has('a')
```
### LRUCache.prototype.staleKey()
return the stalest `key` or `null`。
```js
vat staleKey = cache.staleKey()
```
### LRUCache.prototype.popStale()
return the stalest `data` or `null`。
```js
var staleDate = cache.popStale()
```
### LRUCache.prototype.info()
return `info`。
```js
cache.info()
```
[npm-url]: https://npmjs.org/package/lrucache
[npm-image]: http://img.shields.io/npm/v/lrucache.svg
[travis-url]: https://travis-ci.org/zensh/lrucache
[travis-image]: http://img.shields.io/travis/zensh/lrucache.svg
[downloads-url]: https://npmjs.org/package/lrucache
[downloads-image]: http://img.shields.io/npm/dm/lrucache.svg?style=flat-square