GroupStreamWriter interface
Abstraction du groupe de streams writer pour envoyer un flux logique à un groupe.
Propriétés
| stream |
Identifiant du flux. |
Méthodes
| abort(Stream |
Interrompez le flux avec une erreur. |
| end(End |
Terminez le stream avec succès. |
| on |
Erreur de rappel du flux sortant du registre. Renvoie une fonction pour désenregistrer ce rappel. |
| write(JSONTypes | Array |
Écris un fragment de flux. |
Détails de la propriété
streamId
Identifiant du flux.
streamId: stringValeur de propriété
string
Détails de la méthode
abort(StreamEndError, AbortGroupStreamOptions)
Interrompez le flux avec une erreur.
function abort(error: StreamEndError, options?: AbortGroupStreamOptions): Promise<void>Paramètres
- error
- StreamEndError
- options
- AbortGroupStreamOptions
Retours
Promise<void>
end(EndGroupStreamOptions)
Terminez le stream avec succès.
function end(options?: EndGroupStreamOptions): Promise<void>Paramètres
- options
- EndGroupStreamOptions
Retours
Promise<void>
onError((error: StreamDataError) => void)
Erreur de rappel du flux sortant du registre. Renvoie une fonction pour désenregistrer ce rappel.
function onError(listener: (error: StreamDataError) => void): () => voidParamètres
- listener
-
(error: StreamDataError) => void
Retours
() => void
write(JSONTypes | ArrayBuffer, WebPubSubDataType, GroupStreamWriteOptions)
Écris un fragment de flux.
function write(content: JSONTypes | ArrayBuffer, dataType: WebPubSubDataType, options?: GroupStreamWriteOptions): Promise<void>Paramètres
- content
-
JSONTypes | ArrayBuffer
- dataType
- WebPubSubDataType
- options
- GroupStreamWriteOptions
Retours
Promise<void>