GroupStreamWriter interface
Astrazione dello scrittore di flusso di gruppo per inviare un flusso logico a un gruppo.
Proprietà
| stream |
Identificatore del flusso. |
Metodi
| abort(Stream |
Interrompi lo stream con un errore. |
| end(End |
Termina la diretta con successo. |
| on |
Registra callback di errore del flusso in uscita. Restituisce una funzione per annullare questo callback. |
| write(JSONTypes | Array |
Scrivi un frammento di stream. |
Dettagli proprietà
streamId
Identificatore del flusso.
streamId: stringValore della proprietà
string
Dettagli metodo
abort(StreamEndError, AbortGroupStreamOptions)
Interrompi lo stream con un errore.
function abort(error: StreamEndError, options?: AbortGroupStreamOptions): Promise<void>Parametri
- error
- StreamEndError
- options
- AbortGroupStreamOptions
Valori restituiti
Promise<void>
end(EndGroupStreamOptions)
Termina la diretta con successo.
function end(options?: EndGroupStreamOptions): Promise<void>Parametri
- options
- EndGroupStreamOptions
Valori restituiti
Promise<void>
onError((error: StreamDataError) => void)
Registra callback di errore del flusso in uscita. Restituisce una funzione per annullare questo callback.
function onError(listener: (error: StreamDataError) => void): () => voidParametri
- listener
-
(error: StreamDataError) => void
Valori restituiti
() => void
write(JSONTypes | ArrayBuffer, WebPubSubDataType, GroupStreamWriteOptions)
Scrivi un frammento di stream.
function write(content: JSONTypes | ArrayBuffer, dataType: WebPubSubDataType, options?: GroupStreamWriteOptions): Promise<void>Parametri
- content
-
JSONTypes | ArrayBuffer
- dataType
- WebPubSubDataType
- options
- GroupStreamWriteOptions
Valori restituiti
Promise<void>