Interface●Since v1.9

ChannelEffectOptions

Options for acquireChannelEffect. Extends ChannelProjectionOptions (bufferSize, replay) with the per-event callback and an optional error sink.

interface ChannelEffectOptions

Bases

ChannelProjectionOptions

Properties

property

bufferSize: number

Maximum number of events retained in the projection snapshot. Defaults to 4096 so replay-backed discovery hooks can tolerate bursty token/media streams without dropping early lifecycle events.

property

onError: (error: unknown) => void

Callback that is called when an error occurs.

property

onEvent: (event: Event) => void

Invoked once for every event observed while attached.

property

replay: boolean

Whether to open a real subscription and receive replayed history. Defaults to true. Set false for live-only root-bus inspection when replay is unnecessary.