ChainGraph API Documentation / @badaitech/chaingraph-channel / types / BaseChannelConfig

Interface: BaseChannelConfig

Defined in: types/ChannelConfig.d.ts:8

Base configuration for all channel implementations.

Extended by

• DBOSChannelConfig
• InMemoryChannelConfig
• TRPCChannelConfig

Properties

cleanupStrategy?

optional cleanupStrategy: BufferCleanupStrategy

Defined in: types/ChannelConfig.d.ts:28

Buffer cleanup strategy when maxBufferSize is reached.

• min-position: Keep items from slowest subscriber forward (fair to all)
• sliding-window: Always keep last N items (simple, may drop slow consumers)
• time-based: Remove items older than maxBufferAge
• none: No cleanup (unbounded growth)

Default

'min-position'

---

maxBufferAge?

optional maxBufferAge: number

Defined in: types/ChannelConfig.d.ts:36

Maximum age of buffered items in milliseconds (for time-based cleanup).

Only used when cleanupStrategy is 'time-based'.

Default

60000 (1 minute)

---

maxBufferSize?

optional maxBufferSize: number

Defined in: types/ChannelConfig.d.ts:17

Maximum buffer size (0 = unbounded)

When buffer exceeds this size, cleanup is triggered based on cleanupStrategy.

Default

1000 for InMemoryChannel

Default

0 for DBOSChannel (database-backed, no in-memory buffer limit)