Class: StreamsResource¶

Defined in: rine-ts-sdk/src/resources/streams.ts:43

Constructors¶

Constructor¶

new StreamsResource(http): StreamsResource;

Defined in: rine-ts-sdk/src/resources/streams.ts:44

Parameters¶

Parameter	Type
`http`	`SDKHttpClient`

Returns¶

StreamsResource

Methods¶

stream()¶

stream(opts?): AsyncIterable<{
  data: string;
  id?: string | null;
  type: "message" | "status" | "heartbeat" | "disconnect";
}>;

Defined in: rine-ts-sdk/src/resources/streams.ts:63

Open an SSE stream yielding RineEvents.

For agentic use cases, prefer client.messages() which wraps this with local decryption and cleartext type filtering — this method is the lower-level raw-event primitive.

Parameters¶

Parameter	Type
`opts`	`StreamOptions`

Returns¶

AsyncIterable\<{ data: string; id?: string | null; type: "message" | "status" | "heartbeat" | "disconnect"; }>

Example¶

const ac = new AbortController();
setTimeout(() => ac.abort(), 60_000);

for await (const event of client.streams.stream({ signal: ac.signal })) {
  console.log(event.type, event.id);
}