covenix

Appearance

covenix / SseEvent

Class: SseEvent<T> ​

Defined in: src/sse.ts:29

A Server-Sent Event with explicit framing. Yield one from an @Sse handler to set the event/id/retry fields; yield a plain value to frame it as a data: line with no framing metadata. The data is validated against the @Sse schema, if any.

Example ​

ts
yield token;                                   // data: <json>
yield new SseEvent(result, { event: 'done' }); // event: done\ndata: <json>

Type Parameters ​

T ​

T = unknown

Constructors ​

Constructor ​

new SseEvent<T>(data, init?): SseEvent<T>

Defined in: src/sse.ts:39

Parameters ​

data ​

T

init? ​

SseEventInit = {}

Returns ​

SseEvent<T>

Properties ​

data ​

readonly data: T

Defined in: src/sse.ts:31

The event payload (validated against the @Sse schema).

event ​

readonly event: string | undefined

Defined in: src/sse.ts:33

Event name, if set.

id ​

readonly id: string | number | undefined

Defined in: src/sse.ts:35

Event id, if set.

retry ​

readonly retry: number | undefined

Defined in: src/sse.ts:37

Reconnection delay hint (ms), if set.