@chat-adapter/state-memory
v4.31.0
Published
In-memory state adapter for Chat SDK — zero-dependency subscriptions, locks, and cache for local development and tests
Readme
@chat-adapter/state-memory
npm package:
@chat-adapter/state-memory
In-memory state adapter for Chat SDK. For development and testing only — state is lost on restart.
Warning: Only use the memory adapter for local development and testing. State is lost on restart and locks don't work across multiple instances. For production, use @chat-adapter/state-redis, @chat-adapter/state-ioredis, or @chat-adapter/state-pg.
Documentation: chat-sdk.dev/adapters/official/memory · Guides: vercel.com/kb/chat-sdk
Installation
pnpm add @chat-adapter/state-memoryScaffold with the CLI
To scaffold a local-development Slack bot that uses in-memory state:
npx create-chat-sdk@latest my-bot --adapter slack memoryVisit the adapters directory to see other available official and vendor-official adapters.
Usage
import { Chat } from "chat";
import { createMemoryState } from "@chat-adapter/state-memory";
const bot = new Chat({
userName: "mybot",
adapters: { /* ... */ },
state: createMemoryState(),
});No configuration options are needed.
Features
| Feature | Supported | |---------|-----------| | Persistence | No | | Multi-instance | No | | Subscriptions | Yes (in-memory) | | Locking | Yes (single-process only) | | Key-value caching | Yes (in-memory) | | Zero configuration | Yes |
Limitations
- Not suitable for production — state is lost on restart
- Single process only — locks don't work across multiple instances
- No persistence — subscriptions reset when the process restarts
When to use
- Local development
- Unit testing
- Quick prototyping
AI Coding Agents
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).
License
MIT
