File size: 2,844 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 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 |
/**
* Creates a new EventSource parser.
*
* @param onParse - Callback to invoke when a new event is parsed, or a new reconnection interval
* has been sent from the server
*
* @returns A new EventSource parser, with `parse` and `reset` methods.
* @public
*/
export declare function createParser(onParse: EventSourceParseCallback): EventSourceParser
/**
* Callback passed as the `onParse` callback to a parser
*
* @public
*/
export declare type EventSourceParseCallback = (event: ParseEvent) => void
/**
* EventSource parser instance.
*
* Needs to be reset between reconnections/when switching data source, using the `reset()` method.
*
* @public
*/
export declare interface EventSourceParser {
/**
* Feeds the parser another chunk. The method _does not_ return a parsed message.
* Instead, if the chunk was a complete message (or completed a previously incomplete message),
* it will invoke the `onParse` callback used to create the parsers.
*
* @param chunk - The chunk to parse. Can be a partial, eg in the case of streaming messages.
* @public
*/
feed(chunk: string): void
/**
* Resets the parser state. This is required when you have a new stream of messages -
* for instance in the case of a client being disconnected and reconnecting.
*
* @public
*/
reset(): void
}
/**
* 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
}
/**
* The different types of messages the parsed can emit to the `onParse` callback
*
* @public
*/
export declare type ParseEvent = ParsedEvent | ReconnectInterval
/**
* An event emitted from the parser when the server sends a value in the `retry` field,
* indicating how many seconds the client should wait before attempting to reconnect.
*
* @public
*/
export declare interface ReconnectInterval {
/**
* Differentiates the type from `event` and other types of messages
*/
type: 'reconnect-interval'
/**
* Number of seconds to wait before reconnecting. Note that the parser does not care about
* this value at all - it only emits the value for clients to use.
*/
value: number
}
export {}
|