API Reference
ChannelBridgeOptions
Defined in: channels/channel-bridge.ts:56
Options for a ChannelBridge. Three mutually exclusive ways to provide the run layer:
dispatcher— a caller-owned Dispatcher; the bridge attaches its reply router viaaddSessionListener.agent— a self-contained Agent; the bridge creates a dispatcher around it (the throttling knobs below apply).base— sharedrunAgentconfig; the bridge creates a dispatcher from it (the throttling knobs below apply).
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
agent? | Agent | A self-contained agentic loop; the bridge builds a dispatcher around it. | channels/channel-bridge.ts:66 |
base? | DispatcherRunBase | Shared run config (model, memory, tools, system, …) for every session. | channels/channel-bridge.ts:68 |
capacity? | number | Per-session inbound buffer capacity. See DispatcherOptions.capacity. | channels/channel-bridge.ts:72 |
dispatcher? | Dispatcher | A caller-owned dispatcher to drive. Mutually exclusive with agent, base, and the throttling knobs below — a dispatcher you construct carries its own. | channels/channel-bridge.ts:64 |
maxConcurrency? | number | Max runs in flight across all sessions. See DispatcherOptions.maxConcurrency. | channels/channel-bridge.ts:76 |
onError? | (error, sessionId) => void | Observe a run that failed (non-abort). See DispatcherOptions.onError. | channels/channel-bridge.ts:80 |
overflow? | OverflowPolicy<Message> | Inbound overflow policy. See DispatcherOptions.overflow. | channels/channel-bridge.ts:74 |
sessionIdFor? | (message) => string | Map an inbound message to a sessionId. Default defaultSessionId. | channels/channel-bridge.ts:70 |
source | ChannelSource | The transport to connect. | channels/channel-bridge.ts:58 |
supersede? | boolean | Abort the in-flight run when a newer message arrives. See DispatcherOptions.supersede. | channels/channel-bridge.ts:78 |