Installation
Requirements
Section titled “Requirements”| Dependency | Version |
|---|---|
| Node.js | >= 18 |
| RxJS | >= 7.8.0 |
| TypeScript | >= 5.0 (recommended) |
Install
Section titled “Install”npm install rxjs-ai rxjspnpm add rxjs-ai rxjsyarn add rxjs-ai rxjsrxjs is a peer dependency — you must install it alongside rxjs-ai.
Package exports
Section titled “Package exports”| Import path | What you get |
|---|---|
rxjs-ai | Core primitives, AI controllers, and UI utilities — createStore, createCommandBus, createAsyncController, createChatController, createViewModel |
import { createStore, createCommandBus, createAsyncController, createChatController, createViewModel,} from 'rxjs-ai';TypeScript
Section titled “TypeScript”All types are exported directly from the main entry point. No separate @types package is needed.
import type { Store, StateUpdater, StatePatch, CommandBus, CommandMap, CommandEnvelope, AsyncController, AsyncState, AsyncStatus, ChatController, ChatModelAdapter, ChatModelRequest, ChatMessage, ChatState, ChatStatus, ChatRole, ChatChunk,} from 'rxjs-ai';Next steps
Section titled “Next steps” Quick Start Build your first streaming chat in 5 minutes.