Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bahung1221/cache-all
Fast, efficient cache engines for both express routes & native nodeJs (redis, in-memory & file cache)
https://github.com/bahung1221/cache-all
cache cache-storage cachemanager filecache memcached node node-module nodejs rediscache singleton
Last synced: 3 days ago
JSON representation
Fast, efficient cache engines for both express routes & native nodeJs (redis, in-memory & file cache)
- Host: GitHub
- URL: https://github.com/bahung1221/cache-all
- Owner: bahung1221
- License: mit
- Created: 2019-01-14T13:36:26.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-10-12T06:51:32.000Z (almost 2 years ago)
- Last Synced: 2024-08-10T21:28:01.640Z (about 2 months ago)
- Topics: cache, cache-storage, cachemanager, filecache, memcached, node, node-module, nodejs, rediscache, singleton
- Language: JavaScript
- Homepage:
- Size: 224 KB
- Stars: 22
- Watchers: 4
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.npmjs.com/package/cache-all)
[](https://david-dm.org/bahung1221/cache-all)
[](https://travis-ci.com/bahung1221/cache-all)
[](https://coveralls.io/github/bahung1221/cache-all?branch=master)
[](https://www.codacy.com/manual/bahung1221/cache-all?utm_source=github.com&utm_medium=referral&utm_content=bahung1221/cache-all&utm_campaign=Badge_Grade)
[](https://www.npmjs.com/package/cache-all)
# cache-all
:rocket: Fast, simple cache engines for expressJS & native nodeJS (redis, in-memory & file caching).
- Multi cache engines, each engine has one singleton instance and independent with other engine.
- Include express middleware, which can be use for cache response on specific routes.
- Init once and then use anywhere for caching anything in your application.
## Install
```
npm install --save cache-all
```
or
```
yarn add cache-all
```
## Usages (single cache engine):
### Init
Init cache engine once and then you can use it anywhere,
recommend init when booting your application
Example init in your server.js:
```javascript
const express = require('express')
const cache = require('cache-all') // default is in-memory engine
// or
const cache = require('cache-all/memory') // explicit in-memory engine
// or
const cache = require('cache-all/file') // file engine
// or
const cache = require('cache-all/redis') // redis engine
const app = express()
// if you need to use cache methods immediately after init method, you must await it `await cache.init({...})`
cache.init({
ttl: 90,
})
// ...
app.listen(...)
```
Default config:
Just config for engine that will be use
- in-memory
```javascript
{
ttl: 90,
isEnable: true, // Flag for enable/disable cache, useful for development
}
```
- file
```javascript
{
ttl: 90,
isEnable: true,
file: {
path: path.join(process.cwd(), 'storage', 'cache') // Storage path for file cache engine
}
}
```
- redis
```javascript
{
ttl: 90,
isEnable: true,
redis: {
port: 6379,
host: '127.0.0.1',
// password: String,
// database: String,
// prefix: String, // default is `cacheall:`
// setex: Function
}
}
```
### set(key, value, [expireIn])
Set cache:
```javascript
const cache = require('cache-all')
cache
.set('foo', 'bar')
.then(result => console.log(result))
```
Set cache with specific expire time (second):
```javascript
const cache = require('cache-all')
cache
.set('foo', 'bar', 90)
.then(result => console.log(result)) // {status: 1}
```
### get(key)
Get cache (if key doesn't exist, null will be return):
```javascript
const cache = require('cache-all')
cache
.get('foo')
.then(result => console.log(result)) // 'bar'
```
### getAll()
Get all cached entries as array:
```javascript
const cache = require('cache-all')
cache
.getAll()
.then(result => console.log(result)) // [ { key: 'foo', value: 'bar'},... ]
```
### has(key)
**Deprecated**: should use `cache.get` and then check returned value instead use this function because costs of these functions is same.
Check if given key exist:
```javascript
const cache = require('cache-all')
cache
.has('foo')
.then(result => console.log(result)) // true
```
### remove(key)
Remove given cache key:
```javascript
const cache = require('cache-all')
cache
.remove('foo')
.then(result => console.log(result)) // {status: 1}
```
### removeByPattern(pattern)
Remove all cached data base on pattern/text:
```javascript
const cache = require('cache-all')
await cache.set('user_foo', { name: 'foo' })
await cache.set('user_bar', { name: 'bar' })
await cache.removeByPattern('user') // or removeByPattern(/user/)
```
### middleware([expireIn], [prefix]) (Cache on express route)
This package provide a middleware which will cache your response data
base on request fullpath, request method and prefix (optinal).
**NOTE**: using prefix if you want manual clear data that was cached by middleware (using `removeByPattern(prefix)` method)
```javascript
const express = require('express')
const router = express.Router()
const cache = require('cache-all')
router.get('/api/user', cache.middleware(86400, 'user'), function(req, res, next) {
res.json({foo: 'bar'})
})
// First time request '/foo' will cache response data before send back to client (non-blocking)
// Next time requests '/foo' will be response cached data immediately
```
## Usages (multi engine)
You can use many cache engine together in your application, each engine still has
singleton instance of it, that work independent with other
Just require specific engine you need instead require root
- init
```javascript
const fileCache = require('cache-all/file')
const memoryCache = require('cache-all/memory')
// ...
fileCache.init({
ttl: 60,
file: {
path: path.join(process.cwd(), 'storage', 'cache')
}
})
memoryCache.init({
ttl: 60,
})
// ...
app.listen(...)
```
- set/get/has/remove/middleware
```javascript
const fileCache = require('cache-all/file')
const memoryCache = require('cache-all/memory')
fileCache
.set('foo', 'bar', 90)
.then(result => console.log(result)) // {status: 1}
memoryCache
.set('foo', 'bar', 90)
.then(result => console.log(result)) // {status: 1}
```
## Typescript
Add `@types/express` and `@type/redis` as devDependencies:
```
yarn add -D @types/express @types/redis
```
That's it!
## Test
```
npm run test
```
## TODO
- Mongo cache engines
- Reduce number of dependencies
- Update Code coverage
- Event
## Contributes
You are welcome <3
## Release Note
|Version|Date|Description|
|:--:|:--:|:--|
|1.0.0|2019-01-14|First version, contain basic functions|
|1.1.0|2019-08-19|Add removeByPattern function & update dependencies|
|2.0.0|2019-09-05|Re-structure (DRY) & remove `mkdirp` dependency |
|2.0.1|2019-09-08|Refactor FileStore - use ES6 class instead prototype|
|2.0.2|2019-09-21|Add `getAll` method & integrate travis-ci & code coverage|
|2.0.6|2019-10-24|Allow redis empty prefix [PR#15](https://github.com/bahung1221/cache-all/pull/15)|
|2.0.8|2019-10-28|FS async implementation [PR#19](https://github.com/bahung1221/cache-all/pull/19)|
|2.1.0|2019-10-28|Add type definition (typescript) [PR#22](https://github.com/bahung1221/cache-all/pull/22)|
|2.1.1|2020-08-05|Upgrade node-redis to `v3` (Removed hiredis completely)|
## License
This project is licensed under the terms of the [MIT](https://github.com/bahung1221/cache-all/blob/master/LICENSE) license