Skip to content
English

SseOutputEvent ​

SUPPORT · interface · 类型合同

One outbound event before wire encoding.

导入 ​

ts
import type { SseOutputEvent } from '@jangts/agent-core/sse';
js
/** @typedef {import('@jangts/agent-core/sse').SseOutputEvent} SseOutputEvent */

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

定义 ​

ts
interface SseOutputEvent

字段结构 ​

字段类型必需说明
eventstring必需Event name; must not contain a line break.
datastring必需Payload text; each line becomes its own data: field.

使用示例 ​

在本地解析一帧 SSE ​

入门 · Node.js

ts
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);
js
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

ts
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);
js
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);

相关策略源码 ​

接口参考、使用示例与开发指南。