@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 keyv @keyvhq/redis

Usage

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

const keyv = new Keyv('redis://user:pass@localhost:6379')
keyv.on('error', handleConnectionError)

Any valid Redis options will be passed directly through.

e.g:

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

Or you can manually create a storage adapter instance and pass it to Keyv:

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

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

Or reuse a previous 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 keyvRedis = new KeyvRedis(redis)
const keyv = new Keyv({ store: keyvRedis })

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.4.0 (2021-09-12)

Bug Fixes

• convert key to string if possible (4a232b9)
• fixed namespacing bugs (f14cd4f)
• namespace api (fd07736)
• no namespaced iteration of maps (77b9724)
• test: t.fail instead of t.throw (5dfd9bb)

Features

• use empty namespace by default (a2872d3)