SSE response reference

Generated from the same public contract that feeds the Monaco editor. Declaration-marked deprecated compatibility methods are intentionally excluded. Do not edit this page manually.

This page contains 5 methods. Search the docs for an exact method name, or use this index:

sse.onDisconnect()
sse.send()
sse.json()
sse.comment()
sse.remainingTime()

`sse.onDisconnect()`

Register one callback for continue-and-notify disconnect policy. Invoked at most once in the same isolate. Shares the original execution deadline; no extra time is granted. continue skips it and cancel disposes the isolate. Registration after disconnect still notifies once while execution remains alive. Callback failures appear in diagnostics. CPU-bound code, a hard timeout or process failure can prevent notification; this is not a durable cleanup guarantee.

Signature

static onDisconnect(callback: () => void | Promise<void>): void;

Example

sse.onDisconnect(async () => { await api.setInstanceCache('connection-state', { disconnected: true }, 300); });

`sse.send()`

Send text as SSE data. Await for backpressure, not acknowledgement by the receiver.

Signature

static send(data: string, options?: SseOptions): Promise<void>;

Example

await sse.send('Hello', { event: 'delta', id: '1', retry: 3000 });

`sse.json()`

Serialize JSON and send it as SSE data. Configured automatic terminal event names are reserved; null disables a terminal frame.

Signature

static json(data: JsonValue, options?: SseOptions): Promise<void>;

Example

await sse.json({ current: 1, total: 10 }, { event: 'progress', id: '1' });

`sse.comment()`

Send a multiline-safe comment. The host also emits automatic heartbeats.

Signature

static comment(text: string): Promise<void>;

Example

await sse.comment('Working');

`sse.remainingTime()`

Remaining execution budget in milliseconds, never negative.

Signature

static remainingTime(): number;

Example

const remainingMs = sse.remainingTime();

Build applications

Low-code runtime

Low-code reference

SSE response reference

`sse.onDisconnect()`

Signature

Example

`sse.send()`

Signature

Example

`sse.json()`

Signature

Example

`sse.comment()`

Signature

Example

`sse.remainingTime()`

Signature

Example

​sse.onDisconnect()

​Signature

​Example

​sse.send()

​Signature

​Example

​sse.json()

​Signature

​Example

​sse.comment()

​Signature

​Example

​sse.remainingTime()

​Signature

​Example

`sse.onDisconnect()`

Signature

Example

`sse.send()`

Signature

Example

`sse.json()`

Signature

Example

`sse.comment()`

Signature

Example

`sse.remainingTime()`

Signature

Example