@keyv/redis is an npm package that provides a Redis storage adapter for Keyv, a simple key-value storage library. It allows you to use Redis as a backend for storing key-value pairs, making it easy to integrate Redis into your Node.js applications.

What are @keyv/redis's main functionalities?

Basic Key-Value Storage

This feature allows you to store and retrieve basic key-value pairs using Redis as the backend. The code sample demonstrates how to set and get a value from the Redis store.

const Keyv = require('keyv');
const keyv = new Keyv('redis://user:pass@localhost:6379');

(async () => {
  await keyv.set('foo', 'bar');
  const value = await keyv.get('foo');
  console.log(value); // 'bar'
})();

Expiration of Keys

This feature allows you to set an expiration time for keys. The code sample demonstrates how to set a key with an expiration time and shows that the key is no longer available after the specified time.

const Keyv = require('keyv');
const keyv = new Keyv('redis://user:pass@localhost:6379');

(async () => {
  await keyv.set('foo', 'bar', 1000); // Expires in 1 second
  setTimeout(async () => {
    const value = await keyv.get('foo');
    console.log(value); // undefined
  }, 1500);
})();

Namespace Support

This feature allows you to use namespaces to avoid key collisions. The code sample demonstrates how to set and get a value within a specific namespace.

const Keyv = require('keyv');
const keyv = new Keyv({ uri: 'redis://user:pass@localhost:6379', namespace: 'myapp' });

(async () => {
  await keyv.set('foo', 'bar');
  const value = await keyv.get('foo');
  console.log(value); // 'bar'
})();

Other packages similar to @keyv/redis

Readme

Source

@keyv/redis

Redis storage adapter for Keyv

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

Usage

const Keyv = require('keyv');

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('@keyv/redis');
const Keyv = require('keyv');

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

Or reuse a previous Redis instance:

const KeyvRedis = require('@keyv/redis');
const Redis = require('ioredis');
const Keyv = require('keyv');

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

Or reuse a previous Redis cluster:

const KeyvRedis = require('@keyv/redis');
const Redis = require('ioredis');
const Keyv = require('keyv');

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

License

Keywords

FAQs

What is @keyv/redis?

Is @keyv/redis well maintained?

Last updated on 17 Oct 2022

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install