Index: lib/src/json_document_transformer.dart |
diff --git a/lib/src/json_document_transformer.dart b/lib/src/json_document_transformer.dart |
index 8d8dcce231b68cbdbe14b8bc308491a700ced464..d276e6bfb6b8b103ec7a850b062328037d33f32a 100644 |
--- a/lib/src/json_document_transformer.dart |
+++ b/lib/src/json_document_transformer.dart |
@@ -17,6 +17,10 @@ final jsonDocument = new JsonDocumentTransformer(); |
/// |
/// This decodes JSON that's emitted by the transformed channel's stream, and |
/// encodes objects so that JSON is passed to the transformed channel's sink. |
+/// |
+/// If the transformed channel emits invalid JSON, this will emit a |
+/// [FormatException]. If an unencodable object is added to the sink, it will |
Bob Nystrom
2016/02/01 22:48:28
Remove "will".
|
+/// synchronously throws a [JsonUnsupportedObjectError]. |
class JsonDocumentTransformer |
implements StreamChannelTransformer<String, Object> { |
/// The underlying codec that implements the encoding and decoding logic. |