ioredis

Create a new bot

Scaffold a Next.js bot that stores state in Redis through ioredis with create-chat-sdk. Replace slack with your platform adapter:

The CLI adds @chat-adapter/state-ioredis, wires createIoRedisState({ url: process.env.REDIS_URL }) into src/lib/bot.ts, and lists REDIS_URL in .env.example. To add the adapter to an existing app, start at Install.

Install

Quick start

import { Chat } from "chat";
import { createIoRedisState } from "@chat-adapter/state-ioredis";

const bot = new Chat({
  userName: "mybot",
  adapters: { /* ... */ },
  state: createIoRedisState({ url: process.env.REDIS_URL! }),
});

To provision Upstash Redis or Redis Cloud for a Vercel project with the Vercel CLI, see Vercel Marketplace on the Redis adapter page. The same connection URL works with this adapter.

When to choose ioredis vs redis

Both adapters implement the same state operations with the same key layout. The difference is the Redis client underneath.

Use @chat-adapter/state-ioredis when:

• You already use ioredis in your project.
• You need Redis Sentinel. Pass a Sentinel-configured Redis client as client.
• You prefer the ioredis API.

Use @chat-adapter/state-redis when:

• You want the official redis client.
• You're starting a new project and don't need Sentinel.

Neither adapter supports Redis Cluster. The ioredis adapter's client option accepts a Redis instance, and an ioredis Cluster doesn't satisfy that type.

Configuration

Either url or client is required.

Environment variables

The adapter doesn't read environment variables itself, so pass the URL in your code.

Using an existing client

Pass an ioredis client as client. ioredis connects on its own, and the adapter's disconnect() doesn't quit a client it didn't create.

import Redis from "ioredis";
import { createIoRedisState } from "@chat-adapter/state-ioredis";

const client = new Redis("redis://localhost:6379");

export const state = createIoRedisState({ client });

Data model

Every key starts with keyPrefix, which defaults to "chat-sdk". The layout matches @chat-adapter/state-redis.

Feature support