package
ioredis state adapter for Chat SDK: production state with Redis Sentinel support via ioredis
npm install @chat-adapter/state-ioredisGitHub-flavored package documentation.
Across all versions, last 30 days.
518,282 in 30 days
Runtime metadata.
Tagged topics.
npm package:
@chat-adapter/state-ioredis
Alternative Redis state adapter for Chat SDK using ioredis. Use this if you already have ioredis in your project or need Redis Sentinel support.
Documentation: chat-sdk.dev/adapters/official/ioredis · Guides: vercel.com/kb/chat-sdk
pnpm add @chat-adapter/state-ioredisTo scaffold a new Slack bot that uses ioredis for state:
npx create-chat-sdk@latest my-bot --adapter slack ioredisVisit the adapters directory to see other available official and vendor-official adapters.
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!,
}),
});import Redis from "ioredis";
const client = new Redis("redis://localhost:6379");
const state = createIoRedisState({ client });| Option | Required | Description |
|---|---|---|
url | Yes* | Redis connection URL |
client | No | Existing ioredis client instance |
keyPrefix | No | Prefix for all keys (default: "chat-sdk") |
logger | No | Logger for error reporting (default: console logger) |
*Either url or client is required.
Use @chat-adapter/state-ioredis when:
Use @chat-adapter/state-redis when:
Neither adapter supports Redis Cluster. The client option accepts an ioredis Redis instance, and a Cluster doesn't satisfy that type.
{keyPrefix}:subscriptions - SET of subscribed thread IDs
{keyPrefix}:lock:{threadId} - Lock key with TTL| Feature | Supported |
|---|---|
| Persistence | Yes |
| Multi-instance | Yes |
| Subscriptions | Yes |
| Distributed locking | Yes |
| Key-value caching | Yes |
| Automatic reconnection | Yes |
| Redis Cluster support | No |
| Redis Sentinel support | Yes |
| Key prefix namespacing | Yes |
If you use an AI coding agent such as OpenAI Codex, Claude Code, or Cursor, install the Chat SDK skill so it knows the SDK APIs, adapter patterns, and project conventions before writing code.
npx skills add vercel/chatThe skill references bundled documentation in node_modules/chat/docs, plus adapter guides and starter templates in the published package.
You can also install the Vercel Plugin for a broader agent toolkit — it includes the Chat SDK skill alongside specialist agents, agent slash commands, and more:
npx plugins add vercel/vercel-pluginThe plugin is optional; the skill alone is enough to build with Chat SDK.
For agent-readable documentation, see chat-sdk.dev/llms.txt (page index) or chat-sdk.dev/llms-full.txt (full text).
MIT
vercel-release-bot
infra+release@vercel.com