Skip to content

This is the cache plugin for running next-boost on a cluster

Notifications You must be signed in to change notification settings

next-boost/redis-cache

Repository files navigation

Coverage Status Maintainability

redis-cache

A redis-based cache for next-boost. If you have a cluster of next-boost running, using this plugin to share the cache between instances.

npm i @next-boost/redis-cache

Usage

// in .next-boost.js
const RedisCache = require('@next-boost/redis-cache/dist/adapter').default

module.exports = {
  cacheAdapter: RedisCache.init({
    uri: 'redis://<your-host>/<db>',
    ttl: 15,
    tbd: 3600,
  }),
  rules: [
    ...
  ],
}

Passing your own Redis Client

You can also provide an ioredis client or or cluster instance if you need advanced configuration

cacheAdapter: RedisCache.init({
    redis: new Redis.Cluster({...}),
    ttl: 15,
    tbd: 3600,
})

License

MIT. Copyright 2020, Rakuraku Jyo.