README.md

botbuilder-redis-storage

Redis storage adapter for Microsoft BotBuilder. This class implements the IBotStorage interface.

Install

yarn add botbuilder-redis-storage redis

Usage

The storage depends on a redis client instance.

var redis = require('redis')
var RedisStorage = require('botbuilder-redis-storage').RedisStorage
var builder = require('botbuilder')

// Initialize redis client
var redisClient = redis.createClient(process.env.REDIS_URL, { prefix: 'bot-storage:' });

// Create new storage with redis client
var storage = new RedisStorage(redisClient)

var connector = new builder.ChatConnector()
var bot = new builder.UniversalBot(connector)

// Configure bot to use the RedisStorage
bot.set('storage', storage)

TTL for conversations

You can assign a life time for conversations. When enabling this feature, conversations that take longer than the give TTL will be deleted automatically. Be aware that future interactions with the bot after starting the conversation won't change the TTL of the conversation. Use this feature with caution.

storage.setConversationTTLInSeconds(30 * 60) // 30 minutes

Test

To run the tests:

yarn install
yarn test

Contact

• Martín Ferández [email protected]
• Santiago Doldán [email protected]