File size: 1,167 Bytes
bc20498 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 |
/**
* A TransformStream that ingests a stream of strings and produces a stream of ParsedEvents.
*
* @example
* ```
* const eventStream =
* response.body
* .pipeThrough(new TextDecoderStream())
* .pipeThrough(new EventSourceParserStream())
* ```
* @public
*/
export declare class EventSourceParserStream extends TransformStream<string, ParsedEvent> {
constructor()
}
/**
* A parsed EventSource event
*
* @public
*/
export declare interface ParsedEvent {
/**
* Differentiates the type from reconnection intervals and other types of messages
* Not to be confused with `event`.
*/
type: 'event'
/**
* The event type sent from the server. Note that this differs from the browser `EventSource`
* implementation in that browsers will default this to `message`, whereas this parser will
* leave this as `undefined` if not explicitly declared.
*/
event?: string
/**
* ID of the message, if any was provided by the server. Can be used by clients to keep the
* last received message ID in sync when reconnecting.
*/
id?: string
/**
* The data received for this message
*/
data: string
}
export {}
|