koa-redis-cache
How to use ?
const cache = const Koa = const app = const options = expire: 60 routes: '/index' app
options
- prefix
- type:
String
orFunction
- redis key prefix, default is
koa-redis-cache:
- If a function is supplied, its signature should be
function(ctx) {}
and it should return a string to use as the redis key prefix
- type:
- expire
- type:
Number
- redis expire time (second), default is
30 * 60
(30 min)
- type:
- passParam
- type:
String
- if the passParam is existed in query string, not get from cache
- type:
- maxLength
- type:
Number
- max length of the body to cache
- type:
- routes
- type:
Array
- the routes to cache, default is
['(.*)']
- It could be
['/api/(.*)', '/view/:id']
, see path-to-regexp
- type:
- exclude
- type:
Array
- the routes to exclude, default is
[]
- It could be
['/api/(.*)', '/view/:id']
, see path-to-regexp
- type:
- onerror
- type:
Function
- callback function for error, default is
function() {}
- type:
- redis
- type:
Object
- redis options
- type:
- redis.port
- type:
Number
- type:
- redis.host
- type:
String
- type:
- redis.options
- type:
Object
- see node_redis
- type:
set different expire for each route
const cache = const Koa = const app = const options = routes: path: '/index' expire: 60 path: '/user' expire: 5 app
notes
koa-redis-cache
will set a custom http headerX-Koa-Redis-Cache: true
when the response is from cache
License
MIT