@runloop/remote-agents-sdk
    Preparing search index...

    Interface AxonStreamOptions

    Configuration for creating a low-level Axon stream via axonStream.

    interface AxonStreamOptions {
        afterSequence?: number;
        axon: Axon;
        log?: LogFn;
        onAxonEvent?: (event: AxonEventView) => void;
        onError?: (error: unknown) => void;
        replayTargetSequence?: number;
        signal?: AbortSignal;
        source?: string | (() => string | undefined);
    }
    Index

    ACP Protocol

    afterSequence? axon log? onAxonEvent? onError? replayTargetSequence? signal? source?

    ACP Protocol

    afterSequence?: number

    Axon sequence number to resume from. When set, the initial SSE subscription starts after this sequence — earlier events are skipped. Omit to replay the full event history.

    axon: Axon

    Axon channel to connect to (from @runloop/api-client).

    log?: LogFn

    Diagnostic log callback. When provided, the stream emits verbose logs.

    onAxonEvent?: (event: AxonEventView) => void

    Called for every Axon event before JSON-RPC translation.

    onError?: (error: unknown) => void

    Called when a non-critical error occurs (e.g. unparseable SSE event). Defaults to console.error.

    replayTargetSequence?: number

    When set, events with sequence <= replayTargetSequence are considered historical replay. During replay, onAxonEvent still fires (so timeline listeners work) but agent-to-client requests are buffered instead of enqueued. After replay ends, only unresolved requests are enqueued.

    signal?: AbortSignal

    AbortSignal to cancel the SSE connection and stop publishing.

    source?: string | (() => string | undefined)

    The source string attached to every published Axon event, or a resolver invoked at publish time to obtain it. Use the resolver form to change the source between messages without recreating the stream (e.g. () => this.currentSource). When omitted, or when the resolver returns undefined, the default is used.

    "acp-sdk-client"

    Settings

    Member Visibility

    On This Page

    ACP Protocol