Add note about sendBody buffering to docs
authorRyan <ry@tinyclouds.org>
Mon, 7 Sep 2009 10:56:10 +0000 (12:56 +0200)
committerRyan <ry@tinyclouds.org>
Mon, 7 Sep 2009 10:56:10 +0000 (12:56 +0200)
website/api.txt

index ce5ec38..a4583c6 100644 (file)
@@ -702,6 +702,12 @@ specifies how to encode it into a byte stream. By default the
 +
 Note: This is the raw HTTP body and has nothing to do with
 higher-level multi-part body encodings that may be used.
++
+The first time +sendBody+ is called, it will send the buffered header
+information and the first body to the client. The second time
++sendBody+ is called, Node assumes you're going to be streaming data, and
+sends that seperately. That is, the response is buffered up to the
+first chunk of body.
 
 
 +response.finish()+ ::