sse.ts

Source : sdks/typescript/packages/sdk/src/sse.ts. Retour à l'index de la référence du SDK TypeScript.

remarque

Cette page est générée par tools/docs/gen_sdk_reference.py depuis les sources du SDK et les dossiers de textes OpenAPI. Ne la modifiez pas à la main : changez la source et régénérez.

Interface SSEMessage

Un message Server-Sent Events : nom d'événement, données, identifiant et délai de reconnexion.

Champs :

Nom	Type	Requis	Description
event	string	oui	Nom de l'événement, message quand le flux n'en donne pas.
data	string	oui	Texte brut des lignes data de l'événement, joint par des retours à la ligne.
id	string	non	Valeur du dernier champ id.
retry	number	non	Délai de reconnexion en millisecondes issu du champ retry.

Classe SSEParser

Analyseur incrémental de Server-Sent Events. Il accepte des morceaux de texte quelconques (qui peuvent couper des lignes, des champs ou même des paires CRLF) et renvoie les messages complets vus jusqu'ici.

SSEParser.end

end(): SSEMessage[]

Émet un dernier message quand le flux se termine sans ligne vide.

Cet élément ne prend aucun paramètre.

Retour : SSEMessage[]. Les derniers messages, éventuellement aucun.

SSEParser.push

push(chunk: string): SSEMessage[]

Ajoute un morceau de texte et renvoie les messages qu'il complète.

Nom	Type	Défaut	Requis	Description
chunk	string		oui	Morceau de texte du flux, coupé n'importe où.

Retour : SSEMessage[]. Messages terminés par une ligne vide dans ce morceau.