https://github.com/feross/cache-chunk-store
In-memory LRU (least-recently-used) cache for abstract-chunk-store compliant stores
https://github.com/feross/cache-chunk-store
abstract-chunk-store cache in-memory javascript lru nodejs
Last synced: 4 months ago
JSON representation
In-memory LRU (least-recently-used) cache for abstract-chunk-store compliant stores
- Host: GitHub
- URL: https://github.com/feross/cache-chunk-store
- Owner: feross
- License: mit
- Created: 2015-08-15T23:29:20.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-01-30T09:04:31.000Z (about 2 years ago)
- Last Synced: 2025-01-03T02:53:09.886Z (4 months ago)
- Topics: abstract-chunk-store, cache, in-memory, javascript, lru, nodejs
- Language: JavaScript
- Homepage:
- Size: 43.9 KB
- Stars: 28
- Watchers: 5
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# cache-chunk-store [![ci][ci-image]][ci-url] [![npm][npm-image]][npm-url] [![downloads][downloads-image]][downloads-url] [![javascript style guide][standard-image]][standard-url]
[ci-image]: https://img.shields.io/github/workflow/status/feross/cache-chunk-store/ci/master
[ci-url]: https://github.com/feross/cache-chunk-store/actions
[npm-image]: https://img.shields.io/npm/v/cache-chunk-store.svg
[npm-url]: https://npmjs.org/package/cache-chunk-store
[downloads-image]: https://img.shields.io/npm/dm/cache-chunk-store.svg
[downloads-url]: https://npmjs.org/package/cache-chunk-store
[standard-image]: https://img.shields.io/badge/code_style-standard-brightgreen.svg
[standard-url]: https://standardjs.com
#### In-memory LRU (least-recently-used) cache for [abstract-chunk-store](https://github.com/mafintosh/abstract-chunk-store) compliant stores
[](https://github.com/mafintosh/abstract-chunk-store)
This caches the results of `store.get()` calls using
[`lru`](https://www.npmjs.com/package/lru). See the `lru` docs for the
full list of configuration options.
## Install
```
npm install cache-chunk-store
```
## Usage
``` js
const CacheChunkStore = require('cache-chunk-store')
const FSChunkStore = require('fs-chunk-store') // any chunk store will work
const store = new CacheChunkStore(new FSChunkStore(10), {
// options are passed through to `lru-cache`
max: 100 // maximum cache size (this is probably the only option you need)
})
store.put(0, new Buffer('abc'), err => {
if (err) throw err
store.get(0, (err, data) => {
if (err) throw err
console.log(data)
// this will be super fast because it's cached in memory!
store.get(0, (err, data) => {
if (err) throw err
console.log(data)
})
})
})
```
## License
MIT. Copyright (c) [Feross Aboukhadijeh](https://feross.org).