@keyvhq/redis

@keyvhq/redis

Redis storage adapter for Keyv.

TTL functionality is handled directly by Redis so no timestamps are stored and expired keys are cleaned up internally.

Install

npm install --save @keyvhq/core @keyvhq/redis

Usage

const KeyvRedis = require('@keyvhq/redis')
const Keyv = require('@keyvhq/core')

const keyv = new Keyv({ 
  store: new KeyvRedis('redis://user:pass@localhost:6379')
})

keyv.on('error', handleConnectionError)

Any valid Redis options will be passed directly through:

const KeyvRedis = require('@keyvhq/redis')
const Keyv = require('@keyvhq/core')

const keyv = new Keyv({ 
  store: new KeyvRedis('redis://user:pass@localhost:6379', {
    disable_resubscribing: true
  })
})

Or you can reuse a previously declared Redis instance:

const KeyvRedis = require('@keyvhq/redis')
const Keyv = require('@keyvhq/core')
const Redis = require('ioredis')

const redis = new Redis('redis://user:pass@localhost:6379')
const keyv = new Keyv({ store: new KeyvRedis(redis) })

License

@keyvhq/redis © Luke Childs, released under the MIT License.
Maintained by Microlink with help from contributors.

microlink.io · GitHub microlinkhq · Twitter @microlinkhq

Changelog

1.6.18 (2022-07-12)

Note: Version bump only for package @keyvhq/monorepo