Documentation / @eventkit/http / EventSourceSerializerInit

Type Alias: EventSourceSerializerInit<T>

type EventSourceSerializerInit<T> = object;

Configuration options for customizing how events are serialized into SSE format. Each property can be a function that extracts the corresponding SSE field from an event, or null to exclude that field from the output.

Type Parameters

Type Parameter	Description
T	The type of the events being serialized

Properties

getEvent?

optional getEvent: (value, index) => string | null;

Function to extract the event data. If null, no data will be included. If undefined, the event will be JSON stringified if it's an object, or converted to string otherwise.

---

getId?

optional getId: (value, index) => string | null;

Function to extract the event ID. If null, no ID will be included. If undefined, the event index will be used as the ID.

---

getType?

optional getType: (value, index) => string | null;

Function to extract the event type. If null, no type will be included. If undefined, no type will be included.