SseReadOptions

CORE · type · 类型合同

Per-read configuration; snapshotted when readSse starts.

导入

TypeScript

import type { SseReadOptions } from '@jangts/agent-core/sse';

JavaScript

/** @typedef {import('@jangts/agent-core/sse').SseReadOptions} SseReadOptions */

其他公开入口：@jangts/agent-core、@jangts/agent-core/types、@jangts/agent-core/structs、@jangts/agent-core/sse、@jangts/agent-core/support。

定义

类型： SseReadOptions

字段结构

字段	类型	必需	说明
signal	AbortSignal | undefined	可省略	Cancels the pending read and any later read from the same stream.
idleTimeoutMs	number | undefined	可省略	Maximum silence between chunks in milliseconds; omitted or <= 0 disables the timer.
waitForCancel	boolean | undefined	可省略	Await reader.cancel() before returning. false lets browser adapters skip the wait.

使用示例

• SSE、JSON 帧与有界事件流：复用传输机制，保持取消和背压；协议解析与业务校验仍各自负责。
• Support：推荐用法的聚合入口：Support 聚合推荐的构造、策略与同源配置生成；Core 运行不依赖这个命名空间。

在本地解析一帧 SSE

入门 · Node.js

TypeScript

import { Support } from '@jangts/agent-core';
const frame = Support.encodeSseEvent({ event: 'status', data: JSON.stringify({ phase: 'thinking' }) });
const body = new Response(frame).body!;
for await (const event of Support.readSse(body)) console.log(event.event, event.data);

JavaScript

import { Support } from '@jangts/agent-core';
const frame = Support.encodeSseEvent({ event: 'status', data: JSON.stringify({ phase: 'thinking' }) });
const body = new Response(frame).body;
for await (const event of Support.readSse(body))
    console.log(event.event, event.data);

生产者等待每一次事件交付

配置 · Node.js

TypeScript

import { Support } from '@jangts/agent-core';
const signal = new AbortController().signal;
const stream = Support.streamEvents<{ phase: string }>(async emit => {
  await emit({ phase: 'preparing' });
  await emit({ phase: 'complete' });
}, { signal });
for await (const event of stream) console.log(event.phase);

JavaScript

import { Support } from '@jangts/agent-core';
const signal = new AbortController().signal;
const stream = Support.streamEvents(async (emit) => {
    await emit({ phase: 'preparing' });
    await emit({ phase: 'complete' });
}, { signal });
for await (const event of stream)
    console.log(event.phase);

相关策略源码

• 事件流单槽交接与背压