@joshdb/redis

A provider for @joshdb/core

Description

Want to safely store your data in a redis database? This is the package for you.

Features

• Written in TypeScript
• Offers CommonJS and ESM bundles
• Fully tested

Installation

Using Yarn

yarn add @joshdb/redis@next

Using NPM

npm i @joshdb/redis@next

Provider Options

interface Options {
  /**
   * Redis connection options
   * @since 2.0.0
   */
  connectOptions?: RedisClientOptions; // see https://github.com/redis/node-redis/blob/master/docs/client-configuration.md#createclient-configuration

  /**
   * Expiration time for document entries (seconds)
   * @since 2.0.0
   */
  expiry?: number;

  /**
   * Disable using ``@joshdb/serialize`` for document serialization
   * This can be faster in some cases, but may cause issues with complex data types
   * @since 2.0.0
   */
  disableSerialization?: boolean;
}